@gitpod/gitpod-protocol 0.1.5-sje-installation-admin-dashboard.22 → 0.1.5-sje-installer-fun.1

package/src/util/tracing.ts

@@ -4,35 +4,32 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-
-import * as opentracing from 'opentracing';
-import { TracingConfig, initTracerFromEnv } from 'jaeger-client';
-import { Sampler, SamplingDecision } from './jaeger-client-types';
-import { followsFrom, initGlobalTracer } from 'opentracing';
-import { injectable } from 'inversify';
-import { ResponseError } from 'vscode-jsonrpc';
-import { log, LogContext } from './logging';
+import * as opentracing from "opentracing";
+import { TracingConfig, initTracerFromEnv } from "jaeger-client";
+import { Sampler, SamplingDecision } from "./jaeger-client-types";
+import { initGlobalTracer } from "opentracing";
+import { injectable } from "inversify";
+import { ResponseError } from "vscode-jsonrpc";
+import { log, LogContext } from "./logging";
 
 export interface TraceContext {
-    span?: opentracing.Span
+    span?: opentracing.Span;
 }
 export type TraceContextWithSpan = TraceContext & {
-    span: opentracing.Span
-}
-
+    span: opentracing.Span;
+};
 
 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 && 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)
-            // 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()));
+
+        // references should contain span id.
+        // cf. https://github.com/jaegertracing/jaeger-client-node/issues/432
+        if (!!parentCtx?.span) {
+            const ctx = parentCtx?.span?.context();
+            if (ctx && !!ctx.toTraceId() && !!ctx.toSpanId()) {
+                options.references = [opentracing.followsFrom(ctx)];
+            }
         }
 
         return opentracing.globalTracer().startSpan(operation, options);
@@ -43,18 +40,18 @@ export namespace TraceContext {
         return { span };
     }
 
-    export function withSpan(operation: string, callback: () => void, ctx?: TraceContext, ...referencedSpans: (opentracing.Span | undefined)[]): void {
+    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();
+            callback({});
             return;
         }
 
-        const span = TraceContext.startSpan(operation, ctx, ...referencedSpans);
+        const span = TraceContext.startSpan(operation, ctx);
         try {
-            callback();
+            callback({ span });
         } catch (e) {
-            TraceContext.setError({span}, e);
+            TraceContext.setError({ span }, e);
             throw e;
         } finally {
             span.finish();
@@ -92,7 +89,12 @@ export namespace TraceContext {
         addNestedTags(ctx, tags);
     }
 
-    export function setJsonRPCError(ctx: TraceContext, method: string, err: ResponseError<any>, withStatusCode: boolean = false) {
+    export function setJsonRPCError(
+        ctx: TraceContext,
+        method: string,
+        err: ResponseError<any>,
+        withStatusCode: boolean = false,
+    ) {
         if (!ctx.span) {
             return;
         }
@@ -159,7 +161,7 @@ export namespace TraceContext {
         if (!ctx.span) {
             return;
         }
-        const namespace = _namespace ? `${_namespace}.` : '';
+        const namespace = _namespace ? `${_namespace}.` : "";
 
         try {
             for (const k of Object.keys(keyValueMap)) {
@@ -188,7 +190,6 @@ export namespace TraceContext {
 
 @injectable()
 export class TracingManager {
-
     public setup(serviceName: string, opts?: CustomTracerOpts) {
         initGlobalTracer(this.getTracerForService(serviceName, opts));
     }
@@ -197,16 +198,16 @@ export class TracingManager {
         const config: TracingConfig = {
             disable: false,
             reporter: {
-                logSpans: false
+                logSpans: false,
             },
             serviceName,
-        }
+        };
         const t = initTracerFromEnv(config, {
             logger: console,
             tags: {
-                'service.build.commit': process.env.GITPOD_BUILD_GIT_COMMIT,
-                'service.build.version': process.env.GITPOD_BUILD_VERSION,
-            }
+                "service.build.commit": process.env.GITPOD_BUILD_GIT_COMMIT,
+                "service.build.version": process.env.GITPOD_BUILD_VERSION,
+            },
         });
 
         if (opts) {
@@ -216,24 +217,22 @@ export class TracingManager {
         }
         return t;
     }
-
 }
 
 export interface CustomTracerOpts {
-    perOpSampling?: PerOperationSampling
+    perOpSampling?: PerOperationSampling;
 }
 
-
 // has to conform to https://github.com/jaegertracing/jaeger-client-node/blob/0042b1c0a0796bb655eb93e77ff76ab5e94c2bb6/src/_flow/sampler-thrift.js#L32
 export interface PerOperationSampling {
-    [key: string]: boolean
+    [key: string]: boolean;
 }
 
 export class PerOperationSampler implements Sampler {
     constructor(protected readonly fallback: Sampler, protected readonly strategies: PerOperationSampling) {}
 
     name(): string {
-        return 'PerOperationSampler';
+        return "PerOperationSampler";
     }
 
     toString(): string {
@@ -273,7 +272,7 @@ export class PerOperationSampler implements Sampler {
         return false; // TODO equal should be removed
     }
 
-    close(callback: ()=>void): void {
+    close(callback: () => void): void {
         // all nested samplers are of simple types, so we do not need to Close them
         if (callback) {
             callback();
@@ -282,18 +281,23 @@ export class PerOperationSampler implements Sampler {
 }
 
 // Augment interfaces with an leading parameter "TraceContext" on every method
-type IsValidArg<T> = T extends object ? keyof T extends never ? false : true : true;
-type AddTraceContext<T> =
-    T extends (a: infer A, b: infer B, c: infer C, d: infer D, e: infer E, f: infer F) => infer R ? (
-        IsValidArg<F> extends true ? (ctx: TraceContextWithSpan, a: A, b: B, c: C, d: D, e: E, f: F) => R :
-        IsValidArg<E> extends true ? (ctx: TraceContextWithSpan, a: A, b: B, c: C, d: D, e: E) => R :
-        IsValidArg<D> extends true ? (ctx: TraceContextWithSpan, a: A, b: B, c: C, d: D) => R :
-        IsValidArg<C> extends true ? (ctx: TraceContextWithSpan, a: A, b: B, c: C) => R :
-        IsValidArg<B> extends true ? (ctx: TraceContextWithSpan, a: A, b: B) => R :
-        IsValidArg<A> extends true ? (ctx: TraceContextWithSpan, a: A) => R :
-        (ctx: TraceContextWithSpan) => Promise<R>
-    ) : never;
+type IsValidArg<T> = T extends object ? (keyof T extends never ? false : true) : true;
+type AddTraceContext<T> = T extends (a: infer A, b: infer B, c: infer C, d: infer D, e: infer E, f: infer F) => infer R
+    ? IsValidArg<F> extends true
+        ? (ctx: TraceContextWithSpan, a: A, b: B, c: C, d: D, e: E, f: F) => R
+        : IsValidArg<E> extends true
+        ? (ctx: TraceContextWithSpan, a: A, b: B, c: C, d: D, e: E) => R
+        : IsValidArg<D> extends true
+        ? (ctx: TraceContextWithSpan, a: A, b: B, c: C, d: D) => R
+        : IsValidArg<C> extends true
+        ? (ctx: TraceContextWithSpan, a: A, b: B, c: C) => R
+        : IsValidArg<B> extends true
+        ? (ctx: TraceContextWithSpan, a: A, b: B) => R
+        : IsValidArg<A> extends true
+        ? (ctx: TraceContextWithSpan, a: A) => R
+        : (ctx: TraceContextWithSpan) => Promise<R>
+    : never;
 
 export type InterfaceWithTraceContext<T> = {
-    [P in keyof T]: AddTraceContext<T[P]>
-};
+    [P in keyof T]: AddTraceContext<T[P]>;
+};

package/src/util/workspace-port-authentication.ts

@@ -5,16 +5,13 @@
  */
 
 /**
-* These cookies are set in the Theia frontend. This pattern is relied upon in:
-*  - proxy:
-*    - to filter it out on port locations
-*    - to forward it to the server for authentication
-*  - server:
-*    - to authenticate access to port locations
-*/
-export const worspacePortAuthCookieName = function(host: string, workspaceId: string): string {
-    return host
-        .replace(/https?/, '')
-        .replace(/[\W_]+/g, "_")
-        + `_ws_${workspaceId}_port_auth_`;
-};
+ * These cookies are set in the Theia frontend. This pattern is relied upon in:
+ *  - proxy:
+ *    - to filter it out on port locations
+ *    - to forward it to the server for authentication
+ *  - server:
+ *    - to authenticate access to port locations
+ */
+export const worspacePortAuthCookieName = function (host: string, workspaceId: string): string {
+    return host.replace(/https?/, "").replace(/[\W_]+/g, "_") + `_ws_${workspaceId}_port_auth_`;
+};

package/src/workspace-cluster.ts

@@ -4,10 +4,10 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import * as fs from 'fs';
-import { filePathTelepresenceAware } from './env';
+import * as fs from "fs";
+import { filePathTelepresenceAware } from "./env";
 import { DeepPartial } from "./util/deep-partial";
-import { PermissionName } from './permission';
+import { PermissionName } from "./permission";
 
 export interface WorkspaceCluster {
     // Name of the workspace cluster.
@@ -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";
@@ -50,19 +47,33 @@ export interface TLSConfig {
     crt: string;
 }
 export namespace TLSConfig {
-    export const loadFromBase64File = (path: string): string => fs.readFileSync(filePathTelepresenceAware(path)).toString("base64");
+    export const loadFromBase64File = (path: string): string =>
+        fs.readFileSync(filePathTelepresenceAware(path)).toString("base64");
 }
 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 AdmissionConstraintHasUserLevel = { type: "has-user-level", level: string };
-
-export type AdmissionPreference = AdmissionPreferenceUserLevel;
-export type AdmissionPreferenceUserLevel = { type: 'user-level', level: string };
-
+export type AdmissionConstraintHasPermission = { type: "has-permission"; permission: PermissionName };
+export type AdmissionConstraintHasUserLevel = { type: "has-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 {
@@ -93,4 +104,4 @@ export interface WorkspaceClusterDB {
 }
 export interface WorkspaceClusterFilter extends Pick<WorkspaceCluster, "state" | "govern" | "url"> {
     minScore: number;
-}
+}

package/src/workspace-instance.ts

@@ -51,6 +51,23 @@ 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;
+
+    /**
+     * workspace class, also known as workspace size, determines the type of
+     * resources that are provided to the workspace.
+     */
+    workspaceClass?: string;
+
+    /**
+     * Identifies the team or user to which this instance's runtime should be attributed to
+     * (e.g. for usage analytics or billing purposes).
+     */
+    usageAttributionId?: string;
 }
 
 // WorkspaceInstanceStatus describes the current state of a workspace instance
@@ -90,49 +107,54 @@ export interface WorkspaceInstanceStatus {
 export type WorkspaceInstancePhase =
     // unknown indicates an issue within the system in that it cannot determine the actual phase of
     // a workspace. This phase is usually accompanied by an error.
-    "unknown" |
+    | "unknown"
 
     // Preparing means that we haven't actually started the workspace instance just yet, but rather
-    // are still preparing for launch. This means we're building the Docker image for the workspace.
-    "preparing" |
+    // are still preparing for launch.
+    | "preparing"
+
+    // Building means that we are building the Docker image for the workspace. A workspace will enter this phase only
+    // if an image build is required for that workspace.
+    | "building"
 
     // Pending means the workspace does not yet consume resources in the cluster, but rather is looking for
     // some space within the cluster. If for example the cluster needs to scale up to accomodate the
     // workspace, the workspace will be in Pending state until that happened.
-    "pending" |
+    | "pending"
 
     // Creating means the workspace is currently being created. Thati includes downloading the images required
     // to run the workspace over the network. The time spent in this phase varies widely and depends on the current
     // network speed, image size and cache states.
-    "creating" |
+    | "creating"
 
     // Initializing is the phase in which the workspace is executing the appropriate workspace initializer (e.g. Git
     // clone or backup download). After this phase one can expect the workspace to either be Running or Failed.
-    "initializing" |
+    | "initializing"
 
     // Running means the workspace is able to actively perform work, either by serving a user through Theia,
     // or as a headless workspace.
-    "running" |
+    | "running"
 
     // Interrupted is an exceptional state where the container should be running but is temporarily unavailable.
     // When in this state, we expect it to become running or stopping anytime soon.
-    "interrupted" |
+    | "interrupted"
 
     // Stopping means that the workspace is currently shutting down. It could go to stopped every moment.
-    "stopping" |
+    | "stopping"
 
     // Stopped means the workspace ended regularly because it was shut down.
-    "stopped";
+    | "stopped";
 
 export interface WorkspaceInstanceConditions {
     // Failed contains the reason the workspace failed to operate. If this field is empty, the workspace has not failed.
-    failed?: string
+    // failed contains technical details for the failure of the workspace.
+    failed?: string;
 
     // timeout contains the reason the workspace has timed out. If this field is empty, the workspace has not timed out.
-    timeout?: string
+    timeout?: string;
 
     // PullingImages marks if the workspace is currently pulling its images. This condition can only be set during PhaseCreating
-    pullingImages?: boolean
+    pullingImages?: boolean;
 
     // deployed marks that a workspace instance was sent/deployed at a workspace manager
     deployed?: boolean;
@@ -143,7 +165,10 @@ export interface WorkspaceInstanceConditions {
     // ISO8601 timestamp when the first user activity was registered in the frontend. Only set if the workspace is running.
     firstUserActivity?: string;
 
-    // headless_task_failed indicates that a headless workspace task failed
+    // headlessTaskFailed indicates that a headless workspace task failed
+    // headlessTaskFailed is only set if:
+    //  * this workspace is headless
+    //  * the task being run returned a non 0 exit status code
     headlessTaskFailed?: string;
 
     // stopped_by_request is true if the workspace was stopped using a StopWorkspace call
@@ -151,10 +176,10 @@ export interface WorkspaceInstanceConditions {
 }
 
 // AdmissionLevel describes who can access a workspace instance and its ports.
-export type AdmissionLevel = 'owner_only' | 'everyone';
+export type AdmissionLevel = "owner_only" | "everyone";
 
 // PortVisibility describes how a port can be accessed
-export type PortVisibility = 'public' | 'private';
+export type PortVisibility = "public" | "private";
 
 // WorkspaceInstancePort describes a port exposed on a workspace instance
 export interface WorkspaceInstancePort {
@@ -180,19 +205,25 @@ export interface WorkspaceInstanceRepoStatus {
     uncommitedFiles?: string[];
 
     // the total number of uncommited files
-    totalUncommitedFiles?: number
+    totalUncommitedFiles?: number;
 
     // untrackedFiles is the list of untracked files in the workspace, possibly truncated
     untrackedFiles?: string[];
 
     // the total number of untracked files
-    totalUntrackedFiles?: number
+    totalUntrackedFiles?: number;
 
     // unpushedCommits is the list of unpushed changes in the workspace, possibly truncated
     unpushedCommits?: string[];
 
     // the total number of unpushed changes
-    totalUnpushedCommits?: number
+    totalUnpushedCommits?: number;
+}
+
+// ConfigurationIdeConfig ide config of WorkspaceInstanceConfiguration
+export interface ConfigurationIdeConfig {
+    useLatest?: boolean;
+    desktopIdeAlias?: string;
 }
 
 // WorkspaceInstanceConfiguration contains all per-instance configuration
@@ -208,8 +239,25 @@ export interface WorkspaceInstanceConfiguration {
     ideImage: string;
 
     // desktopIdeImage is the ref of the desktop IDE image this instance uses.
-    desktopIdeImage?: string
+    desktopIdeImage?: string;
 
     // supervisorImage is the ref of the supervisor image this instance uses.
     supervisorImage?: string;
+
+    ideConfig?: ConfigurationIdeConfig;
+}
+
+/**
+ * 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/src/wsready.ts

@@ -1,10 +1,10 @@
 /**
- * Copyright (c) 2021 Gitpod GmbH. All rights reserved.
+ * 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.
  */
 
-// generated using github.com/32leaves/bel on 2021-11-04 12:16:53.917570766 +0000 UTC m=+0.006002884
+// generated using github.com/32leaves/bel on 2022-05-18 18:19:49.011672619 +0000 UTC m=+0.006607361
 // DO NOT MODIFY
 
 export enum WorkspaceInitSource {
@@ -13,5 +13,5 @@ export enum WorkspaceInitSource {
     WorkspaceInitFromOther = "from-other",
 }
 export interface WorkspaceReadyMessage {
-    source: WorkspaceInitSource
+    source: WorkspaceInitSource;
 }