fix!: omit name, avatar_url and last_seen_at from responses when empty (#18005)

BrunoQuaresma · web-flow · commit 94c129c03d0e · 2025-05-23T11:35:05.000-03:00
User name, avatar URL, and last seen at, are not required fields so they
can be empty. Instead of returning the 0 values from Go, we want to make
it more agnostic, and omit them when they are empty. This make the docs
and usage way clearer for consumers.
diff --git a/cli/testdata/coder_list_--output_json.golden b/cli/testdata/coder_list_--output_json.golden
@@ -24,7 +24,6 @@
       "workspace_name": "test-workspace",
       "workspace_owner_id": "==========[first user ID]===========",
       "workspace_owner_name": "testuser",
-      "workspace_owner_avatar_url": "",
       "template_version_id": "============[version ID]============",
       "template_version_name": "===========[version name]===========",
       "build_number": 1,
diff --git a/cli/testdata/coder_users_list_--output_json.golden b/cli/testdata/coder_users_list_--output_json.golden
@@ -2,7 +2,6 @@
   {
     "id": "==========[first user ID]===========",
     "username": "testuser",
-    "avatar_url": "",
     "name": "Test User",
     "email": "testuser@coder.com",
     "created_at": "====[timestamp]=====",
@@ -23,8 +22,6 @@
   {
     "id": "==========[second user ID]==========",
     "username": "testuser2",
-    "avatar_url": "",
-    "name": "",
     "email": "testuser2@coder.com",
     "created_at": "====[timestamp]=====",
     "updated_at": "====[timestamp]=====",
diff --git a/codersdk/organizations.go b/codersdk/organizations.go
@@ -74,8 +74,8 @@ type OrganizationMember struct {
 
 type OrganizationMemberWithUserData struct {
 	Username           string     `table:"username,default_sort" json:"username"`
-	Name               string     `table:"name" json:"name"`
-	AvatarURL          string     `json:"avatar_url"`
+	Name               string     `table:"name" json:"name,omitempty"`
+	AvatarURL          string     `json:"avatar_url,omitempty"`
 	Email              string     `json:"email"`
 	GlobalRoles        []SlimRole `json:"global_roles"`
 	OrganizationMember `table:"m,recursive_inline"`
diff --git a/codersdk/users.go b/codersdk/users.go
@@ -40,7 +40,7 @@ type UsersRequest struct {
 type MinimalUser struct {
 	ID        uuid.UUID `json:"id" validate:"required" table:"id" format:"uuid"`
 	Username  string    `json:"username" validate:"required" table:"username,default_sort"`
-	AvatarURL string    `json:"avatar_url" format:"uri"`
+	AvatarURL string    `json:"avatar_url,omitempty" format:"uri"`
 }
 
 // ReducedUser omits role and organization information. Roles are deduced from
@@ -49,11 +49,11 @@ type MinimalUser struct {
 // required by the frontend.
 type ReducedUser struct {
 	MinimalUser `table:"m,recursive_inline"`
-	Name        string    `json:"name"`
+	Name        string    `json:"name,omitempty"`
 	Email       string    `json:"email" validate:"required" table:"email" format:"email"`
 	CreatedAt   time.Time `json:"created_at" validate:"required" table:"created at" format:"date-time"`
 	UpdatedAt   time.Time `json:"updated_at" table:"updated at" format:"date-time"`
-	LastSeenAt  time.Time `json:"last_seen_at" format:"date-time"`
+	LastSeenAt  time.Time `json:"last_seen_at,omitempty" format:"date-time"`
 
 	Status    UserStatus `json:"status" table:"status" enums:"active,suspended"`
 	LoginType LoginType  `json:"login_type"`
diff --git a/codersdk/workspacebuilds.go b/codersdk/workspacebuilds.go
@@ -58,7 +58,7 @@ type WorkspaceBuild struct {
 	WorkspaceName           string               `json:"workspace_name"`
 	WorkspaceOwnerID        uuid.UUID            `json:"workspace_owner_id" format:"uuid"`
 	WorkspaceOwnerName      string               `json:"workspace_owner_name"`
-	WorkspaceOwnerAvatarURL string               `json:"workspace_owner_avatar_url"`
+	WorkspaceOwnerAvatarURL string               `json:"workspace_owner_avatar_url,omitempty"`
 	TemplateVersionID       uuid.UUID            `json:"template_version_id" format:"uuid"`
 	TemplateVersionName     string               `json:"template_version_name"`
 	BuildNumber             int32                `json:"build_number"`
diff --git a/site/src/api/typesGenerated.ts b/site/src/api/typesGenerated.ts
diff --git a/site/src/components/UserAutocomplete/UserAutocomplete.tsx b/site/src/components/UserAutocomplete/UserAutocomplete.tsx
@@ -20,7 +20,7 @@ import { prepareQuery } from "utils/filters";
 
 // The common properties between users and org members that we need.
 export type SelectedUser = {
-	avatar_url: string;
+	avatar_url?: string;
 	email: string;
 	username: string;
 };
diff --git a/site/src/pages/ChatPage/ChatLanding.tsx b/site/src/pages/ChatPage/ChatLanding.tsx
@@ -62,7 +62,7 @@ const ChatLanding: FC = () => {
 							textAlign: "center",
 						}}
 					>
-						Good evening, {user?.name.split(" ")[0]}
+						Good evening, {(user.name ?? user.username).split(" ")[0]}
 					</h1>
 					<p
 						css={{
diff --git a/site/src/pages/UserSettingsPage/AccountPage/AccountForm.test.tsx b/site/src/pages/UserSettingsPage/AccountPage/AccountForm.test.tsx
@@ -13,7 +13,7 @@ describe("AccountForm", () => {
 			// Given
 			const mockInitialValues: UpdateUserProfileRequest = {
 				username: MockUserMember.username,
-				name: MockUserMember.name,
+				name: MockUserMember.name ?? MockUserMember.username,
 			};
 
 			// When
@@ -44,7 +44,7 @@ describe("AccountForm", () => {
 			// Given
 			const mockInitialValues: UpdateUserProfileRequest = {
 				username: MockUserMember.username,
-				name: MockUserMember.name,
+				name: MockUserMember.name ?? MockUserMember.username,
 			};
 
 			// When
diff --git a/site/src/pages/UserSettingsPage/AccountPage/AccountPage.tsx b/site/src/pages/UserSettingsPage/AccountPage/AccountPage.tsx
@@ -29,7 +29,7 @@ const AccountPage: FC = () => {
 					email={me.email}
 					updateProfileError={updateProfileError}
 					isLoading={isUpdatingProfile}
-					initialValues={{ username: me.username, name: me.name }}
+					initialValues={{ username: me.username, name: me.name ?? "" }}
 					onSubmit={updateProfile}
 				/>
 			</Section>
diff --git a/site/src/testHelpers/entities.ts b/site/src/testHelpers/entities.ts
@@ -539,8 +539,8 @@ export const MockOrganizationMember: TypesGen.OrganizationMemberWithUserData = {
 	user_id: MockUserOwner.id,
 	username: MockUserOwner.username,
 	email: MockUserOwner.email,
-	created_at: "",
-	updated_at: "",
+	updated_at: "2025-05-22T17:51:49.49745Z",
+	created_at: "2025-05-22T17:51:49.497449Z",
 	name: MockUserOwner.name,
 	avatar_url: MockUserOwner.avatar_url,
 	global_roles: MockUserOwner.roles,
@@ -553,8 +553,8 @@ export const MockOrganizationMember2: TypesGen.OrganizationMemberWithUserData =
 		user_id: MockUserMember.id,
 		username: MockUserMember.username,
 		email: MockUserMember.email,
-		created_at: "",
-		updated_at: "",
+		updated_at: "2025-05-22T17:51:49.49745Z",
+		created_at: "2025-05-22T17:51:49.497449Z",
 		name: MockUserMember.name,
 		avatar_url: MockUserMember.avatar_url,
 		global_roles: MockUserMember.roles,

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ const ChatLanding: FC = () => {`
`62`	`62`	`textAlign: "center",`
`63`	`63`	`}}`
`64`	`64`	`>`
`65`		`- Good evening, {user?.name.split(" ")[0]}`
	`65`	`+ Good evening, {(user.name ?? user.username).split(" ")[0]}`
`66`	`66`	`</h1>`
`67`	`67`	`<p`
`68`	`68`	`css={{`