coder · mtojek · Feb 8, 2024 · Feb 8, 2024 · Feb 8, 2024 · Feb 8, 2024
diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
@@ -5687,6 +5687,7 @@ func (q *FakeQuerier) InsertWorkspaceAgentMetadata(_ context.Context, arg databa
 		Key:              arg.Key,
 		Timeout:          arg.Timeout,
 		Interval:         arg.Interval,
+		DisplayOrder:     arg.DisplayOrder,
 	}
 
 	q.workspaceAgentMetadata = append(q.workspaceAgentMetadata, metadatum)

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000188_workspace_agent_metadata_order.down.sql b/coderd/database/migrations/000188_workspace_agent_metadata_order.down.sql
@@ -0,0 +1 @@
+ALTER TABLE workspace_agent_metadata DROP COLUMN display_order;
diff --git a/coderd/database/migrations/000188_workspace_agent_metadata_order.up.sql b/coderd/database/migrations/000188_workspace_agent_metadata_order.up.sql
@@ -0,0 +1,4 @@
+ALTER TABLE workspace_agent_metadata ADD COLUMN display_order integer NOT NULL DEFAULT 0;
+
+COMMENT ON COLUMN workspace_agent_metadata.display_order
+IS 'Specifies the order in which to display agent metadata in user interfaces.';
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/workspaceagents.sql b/coderd/database/queries/workspaceagents.sql
@@ -103,10 +103,11 @@ INSERT INTO
 		key,
 		script,
 		timeout,
-		interval
+		interval,
+		display_order
 	)
 VALUES
-	($1, $2, $3, $4, $5, $6);
+	($1, $2, $3, $4, $5, $6, $7);
 
 -- name: UpdateWorkspaceAgentMetadata :exec
 WITH metadata AS (

diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -1538,6 +1538,7 @@ func InsertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 				Key:              md.Key,
 				Timeout:          md.Timeout,
 				Interval:         md.Interval,
+				DisplayOrder:     int32(md.Order),
 			}
 			err := db.InsertWorkspaceAgentMetadata(ctx, p)
 			if err != nil {

diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -1590,10 +1590,18 @@ func appendUnique[T comparable](dst, src []T) []T {
 }
 
 func convertWorkspaceAgentMetadata(db []database.WorkspaceAgentMetadatum) []codersdk.WorkspaceAgentMetadata {
+	// Sort the input database slice by DisplayOrder and then by Key before processing
+	sort.Slice(db, func(i, j int) bool {
+		if db[i].DisplayOrder == db[j].DisplayOrder {
+			return db[i].Key < db[j].Key
+		}
+		return db[i].DisplayOrder < db[j].DisplayOrder
+	})
+
 	// An empty array is easier for clients to handle than a null.
-	result := make([]codersdk.WorkspaceAgentMetadata, 0, len(db))
-	for _, datum := range db {
-		result = append(result, codersdk.WorkspaceAgentMetadata{
+	result := make([]codersdk.WorkspaceAgentMetadata, len(db))
+	for i, datum := range db {
+		result[i] = codersdk.WorkspaceAgentMetadata{
 			Result: codersdk.WorkspaceAgentMetadataResult{
 				Value:       datum.Value,
 				Error:       datum.Error,
@@ -1607,12 +1615,8 @@ func convertWorkspaceAgentMetadata(db []database.WorkspaceAgentMetadatum) []code
 				Interval:    datum.Interval,
 				Timeout:     datum.Timeout,
 			},
-		})
+		}
 	}
-	// Sorting prevents the metadata from jumping around in the frontend.
-	sort.Slice(result, func(i, j int) bool {
-		return result[i].Description.Key < result[j].Description.Key
-	})
 	return result
 }
 

diff --git a/coderd/workspaceagents_test.go b/coderd/workspaceagents_test.go
@@ -1248,6 +1248,92 @@ func TestWorkspaceAgent_Metadata(t *testing.T) {
 	post(ctx, "unknown", unknownKeyMetadata)
 }
 
+func TestWorkspaceAgent_Metadata_DisplayOrder(t *testing.T) {
+	t.Parallel()
+
+	client, db := coderdtest.NewWithDatabase(t, nil)
+	user := coderdtest.CreateFirstUser(t, client)
+	r := dbfake.WorkspaceBuild(t, db, database.Workspace{
+		OrganizationID: user.OrganizationID,
+		OwnerID:        user.UserID,
+	}).WithAgent(func(agents []*proto.Agent) []*proto.Agent {
+		agents[0].Metadata = []*proto.Agent_Metadata{
+			{
+				DisplayName: "First Meta",
+				Key:         "foo1",
+				Script:      "echo hi",
+				Interval:    10,
+				Timeout:     3,
+				Order:       2,
+			},
+			{
+				DisplayName: "Second Meta",
+				Key:         "foo2",
+				Script:      "echo howdy",
+				Interval:    10,
+				Timeout:     3,
+				Order:       1,
+			},
+			{
+				DisplayName: "Third Meta",
+				Key:         "foo3",
+				Script:      "echo howdy",
+				Interval:    10,
+				Timeout:     3,
+				Order:       2,
+			},
+			{
+				DisplayName: "Fourth Meta",
+				Key:         "foo4",
+				Script:      "echo howdy",
+				Interval:    10,
+				Timeout:     3,
+				Order:       3,
+			},
+		}
+		return agents
+	}).Do()
+
+	workspace, err := client.Workspace(context.Background(), r.Workspace.ID)
+	require.NoError(t, err)
+	for _, res := range workspace.LatestBuild.Resources {
+		for _, a := range res.Agents {
+			require.Equal(t, codersdk.WorkspaceAgentLifecycleCreated, a.LifecycleState)
+		}
+	}
+
+	ctx := testutil.Context(t, testutil.WaitMedium)
+	workspace, err = client.Workspace(ctx, workspace.ID)
+	require.NoError(t, err, "get workspace")
+
+	agentID := workspace.LatestBuild.Resources[0].Agents[0].ID
+
+	var update []codersdk.WorkspaceAgentMetadata
+
+	// Setup is complete, reset the context.
+	ctx = testutil.Context(t, testutil.WaitMedium)
+	updates, errors := client.WatchWorkspaceAgentMetadata(ctx, agentID)
+
+	recvUpdate := func() []codersdk.WorkspaceAgentMetadata {
+		select {
+		case <-ctx.Done():
+			t.Fatalf("context done: %v", ctx.Err())
+		case err := <-errors:
+			t.Fatalf("error watching metadata: %v", err)
+		case update := <-updates:
+			return update
+		}
+		return nil
+	}
+
+	update = recvUpdate()
+	require.Len(t, update, 4)
+	require.Equal(t, "Second Meta", update[0].Description.DisplayName)
+	require.Equal(t, "First Meta", update[1].Description.DisplayName)
+	require.Equal(t, "Third Meta", update[2].Description.DisplayName)
+	require.Equal(t, "Fourth Meta", update[3].Description.DisplayName)
+}
+
 type testWAMErrorStore struct {
 	database.Store
 	err atomic.Pointer[error]

diff --git a/go.mod b/go.mod
@@ -96,7 +96,7 @@ require (
 	github.com/coder/flog v1.1.0
 	github.com/coder/pretty v0.0.0-20230908205945-e89ba86370e0
 	github.com/coder/retry v1.5.1
-	github.com/coder/terraform-provider-coder v0.13.0
+	github.com/coder/terraform-provider-coder v0.14.1
 	github.com/coder/wgtunnel v0.1.13-0.20231127054351-578bfff9b92a
 	github.com/coreos/go-oidc/v3 v3.9.0
 	github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf

diff --git a/go.sum b/go.sum
@@ -204,8 +204,8 @@ github.com/coder/ssh v0.0.0-20231128192721-70855dedb788 h1:YoUSJ19E8AtuUFVYBpXuO
 github.com/coder/ssh v0.0.0-20231128192721-70855dedb788/go.mod h1:aGQbuCLyhRLMzZF067xc84Lh7JDs1FKwCmF1Crl9dxQ=
 github.com/coder/tailscale v1.1.1-0.20231205095743-61c97bad8c8b h1:ut/aL6oI8TjGdg4JI8+bKB9w5j73intbe0dJAmcmYyQ=
 github.com/coder/tailscale v1.1.1-0.20231205095743-61c97bad8c8b/go.mod h1:L8tPrwSi31RAMEMV8rjb0vYTGs7rXt8rAHbqY/p41j4=
-github.com/coder/terraform-provider-coder v0.13.0 h1:MjW7O+THAiqIYcxyiuBoGbFEduqgjp7tUZhSkiwGxwo=
-github.com/coder/terraform-provider-coder v0.13.0/go.mod h1:g2bDO+IkYqMSMxMdziOlyZsVh5BP/8wBIDvhIkSJ4rg=
+github.com/coder/terraform-provider-coder v0.14.1 h1:a97th+fVIs9i5kBj7WTOA4ssAAxaOTvwISLaYl4mbKw=
+github.com/coder/terraform-provider-coder v0.14.1/go.mod h1:pACHRoXSHBGyY696mLeQ1hR/Ag1G2wFk5bw0mT5Zp2g=
 github.com/coder/wgtunnel v0.1.13-0.20231127054351-578bfff9b92a h1:KhR9LUVllMZ+e9lhubZ1HNrtJDgH5YLoTvpKwmrGag4=
 github.com/coder/wgtunnel v0.1.13-0.20231127054351-578bfff9b92a/go.mod h1:QzfptVUdEO+XbkzMKx1kw13i9wwpJlfI1RrZ6SNZ0hA=
 github.com/coder/wireguard-go v0.0.0-20230807234434-d825b45ccbf5 h1:eDk/42Kj4xN4yfE504LsvcFEo3dWUiCOaBiWJ2uIH2A=

diff --git a/provisioner/terraform/resources.go b/provisioner/terraform/resources.go
@@ -25,6 +25,7 @@ type agentMetadata struct {
 	Script      string `mapstructure:"script"`
 	Interval    int64  `mapstructure:"interval"`
 	Timeout     int64  `mapstructure:"timeout"`
+	Order       int64  `mapstructure:"order"`
 }
 
 // A mapping of attributes on the "coder_agent" resource.
@@ -209,6 +210,7 @@ func ConvertState(modules []*tfjson.StateModule, rawGraph string) (*State, error
 					Script:      item.Script,
 					Interval:    item.Interval,
 					Timeout:     item.Timeout,
+					Order:       item.Order,
 				})
 			}
 

diff --git a/provisioner/terraform/resources_test.go b/provisioner/terraform/resources_test.go
@@ -250,6 +250,7 @@ func TestConvertResources(t *testing.T) {
 						Script:      "ps -ef | wc -l",
 						Interval:    5,
 						Timeout:     1,
+						Order:       7,
 					}},
 					ConnectionTimeoutSeconds: 120,
 					DisplayApps:              &displayApps,

diff --git a/provisioner/terraform/testdata/resource-metadata/resource-metadata.tf b/provisioner/terraform/testdata/resource-metadata/resource-metadata.tf
@@ -2,7 +2,7 @@ terraform {
   required_providers {
     coder = {
       source  = "coder/coder"
-      version = "0.7.0"
+      version = "0.14.1"
     }
   }
 }
@@ -16,6 +16,7 @@ resource "coder_agent" "main" {
     script       = "ps -ef | wc -l"
     interval     = 5
     timeout      = 1
+    order        = 7
   }
 }
 

diff --git a/provisioner/terraform/testdata/resource-metadata/resource-metadata.tfplan.dot b/provisioner/terraform/testdata/resource-metadata/resource-metadata.tfplan.dot
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE workspace_agent_metadata DROP COLUMN display_order;