feat: app slugs pt.3

coder · deansheather · Oct 28, 2022 · Oct 16, 2022 · Oct 16, 2022 · Oct 17, 2022
commit c65857275c235a53ae0833ac947dbcf44b4e890c
diff --git a/agent/apphealth.go b/agent/apphealth.go
@@ -41,7 +41,7 @@ func NewWorkspaceAppHealthReporter(logger slog.Logger, workspaceAgentApps Worksp
 		hasHealthchecksEnabled := false
 		health := make(map[string]codersdk.WorkspaceAppHealth, 0)
 		for _, app := range apps {
-			health[app.Name] = app.Health
+			health[app.DisplayName] = app.Health
 			if !hasHealthchecksEnabled && app.Health != codersdk.WorkspaceAppHealthDisabled {
 				hasHealthchecksEnabled = true
 			}
@@ -91,21 +91,21 @@ func NewWorkspaceAppHealthReporter(logger slog.Logger, workspaceAgentApps Worksp
 					}()
 					if err != nil {
 						mu.Lock()
-						if failures[app.Name] < int(app.Healthcheck.Threshold) {
+						if failures[app.DisplayName] < int(app.Healthcheck.Threshold) {
 							// increment the failure count and keep status the same.
 							// we will change it when we hit the threshold.
-							failures[app.Name]++
+							failures[app.DisplayName]++
 						} else {
 							// set to unhealthy if we hit the failure threshold.
 							// we stop incrementing at the threshold to prevent the failure value from increasing forever.
-							health[app.Name] = codersdk.WorkspaceAppHealthUnhealthy
+							health[app.DisplayName] = codersdk.WorkspaceAppHealthUnhealthy
 						}
 						mu.Unlock()
 					} else {
 						mu.Lock()
 						// we only need one successful health check to be considered healthy.
-						health[app.Name] = codersdk.WorkspaceAppHealthHealthy
-						failures[app.Name] = 0
+						health[app.DisplayName] = codersdk.WorkspaceAppHealthHealthy
+						failures[app.DisplayName] = 0
 						mu.Unlock()
 					}
 

diff --git a/agent/apphealth_test.go b/agent/apphealth_test.go
@@ -27,12 +27,12 @@ func TestAppHealth(t *testing.T) {
 		defer cancel()
 		apps := []codersdk.WorkspaceApp{
 			{
-				Name:        "app1",
+				DisplayName: "app1",
 				Healthcheck: codersdk.Healthcheck{},
 				Health:      codersdk.WorkspaceAppHealthDisabled,
 			},
 			{
-				Name: "app2",
+				DisplayName: "app2",
 				Healthcheck: codersdk.Healthcheck{
 					// URL: We don't set the URL for this test because the setup will
 					// create a httptest server for us and set it for us.
@@ -69,7 +69,7 @@ func TestAppHealth(t *testing.T) {
 		defer cancel()
 		apps := []codersdk.WorkspaceApp{
 			{
-				Name: "app2",
+				DisplayName: "app2",
 				Healthcheck: codersdk.Healthcheck{
 					// URL: We don't set the URL for this test because the setup will
 					// create a httptest server for us and set it for us.
@@ -102,7 +102,7 @@ func TestAppHealth(t *testing.T) {
 		defer cancel()
 		apps := []codersdk.WorkspaceApp{
 			{
-				Name: "app2",
+				DisplayName: "app2",
 				Healthcheck: codersdk.Healthcheck{
 					// URL: We don't set the URL for this test because the setup will
 					// create a httptest server for us and set it for us.
@@ -137,7 +137,7 @@ func TestAppHealth(t *testing.T) {
 		defer cancel()
 		apps := []codersdk.WorkspaceApp{
 			{
-				Name: "app2",
+				DisplayName: "app2",
 				Healthcheck: codersdk.Healthcheck{
 					// URL: We don't set the URL for this test because the setup will
 					// create a httptest server for us and set it for us.
@@ -187,7 +187,7 @@ func setupAppReporter(ctx context.Context, t *testing.T, apps []codersdk.Workspa
 		mu.Lock()
 		for name, health := range req.Healths {
 			for i, app := range apps {
-				if app.Name != name {
+				if app.DisplayName != name {
 					continue
 				}
 				app.Health = health

diff --git a/coderd/database/databasefake/databasefake.go b/coderd/database/databasefake/databasefake.go
@@ -2363,7 +2363,7 @@ func (q *fakeQuerier) InsertWorkspaceApp(_ context.Context, arg database.InsertW
 		AgentID:              arg.AgentID,
 		CreatedAt:            arg.CreatedAt,
 		Slug:                 arg.Slug,
-		Name:                 arg.Name,
+		DisplayName:          arg.DisplayName,
 		Icon:                 arg.Icon,
 		Command:              arg.Command,
 		Url:                  arg.Url,

diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000061_app_slug.up.sql b/coderd/database/migrations/000061_app_slug.up.sql
@@ -1,3 +1,5 @@
+BEGIN;
+
 -- add "slug" column to "workspace_apps" table
 ALTER TABLE "workspace_apps" ADD COLUMN "slug" text DEFAULT '';
 
@@ -7,3 +9,5 @@ UPDATE "workspace_apps" SET "slug" = "name";
 -- make "slug" column not nullable and remove default
 ALTER TABLE "workspace_apps" ALTER COLUMN "slug" SET NOT NULL;
 ALTER TABLE "workspace_apps" ALTER COLUMN "slug" DROP DEFAULT;
+
+COMMIT;
diff --git a/coderd/database/migrations/000062_app_display_name.down.sql b/coderd/database/migrations/000062_app_display_name.down.sql
@@ -0,0 +1,2 @@
+-- rename column "display_name" to "name" on "workspace_apps"
+ALTER TABLE "workspace_apps" RENAME COLUMN "display_name" TO "name";
diff --git a/coderd/database/migrations/000062_app_display_name.up.sql b/coderd/database/migrations/000062_app_display_name.up.sql
@@ -0,0 +1,2 @@
+-- rename column "name" to "display_name" on "workspace_apps"
+ALTER TABLE "workspace_apps" RENAME COLUMN "name" TO "display_name";
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
@@ -16,8 +16,8 @@ INSERT INTO
         id,
         created_at,
         agent_id,
-		slug,
-        name,
+        slug,
+        display_name,
         icon,
         command,
         url,

diff --git a/coderd/database/unique_constraint.go b/coderd/database/unique_constraint.go
diff --git a/coderd/httpapi/url.go b/coderd/httpapi/url.go
@@ -51,7 +51,7 @@ func (a ApplicationURL) String() string {
 //
 // Subdomains should be in the form:
 //
-//	{PORT/APP_NAME}--{AGENT_NAME}--{WORKSPACE_NAME}--{USERNAME}
+//	{PORT/APP_SLUG}--{AGENT_NAME}--{WORKSPACE_NAME}--{USERNAME}
 //	(eg. https://8080--main--dev--dean.hi.c8s.io)
 func ParseSubdomainAppURL(subdomain string) (ApplicationURL, error) {
 	matches := appURL.FindAllStringSubmatch(subdomain, -1)

diff --git a/coderd/httpapi/url_test.go b/coderd/httpapi/url_test.go
@@ -131,9 +131,9 @@ func TestParseSubdomainAppURL(t *testing.T) {
 		},
 		{
 			Name:      "HyphenatedNames",
-			Subdomain: "app-name--agent-name--workspace-name--user-name",
+			Subdomain: "app-slug--agent-name--workspace-name--user-name",
 			Expected: httpapi.ApplicationURL{
-				AppSlug:       "app-name",
+				AppSlug:       "app-slug",
 				Port:          0,
 				AgentName:     "agent-name",
 				WorkspaceName: "workspace-name",

diff --git a/coderd/provisionerdaemons.go b/coderd/provisionerdaemons.go
@@ -832,12 +832,12 @@ func insertWorkspaceResource(ctx context.Context, db database.Store, jobID uuid.
 			}
 
 			dbApp, err := db.InsertWorkspaceApp(ctx, database.InsertWorkspaceAppParams{
-				ID:        uuid.New(),
-				CreatedAt: database.Now(),
-				AgentID:   dbAgent.ID,
-				Slug:      slug,
-				Name:      app.DisplayName,
-				Icon:      app.Icon,
+				ID:          uuid.New(),
+				CreatedAt:   database.Now(),
+				AgentID:     dbAgent.ID,
+				Slug:        slug,
+				DisplayName: app.DisplayName,
+				Icon:        app.Icon,
 				Command: sql.NullString{
 					String: app.Command,
 					Valid:  app.Command != "",

diff --git a/coderd/workspaceagents.go b/coderd/workspaceagents.go
@@ -596,7 +596,7 @@ func convertApps(dbApps []database.WorkspaceApp) []codersdk.WorkspaceApp {
 		apps = append(apps, codersdk.WorkspaceApp{
 			ID:           dbApp.ID,
 			Slug:         dbApp.Slug,
-			Name:         dbApp.Name,
+			DisplayName:  dbApp.DisplayName,
 			Command:      dbApp.Command.String,
 			Icon:         dbApp.Icon,
 			Subdomain:    dbApp.Subdomain,
@@ -864,7 +864,7 @@ func (api *API) postWorkspaceAppHealth(rw http.ResponseWriter, r *http.Request)
 	for name, newHealth := range req.Healths {
 		old := func() *database.WorkspaceApp {
 			for _, app := range apps {
-				if app.Name == name {
+				if app.DisplayName == name {
 					return &app
 				}
 			}

diff --git a/coderd/workspaceapps_test.go b/coderd/workspaceapps_test.go
@@ -832,7 +832,7 @@ func TestAppSharing(t *testing.T) {
 			proxyTestAppNamePublic:        codersdk.WorkspaceAppSharingLevelPublic,
 		}
 		for _, app := range agnt.Apps {
-			found[app.Name] = app.SharingLevel
+			found[app.DisplayName] = app.SharingLevel
 		}
 		require.Equal(t, expected, found, "apps have incorrect sharing levels")
 

diff --git a/coderd/workspaces_test.go b/coderd/workspaces_test.go
@@ -1462,7 +1462,7 @@ func TestWorkspaceResource(t *testing.T) {
 		app := apps[0]
 		require.EqualValues(t, app.Command, got.Command)
 		require.EqualValues(t, app.Icon, got.Icon)
-		require.EqualValues(t, app.DisplayName, got.Name)
+		require.EqualValues(t, app.DisplayName, got.DisplayName)
 		require.EqualValues(t, codersdk.WorkspaceAppHealthDisabled, got.Health)
 		require.EqualValues(t, "", got.Healthcheck.URL)
 		require.EqualValues(t, 0, got.Healthcheck.Interval)
@@ -1471,7 +1471,7 @@ func TestWorkspaceResource(t *testing.T) {
 		app = apps[1]
 		require.EqualValues(t, app.Command, got.Command)
 		require.EqualValues(t, app.Icon, got.Icon)
-		require.EqualValues(t, app.DisplayName, got.Name)
+		require.EqualValues(t, app.DisplayName, got.DisplayName)
 		require.EqualValues(t, codersdk.WorkspaceAppHealthInitializing, got.Health)
 		require.EqualValues(t, app.Healthcheck.Url, got.Healthcheck.URL)
 		require.EqualValues(t, app.Healthcheck.Interval, got.Healthcheck.Interval)
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		-- rename column "display_name" to "name" on "workspace_apps"
		ALTER TABLE "workspace_apps" RENAME COLUMN "display_name" TO "name";
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		-- rename column "name" to "display_name" on "workspace_apps"
		ALTER TABLE "workspace_apps" RENAME COLUMN "name" TO "display_name";