@gitpod/gitpod-protocol 0.1.5-update-ovsx.0 → 0.1.5-update-yarnlock.0

package/src/util/date-time.ts

@@ -1,30 +1,30 @@
 /**
- * Copyright (c) 2020 TypeFox GmbH. All rights reserved.
+ * 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.
  */
 
 export function formatDate(date?: string) {
-    return date ? new Date(date).toLocaleString() : '';
+    return date ? new Date(date).toLocaleString() : "";
 }
 
 export function formatHours(hours?: number) {
     if (hours === undefined) {
-        return '';
+        return "";
     }
     const h = Math.floor(Math.abs(hours));
-    const rm = (Math.abs(hours) - h) * 60.;
+    const rm = (Math.abs(hours) - h) * 60;
     const m = Math.floor(rm);
-    const rs = (rm - m) * 60.;
+    const rs = (rm - m) * 60;
     const s = Math.floor(rs);
-    const result = h + ':' + pad2(m) + ':' + pad2(s);
+    const result = h + ":" + pad2(m) + ":" + pad2(s);
     if (hours < 0) {
-        return `-${result}`
+        return `-${result}`;
     } else {
-        return `${result}`
+        return `${result}`;
     }
 }
 
 function pad2(n: number) {
-    return n  < 10 ? '0' + n : '' + n;
+    return n < 10 ? "0" + n : "" + n;
 }

package/src/util/debug-app.ts

@@ -0,0 +1,81 @@
+/**
+ * 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 * as http from "http";
+import * as express from "express";
+import { injectable, postConstruct } from "inversify";
+import { log, LogrusLogLevel } from "./logging";
+
+export interface SetLogLevelRequest {
+    level: LogrusLogLevel;
+}
+export namespace SetLogLevelRequest {
+    export function is(o: any): o is SetLogLevelRequest {
+        return typeof o === "object" && "level" in o;
+    }
+}
+
+@injectable()
+export class DebugApp {
+    protected _app: express.Application;
+    protected httpServer: http.Server | undefined = undefined;
+
+    @postConstruct()
+    public ctor() {
+        this._app = this.create();
+    }
+
+    create(): express.Application {
+        const app = express();
+
+        app.use(express.json());
+        app.use(express.urlencoded({ extended: true }));
+
+        app.post("/debug/logging", (req, res) => {
+            try {
+                const levelRequest = req.body;
+                if (!SetLogLevelRequest.is(levelRequest)) {
+                    res.status(400).end("not a SetLogLevelRequest");
+                    return;
+                }
+
+                const newLogLevel = levelRequest.level;
+                log.setLogLevel(newLogLevel);
+                log.info("set log level", { newLogLevel });
+                res.status(200).end(JSON.stringify(levelRequest));
+            } catch (err) {
+                res.status(500).end(err);
+            }
+        });
+        return app;
+    }
+
+    public start(port: number = 6060) {
+        this.httpServer = this._app.listen(port, "localhost", () => {
+            log.info(`debug server listening on port: ${port}`);
+        });
+    }
+
+    public async stop() {
+        const server = this.httpServer;
+        if (!server) {
+            return;
+        }
+        return new Promise<void>((resolve) =>
+            server.close((err: any) => {
+                if (err) {
+                    log.warn(`error while closing http server`, { err });
+                }
+                this.httpServer = undefined;
+                resolve();
+            }),
+        );
+    }
+
+    public get app(): express.Application {
+        return this._app;
+    }
+}

package/src/util/deep-partial.ts

@@ -1,7 +1,7 @@
 /**
- * Copyright (c) 2020 TypeFox GmbH. All rights reserved.
+ * 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.
  */
 
 /**

package/src/util/deferred.ts

@@ -1,7 +1,7 @@
 /**
- * Copyright (c) 2020 TypeFox GmbH. All rights reserved.
+ * 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.
  */
 
 export class Deferred<T> {
@@ -19,12 +19,12 @@ export class Deferred<T> {
     promise = new Promise<T>((resolve, reject) => {
         this.resolve = (o) => {
             this.isResolved = true;
-            resolve(o)
-            clearTimeout(this.timer)
+            resolve(o as any);
+            clearTimeout(this.timer);
         };
         this.reject = (e) => {
-            reject(e)
-            clearTimeout(this.timer)
-        }
+            reject(e);
+            clearTimeout(this.timer);
+        };
     });
-}
+}

package/src/util/disposable.ts

@@ -16,10 +16,10 @@ export interface Disposable {
 export namespace Disposable {
     export function create(func: () => void): Disposable {
         return {
-            dispose: func
+            dispose: func,
         };
     }
-    export const NULL = create(() => { });
+    export const NULL = create(() => {});
 }
 
 export class DisposableCollection implements Disposable {
@@ -69,9 +69,6 @@ export class DisposableCollection implements Disposable {
     }
 
     pushAll(disposables: Disposable[]): Disposable[] {
-        return disposables.map(disposable =>
-            this.push(disposable)
-        );
+        return disposables.map((disposable) => this.push(disposable));
     }
-
 }

package/src/util/event.ts

@@ -6,13 +6,12 @@
  */
 
 import { Disposable } from "./disposable";
-import { log } from './logging';
+import { log } from "./logging";
 
 /**
  * Represents a typed event.
  */
 export interface Event<T> {
-
     /**
      *
      * @param listener The listener function will be call when the event happens.
@@ -24,12 +23,13 @@ export interface Event<T> {
 }
 
 export namespace Event {
-    const _disposable = { dispose() { } };
-    export const None: Event<any> = function () { return _disposable; };
+    const _disposable = { dispose() {} };
+    export const None: Event<any> = function () {
+        return _disposable;
+    };
 }
 
 class CallbackList {
-
     private _callbacks: Function[] | undefined;
     private _contexts: any[] | undefined;
 
@@ -66,7 +66,7 @@ class CallbackList {
         }
 
         if (foundCallbackWithDifferentContext) {
-            throw new Error('When adding a listener with a context, you should remove it with the same context');
+            throw new Error("When adding a listener with a context, you should remove it with the same context");
         }
     }
 
@@ -105,14 +105,12 @@ export interface EmitterOptions {
 }
 
 export class Emitter<T> {
-
-    private static _noop = function () { };
+    private static _noop = function () {};
 
     private _event: Event<T>;
     private _callbacks: CallbackList | undefined;
 
-    constructor(private _options?: EmitterOptions) {
-    }
+    constructor(private _options?: EmitterOptions) {}
 
     /**
      * For the public to allow to subscribe
@@ -137,7 +135,7 @@ export class Emitter<T> {
                         if (this._options && this._options.onLastListenerRemove && this._callbacks!.isEmpty()) {
                             this._options.onLastListenerRemove(this);
                         }
-                    }
+                    },
                 };
                 if (Array.isArray(disposables)) {
                     disposables.push(result);

package/src/util/garbage-collected-cache.ts

@@ -1,9 +1,10 @@
 /**
- * Copyright (c) 2020 TypeFox GmbH. All rights reserved.
+ * 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.
  */
 
+import { repeat } from "./repeat";
 
 interface CacheEntry<T> {
     key: string;
@@ -13,13 +14,11 @@ interface CacheEntry<T> {
 
 export class GarbageCollectedCache<T> {
     protected readonly store = new Map<string, CacheEntry<T>>();
-    
-    constructor(
-        protected readonly defaultMaxAgeSeconds: number,
-        protected readonly gcIntervalSeconds: number) {
+
+    constructor(protected readonly defaultMaxAgeSeconds: number, protected readonly gcIntervalSeconds: number) {
         this.regularlyCollectGarbage();
     }
-    
+
     public set(key: string, value: T) {
         const oldValue = this.store.get(key);
         if (oldValue) {
@@ -38,11 +37,20 @@ export class GarbageCollectedCache<T> {
         if (!entry) {
             return undefined;
         }
+        // Still valid?
+        if (entry.expiryDate < Date.now()) {
+            this.store.delete(entry.key);
+            return undefined;
+        }
         return entry.value;
     }
 
+    public delete(key: string) {
+        this.store.delete(key);
+    }
+
     protected regularlyCollectGarbage() {
-        setInterval(() => this.collectGarbage(), this.gcIntervalSeconds * 1000);
+        repeat(() => this.collectGarbage(), this.gcIntervalSeconds * 1000);
     }
 
     protected collectGarbage() {
@@ -55,6 +63,6 @@ export class GarbageCollectedCache<T> {
     }
 
     protected calcExpiryDate(maxAgeSeconds?: number): number {
-        return Date.now() + ((maxAgeSeconds || this.defaultMaxAgeSeconds) * 1000);
+        return Date.now() + (maxAgeSeconds || this.defaultMaxAgeSeconds) * 1000;
     }
-}
+}

package/src/util/generate-workspace-id.spec.ts

@@ -0,0 +1,58 @@
+/**
+ * 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 { generateWorkspaceID, colors, animals } from "./generate-workspace-id";
+import { GitpodHostUrl } from "./gitpod-host-url";
+
+const expect = chai.expect;
+
+@suite
+class TestGenerateWorkspaceId {
+    @test public async testGenerateWorkspaceId() {
+        for (let i = 0; i < 10; i++) {
+            const id = await generateWorkspaceID();
+            expect(new GitpodHostUrl().withWorkspacePrefix(id, "eu").workspaceId).to.equal(id);
+        }
+    }
+
+    @test public testLongestName() {
+        const longestColor = colors.sort((a, b) => b.length - a.length)[0];
+        const longestAnimal = animals.sort((a, b) => b.length - a.length)[0];
+        const longestName = `${longestColor}-${longestAnimal}-12345678`;
+        expect(longestName.length <= 36, `"${longestName}" is longer than 36 chars (${longestName.length})`).to.be.true;
+    }
+
+    @test public async testCustomName() {
+        const data = [
+            ["foo", "bar", "foo-bar-"],
+            ["f", "bar", ".{2,16}-bar-"],
+            ["gitpod-io", "gitpod", "gitpodio-gitpod-"],
+            ["breatheco-de", "python-flask-api-tutorial", "breathecode-pythonflask-"],
+            ["short", "muchlongerthaneleven", "short-muchlongerthanel-"],
+            ["muchlongerthaneleven", "short", "muchlongerthanel-short-"],
+            [
+                'this is rather long and has some "§$"% special chars',
+                "also here pretty long and needs abbreviation",
+                "thisisrathe-alsoherepre-",
+            ],
+            ["UPPER", "CaSe", "upper-case-"],
+            [
+                "superlongfirstsegment",
+                "---------",
+                "superlong" /* we don't mantch for the whole first segment, because it has different length depending on the animal that is used to replace the -------*/,
+            ],
+        ];
+        for (const d of data) {
+            const id = await generateWorkspaceID(d[0], d[1]);
+            expect(id).match(new RegExp("^" + d[2]));
+            expect(new GitpodHostUrl().withWorkspacePrefix(id, "eu").workspaceId).to.equal(id);
+            expect(id.length <= 36, `"${id}" is longer than 36 chars (${id.length})`).to.be.true;
+        }
+    }
+}
+module.exports = new TestGenerateWorkspaceId();