fix: Sort workspace agents by name (#3407)

kylecarbs · web-flow · commit 42bac09c1ac1 · 2022-08-08T12:25:29.000-05:00
Fixes #2778.
diff --git a/coderd/workspaceresources.go b/coderd/workspaceresources.go
@@ -4,6 +4,7 @@ import (
 	"database/sql"
 	"errors"
 	"net/http"
+	"sort"
 
 	"github.com/google/uuid"
 
@@ -79,6 +80,9 @@ func (api *API) workspaceResource(rw http.ResponseWriter, r *http.Request) {
 		}
 		apiAgents = append(apiAgents, convertedAgent)
 	}
+	sort.Slice(apiAgents, func(i, j int) bool {
+		return apiAgents[i].Name < apiAgents[j].Name
+	})
 
 	metadata, err := api.Database.GetWorkspaceResourceMetadataByResourceID(r.Context(), workspaceResource.ID)
 	if err != nil {
diff --git a/coderd/workspaceresources_test.go b/coderd/workspaceresources_test.go
@@ -28,6 +28,11 @@ func TestWorkspaceResource(t *testing.T) {
 							Type: "example",
 							Agents: []*proto.Agent{{
 								Id:   "something",
+								Name: "b",
+								Auth: &proto.Agent_Token{},
+							}, {
+								Id:   "another",
+								Name: "a",
 								Auth: &proto.Agent_Token{},
 							}},
 						}},
@@ -41,8 +46,12 @@ func TestWorkspaceResource(t *testing.T) {
 		coderdtest.AwaitWorkspaceBuildJob(t, client, workspace.LatestBuild.ID)
 		resources, err := client.WorkspaceResourcesByBuild(context.Background(), workspace.LatestBuild.ID)
 		require.NoError(t, err)
-		_, err = client.WorkspaceResource(context.Background(), resources[0].ID)
+		resource, err := client.WorkspaceResource(context.Background(), resources[0].ID)
 		require.NoError(t, err)
+		require.Len(t, resource.Agents, 2)
+		// Ensure it's sorted alphabetically!
+		require.Equal(t, "a", resource.Agents[0].Name)
+		require.Equal(t, "b", resource.Agents[1].Name)
 	})
 
 	t.Run("Apps", func(t *testing.T) {

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ import (`
`4`	`4`	`"database/sql"`
`5`	`5`	`"errors"`
`6`	`6`	`"net/http"`
	`7`	`+ "sort"`
`7`	`8`
`8`	`9`	`"github.com/google/uuid"`
`9`	`10`
`@@ -79,6 +80,9 @@ func (api API) workspaceResource(rw http.ResponseWriter, r http.Request) {`
`79`	`80`	`}`
`80`	`81`	`apiAgents = append(apiAgents, convertedAgent)`
`81`	`82`	`}`
	`83`	`+ sort.Slice(apiAgents, func(i, j int) bool {`
	`84`	`+ return apiAgents[i].Name < apiAgents[j].Name`
	`85`	`+ })`
`82`	`86`
`83`	`87`	`metadata, err := api.Database.GetWorkspaceResourceMetadataByResourceID(r.Context(), workspaceResource.ID)`
`84`	`88`	`if err != nil {`