Proper partial updating for onboardingSettings

Tool: gitpod/catfood.gitpod.cloud

Author: filiptronicek

components/dashboard/src/repositories/detail/general/ManageRepoSuggestion.tsx

@@ -36,7 +36,6 @@ export const ManageRepoSuggestion: FC<Props> = ({ configuration }) => {
             await updateTeamSettings.mutateAsync(
                 {
                     onboardingSettings: {
-                        ...orgSettings?.onboardingSettings,
                         recommendedRepositories: [...newRepositories],
                     },
                 },
@@ -47,7 +46,7 @@ export const ManageRepoSuggestion: FC<Props> = ({ configuration }) => {
                 },
             );
         },
-        [orgSettings?.onboardingSettings, toast, updateTeamSettings],
+        [orgSettings?.onboardingSettings?.recommendedRepositories, toast, updateTeamSettings],
     );
 
     const isSuggested = orgSettings?.onboardingSettings?.recommendedRepositories?.includes(configuration.id);

components/dashboard/src/teams/TeamOnboarding.tsx

@@ -75,12 +75,11 @@ export default function TeamOnboardingPage() {
 
             await handleUpdateTeamSettings({
                 onboardingSettings: {
-                    ...settings?.onboardingSettings,
                     internalLink,
                 },
             });
         },
-        [handleUpdateTeamSettings, internalLink, settings?.onboardingSettings],
+        [handleUpdateTeamSettings, internalLink],
     );
 
     useEffect(() => {

components/server/src/api/organization-service-api.ts

@@ -355,19 +355,36 @@ export class OrganizationServiceAPI implements ServiceImpl<typeof OrganizationSe
         }
 
         if (req.onboardingSettings && Object.keys(req.onboardingSettings).length > 0) {
+            update.onboardingSettings = {};
+
             if (!this.config.isDedicatedInstallation) {
                 throw new ApplicationError(
                     ErrorCodes.BAD_REQUEST,
                     "onboardingSettings can only be set on enterprise installations",
                 );
             }
-            if ((req.onboardingSettings.internalLink?.length ?? 0) > 255) {
-                throw new ApplicationError(ErrorCodes.BAD_REQUEST, "internalLink must be <= 255 characters");
+
+            if (req.onboardingSettings.internalLink) {
+                if (req.onboardingSettings.internalLink.length > 255) {
+                    throw new ApplicationError(ErrorCodes.BAD_REQUEST, "internalLink must be <= 255 characters long");
+                }
+
+                update.onboardingSettings.internalLink = req.onboardingSettings.internalLink;
             }
 
             if (
-                req.onboardingSettings.recommendedRepositories &&
-                req.onboardingSettings.updateRecommendedRepositories
+                !req.onboardingSettings.updateRecommendedRepositories &&
+                req.onboardingSettings.recommendedRepositories.length > 0
+            ) {
+                throw new ApplicationError(
+                    ErrorCodes.BAD_REQUEST,
+                    "recommendedRepositories can only be set when updateRecommendedRepositories is true",
+                );
+            }
+
+            if (
+                req.onboardingSettings.updateRecommendedRepositories &&
+                req.onboardingSettings.recommendedRepositories
             ) {
                 if (req.onboardingSettings.recommendedRepositories.length > 3) {
                     throw new ApplicationError(
@@ -385,6 +402,8 @@ export class OrganizationServiceAPI implements ServiceImpl<typeof OrganizationSe
                         throw new ApplicationError(ErrorCodes.BAD_REQUEST, `repository ${configurationId} not found`);
                     }
                 }
+
+                update.onboardingSettings.recommendedRepositories = req.onboardingSettings.recommendedRepositories;
             }
 
             if (
@@ -411,9 +430,15 @@ export class OrganizationServiceAPI implements ServiceImpl<typeof OrganizationSe
                 ) {
                     throw new ApplicationError(ErrorCodes.BAD_REQUEST, "welcomeMessage must not be empty when enabled");
                 }
+
+                update.onboardingSettings.welcomeMessage = req.onboardingSettings.welcomeMessage;
             }
 
-            update.onboardingSettings = req.onboardingSettings;
+            const existingOnboardingSettings = await this.orgService.getSettings(ctxUserId(), req.organizationId);
+            update.onboardingSettings = {
+                ...existingOnboardingSettings.onboardingSettings,
+                ...update.onboardingSettings,
+            };
         }
         if (req.annotateGitCommits !== undefined) {
             update.annotateGitCommits = req.annotateGitCommits;

components/server/src/orgs/organization-service.ts

@@ -37,6 +37,7 @@ import { CostCenter_BillingStrategy } from "@gitpod/gitpod-protocol/lib/usage";
 import { CreateUserParams, UserAuthentication } from "../user/user-authentication";
 import isURL from "validator/lib/isURL";
 import { DBTeamMembership } from "@gitpod/gitpod-db/lib/typeorm/entity/db-team-membership";
+import { TrustedValue } from "@gitpod/gitpod-protocol/lib/util/scrubbing";
 
 @injectable()
 export class OrganizationService {
@@ -603,6 +604,7 @@ export class OrganizationService {
             }
         }
 
+        log.info({ settings: new TrustedValue(settings) }, "Updating organization settings");
         return this.toSettings(await this.teamDB.setOrgSettings(orgId, settings));
     }