feat: add new required slug property to coder_app, use in URLs (#4573)

coderd/database/databasefake/databasefake.go

@@ -1861,7 +1861,7 @@ func (q *fakeQuerier) GetWorkspaceAgentsCreatedAfter(_ context.Context, after ti
 	return workspaceAgents, nil
 }
 
-func (q *fakeQuerier) GetWorkspaceAppByAgentIDAndName(_ context.Context, arg database.GetWorkspaceAppByAgentIDAndNameParams) (database.WorkspaceApp, error) {
+func (q *fakeQuerier) GetWorkspaceAppByAgentIDAndSlug(_ context.Context, arg database.GetWorkspaceAppByAgentIDAndSlugParams) (database.WorkspaceApp, error) {
 	q.mutex.RLock()
 	defer q.mutex.RUnlock()
 
@@ -1869,7 +1869,7 @@ func (q *fakeQuerier) GetWorkspaceAppByAgentIDAndName(_ context.Context, arg dat
 		if app.AgentID != arg.AgentID {
 			continue
 		}
-		if app.Name != arg.Name {
+		if app.Slug != arg.Slug {
 			continue
 		}
 		return app, nil
@@ -2522,7 +2522,8 @@ func (q *fakeQuerier) InsertWorkspaceApp(_ context.Context, arg database.InsertW
 		ID:                   arg.ID,
 		AgentID:              arg.AgentID,
 		CreatedAt:            arg.CreatedAt,
-		Name:                 arg.Name,
+		Slug:                 arg.Slug,
+		DisplayName:          arg.DisplayName,
 		Icon:                 arg.Icon,
 		Command:              arg.Command,
 		Url:                  arg.Url,

coderd/database/dump.sql

@@ -399,7 +399,7 @@ CREATE TABLE workspace_apps (
     id uuid NOT NULL,
     created_at timestamp with time zone NOT NULL,
     agent_id uuid NOT NULL,
-    name character varying(64) NOT NULL,
+    display_name character varying(64) NOT NULL,
     icon character varying(256) NOT NULL,
     command character varying(65534),
     url character varying(65534),
@@ -408,7 +408,8 @@ CREATE TABLE workspace_apps (
     healthcheck_threshold integer DEFAULT 0 NOT NULL,
     health workspace_app_health DEFAULT 'disabled'::public.workspace_app_health NOT NULL,
     subdomain boolean DEFAULT false NOT NULL,
-    sharing_level app_sharing_level DEFAULT 'owner'::public.app_sharing_level NOT NULL
+    sharing_level app_sharing_level DEFAULT 'owner'::public.app_sharing_level NOT NULL,
+    slug text NOT NULL
 );
 
 CREATE TABLE workspace_builds (
@@ -548,7 +549,7 @@ ALTER TABLE ONLY workspace_agents
     ADD CONSTRAINT workspace_agents_pkey PRIMARY KEY (id);
 
 ALTER TABLE ONLY workspace_apps
-    ADD CONSTRAINT workspace_apps_agent_id_name_key UNIQUE (agent_id, name);
+    ADD CONSTRAINT workspace_apps_agent_id_slug_idx UNIQUE (agent_id, slug);
 
 ALTER TABLE ONLY workspace_apps
     ADD CONSTRAINT workspace_apps_pkey PRIMARY KEY (id);

coderd/database/migrations/000066_app_slug.down.sql

@@ -0,0 +1,5 @@
+-- drop unique index on "slug" column
+ALTER TABLE "workspace_apps" DROP CONSTRAINT IF EXISTS "workspace_apps_agent_id_slug_idx";
+
+-- drop "slug" column from "workspace_apps" table
+ALTER TABLE "workspace_apps" DROP COLUMN "slug";

coderd/database/migrations/000066_app_slug.up.sql

@@ -0,0 +1,16 @@
+BEGIN;
+
+-- add "slug" column to "workspace_apps" table
+ALTER TABLE "workspace_apps" ADD COLUMN "slug" text DEFAULT '';
+
+-- copy the "name" column for each workspace app to the "slug" column
+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;
+
+-- add unique index on "slug" column
+ALTER TABLE "workspace_apps" ADD CONSTRAINT "workspace_apps_agent_id_slug_idx" UNIQUE ("agent_id", "slug");
+
+COMMIT;

coderd/database/migrations/000067_app_display_name.down.sql

@@ -0,0 +1,34 @@
+BEGIN;
+
+-- Select all apps with an extra "row_number" column that determines the "rank"
+-- of the display name against other display names in the same agent.
+WITH row_numbers AS (
+    SELECT
+        *,
+        row_number() OVER (PARTITION BY agent_id, display_name ORDER BY display_name ASC) AS row_number
+    FROM
+        workspace_apps
+)
+
+-- Update any app with a "row_number" greater than 1 to have the row number
+-- appended to the display name. This effectively means that all lowercase
+-- display names remain untouched, while non-unique mixed case usernames are
+-- appended with a unique number. If you had three apps called all called asdf,
+-- they would then be renamed to e.g. asdf, asdf1234, and asdf5678.
+UPDATE
+    workspace_apps
+SET
+    display_name = workspace_apps.display_name || floor(random() * 10000)::text
+FROM
+    row_numbers
+WHERE
+    workspace_apps.id = row_numbers.id AND
+    row_numbers.row_number > 1;
+
+-- rename column "display_name" to "name" on "workspace_apps"
+ALTER TABLE "workspace_apps" RENAME COLUMN "display_name" TO "name";
+
+-- restore unique index on "workspace_apps" table
+ALTER TABLE workspace_apps ADD CONSTRAINT workspace_apps_agent_id_name_key UNIQUE ("agent_id", "name");
+
+COMMIT;

coderd/database/migrations/000067_app_display_name.up.sql

@@ -0,0 +1,9 @@
+BEGIN;
+
+-- rename column "name" to "display_name" on "workspace_apps"
+ALTER TABLE "workspace_apps" RENAME COLUMN "name" TO "display_name";
+
+-- drop constraint "workspace_apps_agent_id_name_key" on "workspace_apps".
+ALTER TABLE ONLY workspace_apps DROP CONSTRAINT IF EXISTS workspace_apps_agent_id_name_key;
+
+COMMIT;

coderd/database/models.go

@@ -667,7 +667,7 @@ type WorkspaceApp struct {
 	ID                   uuid.UUID          `db:"id" json:"id"`
 	CreatedAt            time.Time          `db:"created_at" json:"created_at"`
 	AgentID              uuid.UUID          `db:"agent_id" json:"agent_id"`
-	Name                 string             `db:"name" json:"name"`
+	DisplayName          string             `db:"display_name" json:"display_name"`
 	Icon                 string             `db:"icon" json:"icon"`
 	Command              sql.NullString     `db:"command" json:"command"`
 	Url                  sql.NullString     `db:"url" json:"url"`
@@ -677,6 +677,7 @@ type WorkspaceApp struct {
 	Health               WorkspaceAppHealth `db:"health" json:"health"`
 	Subdomain            bool               `db:"subdomain" json:"subdomain"`
 	SharingLevel         AppSharingLevel    `db:"sharing_level" json:"sharing_level"`
+	Slug                 string             `db:"slug" json:"slug"`
 }
 
 type WorkspaceBuild struct {

coderd/database/querier.go

@@ -100,7 +100,7 @@ type sqlcQuerier interface {
 	GetWorkspaceAgentByInstanceID(ctx context.Context, authInstanceID string) (WorkspaceAgent, error)
 	GetWorkspaceAgentsByResourceIDs(ctx context.Context, ids []uuid.UUID) ([]WorkspaceAgent, error)
 	GetWorkspaceAgentsCreatedAfter(ctx context.Context, createdAt time.Time) ([]WorkspaceAgent, error)
-	GetWorkspaceAppByAgentIDAndName(ctx context.Context, arg GetWorkspaceAppByAgentIDAndNameParams) (WorkspaceApp, error)
+	GetWorkspaceAppByAgentIDAndSlug(ctx context.Context, arg GetWorkspaceAppByAgentIDAndSlugParams) (WorkspaceApp, error)
 	GetWorkspaceAppsByAgentID(ctx context.Context, agentID uuid.UUID) ([]WorkspaceApp, error)
 	GetWorkspaceAppsByAgentIDs(ctx context.Context, ids []uuid.UUID) ([]WorkspaceApp, error)
 	GetWorkspaceAppsCreatedAfter(ctx context.Context, createdAt time.Time) ([]WorkspaceApp, error)

coderd/database/queries.sql.go

@@ -973,8 +973,8 @@ func (q *sqlQuerier) UpdateGitSSHKey(ctx context.Context, arg UpdateGitSSHKeyPar
 }
 
 const deleteGroupByID = `-- name: DeleteGroupByID :exec
-DELETE FROM 
-	groups 
+DELETE FROM
+	groups
 WHERE
 	id = $1
 `
@@ -985,8 +985,8 @@ func (q *sqlQuerier) DeleteGroupByID(ctx context.Context, id uuid.UUID) error {
 }
 
 const deleteGroupMember = `-- name: DeleteGroupMember :exec
-DELETE FROM 
-	group_members 
+DELETE FROM
+	group_members
 WHERE
 	user_id = $1
 `
@@ -4773,23 +4773,23 @@ func (q *sqlQuerier) UpdateWorkspaceAgentVersionByID(ctx context.Context, arg Up
 	return err
 }
 
-const getWorkspaceAppByAgentIDAndName = `-- name: GetWorkspaceAppByAgentIDAndName :one
-SELECT id, created_at, agent_id, name, icon, command, url, healthcheck_url, healthcheck_interval, healthcheck_threshold, health, subdomain, sharing_level FROM workspace_apps WHERE agent_id = $1 AND name = $2
+const getWorkspaceAppByAgentIDAndSlug = `-- name: GetWorkspaceAppByAgentIDAndSlug :one
+SELECT id, created_at, agent_id, display_name, icon, command, url, healthcheck_url, healthcheck_interval, healthcheck_threshold, health, subdomain, sharing_level, slug FROM workspace_apps WHERE agent_id = $1 AND slug = $2
 `
 
-type GetWorkspaceAppByAgentIDAndNameParams struct {
+type GetWorkspaceAppByAgentIDAndSlugParams struct {
 	AgentID uuid.UUID `db:"agent_id" json:"agent_id"`
-	Name    string    `db:"name" json:"name"`
+	Slug    string    `db:"slug" json:"slug"`
 }
 
-func (q *sqlQuerier) GetWorkspaceAppByAgentIDAndName(ctx context.Context, arg GetWorkspaceAppByAgentIDAndNameParams) (WorkspaceApp, error) {
-	row := q.db.QueryRowContext(ctx, getWorkspaceAppByAgentIDAndName, arg.AgentID, arg.Name)
+func (q *sqlQuerier) GetWorkspaceAppByAgentIDAndSlug(ctx context.Context, arg GetWorkspaceAppByAgentIDAndSlugParams) (WorkspaceApp, error) {
+	row := q.db.QueryRowContext(ctx, getWorkspaceAppByAgentIDAndSlug, arg.AgentID, arg.Slug)
 	var i WorkspaceApp
 	err := row.Scan(
 		&i.ID,
 		&i.CreatedAt,
 		&i.AgentID,
-		&i.Name,
+		&i.DisplayName,
 		&i.Icon,
 		&i.Command,
 		&i.Url,
@@ -4799,12 +4799,13 @@ func (q *sqlQuerier) GetWorkspaceAppByAgentIDAndName(ctx context.Context, arg Ge
 		&i.Health,
 		&i.Subdomain,
 		&i.SharingLevel,
+		&i.Slug,
 	)
 	return i, err
 }
 
 const getWorkspaceAppsByAgentID = `-- name: GetWorkspaceAppsByAgentID :many
-SELECT id, created_at, agent_id, name, icon, command, url, healthcheck_url, healthcheck_interval, healthcheck_threshold, health, subdomain, sharing_level FROM workspace_apps WHERE agent_id = $1 ORDER BY name ASC
+SELECT id, created_at, agent_id, display_name, icon, command, url, healthcheck_url, healthcheck_interval, healthcheck_threshold, health, subdomain, sharing_level, slug FROM workspace_apps WHERE agent_id = $1 ORDER BY slug ASC
 `
 
 func (q *sqlQuerier) GetWorkspaceAppsByAgentID(ctx context.Context, agentID uuid.UUID) ([]WorkspaceApp, error) {
@@ -4820,7 +4821,7 @@ func (q *sqlQuerier) GetWorkspaceAppsByAgentID(ctx context.Context, agentID uuid
 			&i.ID,
 			&i.CreatedAt,
 			&i.AgentID,
-			&i.Name,
+			&i.DisplayName,
 			&i.Icon,
 			&i.Command,
 			&i.Url,
@@ -4830,6 +4831,7 @@ func (q *sqlQuerier) GetWorkspaceAppsByAgentID(ctx context.Context, agentID uuid
 			&i.Health,
 			&i.Subdomain,
 			&i.SharingLevel,
+			&i.Slug,
 		); err != nil {
 			return nil, err
 		}
@@ -4845,7 +4847,7 @@ func (q *sqlQuerier) GetWorkspaceAppsByAgentID(ctx context.Context, agentID uuid
 }
 
 const getWorkspaceAppsByAgentIDs = `-- name: GetWorkspaceAppsByAgentIDs :many
-SELECT id, created_at, agent_id, name, icon, command, url, healthcheck_url, healthcheck_interval, healthcheck_threshold, health, subdomain, sharing_level FROM workspace_apps WHERE agent_id = ANY($1 :: uuid [ ]) ORDER BY name ASC
+SELECT id, created_at, agent_id, display_name, icon, command, url, healthcheck_url, healthcheck_interval, healthcheck_threshold, health, subdomain, sharing_level, slug FROM workspace_apps WHERE agent_id = ANY($1 :: uuid [ ]) ORDER BY slug ASC
 `
 
 func (q *sqlQuerier) GetWorkspaceAppsByAgentIDs(ctx context.Context, ids []uuid.UUID) ([]WorkspaceApp, error) {
@@ -4861,7 +4863,7 @@ func (q *sqlQuerier) GetWorkspaceAppsByAgentIDs(ctx context.Context, ids []uuid.
 			&i.ID,
 			&i.CreatedAt,
 			&i.AgentID,
-			&i.Name,
+			&i.DisplayName,
 			&i.Icon,
 			&i.Command,
 			&i.Url,
@@ -4871,6 +4873,7 @@ func (q *sqlQuerier) GetWorkspaceAppsByAgentIDs(ctx context.Context, ids []uuid.
 			&i.Health,
 			&i.Subdomain,
 			&i.SharingLevel,
+			&i.Slug,
 		); err != nil {
 			return nil, err
 		}
@@ -4886,7 +4889,7 @@ func (q *sqlQuerier) GetWorkspaceAppsByAgentIDs(ctx context.Context, ids []uuid.
 }
 
 const getWorkspaceAppsCreatedAfter = `-- name: GetWorkspaceAppsCreatedAfter :many
-SELECT id, created_at, agent_id, name, icon, command, url, healthcheck_url, healthcheck_interval, healthcheck_threshold, health, subdomain, sharing_level FROM workspace_apps WHERE created_at > $1 ORDER BY name ASC
+SELECT id, created_at, agent_id, display_name, icon, command, url, healthcheck_url, healthcheck_interval, healthcheck_threshold, health, subdomain, sharing_level, slug FROM workspace_apps WHERE created_at > $1 ORDER BY slug ASC
 `
 
 func (q *sqlQuerier) GetWorkspaceAppsCreatedAfter(ctx context.Context, createdAt time.Time) ([]WorkspaceApp, error) {
@@ -4902,7 +4905,7 @@ func (q *sqlQuerier) GetWorkspaceAppsCreatedAfter(ctx context.Context, createdAt
 			&i.ID,
 			&i.CreatedAt,
 			&i.AgentID,
-			&i.Name,
+			&i.DisplayName,
 			&i.Icon,
 			&i.Command,
 			&i.Url,
@@ -4912,6 +4915,7 @@ func (q *sqlQuerier) GetWorkspaceAppsCreatedAfter(ctx context.Context, createdAt
 			&i.Health,
 			&i.Subdomain,
 			&i.SharingLevel,
+			&i.Slug,
 		); err != nil {
 			return nil, err
 		}
@@ -4932,7 +4936,8 @@ INSERT INTO
         id,
         created_at,
         agent_id,
-        name,
+        slug,
+        display_name,
         icon,
         command,
         url,
@@ -4944,14 +4949,15 @@ INSERT INTO
         health
     )
 VALUES
-    ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13) RETURNING id, created_at, agent_id, name, icon, command, url, healthcheck_url, healthcheck_interval, healthcheck_threshold, health, subdomain, sharing_level
+    ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14) RETURNING id, created_at, agent_id, display_name, icon, command, url, healthcheck_url, healthcheck_interval, healthcheck_threshold, health, subdomain, sharing_level, slug
 `
 
 type InsertWorkspaceAppParams struct {
 	ID                   uuid.UUID          `db:"id" json:"id"`
 	CreatedAt            time.Time          `db:"created_at" json:"created_at"`
 	AgentID              uuid.UUID          `db:"agent_id" json:"agent_id"`
-	Name                 string             `db:"name" json:"name"`
+	Slug                 string             `db:"slug" json:"slug"`
+	DisplayName          string             `db:"display_name" json:"display_name"`
 	Icon                 string             `db:"icon" json:"icon"`
 	Command              sql.NullString     `db:"command" json:"command"`
 	Url                  sql.NullString     `db:"url" json:"url"`
@@ -4968,7 +4974,8 @@ func (q *sqlQuerier) InsertWorkspaceApp(ctx context.Context, arg InsertWorkspace
 		arg.ID,
 		arg.CreatedAt,
 		arg.AgentID,
-		arg.Name,
+		arg.Slug,
+		arg.DisplayName,
 		arg.Icon,
 		arg.Command,
 		arg.Url,
@@ -4984,7 +4991,7 @@ func (q *sqlQuerier) InsertWorkspaceApp(ctx context.Context, arg InsertWorkspace
 		&i.ID,
 		&i.CreatedAt,
 		&i.AgentID,
-		&i.Name,
+		&i.DisplayName,
 		&i.Icon,
 		&i.Command,
 		&i.Url,
@@ -4994,6 +5001,7 @@ func (q *sqlQuerier) InsertWorkspaceApp(ctx context.Context, arg InsertWorkspace
 		&i.Health,
 		&i.Subdomain,
 		&i.SharingLevel,
+		&i.Slug,
 	)
 	return i, err
 }

coderd/database/queries/groups.sql

@@ -81,7 +81,7 @@ VALUES
 	( $1, $2, $3, $4) RETURNING *;
 
 -- We use the organization_id as the id
--- for simplicity since all users is 
+-- for simplicity since all users is
 -- every member of the org.
 -- name: InsertAllUsersGroup :one
 INSERT INTO groups (
@@ -110,14 +110,14 @@ INSERT INTO group_members (
 VALUES ( $1, $2);
 
 -- name: DeleteGroupMember :exec
-DELETE FROM 
-	group_members 
+DELETE FROM
+	group_members
 WHERE
 	user_id = $1;
 
 -- name: DeleteGroupByID :exec
-DELETE FROM 
-	groups 
+DELETE FROM
+	groups
 WHERE
 	id = $1;
 

coderd/database/queries/workspaceapps.sql

@@ -1,14 +1,14 @@
 -- name: GetWorkspaceAppsByAgentID :many
-SELECT * FROM workspace_apps WHERE agent_id = $1 ORDER BY name ASC;
+SELECT * FROM workspace_apps WHERE agent_id = $1 ORDER BY slug ASC;
 
 -- name: GetWorkspaceAppsByAgentIDs :many
-SELECT * FROM workspace_apps WHERE agent_id = ANY(@ids :: uuid [ ]) ORDER BY name ASC;
+SELECT * FROM workspace_apps WHERE agent_id = ANY(@ids :: uuid [ ]) ORDER BY slug ASC;
 
--- name: GetWorkspaceAppByAgentIDAndName :one
-SELECT * FROM workspace_apps WHERE agent_id = $1 AND name = $2;
+-- name: GetWorkspaceAppByAgentIDAndSlug :one
+SELECT * FROM workspace_apps WHERE agent_id = $1 AND slug = $2;
 
 -- name: GetWorkspaceAppsCreatedAfter :many
-SELECT * FROM workspace_apps WHERE created_at > $1 ORDER BY name ASC;
+SELECT * FROM workspace_apps WHERE created_at > $1 ORDER BY slug ASC;
 
 -- name: InsertWorkspaceApp :one
 INSERT INTO
@@ -16,7 +16,8 @@ INSERT INTO
         id,
         created_at,
         agent_id,
-        name,
+        slug,
+        display_name,
         icon,
         command,
         url,
@@ -28,7 +29,7 @@ INSERT INTO
         health
     )
 VALUES
-    ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13) RETURNING *;
+    ($1, $2, $3, $4, $5, $6, $7, $8, $9, $10, $11, $12, $13, $14) RETURNING *;
 
 -- name: UpdateWorkspaceAppHealthByID :exec
 UPDATE

coderd/database/unique_constraint.go

@@ -16,7 +16,7 @@ const (
 	UniqueProvisionerDaemonsNameKey                UniqueConstraint = "provisioner_daemons_name_key"                   // ALTER TABLE ONLY provisioner_daemons ADD CONSTRAINT provisioner_daemons_name_key UNIQUE (name);
 	UniqueSiteConfigsKeyKey                        UniqueConstraint = "site_configs_key_key"                           // ALTER TABLE ONLY site_configs ADD CONSTRAINT site_configs_key_key UNIQUE (key);
 	UniqueTemplateVersionsTemplateIDNameKey        UniqueConstraint = "template_versions_template_id_name_key"         // ALTER TABLE ONLY template_versions ADD CONSTRAINT template_versions_template_id_name_key UNIQUE (template_id, name);
-	UniqueWorkspaceAppsAgentIDNameKey              UniqueConstraint = "workspace_apps_agent_id_name_key"               // ALTER TABLE ONLY workspace_apps ADD CONSTRAINT workspace_apps_agent_id_name_key UNIQUE (agent_id, name);
+	UniqueWorkspaceAppsAgentIDSlugIndex            UniqueConstraint = "workspace_apps_agent_id_slug_idx"               // ALTER TABLE ONLY workspace_apps ADD CONSTRAINT workspace_apps_agent_id_slug_idx UNIQUE (agent_id, slug);
 	UniqueWorkspaceBuildsJobIDKey                  UniqueConstraint = "workspace_builds_job_id_key"                    // ALTER TABLE ONLY workspace_builds ADD CONSTRAINT workspace_builds_job_id_key UNIQUE (job_id);
 	UniqueWorkspaceBuildsWorkspaceIDBuildNumberKey UniqueConstraint = "workspace_builds_workspace_id_build_number_key" // ALTER TABLE ONLY workspace_builds ADD CONSTRAINT workspace_builds_workspace_id_build_number_key UNIQUE (workspace_id, build_number);
 	UniqueIndexOrganizationName                    UniqueConstraint = "idx_organization_name"                          // CREATE UNIQUE INDEX idx_organization_name ON organizations USING btree (name);