[server] Refactor setProjectConfiguration + updateProjectSettings → updateProjectPartial

jankeromnes · jankeromnes · commit 3c2d7d3cd8f4 · 2021-12-13T17:18:52.000Z
diff --git a/components/dashboard/src/projects/ProjectSettings.tsx b/components/dashboard/src/projects/ProjectSettings.tsx
@@ -70,7 +70,12 @@ export default function () {
         }
         setIsLoading(true);
         try {
-            await getGitpodService().server.updateProjectSettings(project.id, { useIncrementalPrebuilds: !isIncrementalPrebuildsEnabled });
+            await getGitpodService().server.updateProjectPartial({
+                id: project.id,
+                settings: {
+                    useIncrementalPrebuilds: !isIncrementalPrebuildsEnabled,
+                }
+            });
             setIsIncrementalPrebuildsEnabled(!isIncrementalPrebuildsEnabled);
         } finally {
             setIsLoading(false);
diff --git a/components/gitpod-db/src/project-db.ts b/components/gitpod-db/src/project-db.ts
@@ -4,7 +4,7 @@
  * See License.enterprise.txt in the project root folder.
  */
 
-import { Project, ProjectConfig, ProjectSettings } from "@gitpod/gitpod-protocol";
+import { PartialProject, Project } from "@gitpod/gitpod-protocol";
 
 export const ProjectDB = Symbol('ProjectDB');
 export interface ProjectDB {
@@ -14,7 +14,6 @@ export interface ProjectDB {
     findTeamProjects(teamId: string): Promise<Project[]>;
     findUserProjects(userId: string): Promise<Project[]>;
     storeProject(project: Project): Promise<Project>;
-    setProjectConfiguration(projectId: string, config: ProjectConfig): Promise<void>;
-    setProjectSettings(projectId: string, settings: ProjectSettings): Promise<void>;
+    updateProject(partialProject: PartialProject): Promise<void>;
     markDeleted(projectId: string): Promise<void>;
 }
diff --git a/components/gitpod-db/src/typeorm/project-db-impl.ts b/components/gitpod-db/src/typeorm/project-db-impl.ts
@@ -9,7 +9,7 @@ import { TypeORM } from "./typeorm";
 import { Repository } from "typeorm";
 import { ProjectDB } from "../project-db";
 import { DBProject } from "./entity/db-project";
-import { Project, ProjectConfig, ProjectSettings } from "@gitpod/gitpod-protocol";
+import { PartialProject, Project } from "@gitpod/gitpod-protocol";
 
 @injectable()
 export class ProjectDBImpl implements ProjectDB {
@@ -60,24 +60,13 @@ export class ProjectDBImpl implements ProjectDB {
         return repo.save(project);
     }
 
-    public async setProjectConfiguration(projectId: string, config: ProjectConfig): Promise<void> {
+    public async updateProject(partialProject: PartialProject): Promise<void> {
         const repo = await this.getRepo();
-        const project = await repo.findOne({ id: projectId, markedDeleted: false });
-        if (!project) {
+        const count = await repo.count({ id: partialProject.id, markedDeleted: false });
+        if (count < 1) {
             throw new Error('A project with this ID could not be found');
         }
-        project.config = config;
-        await repo.save(project);
-    }
-
-    public async setProjectSettings(projectId: string, settings: ProjectSettings): Promise<void> {
-        const repo = await this.getRepo();
-        const project = await repo.findOne({ id: projectId, markedDeleted: false });
-        if (!project) {
-            throw new Error('A project with this ID could not be found');
-        }
-        project.settings = settings;
-        await repo.save(project);
+        await repo.update(partialProject.id, partialProject);
     }
 
     public async markDeleted(projectId: string): Promise<void> {
diff --git a/components/gitpod-protocol/src/gitpod-service.ts b/components/gitpod-protocol/src/gitpod-service.ts
@@ -13,7 +13,7 @@ import {
 } from './protocol';
 import {
     Team, TeamMemberInfo,
-    TeamMembershipInvite, Project, TeamMemberRole, PrebuildWithStatus, StartPrebuildResult, ProjectSettings
+    TeamMembershipInvite, Project, TeamMemberRole, PrebuildWithStatus, StartPrebuildResult, PartialProject
 } from './teams-projects-protocol';
 import { JsonRpcProxy, JsonRpcServer } from './messaging/proxy-factory';
 import { Disposable, CancellationTokenSource } from 'vscode-jsonrpc';
@@ -136,12 +136,12 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     findPrebuilds(params: FindPrebuildsParams): Promise<PrebuildWithStatus[]>;
     triggerPrebuild(projectId: string, branchName: string | null): Promise<StartPrebuildResult>;
     cancelPrebuild(projectId: string, prebuildId: string): Promise<void>;
-    setProjectConfiguration(projectId: string, configString: string): Promise<void>;
     fetchProjectRepositoryConfiguration(projectId: string): Promise<string | undefined>;
     guessProjectConfiguration(projectId: string): Promise<string | undefined>;
     fetchRepositoryConfiguration(cloneUrl: string): Promise<string | undefined>;
     guessRepositoryConfiguration(cloneUrl: string): Promise<string | undefined>;
-    updateProjectSettings(projectId: string, partialSettings: Partial<ProjectSettings>): Promise<void>;
+    setProjectConfiguration(projectId: string, configString: string): Promise<void>;
+    updateProjectPartial(partialProject: PartialProject): Promise<void>;
 
     // content service
     getContentBlobUploadUrl(name: string): Promise<string>
diff --git a/components/gitpod-protocol/src/teams-projects-protocol.ts b/components/gitpod-protocol/src/teams-projects-protocol.ts
@@ -6,6 +6,7 @@
 
 import { PrebuiltWorkspaceState } from "./protocol";
 import { v4 as uuidv4 } from 'uuid';
+import { DeepPartial } from "./util/deep-partial";
 
 export interface ProjectConfig {
     '.gitpod.yml': string;
@@ -60,6 +61,8 @@ export namespace Project {
     }
 }
 
+export type PartialProject = DeepPartial<Project> & Pick<Project, 'id'>;
+
 export interface PrebuildWithStatus {
     info: PrebuildInfo;
     status: PrebuiltWorkspaceState;
diff --git a/components/server/src/auth/rate-limiter.ts b/components/server/src/auth/rate-limiter.ts
@@ -98,12 +98,12 @@ function getConfig(config: RateLimiterConfig): RateLimiterConfig {
         "getProjectOverview":  { group: "default", points: 1 },
         "triggerPrebuild":  { group: "default", points: 1 },
         "cancelPrebuild":  { group: "default", points: 1 },
-        "setProjectConfiguration":  { group: "default", points: 1 },
         "fetchProjectRepositoryConfiguration":  { group: "default", points: 1 },
         "guessProjectConfiguration":  { group: "default", points: 1 },
         "fetchRepositoryConfiguration": { group: "default", points: 1 },
         "guessRepositoryConfiguration": { group: "default", points: 1 },
-        "updateProjectSettings":  { group: "default", points: 1 },
+        "setProjectConfiguration":  { group: "default", points: 1 },
+        "updateProjectPartial":  { group: "default", points: 1 },
         "getContentBlobUploadUrl": { group: "default", points: 1 },
         "getContentBlobDownloadUrl": { group: "default", points: 1 },
         "getGitpodTokens": { group: "default", points: 1 },
diff --git a/components/server/src/projects/projects-service.ts b/components/server/src/projects/projects-service.ts
@@ -6,13 +6,14 @@
 
 import { inject, injectable } from "inversify";
 import { DBWithTracing, ProjectDB, TeamDB, TracedWorkspaceDB, UserDB, WorkspaceDB } from "@gitpod/gitpod-db/lib";
-import { Branch, CommitContext, PrebuildWithStatus, CreateProjectParams, FindPrebuildsParams, Project, ProjectConfig, User, WorkspaceConfig, ProjectSettings } from "@gitpod/gitpod-protocol";
+import { Branch, CommitContext, PrebuildWithStatus, CreateProjectParams, FindPrebuildsParams, Project, User, WorkspaceConfig } from "@gitpod/gitpod-protocol";
 import { TraceContext } from "@gitpod/gitpod-protocol/lib/util/tracing";
 import { HostContextProvider } from "../auth/host-context-provider";
 import { FileProvider, RepoURL } from "../repohost";
 import { log } from '@gitpod/gitpod-protocol/lib/util/logging';
 import { ContextParser } from "../workspace/context-parser-service";
 import { ConfigInferrer } from "./config-inferrer";
+import { PartialProject } from "@gitpod/gitpod-protocol/src/teams-projects-protocol";
 
 @injectable()
 export class ProjectsService {
@@ -178,10 +179,6 @@ export class ProjectsService {
         return result;
     }
 
-    async setProjectConfiguration(projectId: string, config: ProjectConfig): Promise<void> {
-        return this.projectDB.setProjectConfiguration(projectId, config);
-    }
-
     protected async getRepositoryFileProviderAndCommitContext(ctx: TraceContext, user: User, cloneUrl: string): Promise<{fileProvider: FileProvider, commitContext: CommitContext}> {
         const normalizedContextUrl = this.contextParser.normalizeContextURL(cloneUrl);
         const commitContext = (await this.contextParser.handle(ctx, user, normalizedContextUrl)) as CommitContext;
@@ -229,17 +226,8 @@ export class ProjectsService {
         return configString;
     }
 
-    async updateProjectSettings(projectId: string, partialSettings: Partial<ProjectSettings>): Promise<void> {
-        const project = await this.getProject(projectId);
-        if (!project) {
-            throw new Error("Project not found");
-        }
-        const settings = project.settings || {};
-        let key: keyof ProjectSettings;
-        for (key in partialSettings) {
-            settings[key] = partialSettings[key];
-        }
-        return this.projectDB.setProjectSettings(projectId, settings);
+    async updateProjectPartial(partialProject: PartialProject): Promise<void> {
+        return this.projectDB.updateProject(partialProject);
     }
 
 }
diff --git a/components/server/src/workspace/gitpod-server-impl.ts b/components/server/src/workspace/gitpod-server-impl.ts
@@ -53,7 +53,7 @@ import { LocalMessageBroker } from "../messaging/local-message-broker";
 import { CachingBlobServiceClientProvider } from '@gitpod/content-service/lib/sugar';
 import { IDEOptions } from '@gitpod/gitpod-protocol/lib/ide-protocol';
 import { IDEConfigService } from '../ide-config';
-import { ProjectSettings } from '@gitpod/gitpod-protocol/src/teams-projects-protocol';
+import { PartialProject } from '@gitpod/gitpod-protocol/src/teams-projects-protocol';
 
 // shortcut
 export const traceWI = (ctx: TraceContext, wi: Omit<LogContext, "userId">) => TraceContext.setOWI(ctx, wi);    // userId is already taken care of in WebsocketConnectionManager
@@ -1636,18 +1636,6 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         throw new ResponseError(ErrorCodes.EE_FEATURE, `Cancelling Prebuilds is implemented in Gitpod's Enterprise Edition`);
     }
 
-    public async setProjectConfiguration(ctx: TraceContext, projectId: string, configString: string): Promise<void> {
-        traceAPIParams(ctx, { projectId }); // filter configString because of size
-
-        const user = this.checkAndBlockUser("setProjectConfiguration");
-        await this.guardProjectOperation(user, projectId, "update");
-        const parseResult = this.gitpodParser.parse(configString);
-        if (parseResult.validationErrors) {
-            throw new Error(`This configuration could not be parsed: ${parseResult.validationErrors.join(', ')}`);
-        }
-        await this.projectsService.setProjectConfiguration(projectId, { '.gitpod.yml': configString });
-    }
-
     public async fetchRepositoryConfiguration(ctx: TraceContext, cloneUrl: string): Promise<string | undefined> {
         traceAPIParams(ctx, { cloneUrl });
         const user = this.checkUser("fetchRepositoryConfiguration");
@@ -1714,10 +1702,33 @@ export class GitpodServerImpl implements GitpodServerWithTracing, Disposable {
         }
     }
 
-    public async updateProjectSettings(ctx: TraceContext, projectId: string, partialSettings: Partial<ProjectSettings>): Promise<void> {
-        const user = this.checkUser("updateProjectSettings");
+    public async setProjectConfiguration(ctx: TraceContext, projectId: string, configString: string): Promise<void> {
+        traceAPIParams(ctx, { projectId }); // filter configString because of size
+
+        const user = this.checkAndBlockUser("setProjectConfiguration");
         await this.guardProjectOperation(user, projectId, "update");
-        await this.projectsService.updateProjectSettings(projectId, partialSettings);
+        const parseResult = this.gitpodParser.parse(configString);
+        if (parseResult.validationErrors) {
+            throw new Error(`This configuration could not be parsed: ${parseResult.validationErrors.join(', ')}`);
+        }
+        await this.projectsService.updateProjectPartial({
+            id: projectId,
+            config: { '.gitpod.yml': configString },
+        });
+    }
+
+    public async updateProjectPartial(ctx: TraceContext, partialProject: PartialProject): Promise<void> {
+        const user = this.checkUser("updateProjectPartial");
+        await this.guardProjectOperation(user, partialProject.id, "update");
+
+        const partial: PartialProject = { id: partialProject.id };
+        const allowedFields: (keyof Project)[] = ['settings']; // Don't add 'config' here! Please use `setProjectConfiguration` instead to parse & validate configs
+        for (const f of allowedFields) {
+            if (f in partialProject) {
+                (partial[f] as any) = partialProject[f];
+            }
+        }
+        await this.projectsService.updateProjectPartial(partial);
     }
 
     public async getContentBlobUploadUrl(ctx: TraceContext, name: string): Promise<string> {

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`
`7`	`7`	`import { PrebuiltWorkspaceState } from "./protocol";`
`8`	`8`	`import { v4 as uuidv4 } from 'uuid';`
	`9`	`+import { DeepPartial } from "./util/deep-partial";`
`9`	`10`
`10`	`11`	`export interface ProjectConfig {`
`11`	`12`	`'.gitpod.yml': string;`
`@@ -60,6 +61,8 @@ export namespace Project {`
`60`	`61`	`}`
`61`	`62`	`}`
`62`	`63`
	`64`	`+export type PartialProject = DeepPartial<Project> & Pick<Project, 'id'>;`
	`65`	`+`
`63`	`66`	`export interface PrebuildWithStatus {`
`64`	`67`	`info: PrebuildInfo;`
`65`	`68`	`status: PrebuiltWorkspaceState;`