@gitpod/gitpod-protocol 0.1.5-tweak-workspaceconfig-origin-docs-fork.0 → 0.1.5-update-yarnlock.0

package/src/util/logging.ts

@@ -1,11 +1,12 @@
 /**
  * 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.
  */
 
-const inspect: (object: any) => string = require('util').inspect;   // undefined in frontend
+const inspect: (object: any) => string = require("util").inspect; // undefined in frontend
 
+let plainLogging: boolean = false; // set to true during development to get non JSON output
 let jsonLogging: boolean = false;
 let component: string | undefined;
 let version: string | undefined;
@@ -15,19 +16,19 @@ export interface LogContext {
     sessionId?: string;
     userId?: string;
     workspaceId?: string;
-};
+}
 export namespace LogContext {
-    export function from(params : { userId?: string, user?: any, request?: any } ) {
+    export function from(params: { userId?: string; user?: any; request?: any }) {
         return <LogContext>{
             sessionId: params.request?.requestID,
-            userId: params.userId || params.user?.id
-        }
+            userId: params.userId || params.user?.id,
+        };
     }
 }
 
 export interface LogPayload {
     // placeholder to indicate that only dictionary-style objects should be passed as payload
-};
+}
 
 export namespace log {
     export function error(context: LogContext, message: string, error: any, payload: LogPayload): void;
@@ -97,7 +98,11 @@ export namespace log {
     /**
      * Do not use in frontend.
      */
-    export function enableJSONLogging(componentArg: string, versionArg: string | undefined, logLevel?: LogrusLogLevel): void {
+    export function enableJSONLogging(
+        componentArg: string,
+        versionArg: string | undefined,
+        logLevel?: LogrusLogLevel,
+    ): void {
         component = componentArg;
         version = versionArg;
 
@@ -109,16 +114,16 @@ export namespace log {
 
         console.error = function (...args: any[]): void {
             errorLog(true, args);
-        }
+        };
         console.warn = function (...args: any[]): void {
             warnLog(true, args);
-        }
+        };
         console.info = function (...args: any[]): void {
             infoLog(true, args);
-        }
+        };
         console.debug = function (...args: any[]): void {
             debugLog(true, args);
-        }
+        };
 
         console.log = console.info;
         // FIXME wrap also other console methods (e.g. trace())
@@ -154,26 +159,26 @@ type DoLogFunction = (calledViaConsole: boolean, args: any[]) => void;
 
 let errorLog = doErrorLog;
 function doErrorLog(calledViaConsole: boolean, args: any[]): void {
-    doLog(calledViaConsole, errorConsoleLog, 'ERROR', args);
+    doLog(calledViaConsole, errorConsoleLog, "ERROR", args);
 }
 
 let warnLog = doWarnLog;
 function doWarnLog(calledViaConsole: boolean, args: any[]): void {
-    doLog(calledViaConsole, warnConsoleLog, 'WARNING', args);
+    doLog(calledViaConsole, warnConsoleLog, "WARNING", args);
 }
 
 let infoLog = doInfoLog;
 function doInfoLog(calledViaConsole: boolean, args: any[]): void {
-    doLog(calledViaConsole, infoConsoleLog, 'INFO', args);
+    doLog(calledViaConsole, infoConsoleLog, "INFO", args);
 }
 
 let debugLog = doDebugLog;
 function doDebugLog(calledViaConsole: boolean, args: any[]): void {
-    doLog(calledViaConsole, debugConsoleLog, 'DEBUG', args);
+    doLog(calledViaConsole, debugConsoleLog, "DEBUG", args);
 }
 
 // Ref: https://github.com/sirupsen/logrus#level-logging
-export type LogrusLogLevel = keyof (typeof LogrusLogLevels);
+export type LogrusLogLevel = keyof typeof LogrusLogLevels;
 export const LogrusLogLevels = {
     trace: true,
     debug: true,
@@ -182,7 +187,7 @@ export const LogrusLogLevels = {
     error: true,
     fatal: true,
     panic: true,
-}
+};
 export namespace LogrusLogLevel {
     export function isGreatherOrEqual(lvl: LogrusLogLevel | undefined, ref: LogrusLogLevel | undefined): boolean {
         if (lvl === undefined) {
@@ -194,8 +199,7 @@ export namespace LogrusLogLevel {
         return getLevelArity(lvl) >= getLevelArity(ref);
     }
     function getLevelArity(lvl: LogrusLogLevel): number {
-        return Object.keys(LogrusLogLevels)
-            .findIndex((l) => l === lvl);
+        return Object.keys(LogrusLogLevels).findIndex((l) => l === lvl);
     }
     export function getFromEnv(): LogrusLogLevel | undefined {
         const lvlStr = process.env.LOG_LEVEL;
@@ -203,7 +207,7 @@ export namespace LogrusLogLevel {
             return undefined;
         }
         const lvl = lvlStr as LogrusLogLevel;
-        const exists = LogrusLogLevels[lvl]
+        const exists = LogrusLogLevels[lvl];
         if (!exists) {
             return undefined;
         }
@@ -212,12 +216,12 @@ export namespace LogrusLogLevel {
 }
 
 // Source: https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#LogSeverity
-type GoogleLogSeverity = 'EMERGENCY' | 'ALERT' | 'CRITICAL' | 'ERROR' | 'WARNING' | 'INFO' | 'DEBUG';
+type GoogleLogSeverity = "EMERGENCY" | "ALERT" | "CRITICAL" | "ERROR" | "WARNING" | "INFO" | "DEBUG";
 namespace GoogleLogSeverity {
     export const isGreaterOrEqualThanWarning = (severity: GoogleLogSeverity) => {
         switch (severity) {
-            case 'INFO':
-            case 'DEBUG':
+            case "INFO":
+            case "DEBUG":
                 return false;
             default:
                 return true;
@@ -245,7 +249,7 @@ function doLog(calledViaConsole: boolean, consoleLog: ConsoleLog, severity: Goog
         // console.xyz(Error, ...any) / log.xyz(Error) / log.xyz(Error, LogPayload)
         error = args[0];
         payloadArgs = args.slice(1);
-    } else if (typeof args[0] === 'string') {
+    } else if (typeof args[0] === "string") {
         message = args[0];
         if (args.length < 2 || !(args[1] instanceof Error)) {
             // console.xyz(string) / console.xyz(string, !Error, ...any) / log.xyz(string) / log.xyz(string, LogPayload)
@@ -265,7 +269,7 @@ function doLog(calledViaConsole: boolean, consoleLog: ConsoleLog, severity: Goog
             // log.xyz(LogContext, Error) / log.xyz(LogContext, Error, LogPayload)
             error = args[1];
             payloadArgs = args.slice(2);
-        } else if (typeof args[1] === 'string') {
+        } else if (typeof args[1] === "string") {
             message = args[1];
             if (args.length < 3 || !(args[2] instanceof Error)) {
                 // log.xyz(LogContext, string) / log.xyz(LogContext, string, LogPayload)
@@ -288,9 +292,14 @@ function doLog(calledViaConsole: boolean, consoleLog: ConsoleLog, severity: Goog
     }
 }
 
-function makeLogItem(severity: GoogleLogSeverity, context: LogContext | undefined, message: string | undefined,
-        error: Error | undefined, payloadArgs: any[], calledViaConsole: boolean): string | undefined {
-
+function makeLogItem(
+    severity: GoogleLogSeverity,
+    context: LogContext | undefined,
+    message: string | undefined,
+    error: Error | undefined,
+    payloadArgs: any[],
+    calledViaConsole: boolean,
+): string | undefined {
     if (context !== undefined && Object.keys(context).length == 0) {
         context = undefined;
     }
@@ -301,33 +310,40 @@ function makeLogItem(severity: GoogleLogSeverity, context: LogContext | undefine
     }
 
     const payload: any = payloadArgs.length == 0 ? undefined : payloadArgs.length == 1 ? payloadArgs[0] : payloadArgs;
-    const logItem: any = {
+    const logItem = {
         // undefined fields get eliminated in JSON.stringify()
         ...reportedErrorEvent,
         component,
         severity,
         time: new Date().toISOString(),
-        environment: process.env.KUBE_STAGE,
         context,
         message,
         error,
         payload,
-        loggedViaConsole: calledViaConsole ? true : undefined
+        loggedViaConsole: calledViaConsole ? true : undefined,
     };
+    if (plainLogging) {
+        return `[${logItem.severity}] [${logItem.component}] ${logItem.message}
+            ${JSON.stringify(payload || "", undefined, "              ")}
+            ${error || ""}
+        `.trim();
+    }
     let result: string = stringifyLogItem(logItem);
 
     if (result.length > maxAllowedLogItemLength && payload !== undefined) {
         delete logItem.payload;
-        logItem.payloadStub = `Payload stripped as log item was longer than ${maxAllowedLogItemLength} characters`;
+        (<any>(
+            logItem
+        )).payloadStub = `Payload stripped as log item was longer than ${maxAllowedLogItemLength} characters`;
 
         result = stringifyLogItem(logItem);
 
         if (result.length <= maxAllowedLogItemLength) {
-            log.warn('Log item too large, stripping payload', { logItemStub: makeLogItemStub(logItem) });
+            log.warn("Log item too large, stripping payload", { logItemStub: makeLogItemStub(logItem) });
         }
     }
     if (result.length > maxAllowedLogItemLength) {
-        log.error('Log item too large w/o payload, discarding', { logItemStub: makeLogItemStub(logItem) });
+        log.error("Log item too large w/o payload, discarding", { logItemStub: makeLogItemStub(logItem) });
         return undefined;
     }
 
@@ -341,10 +357,10 @@ function makeReportedErrorEvent(error: Error | undefined) {
         // Serves as marker only
         "@type": "type.googleapis.com/google.devtools.clouderrorreporting.v1beta1.ReportedErrorEvent",
         // This is useful for filtering in the UI
-        "serviceContext": {
-            "service": component || "<ts-not-set>",
-            "version": version || "<ts-not-set>",
-        }
+        serviceContext: {
+            service: component || "<ts-not-set>",
+            version: version || "<ts-not-set>",
+        },
     };
 
     if (error) {
@@ -364,9 +380,9 @@ function makeLogItemStub(logItem: any): any {
         severity: logItem.severity,
         time: logItem.time,
         environment: logItem.environment,
-        region: logItem.region
+        region: logItem.region,
     };
-    if (typeof (logItem.message) === 'string') {
+    if (typeof logItem.message === "string") {
         if (logItem.message.length <= maxMessageStubLength) {
             result.message = logItem.message;
         } else {
@@ -400,10 +416,12 @@ function stringifyLogItem(logItem: any): string {
  * Jsonifies Errors properly, not as {} only.
  */
 function jsonStringifyWithErrors(value: any): string {
-    return JSON.stringify(value, (key: string, value: any): any => { return value instanceof Error ? value.stack : value });
+    return JSON.stringify(value, (key: string, value: any): any => {
+        return value instanceof Error ? value.stack : value;
+    });
 }
 
-type ConsoleLog = (message?: any, ...optionalArgs: any[]) => void;  // signature of console.xyz
+type ConsoleLog = (message?: any, ...optionalArgs: any[]) => void; // signature of console.xyz
 const logConsoleLog: ConsoleLog = console.log;
 const errorConsoleLog: ConsoleLog = console.error;
 const warnConsoleLog: ConsoleLog = console.warn;

package/src/util/make-link.ts

@@ -1,22 +1,21 @@
 /**
  * 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.
  */
 
 function isOpenNewTab(event: MouseEvent): boolean {
-    return event.metaKey || (event.ctrlKey);
+    return event.metaKey || event.ctrlKey;
 }
 
 export function makeLink(node: HTMLElement, url: string, hover: string): void {
-    node.onclick = event => {
-        let target = '_self';
+    node.onclick = (event) => {
+        let target = "_self";
         if (isOpenNewTab(event)) {
-            target = '_blank';
+            target = "_blank";
         }
         window.open(url, target);
-    }
-    node.style.cursor = 'pointer';
+    };
+    node.style.cursor = "pointer";
     node.title = hover;
 }
-

package/src/util/nice-grpc.ts

@@ -0,0 +1,96 @@
+/**
+ * Copyright (c) 2022 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 { isAbortError } from "abort-controller-x";
+import {
+    CallOptions,
+    ClientError,
+    ClientMiddleware,
+    ClientMiddlewareCall,
+    Status,
+    MethodDescriptor,
+} from "nice-grpc-common";
+import { GrpcMethodType, IClientCallMetrics } from "./grpc";
+
+function getLabels(method: MethodDescriptor) {
+    const callType = method.requestStream
+        ? method.responseStream
+            ? "bidi_stream"
+            : "client_stream"
+        : method.responseStream
+        ? "server_stream"
+        : "unary";
+    const { path } = method;
+    const [serviceName, methodName] = path.split("/").slice(1);
+
+    return {
+        type: callType as GrpcMethodType,
+        service: serviceName,
+        method: methodName,
+    };
+}
+
+async function* incrementStreamMessagesCounter<T>(iterable: AsyncIterable<T>, callback: () => void): AsyncIterable<T> {
+    for await (const item of iterable) {
+        callback();
+        yield item;
+    }
+}
+
+export function prometheusClientMiddleware(metrics: IClientCallMetrics): ClientMiddleware {
+    return async function* prometheusClientMiddlewareGenerator<Request, Response>(
+        call: ClientMiddlewareCall<Request, Response>,
+        options: CallOptions,
+    ): AsyncGenerator<Response, Response | void, undefined> {
+        const labels = getLabels(call.method);
+
+        metrics.started(labels);
+
+        const stopTimer = metrics.startHandleTimer(labels);
+
+        let settled = false;
+        let status: Status = Status.OK;
+
+        try {
+            let request;
+
+            if (!call.requestStream) {
+                request = call.request;
+            } else {
+                request = incrementStreamMessagesCounter(call.request, metrics.sent.bind(metrics, labels));
+            }
+
+            if (!call.responseStream) {
+                const response = yield* call.next(request, options);
+                settled = true;
+                return response;
+            } else {
+                yield* incrementStreamMessagesCounter(
+                    call.next(request, options),
+                    metrics.received.bind(metrics, labels),
+                );
+                settled = true;
+                return;
+            }
+        } catch (err) {
+            settled = true;
+            if (err instanceof ClientError) {
+                status = err.code;
+            } else if (isAbortError(err)) {
+                status = Status.CANCELLED;
+            } else {
+                status = Status.UNKNOWN;
+            }
+            throw err;
+        } finally {
+            if (!settled) {
+                status = Status.CANCELLED;
+            }
+            stopTimer({ grpc_code: Status[status] });
+            metrics.handled({ ...labels, code: Status[status] });
+        }
+    };
+}

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

@@ -1,17 +1,20 @@
 /**
  * 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 * as chai from 'chai';
-import { suite, test } from 'mocha-typescript';
-import { matchesInstanceIdOrLegacyWorkspaceIdExactly, matchesNewWorkspaceIdExactly, parseWorkspaceIdFromHostname } from './parse-workspace-id';
+import * as chai from "chai";
+import { suite, test } from "mocha-typescript";
+import {
+    matchesInstanceIdOrLegacyWorkspaceIdExactly,
+    matchesNewWorkspaceIdExactly,
+    parseWorkspaceIdFromHostname,
+} from "./parse-workspace-id";
 const expect = chai.expect;
 
 @suite
 export class ParseWorkspaceIdTest {
-
     @test public parseWorkspaceIdFromHostname_fromWorkspaceLocation() {
         const actual = parseWorkspaceIdFromHostname("moccasin-ferret-155799b3.ws-eu01.gitpod.io");
         expect(actual).to.equal("moccasin-ferret-155799b3");
@@ -28,7 +31,9 @@ export class ParseWorkspaceIdTest {
     }
 
     @test public parseWorkspaceIdFromHostname_fromWorkspacePortLocationWithWebviewPrefixCustomHost() {
-        const actual = parseWorkspaceIdFromHostname("webview-3000-moccasin-ferret-155799b3.ws-eu01.some.subdomain.somehost.com");
+        const actual = parseWorkspaceIdFromHostname(
+            "webview-3000-moccasin-ferret-155799b3.ws-eu01.some.subdomain.somehost.com",
+        );
         expect(actual).to.equal("moccasin-ferret-155799b3");
     }
 
@@ -44,12 +49,16 @@ export class ParseWorkspaceIdTest {
     }
 
     @test public parseLegacyWorkspaceIdFromHostname_fromWorkspacePortLocationWithWebviewPrefix() {
-        const actual = parseWorkspaceIdFromHostname("webview-3000-b7e0eaf8-ec73-44ec-81ea-04859263b656.ws-eu01.gitpod.io");
+        const actual = parseWorkspaceIdFromHostname(
+            "webview-3000-b7e0eaf8-ec73-44ec-81ea-04859263b656.ws-eu01.gitpod.io",
+        );
         expect(actual).to.equal("b7e0eaf8-ec73-44ec-81ea-04859263b656");
     }
 
     @test public parseLegacyWorkspaceIdFromHostname_fromWorkspacePortLocationWithWebviewPrefixCustomHost() {
-        const actual = parseWorkspaceIdFromHostname("webview-3000-ca81a50f-09d7-465c-acd9-264a747d5351.ws-eu01.some.subdomain.somehost.com");
+        const actual = parseWorkspaceIdFromHostname(
+            "webview-3000-ca81a50f-09d7-465c-acd9-264a747d5351.ws-eu01.some.subdomain.somehost.com",
+        );
         expect(actual).to.equal("ca81a50f-09d7-465c-acd9-264a747d5351");
     }
 
@@ -73,4 +82,4 @@ export class ParseWorkspaceIdTest {
         expect(actual).to.be.false;
     }
 }
-module.exports = new ParseWorkspaceIdTest()
+module.exports = new ParseWorkspaceIdTest();

package/src/util/parse-workspace-id.ts

@@ -1,10 +1,10 @@
 /**
  * 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.
  */
 
-const REGEX_WORKSPACE_ID = /[0-9a-z]{2,16}-[0-9a-z]{2,16}-[0-9a-z]{8}/;
+const REGEX_WORKSPACE_ID = /[0-9a-z]{2,16}-[0-9a-z]{2,16}-[0-9a-z]{8,11}/;
 const REGEX_WORKSPACE_ID_EXACT = new RegExp(`^${REGEX_WORKSPACE_ID.source}$`);
 // We need to parse the workspace id precisely here to get the case '<some-str>-<port>-<wsid>.ws.' right
 const REGEX_WORKSPACE_ID_FROM_HOSTNAME = new RegExp(`(${REGEX_WORKSPACE_ID.source})\.ws`);
@@ -20,7 +20,7 @@ const REGEX_WORKSPACE_ID_LEGACY_FROM_HOSTNAME = new RegExp(`(${REGEX_WORKSPACE_I
  *  - webview-1234-moccasin-ferret-155799b3.ws-eu01.gitpod.io (or any other string replacing webview)
  * @param hostname The hostname the request is headed to
  */
-export const parseWorkspaceIdFromHostname = function(hostname: string) {
+export const parseWorkspaceIdFromHostname = function (hostname: string) {
     const match = REGEX_WORKSPACE_ID_FROM_HOSTNAME.exec(hostname);
     if (match && match.length >= 2) {
         return match[1];
@@ -41,15 +41,14 @@ const REGEX_INSTANCE_ID_EXACT = new RegExp(`^${REGEX_INSTANCE_ID.source}$`);
  * @param maybeId
  * @returns
  */
-export const matchesInstanceIdOrLegacyWorkspaceIdExactly = function(maybeId: string): boolean {
-    return REGEX_INSTANCE_ID_EXACT.test(maybeId)
-        || REGEX_WORKSPACE_ID_LEGACY_EXACT.test(maybeId);
+export const matchesInstanceIdOrLegacyWorkspaceIdExactly = function (maybeId: string): boolean {
+    return REGEX_INSTANCE_ID_EXACT.test(maybeId) || REGEX_WORKSPACE_ID_LEGACY_EXACT.test(maybeId);
 };
 
 /**
  * @param maybeWorkspaceId
  * @returns
  */
-export const matchesNewWorkspaceIdExactly = function(maybeWorkspaceId: string): boolean {
+export const matchesNewWorkspaceIdExactly = function (maybeWorkspaceId: string): boolean {
     return REGEX_WORKSPACE_ID_EXACT.test(maybeWorkspaceId);
-};
+};

package/src/util/queue.spec.ts

@@ -1,22 +1,22 @@
 /**
  * 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 { suite, test, slow, timeout } from 'mocha-typescript'
-import * as chai from 'chai'
-const chaiSubset = require('chai-subset');
+import { suite, test, slow, timeout } from "mocha-typescript";
+import * as chai from "chai";
+const chaiSubset = require("chai-subset");
 chai.use(chaiSubset);
 
-import { Queue } from '..';
-import { fail } from 'assert';
-import { Deferred } from './deferred';
+import { Queue } from "..";
+import { fail } from "assert";
+import { Deferred } from "./deferred";
 
-const expect = chai.expect
-
-@suite class QueueSpec {
+const expect = chai.expect;
 
+@suite
+class QueueSpec {
     queue: Queue;
     seq: number[];
 
@@ -35,8 +35,7 @@ const expect = chai.expect
                             resolve(undefined);
                         }, sleep);
                     });
-                else
-                    this.seq.push(seqNr);
+                else this.seq.push(seqNr);
             };
 
             if (nextTick)
@@ -45,20 +44,22 @@ const expect = chai.expect
                         push().then(resolve);
                     });
                 });
-            else
-                await push();
+            else await push();
         });
     }
     execError(seqNr: number): Deferred<boolean> {
         const deferred = new Deferred<boolean>();
-        this.queue.enqueue(async () => {
-            this.seq.push(seqNr);
-            throw new Error('test error');
-        }).then(() => {
-            deferred.reject(false);
-        }).catch(() => {
-            deferred.resolve(true);
-        });
+        this.queue
+            .enqueue(async () => {
+                this.seq.push(seqNr);
+                throw new Error("test error");
+            })
+            .then(() => {
+                deferred.reject(false);
+            })
+            .catch(() => {
+                deferred.resolve(true);
+            });
 
         return deferred;
     }
@@ -67,7 +68,9 @@ const expect = chai.expect
         expect(actual).to.have.lengthOf(expected.length);
         const expIt = expected.entries();
         for (const act of actual) {
-            const { value: [, exp] } = expIt.next();
+            const {
+                value: [, exp],
+            } = expIt.next();
             expect(act).to.deep.equal(exp);
         }
     }
@@ -93,7 +96,6 @@ const expect = chai.expect
         this.expectArray(this.seq, [1, 2]);
     }
 
-
     @test public async continueDespiteError() {
         this.exec(1);
         const receivedError = this.execError(2);
@@ -107,7 +109,7 @@ const expect = chai.expect
     @test public async mustCatchError() {
         const f = async () => {
             throw new Error();
-        }
+        };
         try {
             const p = this.queue.enqueue(async () => {
                 return f();
@@ -124,7 +126,7 @@ const expect = chai.expect
     @test public async expectUncaughtError() {
         const f = async () => {
             throw new Error();
-        }
+        };
         const p = this.queue.enqueue(async () => {
             return f();
         });

package/src/util/queue.ts

@@ -1,7 +1,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.
  */
 
 import { Deferred } from "./deferred";

package/src/util/repeat.ts

@@ -0,0 +1,45 @@
+/**
+ * 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 { Disposable } from "..";
+import { log } from "./logging";
+
+/**
+ * This intends to be a drop-in replacement for 'setInterval' implemented with a 'setTimeout' chain
+ * to ensure we're not creating more timeouts than we can process.
+ * @param op
+ * @param everyMilliseconds
+ * @returns
+ */
+export function repeat(op: () => Promise<void> | void, everyMilliseconds: number): Disposable {
+    let timer: NodeJS.Timeout | undefined = undefined;
+    let stopped = false;
+    const repeated = () => {
+        if (stopped) {
+            // in case we missed the clearTimeout i 'await'
+            return;
+        }
+
+        timer = setTimeout(async () => {
+            try {
+                await op();
+            } catch (err) {
+                // catch error here to
+                log.error(err);
+            }
+
+            repeated(); // chain ourselves - after the 'await'
+        }, everyMilliseconds);
+    };
+    repeated();
+
+    return Disposable.create(() => {
+        stopped = true;
+        if (timer) {
+            clearTimeout(timer);
+        }
+    });
+}