@gitpod/gitpod-protocol 0.1.5-pluggable-workspace-cluster.21 → 0.1.5-port-description-3059-fork.6

package/package.json

@@ -1,33 +1,46 @@
 {
   "dependencies": {
+    "@types/react": "17.0.32",
     "ajv": "^6.5.4",
-    "inversify": "^5.0.1",
-    "jaeger-client": "3.17.2",
+    "analytics-node": "^4.0.1",
+    "cookie": "^0.4.1",
+    "inversify": "^5.1.1",
+    "jaeger-client": "^3.18.1",
     "js-yaml": "^3.10.0",
-    "opentracing": "^0.14.4",
-    "prom-client": "^10.2.0",
+    "opentracing": "^0.14.5",
+    "prom-client": "^13.2.0",
     "random-number-csprng": "^1.0.2",
-    "reconnecting-websocket": "^4.2.0",
-    "reflect-metadata": "^0.1.10",
-    "uuid": "^3.3.3",
+    "react": "17.0.2",
+    "react-dom": "17.0.2",
+    "reconnecting-websocket": "^4.4.0",
+    "reflect-metadata": "^0.1.13",
+    "uuid": "^8.3.2",
+    "vscode-jsonrpc": "^5.0.1",
+    "vscode-languageserver-protocol": "3.16.0",
+    "vscode-languageserver-types": "3.16.0",
     "vscode-uri": "^1.0.1",
     "vscode-ws-jsonrpc": "^0.2.0",
-    "ws": "^5.2.2"
+    "ws": "^7.4.6"
   },
   "devDependencies": {
-    "@types/chai-subset": "^1.3.1",
+    "@types/analytics-node": "^3.1.5",
+    "@types/chai-subset": "^1.3.3",
+    "@types/cookie": "^0.4.1",
+    "@types/jaeger-client": "^3.18.3",
     "@types/js-yaml": "^3.10.1",
+    "@types/mocha": "^5.2.7",
+    "@types/node": "^16.11.6",
     "@types/random-number-csprng": "^1.0.0",
-    "@types/uuid": "^3.4.5",
+    "@types/uuid": "^8.3.1",
     "@types/ws": "^5.1.2",
-    "chai": "^4.1.2",
+    "chai": "^4.3.4",
     "chai-subset": "^1.6.0",
     "mocha": "^5.0.0",
     "mocha-typescript": "^1.1.11",
     "rimraf": "^2.6.2",
     "ts-node": "^9.0.0",
-    "typescript": "~4.1.2",
-    "typescript-json-schema": "^0.43.0",
+    "typescript": "~4.4.2",
+    "typescript-json-schema": "^0.50.1",
     "typescript-parser": "^2.6.1"
   },
   "files": [
@@ -43,9 +56,9 @@
     "build": "tsc",
     "clean": "rimraf lib",
     "prepare": "yarn run clean && yarn run build",
-    "test": "mocha --opts mocha.opts '**/*.spec.ts'",
+    "test": "mocha --opts mocha.opts './**/*.spec.ts' --exclude './node_modules/**'",
     "watch": "leeway exec --package .:lib --transitive-dependencies --filter-type yarn --components --parallel -- tsc -w --preserveWatchOutput"
   },
   "types": "./lib/index.d.ts",
-  "version": "0.1.5-pluggable-workspace-cluster.21"
-}
+  "version": "0.1.5-port-description-3059-fork.6"
+}

package/pkg-yarn.lock

@@ -4,19 +4,27 @@
 
 "@gitpod/gitpod-protocol@0.1.5":
   version "0.1.5"
-  resolved "file:///tmp/cache/3a2b24d58c92429bc60efd23a639e535d9aa7887.tar.gz"
+  resolved "file:///tmp/cache/d0a684835a74e617295f530ab6aab84f9c1529e5.tar.gz"
   dependencies:
+    "@types/react" "17.0.32"
     ajv "^6.5.4"
-    inversify "^5.0.1"
-    jaeger-client "3.17.2"
+    analytics-node "^4.0.1"
+    cookie "^0.4.1"
+    inversify "^5.1.1"
+    jaeger-client "^3.18.1"
     js-yaml "^3.10.0"
-    opentracing "^0.14.4"
-    prom-client "^10.2.0"
+    opentracing "^0.14.5"
+    prom-client "^13.2.0"
     random-number-csprng "^1.0.2"
-    reconnecting-websocket "^4.2.0"
-    reflect-metadata "^0.1.10"
-    uuid "^3.3.3"
+    react "17.0.2"
+    react-dom "17.0.2"
+    reconnecting-websocket "^4.4.0"
+    reflect-metadata "^0.1.13"
+    uuid "^8.3.2"
+    vscode-jsonrpc "^5.0.1"
+    vscode-languageserver-protocol "3.16.0"
+    vscode-languageserver-types "3.16.0"
     vscode-uri "^1.0.1"
     vscode-ws-jsonrpc "^0.2.0"
-    ws "^5.2.2"
+    ws "^7.4.6"
 

package/src/accounting-protocol.ts

@@ -4,8 +4,7 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
- import * as uuidv4 from 'uuid/v4';
-import { Without } from "./util/without";
+ import { v4 as uuidv4 } from 'uuid';
 import { User } from './protocol';
 import { oneMonthLater } from './util/timeutil';
 
@@ -47,7 +46,7 @@ export interface AccountEntry {
     description?: object;
 }
 export namespace AccountEntry {
-    export function create<T extends AccountEntry>(entry: Without<T, 'uid'>): T {
+    export function create<T extends AccountEntry>(entry: Omit<T, 'uid'>): T {
         const result = entry as T;
         result.uid = uuidv4();
         return result;
@@ -91,7 +90,6 @@ export interface SessionDescription {
     contextUrl: string;
     workspaceId: string;
     workspaceInstanceId: string;
-    private: boolean;
 }
 export namespace SessionDescription {
     export function is(obj: any): obj is SessionDescription {
@@ -100,7 +98,6 @@ export namespace SessionDescription {
             && obj.hasOwnProperty('contextUrl')
             && obj.hasOwnProperty('workspaceId')
             && obj.hasOwnProperty('workspaceInstanceId')
-            && obj.hasOwnProperty('private');
     }
 }
 
@@ -164,7 +161,7 @@ export namespace AssignedTeamSubscription {
 }
 
 export namespace Subscription {
-    export function create(newSubscription: Without<Subscription, 'uid'>) {
+    export function create(newSubscription: Omit<Subscription, 'uid'>) {
         const subscription = newSubscription as Subscription;
         subscription.uid = uuidv4();
         return subscription;
@@ -193,9 +190,6 @@ export namespace Subscription {
     export function isDowngraded(s: Subscription) {
         return s.paymentData && s.paymentData.downgradeDate;
     };
-    export function isCancelled(s: Subscription) {
-        return !!s.cancellationDate;
-    };
     export function calculateCurrentPeriod(startDate: string, now: Date) {
         let nextStartDate = startDate;
         do {
@@ -215,7 +209,7 @@ export interface Period {
 
 export type MaybePeriod = Period | undefined;
 
-export type AccountEntryFixedPeriod = Without<AccountEntry, 'uid'> & { expiryDate: string };
+export type AccountEntryFixedPeriod = Omit<AccountEntry, 'uid'> & { expiryDate: string };
 export interface AccountStatement extends Period {
     userId: string;
     /**

package/src/admin-protocol.ts

@@ -5,7 +5,6 @@
  */
 
 import { User, Workspace, NamedWorkspaceFeatureFlag } from "./protocol";
-import { Without } from "./util/without";
 import { WorkspaceInstance, WorkspaceInstancePhase } from "./workspace-instance";
 import { RoleOrPermission } from "./permission";
 import { AccountStatement } from "./accounting-protocol";
@@ -21,6 +20,7 @@ export interface AdminServer {
     adminGetWorkspaces(req: AdminGetWorkspacesRequest): Promise<AdminGetListResult<WorkspaceAndInstance>>;
     adminGetWorkspace(id: string): Promise<WorkspaceAndInstance>;
     adminForceStopWorkspace(id: string): Promise<void>;
+    adminRestoreSoftDeletedWorkspace(id: string): Promise<void>;
 
     adminSetLicense(key: string): Promise<void>;
 
@@ -28,6 +28,7 @@ export interface AdminServer {
     adminSetProfessionalOpenSource(userId: string, shouldGetProfOSS: boolean): Promise<void>;
     adminIsStudent(userId: string): Promise<boolean>;
     adminAddStudentEmailDomain(userId: string, domain: string): Promise<void>;
+    adminGrantExtraHours(userId: string, extraHours: number): Promise<void>;
 }
 
 export interface AdminGetListRequest<T> {
@@ -64,7 +65,7 @@ export interface AdminModifyPermanentWorkspaceFeatureFlagRequest {
     }[]
 }
 
-export interface WorkspaceAndInstance extends Without<Workspace, "id"|"creationTime">, Without<WorkspaceInstance, "id"|"creationTime"> {
+export interface WorkspaceAndInstance extends Omit<Workspace, "id"|"creationTime">, Omit<WorkspaceInstance, "id"|"creationTime"> {
     workspaceId: string;
     workspaceCreationTime: string;
     instanceId: string;
@@ -72,6 +73,33 @@ export interface WorkspaceAndInstance extends Without<Workspace, "id"|"creationT
     phase: WorkspaceInstancePhase;
 }
 
-export interface AdminGetWorkspacesRequest extends AdminGetListRequest<WorkspaceAndInstance> {
-    ownerId?: string
-}
+export namespace WorkspaceAndInstance {
+    export function toWorkspace(wai: WorkspaceAndInstance): Workspace {
+        return {
+            id: wai.workspaceId,
+            creationTime: wai.workspaceCreationTime,
+            ... wai
+        };
+    }
+
+    export function toInstance(wai: WorkspaceAndInstance): WorkspaceInstance | undefined {
+        if (!wai.instanceId) {
+            return undefined;
+        }
+        return {
+            id: wai.instanceId,
+            creationTime: wai.instanceCreationTime,
+            ... wai
+        };
+    }
+}
+
+export type AdminGetWorkspacesRequest = AdminGetListRequest<WorkspaceAndInstance> & AdminGetWorkspacesQuery;
+/** The fields are meant to be used either OR (not combined) */
+export type AdminGetWorkspacesQuery = {
+    /** we use this field in case we have a UUIDv4 and don't know whether it's an (old) workspace or instance id */
+    instanceIdOrWorkspaceId?: string;
+    instanceId?: string;
+    workspaceId?: string;
+    ownerId?: string;
+};

package/src/analytics.ts

@@ -0,0 +1,54 @@
+/**
+ * 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 const IAnalyticsWriter = Symbol("IAnalyticsWriter");
+
+type Identity =
+    | { userId: string | number }
+    | { userId?: string | number; anonymousId: string | number };
+
+interface Message {
+    messageId?: string;
+}
+
+export type IdentifyMessage = Message & Identity & {
+    traits?: any;
+    timestamp?: Date;
+    context?: any;
+};
+
+export type TrackMessage = Message & Identity & {
+    event: string;
+    properties?: any;
+    timestamp?: Date;
+    context?: any;
+};
+
+export type PageMessage = Message & Identity & {
+    properties?: any;
+    timestamp?: Date;
+    context?: any;
+};
+
+export type RemoteTrackMessage = Omit<TrackMessage, "timestamp" | "userId" | "anonymousId"> & {
+    anonymousId?: string | number;
+};
+export type RemotePageMessage = Omit<PageMessage, "timestamp" | "userId"> & {
+    anonymousId?: string | number;
+};
+
+export type RemoteIdentifyMessage = Omit<IdentifyMessage, "timestamp" | "userId" | "anonymousId">;
+
+export interface IAnalyticsWriter {
+
+    identify(msg: IdentifyMessage): void;
+
+    track(msg: TrackMessage): void;
+
+    page(msg: PageMessage): void;
+
+}

package/src/context-url.spec.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 * as chai from 'chai';
+import { suite, test } from 'mocha-typescript';
+import { ContextURL } from './context-url';
+const expect = chai.expect;
+
+@suite
+export class ContextUrlTest {
+
+    @test public parseContextUrl_withEnvVar() {
+        const actual = ContextURL.parseToURL("passedin=test%20value/https://github.com/gitpod-io/gitpod-test-repo");
+        expect(actual?.host).to.equal("github.com");
+        expect(actual?.pathname).to.equal("/gitpod-io/gitpod-test-repo");
+    }
+
+    @test public parseContextUrl_withEnvVar_withoutSchema() {
+        const actual = ContextURL.parseToURL("passedin=test%20value/github.com/gitpod-io/gitpod-test-repo");
+        expect(actual?.host).to.equal("github.com");
+        expect(actual?.pathname).to.equal("/gitpod-io/gitpod-test-repo");
+    }
+
+    @test public parseContextUrl_withPrebuild() {
+        const actual = ContextURL.parseToURL("prebuild/https://github.com/gitpod-io/gitpod-test-repo");
+        expect(actual?.host).to.equal("github.com");
+        expect(actual?.pathname).to.equal("/gitpod-io/gitpod-test-repo");
+    }
+
+    @test public parseContextUrl_withPrebuild_withoutSchema() {
+        const actual = ContextURL.parseToURL("prebuild/github.com/gitpod-io/gitpod-test-repo");
+        expect(actual?.host).to.equal("github.com");
+        expect(actual?.pathname).to.equal("/gitpod-io/gitpod-test-repo");
+    }
+}
+module.exports = new ContextUrlTest()

package/src/context-url.ts

@@ -0,0 +1,51 @@
+/**
+ * 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.
+ */
+
+export namespace ContextURL {
+  export const INCREMENTAL_PREBUILD_PREFIX = "incremental-prebuild";
+  export const PREBUILD_PREFIX = "prebuild";
+  export const IMAGEBUILD_PREFIX = "imagebuild";
+
+  /**
+   * 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 {
+    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
+    }
+
+    const segmentsToURL = (offset: number): URL => {
+      let rest = segments.slice(offset).join("/");
+      if (!rest.startsWith("http")) {
+        rest = 'https://' + rest;
+      }
+      return new URL(rest);
+    };
+
+
+    const firstSegment = segments[0];
+    if (firstSegment === PREBUILD_PREFIX ||
+        firstSegment === INCREMENTAL_PREBUILD_PREFIX ||
+        firstSegment === IMAGEBUILD_PREFIX) {
+      return segmentsToURL(1);
+    }
+
+    // check for env vars
+    if (firstSegment.indexOf("=") !== -1) {
+      return segmentsToURL(1);
+    }
+
+    return segmentsToURL(0);
+  }
+}

package/src/email-protocol.ts

@@ -4,8 +4,7 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import { Without } from "./util/without";
-import uuidv4 = require("uuid/v4");
+import { v4 as uuidv4 } from 'uuid';
 
 export type EMailState = "scheduledInternal"
     | "scheduledSendgrid";
@@ -59,7 +58,7 @@ export type EMail = {
 } & EMailStatus;
 
 export namespace EMail {
-    export const create = (ts: Without<EMail, 'uid'>): EMail => {
+    export const create = (ts: Omit<EMail, 'uid'>): EMail => {
         const withId = ts as EMail;
         withId.uid = uuidv4();
         return withId;

package/src/env.ts

@@ -13,18 +13,18 @@ const legacyStagenameTranslation: { [key: string]: KubeStage } = {
     "dev": "dev"
 }
 
+export function translateLegacyStagename(kubeStage: string): KubeStage {
+    const stage = legacyStagenameTranslation[kubeStage];
+    if (!stage) {
+        throw new Error(`Invalid KUBE_STAGE: ${kubeStage}`);
+    }
+
+    return stage;
+}
+
 @injectable()
 export abstract class AbstractComponentEnv {
-    readonly kubeStage: KubeStage = getEnvVarParsed('KUBE_STAGE', (kubeStage) => {
-        const stage = legacyStagenameTranslation[kubeStage];
-        if (!stage) {
-            throw new Error(`Environment variable invalid: KUBE_STAGE=${kubeStage}`);
-        }
-
-        return stage;
-    });
-    readonly kubeNamespace: string = getEnvVar('KUBE_NAMESPACE');
-    readonly version: string = getEnvVar('VERSION');
+    readonly kubeStage: KubeStage = getEnvVarParsed('KUBE_STAGE', translateLegacyStagename);
 
     readonly installationLongname: string = getEnvVar("GITPOD_INSTALLATION_LONGNAME")
     readonly installationShortname: string = getEnvVar("GITPOD_INSTALLATION_SHORTNAME")