@gitpod/gitpod-protocol 0.1.5-sje-installer-namespace-docs.0 → 0.1.5-sje-installer-migration-cmd.0

package/src/protocol.ts

@@ -104,6 +104,9 @@ export interface AdditionalUserData {
     oauthClientsApproved?: { [key: string]: string }
     // to remember GH Orgs the user installed/updated the GH App for
     knownGitHubOrgs?: string[];
+
+    // Git clone URL pointing to the user's dotfile repo
+    dotfileRepo?: string;
 }
 
 export interface EmailNotificationSettings {
@@ -588,7 +591,7 @@ export interface GithubAppPrebuildConfig {
     branches?: boolean
     pullRequests?: boolean
     pullRequestsFromForks?: boolean
-    addCheck?: boolean
+    addCheck?: boolean | 'prevent-merge-on-error'
     addBadge?: boolean
     addLabel?: boolean | string
     addComment?: boolean
@@ -684,6 +687,8 @@ export interface PortConfig {
     port: number;
     onOpen?: PortOnOpen;
     visibility?: PortVisibility;
+    description?: string;
+    name?: string;
 }
 export namespace PortConfig {
     export function is(config: any): config is PortConfig {
@@ -1170,39 +1175,6 @@ export namespace AuthProviderEntry {
     }
 }
 
-export interface Branding {
-    readonly name: string;
-    readonly favicon?: string;
-    /** Either including domain OR absolute path (interpreted relative to host URL) */
-    readonly logo: string;
-    readonly startupLogo: string;
-    readonly showProductivityTips: boolean;
-    readonly redirectUrlIfNotAuthenticated?: string;
-    readonly redirectUrlAfterLogout?: string;
-    readonly homepage: string;
-    readonly ide?: {
-        readonly logo: string;
-        readonly showReleaseNotes: boolean;
-        readonly helpMenu: Branding.Link[];
-    }
-    readonly links: {
-        readonly header: Branding.Link[];
-        readonly footer: Branding.Link[];
-        readonly social: Branding.SocialLink[];
-        readonly legal: Branding.Link[];
-    }
-}
-export namespace Branding {
-    export interface Link {
-        readonly name: string;
-        readonly url: string;
-    }
-    export interface SocialLink {
-        readonly type: string;
-        readonly url: string;
-    }
-}
-
 export interface Configuration {
     readonly daysBeforeGarbageCollection: number;
     readonly garbageCollectionStartDate: number;

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

@@ -27,5 +27,22 @@ const expect = chai.expect
         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-'],
+            ['this is rather long and has some "§$"% special chars','also here pretty long and needs abbreviation','thisisratherlon-alsohere-'],
+            ['breatheco-de', 'python-flask-api-tutorial', 'breathecode-pythonflaska-'],
+            ['UPPER', "CaSe", "upper-case-"]
+        ]
+        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()

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

@@ -5,8 +5,26 @@
  */
 import randomNumber = require("random-number-csprng");
 
-export async function generateWorkspaceID(): Promise<string> {
-    return (await random(colors))+'-'+(await random(animals))+'-'+(await random(characters, 8));
+export async function generateWorkspaceID(firstSegment?: string, secondSegment?: string): Promise<string> {
+    const firstSeg = clean(firstSegment) || await random(colors);
+    const secSeg = clean(secondSegment, Math.min(15, 23 - firstSeg.length)) || await random(animals);
+    return firstSeg+'-'+secSeg+'-'+(await random(characters, 11));
+}
+
+function clean(segment: string | undefined, maxChars: number = 15) {
+  if (!segment) {
+    return undefined;
+  }
+  segment = segment.toLowerCase();
+  let result = '';
+  for (let i =0; i < segment.length; i++) {
+    if (characters.indexOf(segment[i]) !== -1) {
+      result += segment[i];
+    }
+  }
+  if (result.length >= 2) {
+    return result.substring(0, maxChars);
+  }
 }
 
 async function random(array: string[], length: number = 1): Promise<string> {

package/src/util/gitpod-host-url.ts

@@ -12,13 +12,13 @@ export interface UrlChange {
 }
 export type UrlUpdate = UrlChange | Partial<URL>;
 
-const basewoWkspaceIDRegex = "(([a-f][0-9a-f]{7}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|([0-9a-z]{2,16}-[0-9a-z]{2,16}-[0-9a-z]{8}))";
+const baseWorkspaceIDRegex = "(([a-f][0-9a-f]{7}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|([0-9a-z]{2,16}-[0-9a-z]{2,16}-[0-9a-z]{8,11}))";
 
 // this pattern matches v4 UUIDs as well as the new generated workspace ids (e.g. pink-panda-ns35kd21)
-const workspaceIDRegex = RegExp(`^${basewoWkspaceIDRegex}$`);
+const workspaceIDRegex = RegExp(`^${baseWorkspaceIDRegex}$`);
 
 // this pattern matches URL prefixes of workspaces
-const workspaceUrlPrefixRegex = RegExp(`^([0-9]{4,6}-)?${basewoWkspaceIDRegex}\\.`);
+const workspaceUrlPrefixRegex = RegExp(`^([0-9]{4,6}-)?${baseWorkspaceIDRegex}\\.`);
 
 export class GitpodHostUrl {
     readonly url: URL;
@@ -108,10 +108,6 @@ export class GitpodHostUrl {
         return this.with(url => ({ pathname: '/preferences' }));
     }
 
-    asGraphQLApi(): GitpodHostUrl {
-        return this.with(url => ({ pathname: '/graphql/' }));
-    }
-
     asStart(workspaceId = this.workspaceId): GitpodHostUrl {
         return this.withoutWorkspacePrefix().with({
             pathname: '/start/',

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

@@ -4,7 +4,7 @@
  * 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`);

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 { initGlobalTracer } from 'opentracing';
+import { followsFrom, initGlobalTracer } from 'opentracing';
 import { injectable } from 'inversify';
 import { ResponseError } from 'vscode-jsonrpc';
 import { log, LogContext } from './logging';
@@ -22,13 +22,19 @@ export type TraceContextWithSpan = TraceContext & {
 
 
 export namespace TraceContext {
-    export function startSpan(operation: string, parentCtx?: TraceContext): opentracing.Span {
-        let options: opentracing.SpanOptions | undefined = undefined;
-        if (parentCtx) {
-            options = {
-                childOf: parentCtx.span
-            };
+    export function startSpan(operation: string, parentCtx?: TraceContext, ...referencedSpans: (opentracing.Span | undefined)[]): 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()));
+        }
+
         return opentracing.globalTracer().startSpan(operation, options);
     }
 
@@ -37,6 +43,24 @@ export namespace TraceContext {
         return { span };
     }
 
+    export function withSpan(operation: string, callback: () => void, ctx?: TraceContext, ...referencedSpans: (opentracing.Span | undefined)[]): 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, ...referencedSpans);
+        try {
+            callback();
+        } catch (e) {
+            TraceContext.setError({span}, e);
+            throw e;
+        } finally {
+            span.finish();
+        }
+    }
+
     export function setError(ctx: TraceContext, err: Error) {
         if (!ctx.span) {
             return;
@@ -68,13 +92,13 @@ export namespace TraceContext {
         addNestedTags(ctx, tags);
     }
 
-    export function setJsonRPCError(ctx: TraceContext, method: string, err: ResponseError<any>) {
+    export function setJsonRPCError(ctx: TraceContext, method: string, err: ResponseError<any>, withStatusCode: boolean = false) {
         if (!ctx.span) {
             return;
         }
         // not use setError bc this is (most likely) a working operation
 
-        setJsonRPCMetadata(ctx);
+        setJsonRPCMetadata(ctx, method);
         // https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/rpc.md#json-rpc
         addNestedTags(ctx, {
             rpc: {
@@ -84,6 +108,11 @@ export namespace TraceContext {
                 },
             },
         });
+
+        // the field "status_code" is used by honeycomb to derive insights like success rate, etc. Defaults to "0".
+        if (withStatusCode) {
+            ctx.span.setTag("status_code", err.code);
+        }
     }
 
     export function addJsonRPCParameters(ctx: TraceContext, params: { [key: string]: any }) {