[gitpod-db] add new DB entity for VolumeSnapshot

Author: sagor999

components/gitpod-db/README.md

@@ -2,6 +2,9 @@
 
 Contains all the database related functionality, implemented using [typeorm](https://typeorm.io/).
 
+### Working on gitpod-protocol component
+When you are making changes to gitpod-protocol component, make sure to run `yarn build` in gitpod-protocol folder to make sure your changes will be rebuild. Also consider running `yarn watch` so that any changes are rebuilt in realtime.
+
 ### Adding a new table
 1. Create a [migration](./src/typeorm/migration/README.md) - use the [baseline](./src/typeorm/migration/1592203031938-Baseline.ts) as an exemplar
 1. Create a new entity that implements the requisite interface or extend an existing entity as required - see [db-user.ts](./src/typeorm/entity/db-user.ts)

components/gitpod-db/src/typeorm/entity/db-volume-snapshot.ts

@@ -0,0 +1,33 @@
+/**
+ * Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License-AGPL.txt in the project root for license information.
+ */
+
+import { PrimaryColumn, Column, Entity, Index } from "typeorm";
+
+import { VolumeSnapshot } from "@gitpod/gitpod-protocol";
+import { TypeORM } from "../typeorm";
+import { Transformer } from "../transformer";
+
+@Entity()
+@Index("ind_dbsync", ["creationTime"]) // DBSync
+export class DBVolumeSnapshot implements VolumeSnapshot {
+    @PrimaryColumn(TypeORM.UUID_COLUMN_TYPE)
+    id: string;
+
+    @Column({
+        type: "timestamp",
+        precision: 6,
+        default: () => "CURRENT_TIMESTAMP(6)",
+        transformer: Transformer.MAP_ISO_STRING_TO_TIMESTAMP_DROP,
+    })
+    creationTime: string;
+
+    @Column(TypeORM.WORKSPACE_ID_COLUMN_TYPE)
+    @Index("ind_originalWorkspaceId")
+    originalWorkspaceId: string;
+
+    @Column("varchar")
+    volumeHandle: string;
+}

components/gitpod-db/src/typeorm/migration/1651188368768-VolumeSnapshotCreation.ts

@@ -0,0 +1,18 @@
+/**
+ * Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License-AGPL.txt in the project root for license information.
+ */
+
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class VolumeSnapshotCreation1651188368768 implements MigrationInterface {
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(
+            `CREATE TABLE IF NOT EXISTS d_b_volume_snapshot (  id char(36) NOT NULL, creationTime timestamp(6) NOT NULL DEFAULT CURRENT_TIMESTAMP(6) ON UPDATE CURRENT_TIMESTAMP(6),  originalWorkspaceId char(36) NOT NULL, volumeHandle varchar(255) NOT NULL, PRIMARY KEY (id),  KEY ind_originalWorkspaceId (originalWorkspaceId),  KEY ind_dbsync (creationTime)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;`,
+        );
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+    }
+}

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

@@ -25,6 +25,7 @@ import {
     WorkspaceInstanceUser,
     WhitelistedRepository,
     Snapshot,
+    VolumeSnapshot,
     LayoutData,
     PrebuiltWorkspace,
     RunningWorkspaceInfo,
@@ -41,6 +42,7 @@ import { DBWorkspace } from "./entity/db-workspace";
 import { DBWorkspaceInstance } from "./entity/db-workspace-instance";
 import { DBLayoutData } from "./entity/db-layout-data";
 import { DBSnapshot } from "./entity/db-snapshot";
+import { DBVolumeSnapshot } from "./entity/db-volume-snapshot";
 import { DBWorkspaceInstanceUser } from "./entity/db-workspace-instance-user";
 import { DBRepositoryWhiteList } from "./entity/db-repository-whitelist";
 import { log } from "@gitpod/gitpod-protocol/lib/util/logging";
@@ -79,6 +81,10 @@ export abstract class AbstractTypeORMWorkspaceDBImpl implements WorkspaceDB {
         return await (await this.getManager()).getRepository<DBSnapshot>(DBSnapshot);
     }
 
+    protected async getVolumeSnapshotRepo(): Promise<Repository<DBVolumeSnapshot>> {
+        return await (await this.getManager()).getRepository<DBVolumeSnapshot>(DBVolumeSnapshot);
+    }
+
     protected async getPrebuiltWorkspaceRepo(): Promise<Repository<DBPrebuiltWorkspace>> {
         return await (await this.getManager()).getRepository<DBPrebuiltWorkspace>(DBPrebuiltWorkspace);
     }
@@ -700,6 +706,34 @@ export abstract class AbstractTypeORMWorkspaceDBImpl implements WorkspaceDB {
         return snapshots.find({ where: { originalWorkspaceId: workspaceId } });
     }
 
+    public async findVolumeSnapshotById(volumeSnapshotId: string): Promise<VolumeSnapshot | undefined> {
+        const volumeSnapshots = await this.getVolumeSnapshotRepo();
+        return volumeSnapshots.findOne(volumeSnapshotId);
+    }
+
+    public async storeVolumeSnapshot(volumeSnapshot: VolumeSnapshot): Promise<VolumeSnapshot> {
+        const volumeSnapshots = await this.getVolumeSnapshotRepo();
+        const dbVolumeSnapshot = volumeSnapshot as DBVolumeSnapshot;
+        return await volumeSnapshots.save(dbVolumeSnapshot);
+    }
+
+    public async deleteVolumeSnapshot(volumeSnapshotId: string): Promise<void> {
+        const volumeSnapshots = await this.getVolumeSnapshotRepo();
+        await volumeSnapshots.delete(volumeSnapshotId);
+    }
+
+    public async updateVolumeSnapshot(
+        volumeSnapshot: DeepPartial<VolumeSnapshot> & Pick<VolumeSnapshot, "id">,
+    ): Promise<void> {
+        const volumeSnapshots = await this.getVolumeSnapshotRepo();
+        await volumeSnapshots.update(volumeSnapshot.id, volumeSnapshot);
+    }
+
+    public async findVolumeSnapshotsByWorkspaceId(workspaceId: string): Promise<VolumeSnapshot[]> {
+        const volumeSnapshots = await this.getVolumeSnapshotRepo();
+        return volumeSnapshots.find({ where: { originalWorkspaceId: workspaceId } });
+    }
+
     public async storePrebuiltWorkspace(pws: PrebuiltWorkspace): Promise<PrebuiltWorkspace> {
         const repo = await this.getPrebuiltWorkspaceRepo();
         if (pws.error && pws.error.length > 255) {

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

@@ -13,6 +13,7 @@ import {
     WorkspaceInstanceUser,
     WhitelistedRepository,
     Snapshot,
+    VolumeSnapshot,
     LayoutData,
     PrebuiltWorkspace,
     PrebuiltWorkspaceUpdatable,
@@ -159,6 +160,12 @@ export interface WorkspaceDB {
     deleteSnapshot(snapshotId: string): Promise<void>;
     updateSnapshot(snapshot: DeepPartial<Snapshot> & Pick<Snapshot, "id">): Promise<void>;
 
+    findVolumeSnapshotById(volumeSnapshotId: string): Promise<VolumeSnapshot | undefined>;
+    findVolumeSnapshotsByWorkspaceId(workspaceId: string): Promise<VolumeSnapshot[]>;
+    storeVolumeSnapshot(snapshot: VolumeSnapshot): Promise<VolumeSnapshot>;
+    deleteVolumeSnapshot(volumeSnapshotId: string): Promise<void>;
+    updateVolumeSnapshot(snapshot: DeepPartial<VolumeSnapshot> & Pick<VolumeSnapshot, "id">): Promise<void>;
+
     storePrebuiltWorkspace(pws: PrebuiltWorkspace): Promise<PrebuiltWorkspace>;
     findPrebuiltWorkspaceByCommit(cloneURL: string, commit: string): Promise<PrebuiltWorkspace | undefined>;
     findPrebuildsWithWorkpace(cloneURL: string): Promise<PrebuildWithWorkspace[]>;

components/gitpod-protocol/src/protocol.ts

@@ -488,6 +488,13 @@ export interface Snapshot {
     message?: string;
 }
 
+export interface VolumeSnapshot {
+    id: string;
+    creationTime: string;
+    originalWorkspaceId: string;
+    volumeHandle: string;
+}
+
 export type SnapshotState = "pending" | "available" | "error";
 
 export interface LayoutData {