@gitpod/gitpod-protocol 0.1.5-main.648 → 0.1.5-main.6480

package/lib/gitpod-service.js

@@ -2,7 +2,7 @@
 /**
  * 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.
+ * See License.AGPL.txt in the project root for license information.
  */
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
@@ -13,401 +13,307 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-var __values = (this && this.__values) || function(o) {
-    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
-    if (m) return m.call(o);
-    if (o && typeof o.length === "number") return {
-        next: function () {
-            if (o && i >= o.length) o = void 0;
-            return { value: o && o[i++], done: !o };
-        }
-    };
-    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createGitpodService = exports.GitpodServiceImpl = exports.WorkspaceInstanceUpdateListener = exports.GitpodCompositeClient = exports.GitpodServerProxy = exports.GitpodServerPath = exports.createServerMock = exports.createServiceMock = exports.WorkspaceTimeoutValues = exports.GitpodServer = void 0;
-var vscode_jsonrpc_1 = require("vscode-jsonrpc");
-var gitpod_host_url_1 = require("./util/gitpod-host-url");
-var connection_1 = require("./messaging/browser/connection");
-var event_1 = require("./util/event");
-exports.GitpodServer = Symbol('GitpodServer');
-exports.WorkspaceTimeoutValues = ["30m", "60m", "180m"];
-var createServiceMock = function (methods) {
-    return new GitpodServiceImpl(exports.createServerMock(methods));
+exports.createGitpodService = exports.GitpodServiceImpl = exports.WorkspaceInstanceUpdateListener = exports.GitpodCompositeClient = exports.GitpodServerProxy = exports.GitpodServerPath = exports.createServerMock = exports.createServiceMock = exports.WORKSPACE_TIMEOUT_EXTENDED = exports.WORKSPACE_TIMEOUT_DEFAULT_LONG = exports.WORKSPACE_TIMEOUT_DEFAULT_SHORT = exports.WorkspaceTimeoutDuration = exports.GitpodServer = void 0;
+const vscode_jsonrpc_1 = require("vscode-jsonrpc");
+const gitpod_host_url_1 = require("./util/gitpod-host-url");
+const connection_1 = require("./messaging/browser/connection");
+const event_1 = require("./util/event");
+exports.GitpodServer = Symbol("GitpodServer");
+var WorkspaceTimeoutDuration;
+(function (WorkspaceTimeoutDuration) {
+    function validate(duration) {
+        const unit = duration.slice(-1);
+        if (!["m", "h", "d"].includes(unit)) {
+            throw new Error(`Invalid timeout unit: ${unit}`);
+        }
+        const value = parseInt(duration.slice(0, -1));
+        if (isNaN(value) || value <= 0) {
+            throw new Error(`Invalid timeout value: ${duration}`);
+        }
+        return duration;
+    }
+    WorkspaceTimeoutDuration.validate = validate;
+})(WorkspaceTimeoutDuration = exports.WorkspaceTimeoutDuration || (exports.WorkspaceTimeoutDuration = {}));
+exports.WORKSPACE_TIMEOUT_DEFAULT_SHORT = "30m";
+exports.WORKSPACE_TIMEOUT_DEFAULT_LONG = "60m";
+exports.WORKSPACE_TIMEOUT_EXTENDED = "180m";
+const createServiceMock = function (methods) {
+    return new GitpodServiceImpl((0, exports.createServerMock)(methods));
 };
 exports.createServiceMock = createServiceMock;
-var createServerMock = function (methods) {
-    methods.setClient = methods.setClient || (function () { });
-    methods.dispose = methods.dispose || (function () { });
+const createServerMock = function (methods) {
+    methods.setClient = methods.setClient || (() => { });
+    methods.dispose = methods.dispose || (() => { });
     return new Proxy(methods, {
-        get: function (target, property) {
-            var result = target[property];
+        // @ts-ignore
+        get: (target, property) => {
+            const result = target[property];
             if (!result) {
-                throw new Error("Method " + property + " not implemented");
+                throw new Error(`Method ${String(property)} not implemented`);
             }
             return result;
-        }
+        },
     });
 };
 exports.createServerMock = createServerMock;
-exports.GitpodServerPath = '/gitpod';
-exports.GitpodServerProxy = Symbol('GitpodServerProxy');
-var GitpodCompositeClient = /** @class */ (function () {
-    function GitpodCompositeClient() {
+exports.GitpodServerPath = "/gitpod";
+exports.GitpodServerProxy = Symbol("GitpodServerProxy");
+class GitpodCompositeClient {
+    constructor() {
         this.clients = [];
     }
-    GitpodCompositeClient.prototype.registerClient = function (client) {
-        var _this = this;
+    registerClient(client) {
         this.clients.push(client);
-        var index = this.clients.length;
         return {
-            dispose: function () {
-                _this.clients.slice(index, 1);
-            }
+            dispose: () => {
+                const index = this.clients.indexOf(client);
+                if (index > -1) {
+                    this.clients.splice(index, 1);
+                }
+            },
         };
-    };
-    GitpodCompositeClient.prototype.onInstanceUpdate = function (instance) {
-        var e_1, _a;
-        try {
-            for (var _b = __values(this.clients), _c = _b.next(); !_c.done; _c = _b.next()) {
-                var client = _c.value;
-                if (client.onInstanceUpdate) {
-                    try {
-                        client.onInstanceUpdate(instance);
-                    }
-                    catch (error) {
-                        console.error(error);
-                    }
+    }
+    onInstanceUpdate(instance) {
+        for (const client of this.clients) {
+            if (client.onInstanceUpdate) {
+                try {
+                    client.onInstanceUpdate(instance);
                 }
-            }
-        }
-        catch (e_1_1) { e_1 = { error: e_1_1 }; }
-        finally {
-            try {
-                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
-            }
-            finally { if (e_1) throw e_1.error; }
-        }
-    };
-    GitpodCompositeClient.prototype.onWorkspaceImageBuildLogs = function (info, content) {
-        var e_2, _a;
-        try {
-            for (var _b = __values(this.clients), _c = _b.next(); !_c.done; _c = _b.next()) {
-                var client = _c.value;
-                if (client.onWorkspaceImageBuildLogs) {
-                    try {
-                        client.onWorkspaceImageBuildLogs(info, content);
-                    }
-                    catch (error) {
-                        console.error(error);
-                    }
+                catch (error) {
+                    console.error(error);
                 }
             }
         }
-        catch (e_2_1) { e_2 = { error: e_2_1 }; }
-        finally {
-            try {
-                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
-            }
-            finally { if (e_2) throw e_2.error; }
-        }
-    };
-    GitpodCompositeClient.prototype.onHeadlessWorkspaceLogs = function (evt) {
-        var e_3, _a;
-        try {
-            for (var _b = __values(this.clients), _c = _b.next(); !_c.done; _c = _b.next()) {
-                var client = _c.value;
-                if (client.onHeadlessWorkspaceLogs) {
-                    try {
-                        client.onHeadlessWorkspaceLogs(evt);
-                    }
-                    catch (error) {
-                        console.error(error);
-                    }
+    }
+    onPrebuildUpdate(update) {
+        for (const client of this.clients) {
+            if (client.onPrebuildUpdate) {
+                try {
+                    client.onPrebuildUpdate(update);
                 }
-            }
-        }
-        catch (e_3_1) { e_3 = { error: e_3_1 }; }
-        finally {
-            try {
-                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
-            }
-            finally { if (e_3) throw e_3.error; }
-        }
-    };
-    GitpodCompositeClient.prototype.notifyDidOpenConnection = function () {
-        var e_4, _a;
-        try {
-            for (var _b = __values(this.clients), _c = _b.next(); !_c.done; _c = _b.next()) {
-                var client = _c.value;
-                if (client.notifyDidOpenConnection) {
-                    try {
-                        client.notifyDidOpenConnection();
-                    }
-                    catch (error) {
-                        console.error(error);
-                    }
+                catch (error) {
+                    console.error(error);
                 }
             }
         }
-        catch (e_4_1) { e_4 = { error: e_4_1 }; }
-        finally {
-            try {
-                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+    }
+    onWorkspaceImageBuildLogs(info, content) {
+        for (const client of this.clients) {
+            if (client.onWorkspaceImageBuildLogs) {
+                try {
+                    client.onWorkspaceImageBuildLogs(info, content);
+                }
+                catch (error) {
+                    console.error(error);
+                }
             }
-            finally { if (e_4) throw e_4.error; }
         }
-    };
-    GitpodCompositeClient.prototype.notifyDidCloseConnection = function () {
-        var e_5, _a;
-        try {
-            for (var _b = __values(this.clients), _c = _b.next(); !_c.done; _c = _b.next()) {
-                var client = _c.value;
-                if (client.notifyDidCloseConnection) {
-                    try {
-                        client.notifyDidCloseConnection();
-                    }
-                    catch (error) {
-                        console.error(error);
-                    }
+    }
+    notifyDidOpenConnection() {
+        for (const client of this.clients) {
+            if (client.notifyDidOpenConnection) {
+                try {
+                    client.notifyDidOpenConnection();
+                }
+                catch (error) {
+                    console.error(error);
                 }
             }
         }
-        catch (e_5_1) { e_5 = { error: e_5_1 }; }
-        finally {
-            try {
-                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+    }
+    notifyDidCloseConnection() {
+        for (const client of this.clients) {
+            if (client.notifyDidCloseConnection) {
+                try {
+                    client.notifyDidCloseConnection();
+                }
+                catch (error) {
+                    console.error(error);
+                }
             }
-            finally { if (e_5) throw e_5.error; }
         }
-    };
-    GitpodCompositeClient.prototype.onCreditAlert = function (creditAlert) {
-        var e_6, _a;
-        try {
-            for (var _b = __values(this.clients), _c = _b.next(); !_c.done; _c = _b.next()) {
-                var client = _c.value;
-                if (client.onCreditAlert) {
-                    try {
-                        client.onCreditAlert(creditAlert);
-                    }
-                    catch (error) {
-                        console.error(error);
-                    }
+    }
+    onCreditAlert(creditAlert) {
+        for (const client of this.clients) {
+            if (client.onCreditAlert) {
+                try {
+                    client.onCreditAlert(creditAlert);
+                }
+                catch (error) {
+                    console.error(error);
                 }
             }
         }
-        catch (e_6_1) { e_6 = { error: e_6_1 }; }
-        finally {
-            try {
-                if (_c && !_c.done && (_a = _b.return)) _a.call(_b);
+    }
+    onNotificationUpdated() {
+        for (const client of this.clients) {
+            if (client.onNotificationUpdated) {
+                try {
+                    client.onNotificationUpdated();
+                }
+                catch (error) {
+                    console.error(error);
+                }
             }
-            finally { if (e_6) throw e_6.error; }
         }
-    };
-    return GitpodCompositeClient;
-}());
+    }
+}
 exports.GitpodCompositeClient = GitpodCompositeClient;
-var hasWindow = (typeof window !== 'undefined');
-var phasesOrder = {
+const hasWindow = typeof window !== "undefined";
+const phasesOrder = {
     unknown: 0,
     preparing: 1,
-    pending: 2,
-    creating: 3,
-    initializing: 4,
-    running: 5,
-    interrupted: 6,
-    stopping: 7,
-    stopped: 8
+    building: 2,
+    pending: 3,
+    creating: 4,
+    initializing: 5,
+    running: 6,
+    interrupted: 7,
+    stopping: 8,
+    stopped: 9,
 };
-var WorkspaceInstanceUpdateListener = /** @class */ (function () {
-    function WorkspaceInstanceUpdateListener(service, _info) {
-        var _this = this;
+class WorkspaceInstanceUpdateListener {
+    constructor(service, _info) {
         this.service = service;
         this._info = _info;
         this.onDidChangeEmitter = new event_1.Emitter();
         this.onDidChange = this.onDidChangeEmitter.event;
-        this.source = 'sync';
+        this.source = "sync";
         this.syncQueue = Promise.resolve();
         service.registerClient({
-            onInstanceUpdate: function (instance) {
-                if (_this.isOutOfOrder(instance)) {
+            onInstanceUpdate: (instance) => {
+                if (this.isOutOfOrder(instance)) {
                     return;
                 }
-                _this.cancelSync();
-                _this._info.latestInstance = instance;
-                _this.source = 'update';
-                _this.onDidChangeEmitter.fire(undefined);
+                this.cancelSync();
+                this._info.latestInstance = instance;
+                this.source = "update";
+                this.onDidChangeEmitter.fire(undefined);
+            },
+            notifyDidOpenConnection: () => {
+                this.sync();
             },
-            notifyDidOpenConnection: function () {
-                _this.sync();
-            }
         });
         if (hasWindow) {
             // learn about page lifecycle here: https://developers.google.com/web/updates/2018/07/page-lifecycle-api
-            window.document.addEventListener('visibilitychange', function () { return __awaiter(_this, void 0, void 0, function () {
-                return __generator(this, function (_a) {
-                    if (window.document.visibilityState === 'visible') {
-                        this.sync();
-                    }
-                    return [2 /*return*/];
-                });
-            }); });
-            window.addEventListener('pageshow', function (e) {
+            window.document.addEventListener("visibilitychange", () => __awaiter(this, void 0, void 0, function* () {
+                if (window.document.visibilityState === "visible") {
+                    this.sync();
+                }
+            }));
+            window.addEventListener("pageshow", (e) => {
                 if (e.persisted) {
-                    _this.sync();
+                    this.sync();
                 }
             });
         }
     }
-    Object.defineProperty(WorkspaceInstanceUpdateListener.prototype, "info", {
-        get: function () {
-            return this._info;
-        },
-        enumerable: false,
-        configurable: true
-    });
+    get info() {
+        return this._info;
+    }
     /**
      * Only one sync can be performed at the same time.
      * Any new sync request or instance update cancels all previously scheduled sync requests.
      */
-    WorkspaceInstanceUpdateListener.prototype.sync = function () {
-        var _this = this;
+    sync() {
         this.cancelSync();
         this.syncTokenSource = new vscode_jsonrpc_1.CancellationTokenSource();
-        var token = this.syncTokenSource.token;
-        this.syncQueue = this.syncQueue.then(function () { return __awaiter(_this, void 0, void 0, function () {
-            var info, e_7;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
-                    case 0:
-                        if (token.isCancellationRequested) {
-                            return [2 /*return*/];
-                        }
-                        _a.label = 1;
-                    case 1:
-                        _a.trys.push([1, 3, , 4]);
-                        return [4 /*yield*/, this.service.server.getWorkspace(this._info.workspace.id)];
-                    case 2:
-                        info = _a.sent();
-                        if (token.isCancellationRequested) {
-                            return [2 /*return*/];
-                        }
-                        this._info = info;
-                        this.source = 'sync';
-                        this.onDidChangeEmitter.fire(undefined);
-                        return [3 /*break*/, 4];
-                    case 3:
-                        e_7 = _a.sent();
-                        console.error('failed to sync workspace instance:', e_7);
-                        return [3 /*break*/, 4];
-                    case 4: return [2 /*return*/];
+        const token = this.syncTokenSource.token;
+        this.syncQueue = this.syncQueue.then(() => __awaiter(this, void 0, void 0, function* () {
+            if (token.isCancellationRequested) {
+                return;
+            }
+            try {
+                const info = yield this.service.server.getWorkspace(this._info.workspace.id);
+                if (token.isCancellationRequested) {
+                    return;
                 }
-            });
-        }); });
-    };
-    WorkspaceInstanceUpdateListener.prototype.cancelSync = function () {
+                this._info = info;
+                this.source = "sync";
+                this.onDidChangeEmitter.fire(undefined);
+            }
+            catch (e) {
+                console.error("failed to sync workspace instance:", e);
+            }
+        }));
+    }
+    cancelSync() {
         if (this.syncTokenSource) {
             this.syncTokenSource.cancel();
             this.syncTokenSource = undefined;
         }
-    };
+    }
     /**
      * If sync seen more recent update then ignore all updates with previous phases.
      * Within the same phase still the race can occur but which should be eventually consistent.
      */
-    WorkspaceInstanceUpdateListener.prototype.isOutOfOrder = function (instance) {
+    isOutOfOrder(instance) {
         var _a;
         if (instance.workspaceId !== this._info.workspace.id) {
             return true;
         }
-        if (this.source === 'update') {
+        if (this.source === "update") {
             return false;
         }
         if (instance.id !== ((_a = this.info.latestInstance) === null || _a === void 0 ? void 0 : _a.id)) {
             return false;
         }
         return phasesOrder[instance.status.phase] < phasesOrder[this.info.latestInstance.status.phase];
-    };
-    return WorkspaceInstanceUpdateListener;
-}());
+    }
+}
 exports.WorkspaceInstanceUpdateListener = WorkspaceInstanceUpdateListener;
-var GitpodServiceImpl = /** @class */ (function () {
-    function GitpodServiceImpl(server) {
-        var _this = this;
+class GitpodServiceImpl {
+    constructor(server, options) {
         this.server = server;
+        this.options = options;
         this.compositeClient = new GitpodCompositeClient();
         this.instanceListeners = new Map();
         server.setClient(this.compositeClient);
-        server.onDidOpenConnection(function () { return _this.compositeClient.notifyDidOpenConnection(); });
-        server.onDidCloseConnection(function () { return _this.compositeClient.notifyDidCloseConnection(); });
+        server.onDidOpenConnection(() => this.compositeClient.notifyDidOpenConnection());
+        server.onDidCloseConnection(() => this.compositeClient.notifyDidCloseConnection());
     }
-    GitpodServiceImpl.prototype.registerClient = function (client) {
+    registerClient(client) {
         return this.compositeClient.registerClient(client);
-    };
-    GitpodServiceImpl.prototype.listenToInstance = function (workspaceId) {
-        var _this = this;
-        var listener = this.instanceListeners.get(workspaceId) ||
-            (function () { return __awaiter(_this, void 0, void 0, function () {
-                var info;
-                return __generator(this, function (_a) {
-                    switch (_a.label) {
-                        case 0: return [4 /*yield*/, this.server.getWorkspace(workspaceId)];
-                        case 1:
-                            info = _a.sent();
-                            return [2 /*return*/, new WorkspaceInstanceUpdateListener(this, info)];
-                    }
-                });
-            }); })();
+    }
+    listenToInstance(workspaceId) {
+        const listener = this.instanceListeners.get(workspaceId) ||
+            (() => __awaiter(this, void 0, void 0, function* () {
+                const info = yield this.server.getWorkspace(workspaceId);
+                return new WorkspaceInstanceUpdateListener(this, info);
+            }))();
         this.instanceListeners.set(workspaceId, listener);
         return listener;
-    };
-    return GitpodServiceImpl;
-}());
+    }
+    reconnect() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            if ((_a = this.options) === null || _a === void 0 ? void 0 : _a.onReconnect) {
+                yield this.options.onReconnect();
+            }
+        });
+    }
+}
 exports.GitpodServiceImpl = GitpodServiceImpl;
 function createGitpodService(serverUrl) {
-    var toWsUrl = function (serverUrl) {
-        return new gitpod_host_url_1.GitpodHostUrl(serverUrl)
-            .asWebsocket()
-            .withApi({ pathname: exports.GitpodServerPath })
-            .toString();
+    const toWsUrl = (serverUrl) => {
+        return new gitpod_host_url_1.GitpodHostUrl(serverUrl).asWebsocket().withApi({ pathname: exports.GitpodServerPath }).toString();
     };
-    var url;
+    let url;
     if (typeof serverUrl === "string") {
         url = toWsUrl(serverUrl);
     }
     else {
-        url = serverUrl.then(function (url) { return toWsUrl(url); });
+        url = serverUrl.then((url) => toWsUrl(url));
     }
-    var connectionProvider = new connection_1.WebSocketConnectionProvider();
-    var gitpodServer = connectionProvider.createProxy(url);
-    return new GitpodServiceImpl(gitpodServer);
+    const connectionProvider = new connection_1.WebSocketConnectionProvider();
+    let onReconnect = () => { };
+    const gitpodServer = connectionProvider.createProxy(url, undefined, {
+        onListening: (socket) => {
+            onReconnect = () => socket.reconnect();
+        },
+    });
+    return new GitpodServiceImpl(gitpodServer, { onReconnect });
 }
 exports.createGitpodService = createGitpodService;
 //# sourceMappingURL=gitpod-service.js.map