[server] Delete prebuild records when purging workspaces

Author: easyCZ

components/gitpod-db/src/typeorm/entity/db-prebuild-info-entry.ts

@@ -31,4 +31,8 @@ export class DBPrebuildInfo {
         })(),
     })
     info: PrebuildInfo;
+
+    // This column triggers the db-sync deletion mechanism. It's not intended for public consumption.
+    @Column()
+    deleted?: boolean;
 }

components/gitpod-db/src/typeorm/entity/db-prebuilt-workspace.ts

@@ -77,4 +77,8 @@ export class DBPrebuiltWorkspace implements PrebuiltWorkspace {
         transformer: Transformer.MAP_BIGINT_TO_NUMBER,
     })
     statusVersion: number;
+
+    // This column triggers the db-sync deletion mechanism. It's not intended for public consumption.
+    @Column()
+    deleted?: boolean;
 }

components/gitpod-db/src/typeorm/workspace-db-impl.ts

@@ -53,6 +53,12 @@ import { DBPrebuiltWorkspaceUpdatable } from "./entity/db-prebuilt-workspace-upd
 import { BUILTIN_WORKSPACE_PROBE_USER_ID } from "../user-db";
 import { DBPrebuildInfo } from "./entity/db-prebuild-info-entry";
 import { daysBefore } from "@gitpod/gitpod-protocol/lib/util/timeutil";
+import {
+    reportPrebuildInfoPurged,
+    reportPrebuiltWorkspacePurged,
+    reportWorkspaceInstancePurged,
+    reportWorkspacePurged,
+} from "@gitpod/gitpod-db/lib/prometheus-metrics";
 
 type RawTo<T> = (instance: WorkspaceInstance, ws: Workspace) => T;
 interface OrderBy {
@@ -981,8 +987,27 @@ export abstract class AbstractTypeORMWorkspaceDBImpl implements WorkspaceDB {
      *       around to deleting them.
      */
     public async hardDeleteWorkspace(workspaceId: string): Promise<void> {
-        await (await this.getWorkspaceInstanceRepo()).update({ workspaceId }, { deleted: true });
-        await (await this.getWorkspaceRepo()).update(workspaceId, { deleted: true });
+        const prebuild = await this.findPrebuildByWorkspaceID(workspaceId);
+        if (prebuild !== undefined) {
+            // There are prebuilds linked to this workspace. We need to delete these first.
+            const prebuildsDeleted = await (
+                await this.getPrebuiltWorkspaceRepo()
+            ).update({ id: prebuild.id }, { deleted: true });
+            reportPrebuiltWorkspacePurged(prebuildsDeleted.affected || 0);
+
+            // Delete the d_b_prebuilt_workspace_updatable record?
+            // await (await this.getPrebuiltWorkspaceUpdatableRepo()).update()
+
+            const prebuildInfos = await (
+                await this.getPrebuildInfoRepo()
+            ).update({ prebuildId: prebuild.id }, { deleted: true });
+            reportPrebuildInfoPurged(prebuildInfos.affected || 0);
+        }
+        const instances = await (await this.getWorkspaceInstanceRepo()).update({ workspaceId }, { deleted: true });
+        reportWorkspaceInstancePurged(instances.affected || 0);
+
+        const workspaces = await (await this.getWorkspaceRepo()).update(workspaceId, { deleted: true });
+        reportWorkspacePurged(workspaces.affected || 0);
     }
 
     public async findAllWorkspaces(

components/server/src/prometheus-metrics.ts

@@ -169,10 +169,40 @@ export function increasePrebuildsStartedCounter() {
 
 const workspacesPurgedTotal = new prometheusClient.Counter({
     name: "gitpod_server_workspaces_purged_total",
-    help: "Counter of workspaces hard deleted by periodic job running on server.",
+    help: "Counter of workspaces hard deleted by periodic gc.",
     registers: [prometheusClient.register],
 });
 
-export function reportWorkspacePurged() {
-    workspacesPurgedTotal.inc();
+export function reportWorkspacePurged(count: number) {
+    workspacesPurgedTotal.inc(count);
+}
+
+const prebuildWorkspacesPurgedTotal = new prometheusClient.Counter({
+    name: "gitpod_server_prebuild_workspaces_purged_total",
+    help: "Counter of prebuild workspaces hard deleted by periodic gc.",
+    registers: [prometheusClient.register],
+});
+
+export function reportPrebuiltWorkspacePurged(count: number) {
+    prebuildWorkspacesPurgedTotal.inc(count);
+}
+
+const prebuildInfoPurgedTotal = new prometheusClient.Counter({
+    name: "gitpod_server_prebuild_info_purged_total",
+    help: "Counter of prebuild info records hard deleted by periodic gc.",
+    registers: [prometheusClient.register],
+});
+
+export function reportPrebuildInfoPurged(count: number) {
+    prebuildInfoPurgedTotal.inc(count);
+}
+
+const workspaceInstancePurgedTotal = new prometheusClient.Counter({
+    name: "gitpod_server_workspace_instances_purged_total",
+    help: "Counter of workspace instances records hard deleted by periodic gc.",
+    registers: [prometheusClient.register],
+});
+
+export function reportWorkspaceInstancePurged(count: number) {
+    workspaceInstancePurgedTotal.inc(count);
 }

components/server/src/workspace/workspace-deletion-service.ts

@@ -19,7 +19,6 @@ import { TraceContext } from "@gitpod/gitpod-protocol/lib/util/tracing";
 import { WorkspaceManagerClientProvider } from "@gitpod/ws-manager/lib/client-provider";
 import { DeleteVolumeSnapshotRequest } from "@gitpod/ws-manager/lib";
 import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
-import { reportWorkspacePurged } from "../prometheus-metrics";
 
 @injectable()
 export class WorkspaceDeletionService {
@@ -57,7 +56,6 @@ export class WorkspaceDeletionService {
     public async hardDeleteWorkspace(ctx: TraceContext, workspaceId: string): Promise<void> {
         await this.db.trace(ctx).hardDeleteWorkspace(workspaceId);
         log.info(`Purged Workspace ${workspaceId} and all WorkspaceInstances for this workspace`, { workspaceId });
-        reportWorkspacePurged();
     }
 
     /**