Properly do partial org opts

Unfortunately, this entails having a duplicate `OnboardingSettings` message specified in the proto definition

Tool: gitpod/catfood.gitpod.cloud

Author: filiptronicek

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

@@ -14,21 +14,25 @@ import { useOrgWorkspaceClassesQueryInvalidator } from "./org-workspace-classes-
 import { PlainMessage } from "@bufbuild/protobuf";
 import { useOrgRepoSuggestionsInvalidator } from "./suggested-repositories-query";
 
-type UpdateOrganizationSettingsArgs = Partial<
-    Pick<
-        PlainMessage<OrganizationSettings>,
-        | "workspaceSharingDisabled"
-        | "defaultWorkspaceImage"
-        | "allowedWorkspaceClasses"
-        | "pinnedEditorVersions"
-        | "restrictedEditorNames"
-        | "defaultRole"
-        | "timeoutSettings"
-        | "roleRestrictions"
-        | "maxParallelRunningWorkspaces"
-        | "onboardingSettings"
-        | "annotateGitCommits"
-    >
+export type UpdateOrganizationSettingsArgs = Partial<
+    Omit<
+        Pick<
+            PlainMessage<OrganizationSettings>,
+            | "workspaceSharingDisabled"
+            | "defaultWorkspaceImage"
+            | "allowedWorkspaceClasses"
+            | "pinnedEditorVersions"
+            | "restrictedEditorNames"
+            | "defaultRole"
+            | "timeoutSettings"
+            | "roleRestrictions"
+            | "maxParallelRunningWorkspaces"
+            | "annotateGitCommits"
+        >,
+        never
+    > & {
+        onboardingSettings?: Partial<PlainMessage<OrganizationSettings>["onboardingSettings"]>; // this enables us to not have to specify all of the onboarding settings on every update
+    }
 >;
 
 export const useUpdateOrgSettingsMutation = () => {
@@ -66,7 +70,10 @@ export const useUpdateOrgSettingsMutation = () => {
                 roleRestrictions,
                 updateRoleRestrictions: !!roleRestrictions,
                 maxParallelRunningWorkspaces,
-                onboardingSettings,
+                onboardingSettings: {
+                    ...onboardingSettings,
+                    updateRecommendedRepositories: !!onboardingSettings?.recommendedRepositories,
+                },
                 annotateGitCommits,
             });
             return settings.settings!;

components/dashboard/src/repositories/list/RepositoryTable.tsx

@@ -69,6 +69,7 @@ export const RepositoryTable: FC<Props> = ({
         await updateTeamSettings.mutateAsync(
             {
                 onboardingSettings: {
+                    ...settings?.onboardingSettings,
                     recommendedRepositories: [...newRepositories],
                 },
             },

components/dashboard/src/teams/TeamOnboarding.tsx

@@ -4,18 +4,19 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
-import { OrganizationSettings } from "@gitpod/public-api/lib/gitpod/v1/organization_pb";
 import { FormEvent, useCallback, useEffect, useState } from "react";
 import { Heading2, Heading3, Subheading } from "../components/typography/headings";
 import { useIsOwner } from "../data/organizations/members-query";
 import { useOrgSettingsQuery } from "../data/organizations/org-settings-query";
 import { useCurrentOrg } from "../data/organizations/orgs-query";
-import { useUpdateOrgSettingsMutation } from "../data/organizations/update-org-settings-mutation";
+import {
+    UpdateOrganizationSettingsArgs,
+    useUpdateOrgSettingsMutation,
+} from "../data/organizations/update-org-settings-mutation";
 import { OrgSettingsPage } from "./OrgSettingsPage";
 import { ConfigurationSettingsField } from "../repositories/detail/ConfigurationSettingsField";
 import { useDocumentTitle } from "../hooks/use-document-title";
 import { useToast } from "../components/toasts/Toasts";
-import type { PlainMessage } from "@bufbuild/protobuf";
 import { InputField } from "../components/forms/InputField";
 import { TextInput } from "../components/forms/TextInputField";
 import { LoadingButton } from "@podkit/buttons/LoadingButton";
@@ -44,7 +45,7 @@ export default function TeamOnboardingPage() {
     const [internalLink, setInternalLink] = useState<string | undefined>(undefined);
 
     const handleUpdateTeamSettings = useCallback(
-        async (newSettings: Partial<PlainMessage<OrganizationSettings>>, options?: UpdateTeamSettingsOptions) => {
+        async (newSettings: UpdateOrganizationSettingsArgs, options?: UpdateTeamSettingsOptions) => {
             if (!org?.id) {
                 throw new Error("no organization selected");
             }
@@ -74,12 +75,12 @@ export default function TeamOnboardingPage() {
 
             await handleUpdateTeamSettings({
                 onboardingSettings: {
+                    ...settings?.onboardingSettings,
                     internalLink,
-                    recommendedRepositories: settings?.onboardingSettings?.recommendedRepositories ?? [],
                 },
             });
         },
-        [handleUpdateTeamSettings, internalLink, settings?.onboardingSettings?.recommendedRepositories],
+        [handleUpdateTeamSettings, internalLink, settings?.onboardingSettings],
     );
 
     useEffect(() => {

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

@@ -7,9 +7,9 @@
 import { useState } from "react";
 import { useListOrganizationMembers } from "../../data/organizations/members-query";
 
-import { DropdownMenu, DropdownMenuContent, DropdownMenuItem, DropdownMenuTrigger } from "@podkit/dropdown/DropDown";
-import { Button } from "@podkit/buttons/Button";
 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: OnboardingSettings_WelcomeMessage | undefined;

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

@@ -4,14 +4,11 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
+import { OrganizationSettings } from "@gitpod/public-api/lib/gitpod/v1/organization_pb";
 import { Button } from "@podkit/buttons/Button";
-import { ModalHeader } from "../../components/Modal";
-import { ModalBody } from "../../components/Modal";
-import { ModalFooter } from "../../components/Modal";
-import { Modal } from "../../components/Modal";
-import { useMemo, useCallback, useState, useEffect } from "react";
+import { useCallback, useEffect, useMemo, useState } from "react";
+import { Modal, ModalBody, ModalFooter, ModalHeader } from "../../components/Modal";
 import { storageAvailable } from "../../utils";
-import { OrganizationSettings } from "@gitpod/public-api/lib/gitpod/v1/organization_pb";
 import { WelcomeMessagePreview } from "./WelcomeMessagePreview";
 
 type Props = {

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

@@ -4,30 +4,30 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
+import { PlainMessage } from "@bufbuild/protobuf";
+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 { ConfigurationSettingsField } from "../../repositories/detail/ConfigurationSettingsField";
-import { useOrgSettingsQuery } from "../../data/organizations/org-settings-query";
+import { useCallback, useState } from "react";
+import { InputField } from "../../components/forms/InputField";
 import { useToast } from "../../components/toasts/Toasts";
 import { useIsOwner } from "../../data/organizations/members-query";
-import { useUpdateOrgSettingsMutation } from "../../data/organizations/update-org-settings-mutation";
-import { InputField } from "../../components/forms/InputField";
-import { SwitchInputField } from "@podkit/switch/Switch";
+import { useOrgSettingsQuery } from "../../data/organizations/org-settings-query";
+import {
+    UpdateOrganizationSettingsArgs,
+    useUpdateOrgSettingsMutation,
+} from "../../data/organizations/update-org-settings-mutation";
+import { ConfigurationSettingsField } from "../../repositories/detail/ConfigurationSettingsField";
+import { UpdateTeamSettingsOptions } from "../TeamOnboarding";
 import { WelcomeMessageEditorModal } from "./WelcomeMessageEditor";
 import { WelcomeMessagePreview } from "./WelcomeMessagePreview";
-import { useCallback, useState } from "react";
-import type {
-    OnboardingSettings_WelcomeMessage,
-    OrganizationSettings,
-} from "@gitpod/public-api/lib/gitpod/v1/organization_pb";
-import { PlainMessage } from "@bufbuild/protobuf";
-import { UpdateTeamSettingsOptions } from "../TeamOnboarding";
 
 export const gitpodWelcomeSubheading =
     `Gitpod’s sandboxed, ephemeral development environments enable you to use your existing tools without worrying about vulnerabilities impacting their local machines.` as const;
 
 type Props = {
     handleUpdateTeamSettings: (
-        newSettings: Partial<PlainMessage<OrganizationSettings>>,
+        newSettings: UpdateOrganizationSettingsArgs,
         options?: UpdateTeamSettingsOptions,
     ) => Promise<void>;
 };
@@ -48,17 +48,12 @@ export const WelcomeMessageConfigurationField = ({ handleUpdateTeamSettings }: P
                             ...settings?.onboardingSettings?.welcomeMessage,
                             ...newSettings,
                         },
-                        recommendedRepositories: settings?.onboardingSettings?.recommendedRepositories ?? [],
                     },
                 },
                 options,
             );
         },
-        [
-            handleUpdateTeamSettings,
-            settings?.onboardingSettings?.recommendedRepositories,
-            settings?.onboardingSettings?.welcomeMessage,
-        ],
+        [handleUpdateTeamSettings, settings?.onboardingSettings?.welcomeMessage],
     );
 
     return (

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

@@ -10,13 +10,13 @@ import { Button } from "@podkit/buttons/Button";
 import { LoadingButton } from "@podkit/buttons/LoadingButton";
 import { Textarea } from "@podkit/forms/TextArea";
 import { FormEvent, useCallback, useState } from "react";
+import Alert from "../../components/Alert";
 import { Modal, ModalBody, ModalFooter, ModalHeader } from "../../components/Modal";
 import { InputField } from "../../components/forms/InputField";
 import { TextInput } from "../../components/forms/TextInputField";
+import { UpdateTeamSettingsOptions } from "../TeamOnboarding";
 import { OrgMemberAvatarInput } from "./OrgMemberAvatarInput";
 import { gitpodWelcomeSubheading } from "./WelcomeMessageConfigurationField";
-import { UpdateTeamSettingsOptions } from "../TeamOnboarding";
-import Alert from "../../components/Alert";
 
 type Props = {
     settings: OnboardingSettings_WelcomeMessage | undefined;

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

@@ -4,12 +4,11 @@
  * See License.AGPL.txt in the project root for license information.
  */
 
-import { Subheading } from "@podkit/typography/Headings";
-import { Heading2 } from "@podkit/typography/Headings";
 import { Button } from "@podkit/buttons/Button";
-import { useOrgSettingsQuery } from "../../data/organizations/org-settings-query";
-import { gitpodWelcomeSubheading } from "../TeamOnboarding";
+import { Heading2, Subheading } from "@podkit/typography/Headings";
 import Markdown from "react-markdown";
+import { useOrgSettingsQuery } from "../../data/organizations/org-settings-query";
+import { gitpodWelcomeSubheading } from "./WelcomeMessageConfigurationField";
 
 type Props = {
     disabled?: boolean;

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

@@ -59,7 +59,7 @@ message OnboardingSettings {
     // 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. Do not set this field manually.
+    // 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;
   }
 
@@ -169,6 +169,23 @@ message TimeoutSettings {
 }
 
 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;