[server, protocl] Introduce 'waitForSnapshot'

Author: geropl

components/gitpod-protocol/go/gitpod-service.go

@@ -73,6 +73,7 @@ type APIInterface interface {
 	SendFeedback(ctx context.Context, feedback string) (res string, err error)
 	RegisterGithubApp(ctx context.Context, installationID string) (err error)
 	TakeSnapshot(ctx context.Context, options *TakeSnapshotOptions) (res string, err error)
+	WaitForSnapshot(ctx context.Context, options *WaitForSnapshotOptions) (err error)
 	GetSnapshots(ctx context.Context, workspaceID string) (res []*string, err error)
 	StoreLayout(ctx context.Context, workspaceID string, layoutData string) (err error)
 	GetLayout(ctx context.Context, workspaceID string) (res string, err error)
@@ -1277,6 +1278,21 @@ func (gp *APIoverJSONRPC) TakeSnapshot(ctx context.Context, options *TakeSnapsho
 	return
 }
 
+// WaitForSnapshot calls waitForSnapshot on the server
+func (gp *APIoverJSONRPC) WaitForSnapshot(ctx context.Context, options *WaitForSnapshotOptions) (err error) {
+	if gp == nil {
+		err = errNotConnected
+		return
+	}
+	var _params []interface{}
+
+	_params = append(_params, options)
+
+	var result string
+	err = gp.C.Call(ctx, "waitForSnapshot", _params, &result)
+	return
+}
+
 // GetSnapshots calls getSnapshots on the server
 func (gp *APIoverJSONRPC) GetSnapshots(ctx context.Context, workspaceID string) (res []*string, err error) {
 	if gp == nil {
@@ -1927,6 +1943,11 @@ type TakeSnapshotOptions struct {
 	WorkspaceID string `json:"workspaceId,omitempty"`
 }
 
+// WaitForSnapshotOptions is the WaitForSnapshotOptions message type
+type WaitForSnapshotOptions struct {
+	SnapshotID string `json:"snapshotID,omitempty"`
+}
+
 // PreparePluginUploadParams is the PreparePluginUploadParams message type
 type PreparePluginUploadParams struct {
 	FullPluginName string `json:"fullPluginName,omitempty"`

components/gitpod-protocol/go/mock.go

@@ -153,10 +153,15 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     registerGithubApp(installationId: string): Promise<void>;
 
     /**
-     * Stores a new snapshot for the given workspace and bucketId
+     * Stores a new snapshot for the given workspace and bucketId. Returns _before_ the actual snapshot is done. To wait for that, use `waitForSnapshot`.
      * @return the snapshot id
      */
     takeSnapshot(options: GitpodServer.TakeSnapshotOptions): Promise<string>;
+    /**
+     *
+     * @param snapshotId
+     */
+    waitForSnapshot(snapshotId: string): Promise<void>;
 
     /**
      * Returns the list of snapshots that exist for a workspace.

components/gitpod-protocol/src/gitpod-service.ts

@@ -17,3 +17,4 @@ export * from './email-protocol';
 export * from './headless-workspace-log';
 export * from './context-url';
 export * from './teams-projects-protocol';
+export * from './snapshot-url';

components/gitpod-protocol/src/index.ts

@@ -76,6 +76,6 @@ export namespace ErrorCodes {
     // 620 Team Subscription Assignment Failed
     export const TEAM_SUBSCRIPTION_ASSIGNMENT_FAILED = 620;
 
-    // 666 Not Implemented TODO IO-SPLIT remove
-    export const NOT_IMPLEMENTED = 666;
+    // 630 Snapshot Error
+    export const SNAPSHOT_ERROR = 630;
 }

components/gitpod-protocol/src/messaging/error.ts

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) 2020 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 { suite, test } from "mocha-typescript"
+import * as chai from "chai"
+import { SnapshotUrl } from ".";
+
+const expect = chai.expect
+
+@suite class TestSnapshotUrlParser {
+
+    @test public testPositive() {
+        const actual = SnapshotUrl.parse("workspaces/c362d434-6faa-4ce0-9ad4-91b4a87c4abe/3f0556f7-4afa-11e9-98d5-52f8983b9279.tar@gitpod-prodcopy-user-e1e28f18-0354-4a5d-b6b4-8879a2ff73fd");
+
+        expect(actual).to.deep.equal(<SnapshotUrl>{
+            bucketId: "gitpod-prodcopy-user-e1e28f18-0354-4a5d-b6b4-8879a2ff73fd",
+            filename: "3f0556f7-4afa-11e9-98d5-52f8983b9279.tar",
+            fullPath: "workspaces/c362d434-6faa-4ce0-9ad4-91b4a87c4abe/3f0556f7-4afa-11e9-98d5-52f8983b9279.tar",
+        });
+    }
+}
+module.exports = new TestSnapshotUrlParser()   // Only to circumvent no usage warning :-/

components/gitpod-protocol/src/snapshot-url.spec.ts

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) 2021 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.
+ */
+
+export interface SnapshotUrl {
+    bucketId: string;
+    fullPath: string;
+    filename: string;
+}
+export namespace SnapshotUrl {
+    export function parse(url: string): SnapshotUrl {
+        const parts = url.split("@");
+        if (parts.length !== 2) {
+            throw new Error(`cannot parse snapshot URL: ${url}`);
+        }
+        const [fullPath, bucketId] = parts;
+
+        const pathParts = fullPath.split("/");
+        if (pathParts.length < 1) {
+            throw new Error(`cannot parse snapshot URL: ${url}`);
+        }
+        const filename = pathParts[pathParts.length - 1];
+        return { bucketId, fullPath, filename };
+    }
+}

components/gitpod-protocol/src/snapshot-url.ts

@@ -51,6 +51,7 @@ import { UserDeletionServiceEE } from "./user/user-deletion-service";
 import { GitHubAppSupport } from "./github/github-app-support";
 import { GitLabAppSupport } from "./gitlab/gitlab-app-support";
 import { Config } from "../../src/config";
+import { SnapshotService } from "./workspace/snapshot-service";
 
 export const productionEEContainerModule = new ContainerModule((bind, unbind, isBound, rebind) => {
     rebind(Server).to(ServerEE).inSingletonScope();
@@ -87,6 +88,7 @@ export const productionEEContainerModule = new ContainerModule((bind, unbind, is
     bind(EMailDomainService).to(EMailDomainServiceImpl).inSingletonScope();
     rebind(BlockedUserFilter).toService(EMailDomainService);
     rebind(UserController).to(UserControllerEE).inSingletonScope();
+    bind(SnapshotService).toSelf().inSingletonScope();
 
     bind(UserDeletionServiceEE).toSelf().inSingletonScope();
     rebind(UserDeletionService).to(UserDeletionServiceEE).inSingletonScope();

components/server/ee/src/container-module.ts

@@ -7,7 +7,7 @@
 import { injectable, inject } from "inversify";
 import { GitpodServerImpl } from "../../../src/workspace/gitpod-server-impl";
 import { TraceContext } from "@gitpod/gitpod-protocol/lib/util/tracing";
-import { GitpodServer, GitpodClient, AdminGetListRequest, User, AdminGetListResult, Permission, AdminBlockUserRequest, AdminModifyRoleOrPermissionRequest, RoleOrPermission, AdminModifyPermanentWorkspaceFeatureFlagRequest, UserFeatureSettings, AdminGetWorkspacesRequest, WorkspaceAndInstance, GetWorkspaceTimeoutResult, WorkspaceTimeoutDuration, WorkspaceTimeoutValues, SetWorkspaceTimeoutResult, WorkspaceContext, CreateWorkspaceMode, WorkspaceCreationResult, PrebuiltWorkspaceContext, CommitContext, PrebuiltWorkspace, PermissionName, WorkspaceInstance, EduEmailDomain, ProviderRepository, Queue, PrebuildWithStatus, CreateProjectParams, Project, StartPrebuildResult, ClientHeaderFields } from "@gitpod/gitpod-protocol";
+import { GitpodServer, GitpodClient, AdminGetListRequest, User, AdminGetListResult, Permission, AdminBlockUserRequest, AdminModifyRoleOrPermissionRequest, RoleOrPermission, AdminModifyPermanentWorkspaceFeatureFlagRequest, UserFeatureSettings, AdminGetWorkspacesRequest, WorkspaceAndInstance, GetWorkspaceTimeoutResult, WorkspaceTimeoutDuration, WorkspaceTimeoutValues, SetWorkspaceTimeoutResult, WorkspaceContext, CreateWorkspaceMode, WorkspaceCreationResult, PrebuiltWorkspaceContext, CommitContext, PrebuiltWorkspace, PermissionName, WorkspaceInstance, EduEmailDomain, ProviderRepository, Queue, PrebuildWithStatus, CreateProjectParams, Project, StartPrebuildResult, ClientHeaderFields, Workspace } from "@gitpod/gitpod-protocol";
 import { ResponseError } from "vscode-jsonrpc";
 import { TakeSnapshotRequest, AdmissionLevel, ControlAdmissionRequest, StopWorkspacePolicy, DescribeWorkspaceRequest, SetTimeoutRequest } from "@gitpod/ws-manager/lib";
 import { ErrorCodes } from "@gitpod/gitpod-protocol/lib/messaging/error";
@@ -41,6 +41,7 @@ import { Chargebee as chargebee } from '@gitpod/gitpod-payment-endpoint/lib/char
 import { GitHubAppSupport } from "../github/github-app-support";
 import { GitLabAppSupport } from "../gitlab/gitlab-app-support";
 import { Config } from "../../../src/config";
+import { SnapshotService } from "./snapshot-service";
 
 @injectable()
 export class GitpodServerEEImpl extends GitpodServerImpl<GitpodClient, GitpodServer> {
@@ -73,6 +74,8 @@ export class GitpodServerEEImpl extends GitpodServerImpl<GitpodClient, GitpodSer
 
     @inject(Config) protected readonly config: Config;
 
+    @inject(SnapshotService) protected readonly snapshotService: SnapshotService;
+
     initialize(client: GitpodClient | undefined, user: User, accessGuard: ResourceAccessGuard, clientHeaderFields: ClientHeaderFields): void {
         super.initialize(client, user, accessGuard, clientHeaderFields);
         this.listenToCreditAlerts();
@@ -370,18 +373,13 @@ export class GitpodServerEEImpl extends GitpodServerImpl<GitpodClient, GitpodSer
         span.setTag("userId", user.id);
 
         try {
-            const workspace = await this.workspaceDb.trace({ span }).findById(workspaceId);
-            if (!workspace || workspace.ownerId !== user.id) {
-                throw new ResponseError(ErrorCodes.NOT_FOUND, `Workspace ${workspaceId} does not exist.`);
-            }
+            const workspace = await this.guardSnaphotAccess(span, user.id, workspaceId);
 
             const instance = await this.workspaceDb.trace({ span }).findRunningInstance(workspaceId);
             if (!instance) {
                 throw new ResponseError(ErrorCodes.NOT_FOUND, `Workspace ${workspaceId} has no running instance`);
             }
-
             await this.guardAccess({ kind: "workspaceInstance", subject: instance, workspace}, "get");
-            await this.guardAccess({ kind: "snapshot", subject: undefined, workspaceOwnerID: workspace.ownerId, workspaceID: workspace.id }, "create");
 
             const client = await this.workspaceManagerClientProvider.get(instance.region);
             const request = new TakeSnapshotRequest();
@@ -392,18 +390,63 @@ export class GitpodServerEEImpl extends GitpodServerImpl<GitpodClient, GitpodSer
             const resp = await client.takeSnapshot({ span }, request);
 
             const id = uuidv4()
-            this.workspaceDb.trace({ span }).storeSnapshot({
+            await this.workspaceDb.trace({ span }).storeSnapshot({
                 id,
                 creationTime: new Date().toISOString(),
+                state: 'available',
                 bucketId: resp.getUrl(),
                 originalWorkspaceId: workspaceId,
-                layoutData
+                layoutData,
             });
 
             return id;
-        } catch (e) {
-            TraceContext.logError({ span }, e);
-            throw e;
+        } catch (err) {
+            TraceContext.logError({ span }, err);
+            throw err;
+        } finally {
+            span.finish()
+        }
+    }
+
+    protected async guardSnaphotAccess(span: opentracing.Span, userId: string, workspaceId: string) : Promise<Workspace> {
+        const workspace = await this.workspaceDb.trace({ span }).findById(workspaceId);
+        if (!workspace || workspace.ownerId !== userId) {
+            throw new ResponseError(ErrorCodes.NOT_FOUND, `Workspace ${workspaceId} does not exist.`);
+        }
+        await this.guardAccess({ kind: "snapshot", subject: undefined, workspaceOwnerID: workspace.ownerId, workspaceID: workspace.id }, "create");
+
+        return workspace;
+    }
+
+    /**
+     * @param snapshotId
+     * @throws ResponseError with either NOT_FOUND or SNAPSHOT_ERROR in case the snapshot is not done yet.
+     */
+    async waitForSnapshot(snapshotId: string): Promise<void> {
+        this.requireEELicense(Feature.FeatureSnapshot);
+
+        const user = this.checkAndBlockUser("waitForSnapshot");
+
+        const span = opentracing.globalTracer().startSpan("waitForSnapshot");
+        span.setTag("snapshotId", snapshotId);
+        span.setTag("userId", user.id);
+
+        try {
+            const snapshot = await this.workspaceDb.trace({ span }).findSnapshotById(snapshotId);
+            if (!snapshot) {
+                throw new ResponseError(ErrorCodes.NOT_FOUND, `No snapshot with id '${snapshotId}' found.`)
+            }
+            const snapshotWorkspace = await this.guardSnaphotAccess(span, user.id, snapshot.originalWorkspaceId);
+
+            try {
+                await this.snapshotService.driveSnapshot(snapshotWorkspace.ownerId, snapshot);
+            } catch (err) {
+                // wrap in SNAPSHOT_ERROR to signal this call should not be retried.
+                throw new ResponseError(ErrorCodes.SNAPSHOT_ERROR, err.toString());
+            }
+        } catch (err) {
+            TraceContext.logError({ span }, err);
+            throw err;
         } finally {
             span.finish()
         }

components/server/ee/src/workspace/gitpod-server-impl.ts

@@ -0,0 +1,58 @@
+/**
+ * Copyright (c) 2021 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 { WorkspaceDB } from "@gitpod/gitpod-db/lib";
+import { Snapshot } from "@gitpod/gitpod-protocol";
+import { inject, injectable } from "inversify";
+import { StorageClient } from "../../../src/storage/storage-client";
+
+const SNAPSHOT_TIMEOUT_SECONDS = 60 * 30;
+
+@injectable()
+export class SnapshotService {
+    @inject(WorkspaceDB) protected readonly workspaceDb: WorkspaceDB;
+    @inject(StorageClient) protected readonly storageClient: StorageClient;
+
+    public async driveSnapshot(snapshotWorkspaceOwner: string, _snapshot: Snapshot): Promise<void> {
+        const { id: snapshotId, bucketId, originalWorkspaceId, creationTime } = _snapshot;
+        const start = new Date(creationTime).getTime();
+        while (start + SNAPSHOT_TIMEOUT_SECONDS < Date.now()) {
+            await new Promise((resolve) => setTimeout(resolve, 3000));
+
+            // pending: check if we're done:
+            const exists = await this.storageClient.workspaceSnapshotExists(snapshotWorkspaceOwner, originalWorkspaceId, bucketId);
+            if (exists) {
+                await this.workspaceDb.updateSnapshot({
+                    id: snapshotId,
+                    state: 'available',
+                    availableTime: new Date().toISOString(),
+                });
+                return
+            }
+
+            const snapshot = await this.workspaceDb.findSnapshotById(snapshotId);
+            if (!snapshot) {
+                throw new Error(`no snapshot with id '${snapshotId}' found.`)
+            }
+
+            if (snapshot.state === 'available') {
+                return;
+            }
+            if (snapshot.state === 'error') {
+                throw new Error(`snapshot error: ${snapshot.message}`);
+            }
+        }
+
+        // took too long
+        const message = `snapshot timed out after taking longer than ${SNAPSHOT_TIMEOUT_SECONDS}s.`;
+        await this.workspaceDb.updateSnapshot({
+            id: snapshotId,
+            state: 'error',
+            message,
+        });
+        throw new Error(message);
+    }
+}

components/server/ee/src/workspace/snapshot-service.ts

@@ -109,6 +109,7 @@ function getConfig(config: RateLimiterConfig): RateLimiterConfig {
         "sendFeedback": { group: "default", points: 1 },
         "registerGithubApp": { group: "default", points: 1 },
         "takeSnapshot": { group: "default", points: 1 },
+        "waitForSnapshot": { group: "default", points: 1 },
         "getSnapshots": { group: "default", points: 1 },
         "storeLayout": { group: "default", points: 1 },
         "getLayout": { group: "default", points: 1 },

components/server/src/auth/rate-limiter.ts

@@ -9,7 +9,8 @@ import { DeleteUserContentRequest, DeleteUserContentResponse } from "@gitpod/con
 import { IDEPluginServiceClient } from '@gitpod/content-service/lib/ideplugin_grpc_pb';
 import { PluginDownloadURLRequest, PluginDownloadURLResponse, PluginHashRequest, PluginHashResponse, PluginUploadURLRequest, PluginUploadURLResponse } from "@gitpod/content-service/lib/ideplugin_pb";
 import { WorkspaceServiceClient } from '@gitpod/content-service/lib/workspace_grpc_pb';
-import { DeleteWorkspaceRequest, DeleteWorkspaceResponse, WorkspaceDownloadURLRequest, WorkspaceDownloadURLResponse } from "@gitpod/content-service/lib/workspace_pb";
+import { DeleteWorkspaceRequest, DeleteWorkspaceResponse, WorkspaceDownloadURLRequest, WorkspaceDownloadURLResponse, WorkspaceSnapshotExistsRequest, WorkspaceSnapshotExistsResponse } from "@gitpod/content-service/lib/workspace_pb";
+import { SnapshotUrl } from '@gitpod/gitpod-protocol';
 import { inject, injectable } from "inversify";
 import { StorageClient } from "./storage-client";
 
@@ -119,4 +120,22 @@ export class ContentServiceStorageClient implements StorageClient {
         });
         return response.toObject().hash;
     }
+
+    public async workspaceSnapshotExists(ownerId: string, workspaceId: string, snapshotUrl: string): Promise<boolean> {
+        const { filename } = SnapshotUrl.parse(snapshotUrl);
+        const response = await new Promise<WorkspaceSnapshotExistsResponse>((resolve, reject) => {
+            const request = new WorkspaceSnapshotExistsRequest();
+            request.setOwnerId(ownerId);
+            request.setWorkspaceId(workspaceId);
+            request.setFilename(filename);
+            this.workspaceServiceClient.workspaceSnapshotExists(request, (err: any, resp: WorkspaceSnapshotExistsResponse) => {
+                if (err) {
+                    reject(err);
+                } else {
+                    resolve(resp);
+                }
+            });
+        });
+        return response.getExists();
+    }
 }

components/server/src/storage/content-service-client.ts

@@ -21,4 +21,7 @@ export interface StorageClient {
 
     // getHash produces a hash of the of storage object
     getPluginHash(bucketName: string, objectPath: string): Promise<string>;
+
+    // checks whether the specified snashot exists or not
+    workspaceSnapshotExists(ownerId: string, workspaceId: string, snapshotUrl: string): Promise<boolean>;
 }

components/server/src/storage/storage-client.ts

@@ -1254,6 +1254,10 @@ export class GitpodServerImpl<Client extends GitpodClient, Server extends Gitpod
         throw new ResponseError(ErrorCodes.EE_FEATURE, `Snapshot support is implemented in Gitpod's Enterprise Edition`);
     }
 
+    async waitForSnapshot(snapshotId: string): Promise<void> {
+        throw new ResponseError(ErrorCodes.EE_FEATURE, `Snapshot support is implemented in Gitpod's Enterprise Edition`);
+    }
+
     async getSnapshots(workspaceId: string): Promise<string[]> {
         // this is an EE feature. Throwing an exception here would break the dashboard though.
         return [];