coder · DanielleMaywood · Sep 9, 2024 · Sep 5, 2024 · Sep 5, 2024 · Sep 5, 2024
@@ -41,6 +41,7 @@ message WorkspaceApp {
 		UNHEALTHY = 4;
 	}
 	Health health = 12;
+	bool hidden = 13;
 }
 
 message WorkspaceAgentScript {

diff --git a/coderd/agentapi/manifest.go b/coderd/agentapi/manifest.go
@@ -229,5 +229,6 @@ func dbAppToProto(dbApp database.WorkspaceApp, agent database.WorkspaceAgent, ow
 			Threshold: dbApp.HealthcheckThreshold,
 		},
 		Health: agentproto.WorkspaceApp_Health(healthRaw),
+		Hidden: dbApp.Hidden,
 	}, nil
 }
diff --git a/coderd/agentapi/manifest_test.go b/coderd/agentapi/manifest_test.go
@@ -87,6 +87,7 @@ func TestGetManifest(t *testing.T) {
 				Subdomain:    false,
 				SharingLevel: database.AppSharingLevelPublic,
 				Health:       database.WorkspaceAppHealthDisabled,
+				Hidden:       false,
 			},
 			{
 				ID:                   uuid.New(),
@@ -102,6 +103,7 @@ func TestGetManifest(t *testing.T) {
 				HealthcheckUrl:       "http://localhost:4321/health",
 				HealthcheckInterval:  20,
 				HealthcheckThreshold: 5,
+				Hidden:               true,
 			},
 		}
 		scripts = []database.WorkspaceAgentScript{
@@ -182,6 +184,7 @@ func TestGetManifest(t *testing.T) {
 					Threshold: apps[0].HealthcheckThreshold,
 				},
 				Health: agentproto.WorkspaceApp_HEALTHY,
+				Hidden: false,
 			},
 			{
 				Id:            apps[1].ID[:],
@@ -200,6 +203,7 @@ func TestGetManifest(t *testing.T) {
 					Threshold: 0,
 				},
 				Health: agentproto.WorkspaceApp_DISABLED,
+				Hidden: false,
 			},
 			{
 				Id:            apps[2].ID[:],
@@ -218,6 +222,7 @@ func TestGetManifest(t *testing.T) {
 					Threshold: apps[2].HealthcheckThreshold,
 				},
 				Health: agentproto.WorkspaceApp_UNHEALTHY,
+				Hidden: true,
 			},
 		}
 		protoScripts = []*agentproto.WorkspaceAgentScript{

diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/database/db2sdk/db2sdk.go b/coderd/database/db2sdk/db2sdk.go
@@ -517,6 +517,7 @@ func Apps(dbApps []database.WorkspaceApp, agent database.WorkspaceAgent, ownerNa
 				Threshold: dbApp.HealthcheckThreshold,
 			},
 			Health: codersdk.WorkspaceAppHealth(dbApp.Health),
+			Hidden: dbApp.Hidden,
 		})
 	}
 	return apps

diff --git a/coderd/database/dbgen/dbgen.go b/coderd/database/dbgen/dbgen.go
@@ -547,6 +547,7 @@ func WorkspaceApp(t testing.TB, db database.Store, orig database.WorkspaceApp) d
 		HealthcheckThreshold: takeFirst(orig.HealthcheckThreshold, 60),
 		Health:               takeFirst(orig.Health, database.WorkspaceAppHealthHealthy),
 		DisplayOrder:         takeFirst(orig.DisplayOrder, 1),
+		Hidden:               orig.Hidden,
 	})
 	require.NoError(t, err, "insert app")
 	return resource

diff --git a/coderd/database/dbmem/dbmem.go b/coderd/database/dbmem/dbmem.go
@@ -7291,6 +7291,7 @@ func (q *FakeQuerier) InsertWorkspaceApp(_ context.Context, arg database.InsertW
 		HealthcheckInterval:  arg.HealthcheckInterval,
 		HealthcheckThreshold: arg.HealthcheckThreshold,
 		Health:               arg.Health,
+		Hidden:               arg.Hidden,
 		DisplayOrder:         arg.DisplayOrder,
 	}
 	q.workspaceApps = append(q.workspaceApps, workspaceApp)

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000249_workspace_app_hidden.down.sql b/coderd/database/migrations/000249_workspace_app_hidden.down.sql
@@ -0,0 +1 @@
+ALTER TABLE workspace_apps DROP COLUMN hidden;
diff --git a/coderd/database/migrations/000249_workspace_app_hidden.up.sql b/coderd/database/migrations/000249_workspace_app_hidden.up.sql
@@ -0,0 +1,4 @@
+ALTER TABLE workspace_apps ADD COLUMN hidden boolean NOT NULL DEFAULT false;
+
+COMMENT ON COLUMN workspace_apps.hidden
+IS 'Determines if the app is not shown 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/workspaceapps.sql b/coderd/database/queries/workspaceapps.sql
@@ -28,10 +28,11 @@ INSERT INTO
         healthcheck_interval,
         healthcheck_threshold,
         health,
-        display_order
+        display_order,
+        hidden
     )
 VALUES
-    ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16) RETURNING *;
+    ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14, $15, $16, $17) RETURNING *;
 
 -- name: UpdateWorkspaceAppHealthByID :exec
 UPDATE

diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -1918,6 +1918,7 @@ func InsertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 				HealthcheckThreshold: app.Healthcheck.Threshold,
 				Health:               health,
 				DisplayOrder:         int32(app.Order),
+				Hidden:               app.Hidden,
 			})
 			if err != nil {
 				return xerrors.Errorf("insert app: %w", err)

diff --git a/codersdk/agentsdk/convert.go b/codersdk/agentsdk/convert.go
@@ -245,6 +245,7 @@ func AppFromProto(protoApp *proto.WorkspaceApp) (codersdk.WorkspaceApp, error) {
 			Threshold: protoApp.Healthcheck.Threshold,
 		},
 		Health: health,
+		Hidden: protoApp.Hidden,
 	}, nil
 }
 
@@ -274,6 +275,7 @@ func ProtoFromApp(a codersdk.WorkspaceApp) (*proto.WorkspaceApp, error) {
 			Threshold: a.Healthcheck.Threshold,
 		},
 		Health: proto.WorkspaceApp_Health(health),
+		Hidden: a.Hidden,
 	}, nil
 }
 

diff --git a/codersdk/agentsdk/convert_test.go b/codersdk/agentsdk/convert_test.go
@@ -44,6 +44,7 @@ func TestManifest(t *testing.T) {
 					Threshold: 55555666,
 				},
 				Health: codersdk.WorkspaceAppHealthHealthy,
+				Hidden: false,
 			},
 			{
 				ID:            uuid.New(),
@@ -62,6 +63,7 @@ func TestManifest(t *testing.T) {
 					Threshold: 22555666,
 				},
 				Health: codersdk.WorkspaceAppHealthInitializing,
+				Hidden: true,
 			},
 		},
 		DERPMap: &tailcfg.DERPMap{

diff --git a/codersdk/workspaceapps.go b/codersdk/workspaceapps.go
@@ -61,6 +61,7 @@ type WorkspaceApp struct {
 	// Healthcheck specifies the configuration for checking app health.
 	Healthcheck Healthcheck        `json:"healthcheck"`
 	Health      WorkspaceAppHealth `json:"health"`
+	Hidden      bool               `json:"hidden"`
 }
 
 type Healthcheck struct {

diff --git a/docs/reference/api/agents.md b/docs/reference/api/agents.md
diff --git a/docs/reference/api/builds.md b/docs/reference/api/builds.md