Passing Argo context to Argo Workflow calls (#17)

Author: pclata

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.0.4 (2021-06-03)
+### Fixed
+* Passing Argo context to Argo Workflow calls
+
 ## v0.0.3 (2021-05-27)
 ### Changed
 * Update environmental variable name to specify workflow execution namespace

service/handlers.go

@@ -108,6 +108,7 @@ type handler struct {
 	logger                 log.Logger
 	newCredentialsProvider func(a Authorization) (credentialsProvider, error)
 	argo                   workflow.Workflow
+	argoCtx                context.Context
 	config                 *Config
 	gitClient              gitClient
 }
@@ -150,15 +151,14 @@ func (h handler) healthCheck(w http.ResponseWriter, r *http.Request) {
 func (h handler) listWorkflows(w http.ResponseWriter, r *http.Request) {
 	// TODO authenticate user can list this workflow once auth figured out
 	// TODO fail if project / target does not exist or are not valid format
-	ctx := r.Context()
 	vars := mux.Vars(r)
 	projectName := vars["projectName"]
 	targetName := vars["targetName"]
 
 	l := h.requestLogger(r, "op", "list-workflows", "project", projectName, "target", targetName)
 
 	level.Debug(l).Log("message", "listing workflows")
-	workflowIDs, err := h.argo.List(ctx)
+	workflowIDs, err := h.argo.List(h.argoCtx)
 	if err != nil {
 		level.Error(l).Log("message", "error listing workflows", "error", err)
 		h.errorResponse(w, "error listing workflows", http.StatusBadRequest, err)
@@ -170,7 +170,7 @@ func (h handler) listWorkflows(w http.ResponseWriter, r *http.Request) {
 	prefix := fmt.Sprintf("%s-%s", projectName, targetName)
 	for _, workflowID := range workflowIDs {
 		if strings.HasPrefix(workflowID, prefix) {
-			workflow, err := h.argo.Status(ctx, workflowID)
+			workflow, err := h.argo.Status(h.argoCtx, workflowID)
 			if err != nil {
 				level.Error(l).Log("message", "error retrieving workflows", "error", err)
 				h.errorResponse(w, "error retrieving workflows", http.StatusBadRequest, err)
@@ -400,7 +400,7 @@ func (h handler) createWorkflowFromRequest(ctx context.Context, w http.ResponseW
 	parameters := workflow.NewParameters(environmentVariablesString, executeCommand, executeContainerImageURI, cwr.TargetName, cwr.ProjectName, cwr.Parameters, credentialsToken)
 
 	level.Debug(l).Log("message", "creating workflow")
-	workflowName, err := h.argo.Submit(ctx, workflowFrom, parameters)
+	workflowName, err := h.argo.Submit(h.argoCtx, workflowFrom, parameters)
 	if err != nil {
 		level.Error(l).Log("message", "error creating workflow", "error", err)
 		h.errorResponse(w, "error creating workflow", http.StatusInternalServerError, err)
@@ -425,7 +425,6 @@ func (h handler) createWorkflowFromRequest(ctx context.Context, w http.ResponseW
 
 // Gets a workflow
 func (h handler) getWorkflow(w http.ResponseWriter, r *http.Request) {
-	ctx := r.Context()
 	vars := mux.Vars(r)
 	workflowName := vars["workflowName"]
 	// TODO: Workflow name must include -
@@ -436,7 +435,7 @@ func (h handler) getWorkflow(w http.ResponseWriter, r *http.Request) {
 	l := h.requestLogger(r, "op", "get-workflow", "workflow", workflowName)
 
 	level.Debug(l).Log("message", "getting workflow status")
-	status, err := h.argo.Status(ctx, workflowName)
+	status, err := h.argo.Status(h.argoCtx, workflowName)
 	if err != nil {
 		level.Error(l).Log("message", "error getting workflow", "error", err)
 		h.errorResponse(w, "error getting workflow", http.StatusBadRequest, err)
@@ -506,7 +505,6 @@ func (h handler) getTarget(w http.ResponseWriter, r *http.Request) {
 
 // Returns the logs for a workflow
 func (h handler) getWorkflowLogs(w http.ResponseWriter, r *http.Request) {
-	ctx := r.Context()
 	vars := mux.Vars(r)
 	workflowName := vars["workflowName"]
 	// TODO: Workflow name must include -
@@ -517,7 +515,7 @@ func (h handler) getWorkflowLogs(w http.ResponseWriter, r *http.Request) {
 	l := h.requestLogger(r, "op", "get-workflow-logs", "workflow", workflowName)
 
 	level.Debug(l).Log("message", "retrieving workflow logs")
-	argoWorkflowLogs, err := h.argo.Logs(ctx, workflowName)
+	argoWorkflowLogs, err := h.argo.Logs(h.argoCtx, workflowName)
 	if err != nil {
 		level.Error(l).Log("message", "error getting workflow logs", "error", err)
 		h.errorResponse(w, "error getting workflow logs", http.StatusBadRequest, err)
@@ -535,7 +533,6 @@ func (h handler) getWorkflowLogs(w http.ResponseWriter, r *http.Request) {
 
 // Streams workflow logs
 func (h handler) getWorkflowLogStream(w http.ResponseWriter, r *http.Request) {
-	ctx := r.Context()
 	w.Header().Set("Content-Type", "text/plain")
 	vars := mux.Vars(r)
 	workflowName := vars["workflowName"]
@@ -547,7 +544,7 @@ func (h handler) getWorkflowLogStream(w http.ResponseWriter, r *http.Request) {
 	l := h.requestLogger(r, "op", "get-workflow-log-stream", "workflow", workflowName)
 
 	level.Debug(l).Log("message", "retrieving workflow logs", "workflow", workflowName)
-	err := h.argo.LogStream(ctx, workflowName, w)
+	err := h.argo.LogStream(h.argoCtx, workflowName, w)
 	if err != nil {
 		level.Error(l).Log("message", "error getting workflow logstream", "error", err)
 		h.errorResponse(w, "error getting workflow logs", http.StatusBadRequest, err)

service/main.go

@@ -70,13 +70,18 @@ func main() {
 		panic("error creating git client")
 	}
 
-	_, argoClient := client.NewAPIClient()
+	// The Argo context is needed for any Argo client method calls or else, nil errors.
+	argoCtx, argoClient := client.NewAPIClient()
 	namespace := acoEnv.ArgoNamespace()
 
+	// Any Argo Workflow client method calls need the context returned from NewAPIClient, otherwise
+	// nil errors will occur. Mux sets its params in context, so passing the Argo Workflow context to
+	// setupRouter and applying it to the request will wipe out Mux vars (or any other data Mux sets in its context).
 	h := handler{
 		logger:                 logger,
 		newCredentialsProvider: newVaultProvider(vaultSvc),
 		argo:                   workflow.NewArgoWorkflow(argoClient.NewWorkflowServiceClient(), namespace),
+		argoCtx:                argoCtx,
 		config:                 config,
 		gitClient:              gitClient,
 	}