Refactor organization welcome message type definitions

Restructure the protobuf definitions for organization onboarding settings and welcome messages, including:
- Separate OnboardingSettings from OrganizationSettings
- Clarify field descriptions
- Add validation for featuredMemberResolvedAvatarUrl
- Update type references across multiple components

Tool: gitpod/catfood.gitpod.cloud

Author: filiptronicek

components/dashboard/src/data/organizations/update-org-settings-mutation.ts

@@ -73,6 +73,10 @@ export const useUpdateOrgSettingsMutation = () => {
                 onboardingSettings: {
                     ...onboardingSettings,
                     updateRecommendedRepositories: !!onboardingSettings?.recommendedRepositories,
+                    welcomeMessage: {
+                        ...onboardingSettings?.welcomeMessage,
+                        featuredMemberResolvedAvatarUrl: undefined, // This field is not allowed to be set in the request.
+                    },
                 },
                 annotateGitCommits,
             });

components/dashboard/src/teams/onboarding/OrgMemberAvatarInput.tsx

@@ -7,12 +7,12 @@
 import { useState } from "react";
 import { useListOrganizationMembers } from "../../data/organizations/members-query";
 
-import type { OrganizationSettings_OnboardingSettings_WelcomeMessage } from "@gitpod/public-api/lib/gitpod/v1/organization_pb";
+import type { OnboardingSettings_WelcomeMessage } from "@gitpod/public-api/lib/gitpod/v1/organization_pb";
 import { Button } from "@podkit/buttons/Button";
 import { DropdownMenu, DropdownMenuContent, DropdownMenuItem, DropdownMenuTrigger } from "@podkit/dropdown/DropDown";
 
 type Props = {
-    settings: OrganizationSettings_OnboardingSettings_WelcomeMessage | undefined;
+    settings: OnboardingSettings_WelcomeMessage | undefined;
     setFeaturedMemberId: (featuredMemberId: string | undefined) => void;
 };
 export const OrgMemberAvatarInput = ({ settings, setFeaturedMemberId }: Props) => {

components/dashboard/src/teams/onboarding/WelcomeMessageConfigurationField.tsx

@@ -5,7 +5,7 @@
  */
 
 import { PlainMessage } from "@bufbuild/protobuf";
-import type { OrganizationSettings_OnboardingSettings_WelcomeMessage } from "@gitpod/public-api/lib/gitpod/v1/organization_pb";
+import type { OnboardingSettings_WelcomeMessage } from "@gitpod/public-api/lib/gitpod/v1/organization_pb";
 import { SwitchInputField } from "@podkit/switch/Switch";
 import { Heading3, Subheading } from "@podkit/typography/Headings";
 import { useCallback, useState } from "react";
@@ -40,10 +40,7 @@ export const WelcomeMessageConfigurationField = ({ handleUpdateTeamSettings }: P
     const [welcomeMessageEditorOpen, setWelcomeMessageEditorOpen] = useState(false);
 
     const handleUpdateWelcomeMessage = useCallback(
-        async (
-            newSettings: PlainMessage<OrganizationSettings_OnboardingSettings_WelcomeMessage>,
-            options?: UpdateTeamSettingsOptions,
-        ) => {
+        async (newSettings: PlainMessage<OnboardingSettings_WelcomeMessage>, options?: UpdateTeamSettingsOptions) => {
             await handleUpdateTeamSettings(
                 {
                     onboardingSettings: {

components/dashboard/src/teams/onboarding/WelcomeMessageEditor.tsx

@@ -5,7 +5,7 @@
  */
 
 import { PlainMessage } from "@bufbuild/protobuf";
-import type { OrganizationSettings_OnboardingSettings_WelcomeMessage } from "@gitpod/public-api/lib/gitpod/v1/organization_pb";
+import type { OnboardingSettings_WelcomeMessage } from "@gitpod/public-api/lib/gitpod/v1/organization_pb";
 import { Button } from "@podkit/buttons/Button";
 import { LoadingButton } from "@podkit/buttons/LoadingButton";
 import { Textarea } from "@podkit/forms/TextArea";
@@ -19,12 +19,12 @@ import { OrgMemberAvatarInput } from "./OrgMemberAvatarInput";
 import { gitpodWelcomeSubheading } from "./WelcomeMessageConfigurationField";
 
 type Props = {
-    settings: OrganizationSettings_OnboardingSettings_WelcomeMessage | undefined;
+    settings: OnboardingSettings_WelcomeMessage | undefined;
     isLoading: boolean;
     isOwner: boolean;
     isOpen: boolean;
     handleUpdateWelcomeMessage: (
-        newSettings: PlainMessage<OrganizationSettings_OnboardingSettings_WelcomeMessage>,
+        newSettings: PlainMessage<OnboardingSettings_WelcomeMessage>,
         options?: UpdateTeamSettingsOptions,
     ) => Promise<void>;
     setIsOpen: (isOpen: boolean) => void;

components/public-api/gitpod/v1/organization.proto

@@ -34,7 +34,8 @@ enum OrganizationRole {
   ORGANIZATION_ROLE_COLLABORATOR = 3;
 }
 
-// OrganizationPermissions define permissions that are restrictable using RoleRestrictions
+// OrganizationPermissions define permissions that are restrictable using
+// RoleRestrictions
 enum OrganizationPermission {
   ORGANIZATION_PERMISSION_UNSPECIFIED = 0;
   ORGANIZATION_PERMISSION_START_ARBITRARY_REPOS = 1;
@@ -48,33 +49,43 @@ message RoleRestrictionEntry {
   repeated OrganizationPermission permissions = 2;
 }
 
-message OrganizationSettings {
-  // onboarding_settings are the settings for the organization's onboarding
-  message OnboardingSettings {
-    message WelcomeMessage {
-      // enabled specifies whether the welcome message is enabled
-      bool enabled = 1;
+// onboarding_settings are the settings for the organization's onboarding
+message OnboardingSettings {
+  message WelcomeMessage {
+    // enabled specifies whether the welcome message is enabled
+    bool enabled = 1;
 
-      // message is the welcome message for the organization
-      optional string message = 2;
+    // message is the welcome message for the organization
+    optional string message = 2;
 
-      // featured_member_id is the ID of the member to show in the welcome message
-      optional string featured_member_id = 4;
+    // featured_member_id is the ID of the member to show in the welcome message
+    optional string featured_member_id = 4;
 
-      // featured_member_resolved_avatar_url is the avatar URL that is resolved from the featured_member_id by the server
-      optional string featured_member_resolved_avatar_url = 5;
-    }
+    // featured_member_resolved_avatar_url is the avatar URL that is resolved
+    // from the featured_member_id by the server
+    // This field **can not** be set in the request.
+    optional string featured_member_resolved_avatar_url = 5;
+  }
 
-    // internal_link is the link to an internal onboarding page for the organization, possibly featuring a custom onboarding guide and other resources
-    optional string internal_link = 1;
+  // internal_link is the link to an internal onboarding page for the
+  // organization, possibly featuring a custom onboarding guide and other
+  // resources
+  optional string internal_link = 1;
 
-    // recommended_repositories are the repositories that are recommended for new org members
-    repeated string recommended_repositories = 2;
+  // recommended_repositories are the repositories that are recommended for new
+  // org members
+  repeated string recommended_repositories = 2;
 
-    // welcome_message is the welcome message for the organization
-    optional WelcomeMessage welcome_message = 3;
-  }
+  // update_recommended_repositories specifies whether recommended_repositories
+  // should be updated.
+  // This field **will not** be specified in server responses.
+  optional bool update_recommended_repositories = 3;
 
+  // welcome_message is the welcome message for the organization
+  optional WelcomeMessage welcome_message = 4;
+}
+
+message OrganizationSettings {
   bool workspace_sharing_disabled = 1;
   string default_workspace_image = 2;
   repeated string allowed_workspace_classes = 3;
@@ -83,9 +94,10 @@ message OrganizationSettings {
   string default_role = 6;
   TimeoutSettings timeout_settings = 7;
   repeated RoleRestrictionEntry role_restrictions = 8;
-  // max_parallel_running_workspaces is the maximum number of workspaces that a single user can run in parallel. 0 resets to the default, which depends on the org plan
+  // max_parallel_running_workspaces is the maximum number of workspaces that a
+  // single user can run in parallel. 0 resets to the default, which depends on
+  // the org plan
   int32 max_parallel_running_workspaces = 9;
-  // this is nested under OrganizationSettings because of the differences between the request & response shapes (see `featured_member_resolved_avatar_url` and `update_recommended_repositories`)
   OnboardingSettings onboarding_settings = 10;
   bool annotate_git_commits = 11;
 }
@@ -166,28 +178,12 @@ message TimeoutSettings {
   // inactivity is the duration of inactivity after which a workspace is stopped
   optional google.protobuf.Duration inactivity = 1;
 
-  // deny_user_timeout specifies whether applying custom timeouts is denied for organization members
+  // deny_user_timeout specifies whether applying custom timeouts is denied for
+  // organization members
   optional bool deny_user_timeouts = 2;
 }
 
 message UpdateOrganizationSettingsRequest {
-  message OnboardingSettings {
-    message WelcomeMessage {
-      optional bool enabled = 1;
-      optional string message = 2;
-      optional string featured_member_id = 3;
-    }
-
-    optional string internal_link = 1;
-
-    // update_recommended_repositories specifies whether recommended_repositories should be updated
-    // this is necessary because proto 3 doesn't support optional repeated fields. Will not be specified in server responses.
-    optional bool update_recommended_repositories = 2;
-    repeated string recommended_repositories = 3;
-
-    optional WelcomeMessage welcome_message = 4;
-  }
-
   // organization_id is the ID of the organization to update the settings for
   string organization_id = 1;
 
@@ -225,16 +221,20 @@ message UpdateOrganizationSettingsRequest {
 
   repeated RoleRestrictionEntry role_restrictions = 12;
 
-  // update_role_restrictions specifies whether role_restrictions should be updated
+  // update_role_restrictions specifies whether role_restrictions should be
+  // updated
   optional bool update_role_restrictions = 13;
 
-  // max_parallel_running_workspaces is the maximum number of workspaces that a single user can run in parallel. 0 resets to the default, which depends on the org plan
+  // max_parallel_running_workspaces is the maximum number of workspaces that a
+  // single user can run in parallel. 0 resets to the default, which depends on
+  // the org plan
   optional int32 max_parallel_running_workspaces = 15;
 
   // onboarding_settings are the settings for the organization's onboarding
   optional OnboardingSettings onboarding_settings = 16;
 
-  // annotate_git_commits specifies whether to annotate git commits created in Gitpod workspaces with the gitpod host
+  // annotate_git_commits specifies whether to annotate git commits created in
+  // Gitpod workspaces with the gitpod host
   optional bool annotate_git_commits = 17;
 }