display name defaults to empty string

coder · Emyrk · Aug 2, 2023 · Jul 26, 2023 · Jul 26, 2023 · Jul 26, 2023
commit 532aaa105038007f5e3b881e38c981ba3ccb6b1c
diff --git a/coderd/database/dbfake/dbfake.go b/coderd/database/dbfake/dbfake.go
@@ -3381,7 +3381,7 @@ func (q *FakeQuerier) InsertAllUsersGroup(ctx context.Context, orgID uuid.UUID)
 	return q.InsertGroup(ctx, database.InsertGroupParams{
 		ID:             orgID,
 		Name:           database.AllUsersGroup,
-		DisplayName:    database.AllUsersGroup,
+		DisplayName:    "",
 		OrganizationID: orgID,
 	})
 }

diff --git a/coderd/database/migrations/000142_group_display_name.up.sql b/coderd/database/migrations/000142_group_display_name.up.sql
@@ -5,7 +5,4 @@ ALTER TABLE groups
 
 COMMENT ON COLUMN groups.display_name IS 'Display name is a custom, human-friendly group name that user can set. This is not required to be unique.';
 
--- Use the name as the display name for all existing groups
-UPDATE groups SET display_name = name;
-
 COMMIT;
diff --git a/coderd/database/queries/groups.sql b/coderd/database/queries/groups.sql
@@ -49,11 +49,10 @@ VALUES
 INSERT INTO groups (
 	id,
 	name,
-	display_name,
 	organization_id
 )
 VALUES
-	(sqlc.arg(organization_id), 'Everyone', 'Everyone', sqlc.arg(organization_id)) RETURNING *;
+	(sqlc.arg(organization_id), 'Everyone', sqlc.arg(organization_id)) RETURNING *;
 
 -- name: UpdateGroupByID :one
 UPDATE

diff --git a/enterprise/cli/grouplist.go b/enterprise/cli/grouplist.go
@@ -67,6 +67,7 @@ type groupTableRow struct {
 
 	// For table output:
 	Name           string    `json:"-" table:"name,default_sort"`
+	DisplayName    string    `json:"-" table:"display_name"`
 	OrganizationID uuid.UUID `json:"-" table:"organization_id"`
 	Members        []string  `json:"-" table:"members"`
 	AvatarURL      string    `json:"-" table:"avatar_url"`
@@ -81,6 +82,7 @@ func groupsToRows(groups ...codersdk.Group) []groupTableRow {
 		}
 		rows = append(rows, groupTableRow{
 			Name:           group.Name,
+			DisplayName:    group.DisplayName,
 			OrganizationID: group.OrganizationID,
 			AvatarURL:      group.AvatarURL,
 			Members:        members,

diff --git a/enterprise/coderd/groups.go b/enterprise/coderd/groups.go
@@ -131,11 +131,6 @@ func (api *API) patchGroup(rw http.ResponseWriter, r *http.Request) {
 		req.Name = ""
 	}
 
-	// Do not update the display name if it is the same.
-	if req.DisplayName == group.DisplayName {
-		req.DisplayName = ""
-	}
-
 	users := make([]string, 0, len(req.AddUsers)+len(req.RemoveUsers))
 	users = append(users, req.AddUsers...)
 	users = append(users, req.RemoveUsers...)
@@ -205,6 +200,10 @@ func (api *API) patchGroup(rw http.ResponseWriter, r *http.Request) {
 		if req.DisplayName != "" {
 			updateGroupParams.DisplayName = req.DisplayName
 		}
+		// If the names are identical, then remove the display name.
+		if req.DisplayName == req.Name {
+			updateGroupParams.DisplayName = ""
+		}
 
 		group, err = tx.UpdateGroupByID(ctx, updateGroupParams)
 		if err != nil {
@@ -410,10 +409,15 @@ func convertGroup(g database.Group, users []database.User) codersdk.Group {
 	for _, user := range users {
 		orgs[user.ID] = []uuid.UUID{g.OrganizationID}
 	}
+	// Always default to the group name if the display name is empty
+	displayName := g.DisplayName
+	if displayName == "" {
+		displayName = g.Name
+	}
 	return codersdk.Group{
 		ID:             g.ID,
 		Name:           g.Name,
-		DisplayName:    g.DisplayName,
+		DisplayName:    displayName,
 		OrganizationID: g.OrganizationID,
 		AvatarURL:      g.AvatarURL,
 		QuotaAllowance: int(g.QuotaAllowance),

diff --git a/site/src/pages/GroupsPage/SettingsGroupPageView.tsx b/site/src/pages/GroupsPage/SettingsGroupPageView.tsx
@@ -35,7 +35,9 @@ const UpdateGroupForm: FC<{
   const form = useFormik<FormData>({
     initialValues: {
       name: group.name,
-      display_name: group.display_name,
+      // If these are equal, keep the display name blank. A blank display name means
+      // default to using the name.
+      display_name: group.display_name === group.name ? "" : group.display_name,
       avatar_url: group.avatar_url,
       quota_allowance: group.quota_allowance,
     },
@@ -57,6 +59,18 @@ const UpdateGroupForm: FC<{
             fullWidth
             label="Name"
           />
+          {/* We might want to always show this at some point, but for now only show if
+          the display name differs from the original name. */}
+          {group.name !== group.display_name && (
+            <TextField
+              {...getFieldHelpers("display_name")}
+              onChange={onChangeTrimmed(form)}
+              autoComplete="display_name"
+              autoFocus
+              fullWidth
+              label="Display Name"
+            />
+          )}
 
           <LazyIconField
             {...getFieldHelpers("avatar_url")}