Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[gitpod-shared] Use "waitForSnapshot" to avoid disconnects #169

Merged
merged 1 commit into from
Nov 19, 2021
Merged

[gitpod-shared] Use "waitForSnapshot" to avoid disconnects #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion extensions/gitpod-shared/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"@types/ws": "^7.2.6"
},
"dependencies": {
"@gitpod/gitpod-protocol": "akosyakov-code-new-gitpod-protocol-5717",
"@gitpod/gitpod-protocol": "gpl-5862-snapshot",
"@gitpod/supervisor-api-grpc": "ak-no-code-desktop-in-stable",
"bufferutil": "^4.0.1",
"reconnecting-websocket": "^4.4.0",
Expand Down
33 changes: 27 additions & 6 deletions extensions/gitpod-shared/src/features.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ require('reflect-metadata');
import { GitpodClient, GitpodServer, GitpodServiceImpl, WorkspaceInstanceUpdateListener } from '@gitpod/gitpod-protocol/lib/gitpod-service';
import { JsonRpcProxyFactory } from '@gitpod/gitpod-protocol/lib/messaging/proxy-factory';
import { NavigatorContext, PullRequestContext, User } from '@gitpod/gitpod-protocol/lib/protocol';
import { ErrorCodes } from '@gitpod/gitpod-protocol/lib/messaging/error';
import { GitpodHostUrl } from '@gitpod/gitpod-protocol/lib/util/gitpod-host-url';
import { ControlServiceClient } from '@gitpod/supervisor-api-grpc/lib/control_grpc_pb';
import { InfoServiceClient } from '@gitpod/supervisor-api-grpc/lib/info_grpc_pb';
Expand All @@ -29,7 +30,7 @@ import ReconnectingWebSocket from 'reconnecting-websocket';
import { URL } from 'url';
import * as util from 'util';
import * as vscode from 'vscode';
import { ConsoleLogger, listen as doListen } from 'vscode-ws-jsonrpc';
import { CancellationToken, ConsoleLogger, listen as doListen } from 'vscode-ws-jsonrpc';
import WebSocket = require('ws');
import { BaseGitpodAnalyticsEventPropeties, GitpodAnalyticsEvent } from './analytics';
import * as uuid from 'uuid';
Expand Down Expand Up @@ -68,7 +69,7 @@ export class SupervisorConnection {
}
}

type UsedGitpodFunction = ['getWorkspace', 'openPort', 'stopWorkspace', 'setWorkspaceTimeout', 'getWorkspaceTimeout', 'getLoggedInUser', 'takeSnapshot', 'controlAdmission', 'sendHeartBeat', 'trackEvent'];
type UsedGitpodFunction = ['getWorkspace', 'openPort', 'stopWorkspace', 'setWorkspaceTimeout', 'getWorkspaceTimeout', 'getLoggedInUser', 'takeSnapshot', 'waitForSnapshot', 'controlAdmission', 'sendHeartBeat', 'trackEvent'];
type Union<Tuple extends any[], Union = never> = Tuple[number] | Union;
export type GitpodConnection = Omit<GitpodServiceImpl<GitpodClient, GitpodServer>, 'server'> & {
server: Pick<GitpodServer, Union<UsedGitpodFunction>>
Expand Down Expand Up @@ -237,7 +238,7 @@ export async function createGitpodExtensionContext(context: vscode.ExtensionCont
const gitpodApi = workspaceInfo.getGitpodApi()!;

const factory = new JsonRpcProxyFactory<GitpodServer>();
const gitpodFunctions: UsedGitpodFunction = ['getWorkspace', 'openPort', 'stopWorkspace', 'setWorkspaceTimeout', 'getWorkspaceTimeout', 'getLoggedInUser', 'takeSnapshot', 'controlAdmission', 'sendHeartBeat', 'trackEvent'];
const gitpodFunctions: UsedGitpodFunction = ['getWorkspace', 'openPort', 'stopWorkspace', 'setWorkspaceTimeout', 'getWorkspaceTimeout', 'getLoggedInUser', 'takeSnapshot', 'waitForSnapshot', 'controlAdmission', 'sendHeartBeat', 'trackEvent'];
const gitpodService: GitpodConnection = new GitpodServiceImpl<GitpodClient, GitpodServer>(factory.createProxy()) as any;
const gitpodScopes = new Set<string>([
'resource:workspace::' + workspaceId + '::get/update',
Expand Down Expand Up @@ -474,13 +475,33 @@ export async function registerWorkspaceCommands(context: GitpodExtensionContext)
properties: { action: 'snapshot' }
});
try {
const snapshotId = await vscode.window.withProgress({
let snapshotId: string | undefined = undefined;
await vscode.window.withProgress({
akosyakov marked this conversation as resolved.
Show resolved Hide resolved
location: vscode.ProgressLocation.Notification,
cancellable: true,
title: 'Capturing workspace snapshot'
}, _ => {
return context.gitpod.server.takeSnapshot({ workspaceId: context.info.getWorkspaceId() /*, layoutData?*/ });
}, async (_, cancelToken: CancellationToken) => {
snapshotId = await context.gitpod.server.takeSnapshot({ workspaceId: context.info.getWorkspaceId() /*, layoutData?*/, dontWait: true });

while (!cancelToken.isCancellationRequested) {
try {
await context.gitpod.server.waitForSnapshot(snapshotId);
return;
} catch (err) {
if (err.code === ErrorCodes.SNAPSHOT_ERROR || err.code === ErrorCodes.NOT_FOUND) {
// this is indeed an error with snapshot creation itself, break here!
throw err;
}

// other errors (like connection errors): retry
await new Promise((resolve) => setTimeout(resolve, 3000));
}
}
});
if (!snapshotId) {
throw new Error('error taking snapshot');
}

const hostname = context.info.getGitpodApi()!.getHost();
const uri = `https://${hostname}#snapshot/${snapshotId}`;
const copyAction = await vscode.window.showInformationMessage(`The current state is captured in a snapshot. Using [this link](${uri}) anybody can create their own copy of this workspace.`,
Expand Down
39 changes: 30 additions & 9 deletions extensions/yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,25 @@
# yarn lockfile v1


"@gitpod/gitpod-protocol@akosyakov-code-new-gitpod-protocol-5717":
version "0.1.5-akosyakov-code-new-gitpod-protocol-5717.0"
resolved "https://registry.yarnpkg.com/@gitpod/gitpod-protocol/-/gitpod-protocol-0.1.5-akosyakov-code-new-gitpod-protocol-5717.0.tgz#2ba3dbf8977a918617c43e057a632cf491a63a17"
integrity sha512-/A4NU1YVa9ACnmQMxZTHoiSzbJvhl4yubFUot3HcptUnzSND4DUj3Se4m7hIRCT2GNtpbQyeTDJhdXwVxgrOrg==
"@gitpod/gitpod-protocol@gpl-5862-snapshot":
version "0.1.5-gpl-5862-snapshot.33"
resolved "https://registry.yarnpkg.com/@gitpod/gitpod-protocol/-/gitpod-protocol-0.1.5-gpl-5862-snapshot.33.tgz#fc08bbc24559464ce7d5bd445aefaf8d29f50e7e"
integrity sha512-fhfCwZzOBmSM4UavpLkK3RsfPuw2U49q3eAGUKbMYGqnscEXjqLi1Z0QatFMOWGdybfTYeRghMqEm7XYBD5i4g==
dependencies:
ajv "^6.5.4"
analytics-node "^4.0.1"
cookie "^0.4.1"
inversify "^5.0.1"
jaeger-client "3.17.2"
js-yaml "^3.10.0"
opentracing "^0.14.4"
prom-client "^10.2.0"
prom-client "^13.2.0"
random-number-csprng "^1.0.2"
reconnecting-websocket "^4.4.0"
reflect-metadata "^0.1.10"
uuid "^3.3.3"
vscode-jsonrpc "^5.0.1"
vscode-languageserver-protocol "3.15.3"
vscode-uri "^1.0.1"
vscode-ws-jsonrpc "^0.2.0"
ws "^7.4.6"
Expand Down Expand Up @@ -266,6 +269,11 @@ [email protected]:
resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"
integrity sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=

cookie@^0.4.1:
version "0.4.1"
resolved "https://registry.yarnpkg.com/cookie/-/cookie-0.4.1.tgz#afd713fe26ebd21ba95ceb61f9a8116e50a537d1"
integrity sha512-ZwrFkGJxUR3EIoXtO+yVE69Eb7KlixbaeAWfBQB9vVsNn/o+Yw69gBWSSDK825hQNdN+wF8zELf3dFNl/kxkUA==

create-error@^0.3.1:
version "0.3.1"
resolved "https://registry.yarnpkg.com/create-error/-/create-error-0.3.1.tgz#69810245a629e654432bf04377360003a5351a23"
Expand Down Expand Up @@ -542,10 +550,10 @@ process@^0.10.0:
resolved "https://registry.yarnpkg.com/process/-/process-0.10.1.tgz#842457cc51cfed72dc775afeeafb8c6034372725"
integrity sha1-hCRXzFHP7XLcd1r+6vuMYDQ3JyU=

prom-client@^10.2.0:
version "10.2.3"
resolved "https://registry.yarnpkg.com/prom-client/-/prom-client-10.2.3.tgz#a51bf21c239c954a6c5be4b1361fdd380218bb41"
integrity sha512-Xboq5+TdUwuQtSSDRZRNnb5NprINlgQN999VqUjZxnLKydUNLeIPx6Eiahg6oJua3XBg2TGnh5Cth1s4I6+r7g==
prom-client@^13.2.0:
version "13.2.0"
resolved "https://registry.yarnpkg.com/prom-client/-/prom-client-13.2.0.tgz#99d13357912dd400f8911b77df19f7b328a93e92"
integrity sha512-wGr5mlNNdRNzEhRYXgboUU2LxHWIojxscJKmtG3R8f4/KiWqyYgXTLHs0+Ted7tG3zFT7pgHJbtomzZ1L0ARaQ==
dependencies:
tdigest "^0.1.1"

Expand Down Expand Up @@ -669,6 +677,19 @@ vscode-jsonrpc@^5.0.0, vscode-jsonrpc@^5.0.1:
resolved "https://registry.yarnpkg.com/vscode-jsonrpc/-/vscode-jsonrpc-5.0.1.tgz#9bab9c330d89f43fc8c1e8702b5c36e058a01794"
integrity sha512-JvONPptw3GAQGXlVV2utDcHx0BiY34FupW/kI6mZ5x06ER5DdPG/tXWMVHjTNULF5uKPOUUD0SaXg5QaubJL0A==

[email protected]:
version "3.15.3"
resolved "https://registry.yarnpkg.com/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.15.3.tgz#3fa9a0702d742cf7883cb6182a6212fcd0a1d8bb"
integrity sha512-zrMuwHOAQRhjDSnflWdJG+O2ztMWss8GqUUB8dXLR/FPenwkiBNkMIJJYfSN6sgskvsF0rHAoBowNQfbyZnnvw==
dependencies:
vscode-jsonrpc "^5.0.1"
vscode-languageserver-types "3.15.1"

[email protected]:
version "3.15.1"
resolved "https://registry.yarnpkg.com/vscode-languageserver-types/-/vscode-languageserver-types-3.15.1.tgz#17be71d78d2f6236d414f0001ce1ef4d23e6b6de"
integrity sha512-+a9MPUQrNGRrGU630OGbYVQ+11iOIovjCkqxajPa9w57Sd5ruK8WQNsslzpa0x/QJqC8kRc2DUxWjIFwoNm4ZQ==

vscode-nls@^5.0.0:
version "5.0.0"
resolved "https://registry.yarnpkg.com/vscode-nls/-/vscode-nls-5.0.0.tgz#99f0da0bd9ea7cda44e565a74c54b1f2bc257840"
Expand Down