@gitpod/gitpod-protocol 0.1.5-se-multi-repo.11 → 0.1.5-se-multi-repo.19

package/src/context-url.ts

@@ -4,41 +4,95 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
+import { Workspace } from ".";
+
+/**
+ * The whole point of these methods is to overcome inconsistencies in our data model.
+ * Ideally we remove it at some point once we fixed our model, as it:
+ *  - duplicates logic
+ *  - but additional burden on clients (using this, copying this to other languages!)
+ *
+ * TODO(gpl) See if we can get this into `server` code to remove the burden from clients
+ */
 export namespace ContextURL {
   export const INCREMENTAL_PREBUILD_PREFIX = "incremental-prebuild";
   export const PREBUILD_PREFIX = "prebuild";
   export const IMAGEBUILD_PREFIX = "imagebuild";
+  export const SNAPSHOT_PREFIX = "snapshot";
   export const REFERRER_PREFIX = 'referrer:';
 
+  /**
+   * This function will (try to) return the HTTP(S) URL of the context the user originally created this workspace on.
+   * Especially it will not contain any modifiers or be of different scheme than HTTP(S).
+   *
+   * Use this function if you need to provided a _working_ URL to the original context.
+   * @param ws
+   * @returns
+   */
+  export function getNormalizedURL(ws: Pick<Workspace, "context" | "contextURL"> | undefined): URL | undefined {
+    const normalized = normalize(ws);
+    if (!normalized) {
+      return undefined;
+    }
+
+    try {
+      return new URL(normalized);
+    } catch (err) {
+      console.error(`unable to parse URL from normalized contextURL: '${normalized}'`, err);
+    }
+    return undefined;
+  }
+
+  function normalize(ws: Pick<Workspace, "context" | "contextURL"> | undefined): string | undefined {
+    if (!ws) {
+      return undefined;
+    }
+    if (ws.context.normalizedContextURL) {
+      return ws.context.normalizedContextURL;
+    }
+
+    // fallback: we do not yet set normalizedContextURL on all workspaces, yet, let alone older existing workspaces
+    let fallback: string | undefined = undefined;
+    try {
+      fallback = removePrefixes(ws.contextURL);
+    } catch (err) {
+      console.error(`unable to remove prefixes from contextURL: '${ws.contextURL}'`, err);
+    }
+    return fallback;
+  }
+
   /**
    * The field "contextUrl" might contain prefixes like:
    *  - envvar1=value1/...
    *  - prebuild/...
    * This is the analogon to the (Prefix)ContextParser structure in "server".
    */
-  export function parseToURL(contextUrl: string | undefined): URL | undefined {
+  function removePrefixes(contextUrl: string | undefined): string | undefined {
     if (contextUrl === undefined) {
       return undefined;
     }
 
     const segments = contextUrl.split("/");
     if (segments.length === 1) {
-      return new URL(segments[0]);  // this might be something, we just try
+      return segments[0];  // this might be something, we just try
     }
 
-    const segmentsToURL = (offset: number): URL => {
+    const segmentsToURL = (offset: number): string => {
       let rest = segments.slice(offset).join("/");
+      if (/^git@[^:\/]+:/.test(rest)) {
+        rest = rest.replace(/^git@([^:\/]+):/, 'https://$1/');
+      }
       if (!rest.startsWith("http")) {
         rest = 'https://' + rest;
       }
-      return new URL(rest);
+      return rest;
     };
 
-
     const firstSegment = segments[0];
     if (firstSegment === PREBUILD_PREFIX ||
         firstSegment === INCREMENTAL_PREBUILD_PREFIX ||
         firstSegment === IMAGEBUILD_PREFIX ||
+        firstSegment === SNAPSHOT_PREFIX ||
         firstSegment.startsWith(REFERRER_PREFIX)) {
       return segmentsToURL(1);
     }

package/src/gitpod-service.ts

@@ -72,6 +72,7 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     getWorkspaceOwner(workspaceId: string): Promise<UserInfo | undefined>;
     getWorkspaceUsers(workspaceId: string): Promise<WorkspaceInstanceUser[]>;
     getFeaturedRepositories(): Promise<WhitelistedRepository[]>;
+    getSuggestedContextURLs(): Promise<string[]>;
     /**
      * **Security:**
      * Sensitive information like an owner token is erased, since it allows access for all team members.
@@ -252,6 +253,16 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     identifyUser(event: RemoteIdentifyMessage): Promise<void>;
 }
 
+export interface RateLimiterError {
+    method?: string,
+
+    /**
+     * Retry after this many seconds, earliest.
+     * cmp.: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
+     */
+    retryAfter: number,
+}
+
 export interface CreateProjectParams {
     name: string;
     slug?: string;

package/src/ide-protocol.ts

@@ -102,6 +102,11 @@ export interface IDEOption {
      */
     image: string;
 
+    /**
+     * The latest image ref to the IDE image, this image ref always resolve to digest.
+     */
+    latestImage?: string;
+
     /**
      * When this is `true`, the tag of this image is resolved to the latest
      * image digest regularly.

package/src/protocol.ts

@@ -119,6 +119,7 @@ export type IDESettings = {
     defaultIde?: string
     useDesktopIde?: boolean
     defaultDesktopIde?: string
+    useLatestVersion?: boolean
 }
 
 export interface UserPlatform {
@@ -566,14 +567,14 @@ export interface VSCodeConfig {
     extensions?: string[];
 }
 
-export interface SubRepository {
+export interface RepositoryCloneInformation {
     url: string;
     checkoutLocation?: string;
 }
 
 export interface WorkspaceConfig {
-    mainRepository?: string;
-    subRepositories?: SubRepository[];
+    mainConfiguration?: string;
+    additionalRepositories?: RepositoryCloneInformation[];
     image?: ImageConfig;
     ports?: PortConfig[];
     tasks?: TaskConfig[];
@@ -1217,6 +1218,8 @@ export interface AuthProviderEntry {
     readonly status: AuthProviderEntry.Status;
 
     readonly oauth: OAuth2Config;
+    /** A random string that is to change whenever oauth changes (enforced on DB level) */
+    readonly oauthRevision?: string;
 }
 
 export interface OAuth2Config {

package/lib/messaging/connection-error-handler.d.ts

@@ -1,27 +0,0 @@
-import { Message } from "vscode-jsonrpc";
-export interface ResolvedConnectionErrorHandlerOptions {
-    readonly serverName: string;
-    /**
-     * The maximum amount of errors allowed before stopping the server.
-     */
-    readonly maxErrors: number;
-    /**
-     * The maimum amount of restarts allowed in the restart interval.
-     */
-    readonly maxRestarts: number;
-    /**
-     * In minutes.
-     */
-    readonly restartInterval: number;
-}
-export declare type ConnectionErrorHandlerOptions = Partial<ResolvedConnectionErrorHandlerOptions> & {
-    readonly serverName: string;
-};
-export declare class ConnectionErrorHandler {
-    protected readonly options: ResolvedConnectionErrorHandlerOptions;
-    constructor(options: ConnectionErrorHandlerOptions);
-    shouldStop(error: Error, message?: Message, count?: number): boolean;
-    protected readonly restarts: number[];
-    shouldRestart(): boolean;
-}
-//# sourceMappingURL=connection-error-handler.d.ts.map

package/lib/messaging/connection-error-handler.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"connection-error-handler.d.ts","sourceRoot":"","sources":["../../src/messaging/connection-error-handler.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAGzC,MAAM,WAAW,qCAAqC;IAClD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAA;IAC5B;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAA;CACnC;AAED,oBAAY,6BAA6B,GAAG,OAAO,CAAC,qCAAqC,CAAC,GAAG;IACzF,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC9B,CAAC;AAEF,qBAAa,sBAAsB;IAE/B,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,qCAAqC,CAAC;gBACtD,OAAO,EAAE,6BAA6B;IASlD,UAAU,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO;IAIpE,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAM;IAC3C,aAAa,IAAI,OAAO;CAc3B"}

package/lib/messaging/connection-error-handler.js

@@ -1,34 +0,0 @@
-"use strict";
-/*
- * Copyright (C) 2017 TypeFox and others.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConnectionErrorHandler = void 0;
-const logging_1 = require("../util/logging");
-class ConnectionErrorHandler {
-    constructor(options) {
-        this.restarts = [];
-        this.options = Object.assign({ maxErrors: 3, maxRestarts: 5, restartInterval: 3 }, options);
-    }
-    shouldStop(error, message, count) {
-        return !count || count > this.options.maxErrors;
-    }
-    shouldRestart() {
-        this.restarts.push(Date.now());
-        if (this.restarts.length <= this.options.maxRestarts) {
-            return true;
-        }
-        const diff = this.restarts[this.restarts.length - 1] - this.restarts[0];
-        if (diff <= this.options.restartInterval * 60 * 1000) {
-            logging_1.log.error(`Server ${this.options.serverName} crashed ${this.options.maxRestarts} times in the last ${this.options.restartInterval} minutes. Will not restart`);
-            return false;
-        }
-        this.restarts.shift();
-        return true;
-    }
-}
-exports.ConnectionErrorHandler = ConnectionErrorHandler;
-//# sourceMappingURL=connection-error-handler.js.map

package/lib/messaging/connection-error-handler.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"connection-error-handler.js","sourceRoot":"","sources":["../../src/messaging/connection-error-handler.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAGH,6CAAsC;AAsBtC,MAAa,sBAAsB;IAG/B,YAAY,OAAsC;QAa/B,aAAQ,GAAa,EAAE,CAAC;QAZvC,IAAI,CAAC,OAAO,mBACR,SAAS,EAAE,CAAC,EACZ,WAAW,EAAE,CAAC,EACd,eAAe,EAAE,CAAC,IACf,OAAO,CACb,CAAC;IACN,CAAC;IAED,UAAU,CAAC,KAAY,EAAE,OAAiB,EAAE,KAAc;QACtD,OAAO,CAAC,KAAK,IAAI,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;IACpD,CAAC;IAGD,aAAa;QACT,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/B,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE;YAClD,OAAO,IAAI,CAAC;SACf;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACxE,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,eAAe,GAAG,EAAE,GAAG,IAAI,EAAE;YAClD,aAAG,CAAC,KAAK,CAAC,UAAU,IAAI,CAAC,OAAO,CAAC,UAAU,YAAY,IAAI,CAAC,OAAO,CAAC,WAAW,sBAAsB,IAAI,CAAC,OAAO,CAAC,eAAe,4BAA4B,CAAC,CAAC;YAC/J,OAAO,KAAK,CAAC;SAChB;QACD,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IAChB,CAAC;CAEJ;AA/BD,wDA+BC"}

package/lib/util/safe-promise.d.ts

@@ -1,11 +0,0 @@
-/**
- * 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 { LogContext } from './logging';
-export declare class SafePromise {
-    static catchAndLog<T>(p: Promise<T>, logCtx?: LogContext): Promise<T>;
-    static catch<T>(p: Promise<T>, handler: (err: any) => void): Promise<T>;
-}
-//# sourceMappingURL=safe-promise.d.ts.map

package/lib/util/safe-promise.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"safe-promise.d.ts","sourceRoot":"","sources":["../../src/util/safe-promise.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAO,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5C,qBAAa,WAAW;WACN,WAAW,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,UAAU;WASjD,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC;CAMjF"}

package/lib/util/safe-promise.js

@@ -1,31 +0,0 @@
-"use strict";
-/**
- * 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.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SafePromise = void 0;
-const logging_1 = require("./logging");
-class SafePromise {
-    static catchAndLog(p, logCtx) {
-        return SafePromise.catch(p, (err) => {
-            if (logCtx) {
-                logging_1.log.error(logCtx, err);
-            }
-            else {
-                logging_1.log.error(err);
-            }
-        });
-    }
-    ;
-    static catch(p, handler) {
-        return p.catch((err) => {
-            handler(err);
-            return {}; // Nobody will ever see this value as the Promise already failed. It's just there to please the compiler
-        });
-    }
-    ;
-}
-exports.SafePromise = SafePromise;
-//# sourceMappingURL=safe-promise.js.map

package/lib/util/safe-promise.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"safe-promise.js","sourceRoot":"","sources":["../../src/util/safe-promise.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAGH,uCAA4C;AAE5C,MAAa,WAAW;IACb,MAAM,CAAC,WAAW,CAAI,CAAa,EAAE,MAAmB;QAC3D,OAAO,WAAW,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE;YAChC,IAAI,MAAM,EAAE;gBACR,aAAG,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;aAC1B;iBAAM;gBACH,aAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;aAClB;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAAA,CAAC;IACK,MAAM,CAAC,KAAK,CAAI,CAAa,EAAE,OAA2B;QAC7D,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,OAAO,CAAC,GAAG,CAAC,CAAC;YACb,OAAO,EAAO,CAAC,CAAC,wGAAwG;QAC5H,CAAC,CAAC,CAAC;IACP,CAAC;IAAA,CAAC;CACL;AAhBD,kCAgBC"}

package/src/messaging/connection-error-handler.ts

@@ -1,62 +0,0 @@
-/*
- * Copyright (C) 2017 TypeFox and others.
- *
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- */
-
-import { Message } from "vscode-jsonrpc";
-import { log } from '../util/logging';
-
-export interface ResolvedConnectionErrorHandlerOptions {
-    readonly serverName: string
-    /**
-     * The maximum amount of errors allowed before stopping the server.
-     */
-    readonly maxErrors: number
-    /**
-     * The maimum amount of restarts allowed in the restart interval.
-     */
-    readonly maxRestarts: number
-    /**
-     * In minutes.
-     */
-    readonly restartInterval: number
-}
-
-export type ConnectionErrorHandlerOptions = Partial<ResolvedConnectionErrorHandlerOptions> & {
-    readonly serverName: string
-};
-
-export class ConnectionErrorHandler {
-
-    protected readonly options: ResolvedConnectionErrorHandlerOptions;
-    constructor(options: ConnectionErrorHandlerOptions) {
-        this.options = {
-            maxErrors: 3,
-            maxRestarts: 5,
-            restartInterval: 3,
-            ...options
-        };
-    }
-
-    shouldStop(error: Error, message?: Message, count?: number): boolean {
-        return !count || count > this.options.maxErrors;
-    }
-
-    protected readonly restarts: number[] = [];
-    shouldRestart(): boolean {
-        this.restarts.push(Date.now());
-        if (this.restarts.length <= this.options.maxRestarts) {
-            return true;
-        }
-        const diff = this.restarts[this.restarts.length - 1] - this.restarts[0];
-        if (diff <= this.options.restartInterval * 60 * 1000) {
-            log.error(`Server ${this.options.serverName} crashed ${this.options.maxRestarts} times in the last ${this.options.restartInterval} minutes. Will not restart`);
-            return false;
-        }
-        this.restarts.shift();
-        return true;
-    }
-
-}

package/src/util/safe-promise.ts

@@ -1,26 +0,0 @@
-/**
- * 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 { log, LogContext } from './logging';
-
-export class SafePromise {
-    public static catchAndLog<T>(p: Promise<T>, logCtx?: LogContext) {
-        return SafePromise.catch(p, (err) => {
-            if (logCtx) {
-                log.error(logCtx, err);
-            } else {
-                log.error(err);
-            }
-        });
-    };
-    public static catch<T>(p: Promise<T>, handler: (err: any) => void): Promise<T> {
-        return p.catch((err) => {
-            handler(err);
-            return {} as T; // Nobody will ever see this value as the Promise already failed. It's just there to please the compiler
-        });
-    };
-}