fix: Add optional UID query parameter to GetWorkflow (#15251)

eduardodbr · github-actions[bot] · commit 5fc8d4f20934 · 2026-02-17T13:45:44.000Z
Signed-off-by: Eduardo Rodrigues &lt;eduardodbr@hotmail.com&gt;
diff --git a/api/openapi-spec/swagger.json b/api/openapi-spec/swagger.json
diff --git a/pkg/apiclient/workflow/workflow.pb.go b/pkg/apiclient/workflow/workflow.pb.go
diff --git a/pkg/apiclient/workflow/workflow.proto b/pkg/apiclient/workflow/workflow.proto
@@ -26,6 +26,8 @@ message WorkflowGetRequest {
   k8s.io.apimachinery.pkg.apis.meta.v1.GetOptions getOptions = 3;
   // Fields to be included or excluded in the response. e.g. "spec,status.phase", "-status.nodes"
   string fields = 4;
+  // Optional UID to retrieve a specific workflow (useful for archived workflows with the same name)
+  string uid = 5;
 }
 
 message WorkflowListRequest {
diff --git a/sdks/java/client/docs/WorkflowServiceApi.md b/sdks/java/client/docs/WorkflowServiceApi.md
diff --git a/server/workflow/workflow_server.go b/server/workflow/workflow_server.go
@@ -150,7 +150,7 @@ func (s *workflowServer) GetWorkflow(ctx context.Context, req *workflowpkg.Workf
 		wfGetOption = *req.GetOptions
 	}
 	wfClient := auth.GetWfClient(ctx)
-	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, wfGetOption)
+	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, req.Uid, wfGetOption)
 	if err != nil {
 		return nil, sutils.ToStatusError(err, codes.Internal)
 	}
@@ -311,7 +311,7 @@ func (s *workflowServer) WatchWorkflows(req *workflowpkg.WatchWorkflowsRequest,
 		if wfName != "" {
 			// If we are using an alias (such as `@latest`) we need to dereference it.
 			// s.getWorkflow does that for us
-			wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, wfName, metav1.GetOptions{})
+			wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, wfName, "", metav1.GetOptions{})
 			if err != nil {
 				return sutils.ToStatusError(err, codes.Internal)
 			}
@@ -432,7 +432,7 @@ func (s *workflowServer) WatchEvents(req *workflowpkg.WatchEventsRequest, ws wor
 
 func (s *workflowServer) DeleteWorkflow(ctx context.Context, req *workflowpkg.WorkflowDeleteRequest) (*workflowpkg.WorkflowDeleteResponse, error) {
 	wfClient := auth.GetWfClient(ctx)
-	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, metav1.GetOptions{})
+	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, "", metav1.GetOptions{})
 	if err != nil {
 		return nil, sutils.ToStatusError(err, codes.Internal)
 	}
@@ -467,7 +467,7 @@ func (s *workflowServer) RetryWorkflow(ctx context.Context, req *workflowpkg.Wor
 	wfClient := auth.GetWfClient(ctx)
 	kubeClient := auth.GetKubeClient(ctx)
 
-	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, metav1.GetOptions{})
+	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, "", metav1.GetOptions{})
 	if err != nil {
 		return nil, sutils.ToStatusError(err, codes.Internal)
 	}
@@ -525,7 +525,7 @@ func (s *workflowServer) RetryWorkflow(ctx context.Context, req *workflowpkg.Wor
 
 func (s *workflowServer) ResubmitWorkflow(ctx context.Context, req *workflowpkg.WorkflowResubmitRequest) (*wfv1.Workflow, error) {
 	wfClient := auth.GetWfClient(ctx)
-	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, metav1.GetOptions{})
+	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, "", metav1.GetOptions{})
 	if err != nil {
 		return nil, sutils.ToStatusError(err, codes.Internal)
 	}
@@ -550,7 +550,7 @@ func (s *workflowServer) ResubmitWorkflow(ctx context.Context, req *workflowpkg.
 
 func (s *workflowServer) ResumeWorkflow(ctx context.Context, req *workflowpkg.WorkflowResumeRequest) (*wfv1.Workflow, error) {
 	wfClient := auth.GetWfClient(ctx)
-	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, metav1.GetOptions{})
+	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, "", metav1.GetOptions{})
 	if err != nil {
 		return nil, sutils.ToStatusError(err, codes.Internal)
 	}
@@ -579,7 +579,7 @@ func (s *workflowServer) ResumeWorkflow(ctx context.Context, req *workflowpkg.Wo
 func (s *workflowServer) SuspendWorkflow(ctx context.Context, req *workflowpkg.WorkflowSuspendRequest) (*wfv1.Workflow, error) {
 	wfClient := auth.GetWfClient(ctx)
 
-	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, metav1.GetOptions{})
+	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, "", metav1.GetOptions{})
 	if err != nil {
 		return nil, sutils.ToStatusError(err, codes.Internal)
 	}
@@ -605,7 +605,7 @@ func (s *workflowServer) SuspendWorkflow(ctx context.Context, req *workflowpkg.W
 func (s *workflowServer) TerminateWorkflow(ctx context.Context, req *workflowpkg.WorkflowTerminateRequest) (*wfv1.Workflow, error) {
 	wfClient := auth.GetWfClient(ctx)
 
-	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, metav1.GetOptions{})
+	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, "", metav1.GetOptions{})
 	if err != nil {
 		return nil, sutils.ToStatusError(err, codes.Internal)
 	}
@@ -629,7 +629,7 @@ func (s *workflowServer) TerminateWorkflow(ctx context.Context, req *workflowpkg
 
 func (s *workflowServer) StopWorkflow(ctx context.Context, req *workflowpkg.WorkflowStopRequest) (*wfv1.Workflow, error) {
 	wfClient := auth.GetWfClient(ctx)
-	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, metav1.GetOptions{})
+	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, "", metav1.GetOptions{})
 	if err != nil {
 		return nil, sutils.ToStatusError(err, codes.Internal)
 	}
@@ -651,7 +651,7 @@ func (s *workflowServer) StopWorkflow(ctx context.Context, req *workflowpkg.Work
 
 func (s *workflowServer) SetWorkflow(ctx context.Context, req *workflowpkg.WorkflowSetRequest) (*wfv1.Workflow, error) {
 	wfClient := auth.GetWfClient(ctx)
-	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, metav1.GetOptions{})
+	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, "", metav1.GetOptions{})
 	if err != nil {
 		return nil, sutils.ToStatusError(err, codes.Internal)
 	}
@@ -715,7 +715,7 @@ func (s *workflowServer) PodLogs(req *workflowpkg.WorkflowLogRequest, ws workflo
 	ctx := ws.Context()
 	wfClient := auth.GetWfClient(ctx)
 	kubeClient := auth.GetKubeClient(ctx)
-	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, metav1.GetOptions{})
+	wf, err := s.getWorkflow(ctx, wfClient, req.Namespace, req.Name, "", metav1.GetOptions{})
 	if err != nil {
 		return sutils.ToStatusError(err, codes.Internal)
 	}
@@ -738,7 +738,7 @@ func (s *workflowServer) WorkflowLogs(req *workflowpkg.WorkflowLogRequest, ws wo
 	return sutils.ToStatusError(s.PodLogs(req, ws), codes.Internal)
 }
 
-func (s *workflowServer) getWorkflow(ctx context.Context, wfClient versioned.Interface, namespace string, name string, options metav1.GetOptions) (*wfv1.Workflow, error) {
+func (s *workflowServer) getWorkflow(ctx context.Context, wfClient versioned.Interface, namespace string, name string, uid string, options metav1.GetOptions) (*wfv1.Workflow, error) {
 	logger := logging.RequireLoggerFromContext(ctx)
 	if name == latestAlias {
 		latest, err := getLatestWorkflow(ctx, wfClient, namespace)
@@ -751,7 +751,7 @@ func (s *workflowServer) getWorkflow(ctx context.Context, wfClient versioned.Int
 
 	wf, origErr := wfClient.ArgoprojV1alpha1().Workflows(namespace).Get(ctx, name, options)
 	// fallback to retrieve from archived workflows
-	if wf == nil || origErr != nil {
+	if wf == nil || origErr != nil || (uid != "" && string(wf.UID) != uid) {
 		allowed, err := auth.CanI(ctx, "get", workflow.WorkflowPlural, namespace, name)
 		if err != nil {
 			return nil, getWorkflowOrigErr(ctx, origErr, err)
@@ -761,7 +761,7 @@ func (s *workflowServer) getWorkflow(ctx context.Context, wfClient versioned.Int
 			return nil, getWorkflowOrigErr(ctx, origErr, err)
 		}
 
-		wf, err = s.wfArchive.GetWorkflow(ctx, "", namespace, name)
+		wf, err = s.wfArchive.GetWorkflow(ctx, uid, namespace, name)
 		if wf == nil || err != nil {
 			return nil, getWorkflowOrigErr(ctx, origErr, err)
 		}
diff --git a/server/workflow/workflow_server_test.go b/server/workflow/workflow_server_test.go
@@ -611,6 +611,17 @@ func getWorkflowServer(t *testing.T) (workflowpkg.WorkflowServiceServer, context
 	archivedRepo.On("GetWorkflow", mock.Anything, "", "test", "unlabelled").Return(nil, nil)
 	archivedRepo.On("GetWorkflow", mock.Anything, "", "workflows", "latest").Return(nil, nil)
 	archivedRepo.On("GetWorkflow", mock.Anything, "", "workflows", "hello-world-9tql2-not").Return(nil, nil)
+	// Mock for UID-based lookups on archive
+	archivedRepo.On("GetWorkflow", mock.Anything, "91066a6c-1ddc-11ea-b443-42010aa80099", "test", "hello-world-9tql2-test").Return(&v1alpha1.Workflow{
+		ObjectMeta: metav1.ObjectMeta{
+			Name:      "hello-world-9tql2-test",
+			Namespace: "test",
+			UID:       "91066a6c-1ddc-11ea-b443-42010aa80099",
+			Labels: map[string]string{
+				common.LabelKeyControllerInstanceID: "my-instanceid", // necessary to pass validation
+			},
+		},
+	}, nil)
 	r, err := labels.ParseToRequirements("workflows.argoproj.io/controller-instanceid=my-instanceid")
 	if err != nil {
 		panic(err)
@@ -750,10 +761,10 @@ func TestGetWorkflow(t *testing.T) {
 	server, ctx := getWorkflowServer(t)
 	s := server.(*workflowServer)
 	wfClient := auth.GetWfClient(ctx)
-	wf, err := s.getWorkflow(ctx, wfClient, "test", "hello-world-9tql2-test", metav1.GetOptions{})
+	wf, err := s.getWorkflow(ctx, wfClient, "test", "hello-world-9tql2-test", "", metav1.GetOptions{})
 	require.NoError(t, err)
 	assert.NotNil(t, wf)
-	wf, err = s.getWorkflow(ctx, wfClient, "test", "hello-world-9tql2-test", metav1.GetOptions{})
+	wf, err = s.getWorkflow(ctx, wfClient, "test", "hello-world-9tql2-test", "", metav1.GetOptions{})
 	require.NoError(t, err)
 	assert.NotNil(t, wf)
 }
@@ -762,11 +773,81 @@ func TestValidateWorkflow(t *testing.T) {
 	server, ctx := getWorkflowServer(t)
 	s := server.(*workflowServer)
 	wfClient := auth.GetWfClient(ctx)
-	wf, err := s.getWorkflow(ctx, wfClient, "test", "hello-world-9tql2-test", metav1.GetOptions{})
+	wf, err := s.getWorkflow(ctx, wfClient, "test", "hello-world-9tql2-test", "", metav1.GetOptions{})
 	require.NoError(t, err)
 	require.NoError(t, s.validateWorkflow(wf))
 }
 
+func TestGetWorkflowByUID(t *testing.T) {
+	server, ctx := getWorkflowServer(t)
+	s := server.(*workflowServer)
+	wfClient := auth.GetWfClient(ctx)
+
+	t.Run("GetWorkflowWithValidUID", func(t *testing.T) {
+		wf, err := s.getWorkflow(ctx, wfClient, "test", "hello-world-9tql2-test", "6522aff1-1e01-11ea-b443-42010aa80074", metav1.GetOptions{})
+		require.NoError(t, err)
+		assert.NotNil(t, wf)
+		assert.Equal(t, "hello-world-9tql2-test", wf.Name)
+		assert.Equal(t, "6522aff1-1e01-11ea-b443-42010aa80074", string(wf.UID))
+	})
+
+	t.Run("GetWorkflowWithUIDMatchesClusterUID", func(t *testing.T) {
+		wfWithUID, err := s.getWorkflow(ctx, wfClient, "test", "hello-world-9tql2-test", "6522aff1-1e01-11ea-b443-42010aa80074", metav1.GetOptions{})
+		require.NoError(t, err)
+		assert.NotNil(t, wfWithUID)
+		wfWithoutUID, err := s.getWorkflow(ctx, wfClient, "test", "hello-world-9tql2-test", "", metav1.GetOptions{})
+		require.NoError(t, err)
+		assert.NotNil(t, wfWithoutUID)
+		assert.Equal(t, wfWithoutUID, wfWithUID)
+	})
+
+	t.Run("GetWorkflowWithMismatchedUID", func(t *testing.T) {
+		// The cluster has uid "6522aff1-1e01-11ea-b443-42010aa80074"
+		// archive has uid "91066a6c-1ddc-11ea-b443-42010aa80099"
+		wf, err := s.getWorkflow(ctx, wfClient, "test", "hello-world-9tql2-test", "91066a6c-1ddc-11ea-b443-42010aa80099", metav1.GetOptions{})
+		require.NoError(t, err)
+		assert.NotNil(t, wf)
+		assert.Equal(t, "91066a6c-1ddc-11ea-b443-42010aa80099", string(wf.UID))
+	})
+
+	t.Run("GetClusterWorkflowViaAPI", func(t *testing.T) {
+		// Test the full API with UID parameter
+		wf, err := server.GetWorkflow(ctx, &workflowpkg.WorkflowGetRequest{
+			Name:      "hello-world-9tql2-test",
+			Namespace: "test",
+			Uid:       "6522aff1-1e01-11ea-b443-42010aa80074",
+		})
+		require.NoError(t, err)
+		assert.NotNil(t, wf)
+		assert.Equal(t, "hello-world-9tql2-test", wf.Name)
+		assert.Equal(t, "6522aff1-1e01-11ea-b443-42010aa80074", string(wf.UID))
+	})
+
+	t.Run("GetClusterWorkflowViaAPIWithoutUID", func(t *testing.T) {
+		// Test the full API without UID parameter
+		wf, err := server.GetWorkflow(ctx, &workflowpkg.WorkflowGetRequest{
+			Name:      "hello-world-9tql2-test",
+			Namespace: "test",
+			Uid:       "",
+		})
+		require.NoError(t, err)
+		assert.NotNil(t, wf)
+		assert.Equal(t, "hello-world-9tql2-test", wf.Name)
+		assert.Equal(t, "6522aff1-1e01-11ea-b443-42010aa80074", string(wf.UID))
+	})
+
+	t.Run("GetArchivedWorkflowViaAPI", func(t *testing.T) {
+		wf, err := server.GetWorkflow(ctx, &workflowpkg.WorkflowGetRequest{
+			Name:      "hello-world-9tql2-test",
+			Namespace: "test",
+			Uid:       "91066a6c-1ddc-11ea-b443-42010aa80099",
+		})
+		require.NoError(t, err)
+		assert.NotNil(t, wf)
+		assert.Equal(t, "91066a6c-1ddc-11ea-b443-42010aa80099", string(wf.UID))
+	})
+}
+
 func TestListWorkflow(t *testing.T) {
 	server, ctx := getWorkflowServer(t)
 	wfl, err := getWorkflowList(ctx, server, "workflows")
diff --git a/test/e2e/argo_server_test.go b/test/e2e/argo_server_test.go
@@ -809,9 +809,9 @@ func (s *ArgoServerSuite) TestCreateWorkflowDryRun() {
 }
 
 func (s *ArgoServerSuite) TestWorkflowService() {
-	var name string
+	var name, uid string
 	s.Run("Create", func() {
-		name = s.e().POST("/api/v1/workflows/argo").
+		jsonResp := s.e().POST("/api/v1/workflows/argo").
 			WithBytes([]byte(`{
   "workflow": {
     "metadata": {
@@ -836,8 +836,12 @@ func (s *ArgoServerSuite) TestWorkflowService() {
 }`)).
 			Expect().
 			Status(200).
-			JSON().
-			Path("$.metadata.name").
+			JSON()
+		name = jsonResp.Path("$.metadata.name").
+			NotNull().
+			String().
+			Raw()
+		uid = jsonResp.Path("$.metadata.uid").
 			NotNull().
 			String().
 			Raw()
@@ -891,6 +895,16 @@ func (s *ArgoServerSuite) TestWorkflowService() {
 			Status(404)
 	})
 
+	s.Run("GetByUid", func() {
+		j := s.e().GET("/api/v1/workflows/argo/"+name).
+			WithQuery("uid", uid).
+			Expect().
+			Status(200).
+			JSON()
+		j.Path("$.status.nodes").
+			NotNull()
+	})
+
 	s.Run("GetWithFields", func() {
 		j := s.e().GET("/api/v1/workflows/argo/"+name).
 			WithQuery("fields", "status.phase").
diff --git a/ui/src/shared/services/workflows-service.ts b/ui/src/shared/services/workflows-service.ts
@@ -64,8 +64,9 @@ export const WorkflowsService = {
         return requests.get(`api/v1/workflows/${namespace}?${params.join('&')}`).then(res => res.body as WorkflowList);
     },
 
-    get(namespace: string, name: string) {
-        return requests.get(`api/v1/workflows/${namespace}/${name}`).then(res => res.body as Workflow);
+    get(namespace: string, name: string, uid?: string) {
+        const params = uid ? `?uid=${uid}` : '';
+        return requests.get(`api/v1/workflows/${namespace}/${name}${params}`).then(res => res.body as Workflow);
     },
 
     getArchived(namespace: string, uid: string) {
diff --git a/ui/src/workflows/components/workflow-details/workflow-details.tsx b/ui/src/workflows/components/workflow-details/workflow-details.tsx
@@ -394,7 +394,8 @@ export function WorkflowDetails({history, location, match}: RouteComponentProps<
     useEffect(() => {
         (async () => {
             try {
-                const wf = await services.workflows.get(namespace, name);
+                // Pass uid if available from URL query params
+                const wf = await services.workflows.get(namespace, name, uid || undefined);
                 setUid(wf.metadata.uid);
                 setWorkflow(wf);
                 setError(null);

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,8 @@ message WorkflowGetRequest {`
`26`	`26`	`k8s.io.apimachinery.pkg.apis.meta.v1.GetOptions getOptions = 3;`
`27`	`27`	`// Fields to be included or excluded in the response. e.g. "spec,status.phase", "-status.nodes"`
`28`	`28`	`string fields = 4;`
	`29`	`+ // Optional UID to retrieve a specific workflow (useful for archived workflows with the same name)`
	`30`	`+ string uid = 5;`
`29`	`31`	`}`
`30`	`32`
`31`	`33`	`message WorkflowListRequest {`