Add display name to edit group UI

Emyrk · Emyrk · commit 2debc91c0443 · 2023-07-26T16:28:03.000-04:00
diff --git a/codersdk/groups.go b/codersdk/groups.go
@@ -100,7 +100,7 @@ type PatchGroupRequest struct {
 	AddUsers       []string `json:"add_users"`
 	RemoveUsers    []string `json:"remove_users"`
 	Name           string   `json:"name"`
-	DisplayName    string   `db:"display_name" json:"display_name"`
+	DisplayName    *string  `json:"display_name"`
 	AvatarURL      *string  `json:"avatar_url"`
 	QuotaAllowance *int     `json:"quota_allowance"`
 }
diff --git a/docs/cli/groups_list.md b/docs/cli/groups_list.md
diff --git a/enterprise/coderd/groups.go b/enterprise/coderd/groups.go
@@ -53,11 +53,6 @@ func (api *API) postGroupByOrganization(rw http.ResponseWriter, r *http.Request)
 		return
 	}
 
-	// Default the name and display name to the same.
-	if req.DisplayName == "" {
-		req.DisplayName = req.Name
-	}
-
 	group, err := api.Database.InsertGroup(ctx, database.InsertGroupParams{
 		ID:             uuid.New(),
 		Name:           req.Name,
@@ -197,8 +192,8 @@ func (api *API) patchGroup(rw http.ResponseWriter, r *http.Request) {
 		if req.QuotaAllowance != nil {
 			updateGroupParams.QuotaAllowance = int32(*req.QuotaAllowance)
 		}
-		if req.DisplayName != "" {
-			updateGroupParams.DisplayName = req.DisplayName
+		if req.DisplayName != nil {
+			updateGroupParams.DisplayName = *req.DisplayName
 		}
 
 		group, err = tx.UpdateGroupByID(ctx, updateGroupParams)
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
@@ -175,6 +175,7 @@ export interface CreateFirstUserResponse {
 // From codersdk/groups.go
 export interface CreateGroupRequest {
   readonly name: string
+  readonly display_name: string
   readonly avatar_url: string
   readonly quota_allowance: number
 }
@@ -666,7 +667,7 @@ export interface PatchGroupRequest {
   readonly add_users: string[]
   readonly remove_users: string[]
   readonly name: string
-  readonly display_name: string
+  readonly display_name?: string
   readonly avatar_url?: string
   readonly quota_allowance?: number
 }
diff --git a/site/src/pages/GroupsPage/CreateGroupPageView.tsx b/site/src/pages/GroupsPage/CreateGroupPageView.tsx
@@ -29,6 +29,7 @@ export const CreateGroupPageView: FC<CreateGroupPageViewProps> = ({
   const form = useFormik<CreateGroupRequest>({
     initialValues: {
       name: "",
+      display_name: "",
       avatar_url: "",
       quota_allowance: 0,
     },
diff --git a/site/src/pages/GroupsPage/SettingsGroupPageView.tsx b/site/src/pages/GroupsPage/SettingsGroupPageView.tsx
@@ -37,7 +37,7 @@ const UpdateGroupForm: FC<{
       name: group.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,
+      display_name: group.display_name,
       avatar_url: group.avatar_url,
       quota_allowance: group.quota_allowance,
     },
@@ -59,27 +59,24 @@ 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"
-            />
-          )}
-
+          <TextField
+            {...getFieldHelpers(
+              "display_name",
+              "Optional: keep empty to default to the name.",
+            )}
+            onChange={onChangeTrimmed(form)}
+            autoComplete="display_name"
+            autoFocus
+            fullWidth
+            label="Display Name"
+          />
           <LazyIconField
             {...getFieldHelpers("avatar_url")}
             onChange={onChangeTrimmed(form)}
             fullWidth
             label={t("form.fields.icon")}
             onPickEmoji={(value) => form.setFieldValue("avatar_url", value)}
           />
-
           <TextField
             {...getFieldHelpers(
               "quota_allowance",

Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@ type PatchGroupRequest struct {`
`100`	`100`	AddUsers []string `json:"add_users"`
`101`	`101`	RemoveUsers []string `json:"remove_users"`
`102`	`102`	Name string `json:"name"`
`103`		- DisplayName string `db:"display_name" json:"display_name"`
	`103`	+ DisplayName *string `json:"display_name"`
`104`	`104`	AvatarURL *string `json:"avatar_url"`
`105`	`105`	QuotaAllowance *int `json:"quota_allowance"`
`106`	`106`	`}`