feat: Support GetWorkflow regardless of its archival status #11055
Conversation
Signed-off-by: Yuan Tang <terrytangyuan@gmail.com>
| @@ -15,6 +15,7 @@ message ListArchivedWorkflowsRequest { | |||
| message GetArchivedWorkflowRequest { | |||
| string uid = 1; | |||
| string namespace = 2; | |||
| string name = 3; | |||
There was a problem hiding this comment.
I would recommend creating a new API and deprecating the existing one for supporting backward capability.
There was a problem hiding this comment.
Introducing new API will bring more maintenance effort IMO. There are already multiple artifacts APIs that need to be refactored later. Perhaps we can add a parameter, e.g. lookUpArchived=true, to toggle this functionality to maintain compatibility?
There was a problem hiding this comment.
Moving discussions to #10781
There was a problem hiding this comment.
Is it going to be a breaking change? Is there a way we can support this feature with backward compatibility?
There was a problem hiding this comment.
The change would not be considered breaking since introducing fields would not break any existing behavior. We're introducing a new name field as part of the existing request to allow users to retrieve workflows by name/namespace, but existing users who are retrieving workflow by UID would not be affected.
There was a problem hiding this comment.
Thanks, @jessesuen Just had a discussion with @terrytangyuan. I request to test the using current SDK with the new Argo server(signature changes) whether it passes the "" for new arguments or user needs to update the new SDK.
There was a problem hiding this comment.
I tested this with existing SDK against the new Argo Server and existing behavior preserves. Users can still use only UID to retrieve the archived workflow.
There was a problem hiding this comment.
@terrytangyuan how do we address the need for a unified list API? It's one thing to GET a workflow by namespace/name from either etcd or archive, but don't we want to improve the UX such that archived workflows could also be presented in same list view?
persist/sqldb/workflow_archive.go
Outdated
| And(nameEqual(name)). | ||
| One(archivedWf) | ||
| } else { | ||
| return nil, fmt.Errorf("both name and namespace are required if uid is not specified") |
There was a problem hiding this comment.
Is there a way to return an error that would cause us to return 400 Bad Request as an http response?
There was a problem hiding this comment.
Yes, see my latest commit. Good idea.
There was a problem hiding this comment.
The mapping of error codes can be found in https://github.com/argoproj/argo-workflows/blob/master/server/utils/errors.go
Signed-off-by: Yuan Tang <terrytangyuan@gmail.com>
This includes the backend changes for #10781.