implement

Author: mustard-mh

components/dashboard/src/service/json-rpc-workspace-client.ts

@@ -39,6 +39,12 @@ import {
     StopWorkspaceRequest,
     StopWorkspaceResponse,
     AdmissionLevel,
+    CreateWorkspaceSnapshotRequest,
+    CreateWorkspaceSnapshotResponse,
+    ListWorkspaceSnapshotsRequest,
+    ListWorkspaceSnapshotsResponse,
+    WaitForWorkspaceSnapshotRequest,
+    WaitForWorkspaceSnapshotResponse,
 } from "@gitpod/public-api/lib/gitpod/v1/workspace_pb";
 import { converter } from "./public-api";
 import { getGitpodService } from "./service";
@@ -359,4 +365,49 @@ export class JsonRpcWorkspaceClient implements PromiseClient<typeof WorkspaceSer
         response.workspaceClasses = list.map((i) => converter.toWorkspaceClass(i));
         return response;
     }
+
+    async createWorkspaceSnapshot(
+        req: PartialMessage<CreateWorkspaceSnapshotRequest>,
+        _options?: CallOptions | undefined,
+    ): Promise<CreateWorkspaceSnapshotResponse> {
+        if (!req.workspaceId) {
+            throw new ApplicationError(ErrorCodes.BAD_REQUEST, "workspaceId is required");
+        }
+        const snapshotId = await getGitpodService().server.takeSnapshot({
+            workspaceId: req.workspaceId,
+            dontWait: true,
+        });
+        return new CreateWorkspaceSnapshotResponse({
+            snapshot: converter.toWorkspaceSnapshot({
+                id: snapshotId,
+                originalWorkspaceId: req.workspaceId,
+            }),
+        });
+    }
+
+    async waitForWorkspaceSnapshot(
+        req: PartialMessage<WaitForWorkspaceSnapshotRequest>,
+        _options?: CallOptions | undefined,
+    ): Promise<WaitForWorkspaceSnapshotResponse> {
+        if (!req.snapshotId || !uuidValidate(req.snapshotId)) {
+            throw new ApplicationError(ErrorCodes.BAD_REQUEST, "snapshotId is required");
+        }
+        await getGitpodService().server.waitForSnapshot(req.snapshotId);
+        return new WaitForWorkspaceSnapshotResponse();
+    }
+
+    async listWorkspaceSnapshots(
+        req: PartialMessage<ListWorkspaceSnapshotsRequest>,
+        _options?: CallOptions | undefined,
+    ): Promise<ListWorkspaceSnapshotsResponse> {
+        if (!req.workspaceId) {
+            throw new ApplicationError(ErrorCodes.BAD_REQUEST, "workspaceId is required");
+        }
+        const snapshotIdList = await getGitpodService().server.getSnapshots(req.workspaceId);
+        return new ListWorkspaceSnapshotsResponse({
+            snapshots: snapshotIdList.map((id) =>
+                converter.toWorkspaceSnapshot({ id, originalWorkspaceId: req.workspaceId }),
+            ),
+        });
+    }
 }

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

@@ -63,6 +63,16 @@ service WorkspaceService {
   // GetWorkspaceEditorCredentials returns an credentials that is used in editor
   // to encrypt and decrypt secrets
   rpc GetWorkspaceEditorCredentials(GetWorkspaceEditorCredentialsRequest) returns (GetWorkspaceEditorCredentialsResponse) {}
+
+  // CreateWorkspaceSnapshot creates a snapshot of the workspace that can be
+  // shared with others.
+  rpc CreateWorkspaceSnapshot(CreateWorkspaceSnapshotRequest) returns (CreateWorkspaceSnapshotResponse) {}
+
+  // WaitWorkspaceSnapshot waits for the snapshot to be available or failed.
+  rpc WaitForWorkspaceSnapshot(WaitForWorkspaceSnapshotRequest) returns (WaitForWorkspaceSnapshotResponse) {}
+
+  // ListWorkspaceSnapshots lists the snapshots.
+  rpc ListWorkspaceSnapshots(ListWorkspaceSnapshotsRequest) returns (ListWorkspaceSnapshotsResponse) {}
 }
 
 message GetWorkspaceRequest {
@@ -753,3 +763,48 @@ message WorkspaceClass {
   // is_default indicates if this workspace class is the default one
   bool is_default = 4;
 }
+
+message CreateWorkspaceSnapshotRequest {
+  // workspace_id specifies the workspace to create snapshot
+  //
+  // +required
+  string workspace_id = 1;
+}
+
+message CreateWorkspaceSnapshotResponse {
+  WorkspaceSnapshot snapshot = 1;
+}
+
+message WaitForWorkspaceSnapshotRequest {
+  // snapshot_id specifies the snapshot to wait for
+  //
+  // +required
+  string snapshot_id = 1;
+}
+
+message WaitForWorkspaceSnapshotResponse {}
+
+message ListWorkspaceSnapshotsRequest {
+  PaginationRequest pagination = 1;
+
+  // workspace_id
+  //
+  // +required
+  string workspace_id = 2;
+}
+
+message ListWorkspaceSnapshotsResponse {
+  PaginationResponse pagination = 1;
+
+  repeated WorkspaceSnapshot snapshots = 2;
+}
+
+message WorkspaceSnapshot {
+  // id is the unique identifier of the snapshot
+  string id = 1;
+
+  // workspace_id is the source workspace id of snapshot
+  string workspace_id = 2;
+
+  google.protobuf.Timestamp creation_time = 3;
+}