@gitpod/gitpod-protocol 0.1.5-me-ingress.14 → 0.1.5-me-image.3

package/src/util/tracing.ts

@@ -8,7 +8,7 @@
 import * as opentracing from 'opentracing';
 import { TracingConfig, initTracerFromEnv } from 'jaeger-client';
 import { Sampler, SamplingDecision } from './jaeger-client-types';
-import { followsFrom, initGlobalTracer } from 'opentracing';
+import { initGlobalTracer } from 'opentracing';
 import { injectable } from 'inversify';
 import { ResponseError } from 'vscode-jsonrpc';
 import { log, LogContext } from './logging';
@@ -22,15 +22,19 @@ export type TraceContextWithSpan = TraceContext & {
 
 
 export namespace TraceContext {
-    export function startSpan(operation: string, parentCtx?: TraceContext, ...referencedSpans: (opentracing.Span | undefined)[]): opentracing.Span {
+    export function startSpan(operation: string, parentCtx?: TraceContext): opentracing.Span {
         const options: opentracing.SpanOptions = {};
-        if (parentCtx) {
+        if (parentCtx && parentCtx.span && !!parentCtx.span.context().toSpanId()) {
             options.childOf = parentCtx.span;
         }
-        if (referencedSpans) {
-            // note: allthough followsForm's type says it takes 'opentracing.Span | opentracing.SpanContext', it only works with SpanContext (typing mismatch)
-            options.references = referencedSpans.filter(s => s !== undefined).map(s => followsFrom(s!.context()));
-        }
+        // TODO(gpl) references lead to a huge amount of errors in prod logs. Avoid those until we have time to figure out how to fix it.
+        // if (referencedSpans) {
+        //     // note: allthough followsForm's type says it takes 'opentracing.Span | opentracing.SpanContext', it only works with SpanContext (typing mismatch)
+        //     // note2: we need to filter out debug spans (spanId === "")
+        //     options.references = referencedSpans.filter(s => s !== undefined)
+        //         .filter(s => !!s!.context().toSpanId())
+        //         .map(s => followsFrom(s!.context()));
+        // }
 
         return opentracing.globalTracer().startSpan(operation, options);
     }
@@ -40,6 +44,24 @@ export namespace TraceContext {
         return { span };
     }
 
+    export function withSpan(operation: string, callback: (ctx: TraceContext) => void, ctx?: TraceContext): void {
+        // if we don't have a parent span, don't create a trace here as those <trace-without-root-spans> are not useful.
+        if (!ctx || !ctx.span || !ctx.span.context()) {
+            callback({});
+            return;
+        }
+
+        const span = TraceContext.startSpan(operation, ctx);
+        try {
+            callback({span});
+        } catch (e) {
+            TraceContext.setError({span}, e);
+            throw e;
+        } finally {
+            span.finish();
+        }
+    }
+
     export function setError(ctx: TraceContext, err: Error) {
         if (!ctx.span) {
             return;

package/src/workspace-cluster.ts

@@ -35,9 +35,6 @@ export interface WorkspaceCluster {
 
     // An optional set of constraints that limit who can start workspaces on the cluster
     admissionConstraints?: AdmissionConstraint[];
-
-    // An optional set of admission preferences that guide cluster selection
-    admissionPreferences?: AdmissionPreference[];
 }
 
 export type WorkspaceClusterState = "available" | "cordoned" | "draining";
@@ -55,14 +52,25 @@ export namespace TLSConfig {
 export type WorkspaceClusterWoTLS = Omit<WorkspaceCluster, "tls">;
 export type WorkspaceManagerConnectionInfo = Pick<WorkspaceCluster, "name" | "url" | "tls">;
 
-export type AdmissionConstraint = AdmissionConstraintFeaturePreview | AdmissionConstraintHasRole | AdmissionConstraintHasUserLevel;
+export type AdmissionConstraint = AdmissionConstraintFeaturePreview | AdmissionConstraintHasPermission | AdmissionConstraintHasUserLevel | AdmissionConstraintHasMoreResources;
 export type AdmissionConstraintFeaturePreview = { type: "has-feature-preview" };
-export type AdmissionConstraintHasRole = { type: "has-permission", permission: PermissionName };
+export type AdmissionConstraintHasPermission = { type: "has-permission", permission: PermissionName };
 export type AdmissionConstraintHasUserLevel = { type: "has-user-level", level: string };
-
-export type AdmissionPreference = AdmissionPreferenceUserLevel;
-export type AdmissionPreferenceUserLevel = { type: 'user-level', level: string };
-
+export type AdmissionConstraintHasMoreResources = { type: "has-more-resources" };
+
+export namespace AdmissionConstraint {
+    export function is(o: any): o is AdmissionConstraint {
+        return !!o
+            && 'type' in o;
+    }
+    export function isHasPermissionConstraint(o: any): o is AdmissionConstraintHasPermission {
+        return is(o)
+            && o.type === "has-permission";
+    }
+    export function hasPermission(ac: AdmissionConstraint, permission: PermissionName): boolean {
+        return isHasPermissionConstraint(ac) && ac.permission === permission;
+    }
+}
 
 export const WorkspaceClusterDB = Symbol("WorkspaceClusterDB");
 export interface WorkspaceClusterDB {

package/src/workspace-instance.ts

@@ -51,6 +51,11 @@ export interface WorkspaceInstance {
 
     // instance is hard-deleted on the database and about to be collected by db-sync
     readonly deleted?: boolean;
+
+    /**
+     * Contains information about the image build, if there was any
+     */
+     imageBuildInfo?: ImageBuildInfo;
 }
 
 // WorkspaceInstanceStatus describes the current state of a workspace instance
@@ -213,3 +218,18 @@ export interface WorkspaceInstanceConfiguration {
     // supervisorImage is the ref of the supervisor image this instance uses.
     supervisorImage?: string;
 }
+
+/**
+ * Holds information about the image build (if there was one) for this WorkspaceInstance
+ */
+export interface ImageBuildInfo {
+    log?: ImageBuildLogInfo,
+}
+
+/**
+ * Holds information about how to access logs for this an image build
+ */
+export interface ImageBuildLogInfo {
+    url: string,
+    headers: { [key: string]: string },
+}

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
-        });
-    };
-}