fix(cli): handle version mismatch re MatchedProvisioners response

johnstcn · johnstcn · commit a2529f76f2a3 · 2024-11-28T20:17:59.000Z
diff --git a/cli/templatepush.go b/cli/templatepush.go
@@ -416,29 +416,6 @@ func createValidTemplateVersion(inv *serpent.Invocation, args createValidTemplat
 	if err != nil {
 		return nil, err
 	}
-	var tagsJSON strings.Builder
-	if err := json.NewEncoder(&tagsJSON).Encode(version.Job.Tags); err != nil {
-		// Fall back to the less-pretty string representation.
-		tagsJSON.Reset()
-		_, _ = tagsJSON.WriteString(fmt.Sprintf("%v", version.Job.Tags))
-	}
-	if version.MatchedProvisioners.Count == 0 {
-		cliui.Warnf(inv.Stderr, `No provisioners are available to handle the job!
-Please contact your deployment administrator for assistance.
-Details:
-	Provisioner job ID : %s
-	Requested tags     : %s
-`, version.Job.ID, tagsJSON.String())
-	} else if version.MatchedProvisioners.Available == 0 {
-		cliui.Warnf(inv.Stderr, `All available provisioner daemons have been silent for a while.
-Your build will proceed once they become available.
-If this persists, please contact your deployment administrator for assistance.
-Details:
-	Provisioner job ID : %s
-	Requested tags     : %s
-	Most recently seen : %s
-`, version.Job.ID, strings.TrimSpace(tagsJSON.String()), version.MatchedProvisioners.MostRecentlySeen.Time)
-	}
 
 	err = cliui.ProvisionerJob(inv.Context(), inv.Stdout, cliui.ProvisionerJobOptions{
 		Fetch: func() (codersdk.ProvisionerJob, error) {
@@ -505,6 +482,44 @@ func ParseProvisionerTags(rawTags []string) (map[string]string, error) {
 	return tags, nil
 }
 
+var (
+	warnNoMatchedProvisioners = `No provisioners are available to handle the job!
+Please contact your deployment administrator for assistance.
+Details:
+	Provisioner job ID : %s
+	Requested tags     : %s
+`
+	warnNoAvailableProvisioners = `All available provisioner daemons have been silent for a while.
+Your build will proceed once they become available.
+If this persists, please contact your deployment administrator for assistance.
+Details:
+	Provisioner job ID : %s
+	Requested tags     : %s
+	Most recently seen : %s
+`
+)
+
+func WarnMatchedProvisioners(inv *serpent.Invocation, tv codersdk.TemplateVersion) {
+	var tagsJSON strings.Builder
+	if err := json.NewEncoder(&tagsJSON).Encode(tv.Job.Tags); err != nil {
+		// Fall back to the less-pretty string representation.
+		tagsJSON.Reset()
+		_, _ = tagsJSON.WriteString(fmt.Sprintf("%v", tv.Job.Tags))
+	}
+	if tv.MatchedProvisioners == nil {
+		// Nothing in the response, nothing to do here!
+		return
+	}
+	if tv.MatchedProvisioners.Count == 0 {
+		cliui.Warnf(inv.Stderr, warnNoMatchedProvisioners, tv.Job.ID, tagsJSON.String())
+		return
+	}
+	if tv.MatchedProvisioners.Available == 0 {
+		cliui.Warnf(inv.Stderr, warnNoAvailableProvisioners, tv.Job.ID, strings.TrimSpace(tagsJSON.String()), tv.MatchedProvisioners.MostRecentlySeen.Time)
+		return
+	}
+}
+
 // prettyDirectoryPath returns a prettified path when inside the users
 // home directory. Falls back to dir if the users home directory cannot
 // discerned. This function calls filepath.Clean on the result.
diff --git a/coderd/templateversions.go b/coderd/templateversions.go
@@ -1719,7 +1719,7 @@ func convertTemplateVersion(version database.TemplateVersion, job codersdk.Provi
 		},
 		Archived:            version.Archived,
 		Warnings:            warnings,
-		MatchedProvisioners: matchedProvisioners,
+		MatchedProvisioners: &matchedProvisioners,
 	}
 }
 
diff --git a/coderd/templateversions_test.go b/coderd/templateversions_test.go
@@ -471,14 +471,13 @@ func TestPostTemplateVersionsByOrganization(t *testing.T) {
 					pj, err := store.GetProvisionerJobByID(ctx, tv.Job.ID)
 					require.NoError(t, err)
 					require.EqualValues(t, tt.wantTags, pj.Tags)
+					// Also assert that we get the expected information back from the API endpoint
+					require.Zero(t, tv.MatchedProvisioners.Count)
+					require.Zero(t, tv.MatchedProvisioners.Available)
+					require.Zero(t, tv.MatchedProvisioners.MostRecentlySeen.Time)
 				} else {
 					require.ErrorContains(t, err, tt.expectError)
 				}
-
-				// Also assert that we get the expected information back from the API endpoint
-				require.Zero(t, tv.MatchedProvisioners.Count)
-				require.Zero(t, tv.MatchedProvisioners.Available)
-				require.Zero(t, tv.MatchedProvisioners.MostRecentlySeen.Time)
 			})
 		}
 	})
diff --git a/codersdk/provisionerdaemons.go b/codersdk/provisionerdaemons.go
@@ -53,6 +53,7 @@ type ProvisionerDaemon struct {
 
 // MatchedProvisioners represents the number of provisioner daemons
 // available to take a job at a specific point in time.
+// Introduced in Coder version 2.18.0.
 type MatchedProvisioners struct {
 	// Count is the number of provisioner daemons that matched the given
 	// tags. If the count is 0, it means no provisioner daemons matched the
diff --git a/codersdk/templateversions.go b/codersdk/templateversions.go
@@ -32,7 +32,7 @@ type TemplateVersion struct {
 	Archived       bool           `json:"archived"`
 
 	Warnings            []TemplateVersionWarning `json:"warnings,omitempty" enums:"DEPRECATED_PARAMETERS"`
-	MatchedProvisioners MatchedProvisioners      `json:"matched_provisioners,omitempty"`
+	MatchedProvisioners *MatchedProvisioners     `json:"matched_provisioners,omitempty"`
 }
 
 type TemplateVersionExternalAuth struct {

Original file line number	Diff line number	Diff line change
`@@ -1719,7 +1719,7 @@ func convertTemplateVersion(version database.TemplateVersion, job codersdk.Provi`
`1719`	`1719`	`},`
`1720`	`1720`	`Archived: version.Archived,`
`1721`	`1721`	`Warnings: warnings,`
`1722`		`- MatchedProvisioners: matchedProvisioners,`
	`1722`	`+ MatchedProvisioners: &matchedProvisioners,`
`1723`	`1723`	`}`
`1724`	`1724`	`}`
`1725`	`1725`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ type TemplateVersion struct {`
`32`	`32`	Archived bool `json:"archived"`
`33`	`33`
`34`	`34`	Warnings []TemplateVersionWarning `json:"warnings,omitempty" enums:"DEPRECATED_PARAMETERS"`
`35`		- MatchedProvisioners MatchedProvisioners `json:"matched_provisioners,omitempty"`
	`35`	+ MatchedProvisioners *MatchedProvisioners `json:"matched_provisioners,omitempty"`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`type TemplateVersionExternalAuth struct {`