@gitpod/gitpod-protocol 0.1.5-to-new-image.2 → 0.1.5-to-monitor-delete.18

package/src/util/gitpod-cookie.ts

@@ -3,8 +3,7 @@
  * Licensed under the GNU Affero General Public License (AGPL).
  * See License-AGPL.txt in the project root for license information.
  */
-import * as cookie from 'cookie';
-
+import * as cookie from "cookie";
 
 /**
  * This cookie indicates whether the connected client is a Gitpod user (= "has logged in within the last year") or not.
@@ -20,20 +19,20 @@ export const VALUE = "true";
 export function options(domain: string): cookie.CookieSerializeOptions {
     // Reference: https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies
     return {
-        path: "/",                          // make sure we send the cookie to all sub-pages
+        path: "/", // make sure we send the cookie to all sub-pages
         httpOnly: false,
         secure: false,
-        maxAge: 60 * 60 * 24 * 365,         // 1 year
-        sameSite: "lax",                    // default: true. "Lax" needed to ensure we see cookies from users that neavigate to gitpod.io from external sites
-        domain: `.${domain}`,               // explicilty include subdomains to not only cover "gitpod.io", but also "www.gitpod.io" or workspaces
+        maxAge: 60 * 60 * 24 * 365, // 1 year
+        sameSite: "lax", // default: true. "Lax" needed to ensure we see cookies from users that neavigate to gitpod.io from external sites
+        domain: `.${domain}`, // explicilty include subdomains to not only cover "gitpod.io", but also "www.gitpod.io" or workspaces
     };
-};
+}
 
 export function generateCookie(domain: string): string {
     return cookie.serialize(NAME, VALUE, options(domain));
-};
+}
 
 export function isPresent(cookies: string): boolean {
     // needs to match the old (gitpod-user=loggedIn) and new (gitpod-user=true) values to ensure a smooth transition during rollout.
     return !!cookies.match(`${NAME}=`);
-};
+}

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

@@ -4,46 +4,73 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import * as chai from 'chai';
-import { suite, test } from 'mocha-typescript';
-import { GitpodHostUrl } from './gitpod-host-url';
+import * as chai from "chai";
+import { suite, test } from "mocha-typescript";
+import { GitpodHostUrl } from "./gitpod-host-url";
 const expect = chai.expect;
 
 @suite
 export class GitpodHostUrlTest {
-
     @test public parseWorkspaceId_pathBased() {
-        const actual = GitpodHostUrl.fromWorkspaceUrl("http://35.223.201.195/workspace/bc77e03d-c781-4235-bca0-e24087f5e472/").workspaceId;
+        const actual = GitpodHostUrl.fromWorkspaceUrl(
+            "http://35.223.201.195/workspace/bc77e03d-c781-4235-bca0-e24087f5e472/",
+        ).workspaceId;
         expect(actual).to.equal("bc77e03d-c781-4235-bca0-e24087f5e472");
     }
 
     @test public parseWorkspaceId_hosts_withEnvVarsInjected() {
-        const actual = GitpodHostUrl.fromWorkspaceUrl("https://gray-grasshopper-nfbitfia.ws-eu02.gitpod-staging.com/#passedin=test%20value/https://github.com/gitpod-io/gitpod-test-repo").workspaceId;
+        const actual = GitpodHostUrl.fromWorkspaceUrl(
+            "https://gray-grasshopper-nfbitfia.ws-eu02.gitpod-staging.com/#passedin=test%20value/https://github.com/gitpod-io/gitpod-test-repo",
+        ).workspaceId;
         expect(actual).to.equal("gray-grasshopper-nfbitfia");
     }
 
     @test public async testWithoutWorkspacePrefix() {
-        expect(GitpodHostUrl.fromWorkspaceUrl("https://3000-moccasin-ferret-155799b3.ws-eu02.gitpod-staging.com/").withoutWorkspacePrefix().toString()).to.equal("https://gitpod-staging.com/");
+        expect(
+            GitpodHostUrl.fromWorkspaceUrl("https://3000-moccasin-ferret-155799b3.ws-eu02.gitpod-staging.com/")
+                .withoutWorkspacePrefix()
+                .toString(),
+        ).to.equal("https://gitpod-staging.com/");
     }
 
     @test public async testWithoutWorkspacePrefix2() {
-        expect(GitpodHostUrl.fromWorkspaceUrl("https://gitpod-staging.com/").withoutWorkspacePrefix().toString()).to.equal("https://gitpod-staging.com/");
+        expect(
+            GitpodHostUrl.fromWorkspaceUrl("https://gitpod-staging.com/").withoutWorkspacePrefix().toString(),
+        ).to.equal("https://gitpod-staging.com/");
     }
 
     @test public async testWithoutWorkspacePrefix3() {
-        expect(GitpodHostUrl.fromWorkspaceUrl("https://gray-rook-5523v5d8.ws-dev.my-branch-1234.staging.gitpod-dev.com/").withoutWorkspacePrefix().toString()).to.equal("https://my-branch-1234.staging.gitpod-dev.com/");
+        expect(
+            GitpodHostUrl.fromWorkspaceUrl("https://gray-rook-5523v5d8.ws-dev.my-branch-1234.staging.gitpod-dev.com/")
+                .withoutWorkspacePrefix()
+                .toString(),
+        ).to.equal("https://my-branch-1234.staging.gitpod-dev.com/");
     }
 
     @test public async testWithoutWorkspacePrefix4() {
-        expect(GitpodHostUrl.fromWorkspaceUrl("https://my-branch-1234.staging.gitpod-dev.com/").withoutWorkspacePrefix().toString()).to.equal("https://my-branch-1234.staging.gitpod-dev.com/");
+        expect(
+            GitpodHostUrl.fromWorkspaceUrl("https://my-branch-1234.staging.gitpod-dev.com/")
+                .withoutWorkspacePrefix()
+                .toString(),
+        ).to.equal("https://my-branch-1234.staging.gitpod-dev.com/");
     }
 
     @test public async testWithoutWorkspacePrefix5() {
-        expect(GitpodHostUrl.fromWorkspaceUrl("https://abc-nice-brunch-4224.staging.gitpod-dev.com/").withoutWorkspacePrefix().toString()).to.equal("https://abc-nice-brunch-4224.staging.gitpod-dev.com/");
+        expect(
+            GitpodHostUrl.fromWorkspaceUrl("https://abc-nice-brunch-4224.staging.gitpod-dev.com/")
+                .withoutWorkspacePrefix()
+                .toString(),
+        ).to.equal("https://abc-nice-brunch-4224.staging.gitpod-dev.com/");
     }
 
     @test public async testWithoutWorkspacePrefix6() {
-        expect(GitpodHostUrl.fromWorkspaceUrl("https://gray-rook-5523v5d8.ws-dev.abc-nice-brunch-4224.staging.gitpod-dev.com/").withoutWorkspacePrefix().toString()).to.equal("https://abc-nice-brunch-4224.staging.gitpod-dev.com/");
+        expect(
+            GitpodHostUrl.fromWorkspaceUrl(
+                "https://gray-rook-5523v5d8.ws-dev.abc-nice-brunch-4224.staging.gitpod-dev.com/",
+            )
+                .withoutWorkspacePrefix()
+                .toString(),
+        ).to.equal("https://abc-nice-brunch-4224.staging.gitpod-dev.com/");
     }
 }
-module.exports = new GitpodHostUrlTest()
+module.exports = new GitpodHostUrlTest();

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

@@ -4,15 +4,16 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-const URL = require('url').URL || window.URL;
-import { log } from './logging';
+const URL = require("url").URL || window.URL;
+import { log } from "./logging";
 
 export interface UrlChange {
-    (old: URL): Partial<URL>
+    (old: URL): Partial<URL>;
 }
 export type UrlUpdate = UrlChange | Partial<URL>;
 
-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}))";
+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(`^${baseWorkspaceIDRegex}$`);
@@ -24,15 +25,15 @@ export class GitpodHostUrl {
     readonly url: URL;
 
     constructor(urlParam?: string | URL) {
-        if (urlParam === undefined || typeof urlParam === 'string') {
-            this.url = new URL(urlParam || 'https://gitpod.io');
-            this.url.search = '';
-            this.url.hash = '';
-            this.url.pathname = '';
+        if (urlParam === undefined || typeof urlParam === "string") {
+            this.url = new URL(urlParam || "https://gitpod.io");
+            this.url.search = "";
+            this.url.hash = "";
+            this.url.pathname = "";
         } else if (urlParam instanceof URL) {
             this.url = urlParam;
         } else {
-            log.error('Unexpected urlParam', { urlParam });
+            log.error("Unexpected urlParam", { urlParam });
         }
     }
 
@@ -45,7 +46,7 @@ export class GitpodHostUrl {
     }
 
     withDomainPrefix(prefix: string): GitpodHostUrl {
-        return this.with(url => ({ host: prefix + url.host }));;
+        return this.with((url) => ({ host: prefix + url.host }));
     }
 
     withoutWorkspacePrefix(): GitpodHostUrl {
@@ -58,14 +59,14 @@ export class GitpodHostUrl {
     }
 
     withoutDomainPrefix(removeSegmentsCount: number): GitpodHostUrl {
-        return this.with(url => ({ host: url.host.split('.').splice(removeSegmentsCount).join('.') }));
+        return this.with((url) => ({ host: url.host.split(".").splice(removeSegmentsCount).join(".") }));
     }
 
     with(urlUpdate: UrlUpdate) {
-        const update = typeof urlUpdate === 'function' ? urlUpdate(this.url) : urlUpdate;
-        const addSlashToPath = update.pathname && update.pathname.length > 0 && !update.pathname.startsWith('/');
+        const update = typeof urlUpdate === "function" ? urlUpdate(this.url) : urlUpdate;
+        const addSlashToPath = update.pathname && update.pathname.length > 0 && !update.pathname.startsWith("/");
         if (addSlashToPath) {
-            update.pathname = '/' + update.pathname;
+            update.pathname = "/" + update.pathname;
         }
         const result = Object.assign(new URL(this.toString()), update);
         return new GitpodHostUrl(result);
@@ -73,50 +74,57 @@ export class GitpodHostUrl {
 
     withApi(urlUpdate?: UrlUpdate) {
         const updated = urlUpdate ? this.with(urlUpdate) : this;
-        return updated.with(url => ({ pathname: `/api${url.pathname}` }));
+        return updated.with((url) => ({ pathname: `/api${url.pathname}` }));
     }
 
     withContext(contextUrl: string) {
-        return this.with(url => ({ hash: contextUrl }));
+        return this.with((url) => ({ hash: contextUrl }));
     }
 
     asWebsocket(): GitpodHostUrl {
-        return this.with(url => ({ protocol: url.protocol === 'https:' ? 'wss:' : 'ws:' }));
+        return this.with((url) => ({ protocol: url.protocol === "https:" ? "wss:" : "ws:" }));
+    }
+
+    asWorkspacePage(): GitpodHostUrl {
+        return this.with((url) => ({ pathname: "/workspaces" }));
     }
 
     asDashboard(): GitpodHostUrl {
-        return this.with(url => ({ pathname: '/' }));
+        return this.with((url) => ({ pathname: "/" }));
     }
 
     asLogin(): GitpodHostUrl {
-        return this.with(url => ({ pathname: '/login' }));
+        return this.with((url) => ({ pathname: "/login" }));
     }
 
     asUpgradeSubscription(): GitpodHostUrl {
-        return this.with(url => ({ pathname: '/plans' }));
+        return this.with((url) => ({ pathname: "/plans" }));
     }
 
     asAccessControl(): GitpodHostUrl {
-        return this.with(url => ({ pathname: '/integrations' }));
+        return this.with((url) => ({ pathname: "/integrations" }));
     }
 
     asSettings(): GitpodHostUrl {
-        return this.with(url => ({ pathname: '/settings' }));
+        return this.with((url) => ({ pathname: "/settings" }));
     }
 
     asPreferences(): GitpodHostUrl {
-        return this.with(url => ({ pathname: '/preferences' }));
+        return this.with((url) => ({ pathname: "/preferences" }));
     }
 
     asStart(workspaceId = this.workspaceId): GitpodHostUrl {
         return this.withoutWorkspacePrefix().with({
-            pathname: '/start/',
-            hash: '#' + workspaceId
+            pathname: "/start/",
+            hash: "#" + workspaceId,
         });
     }
 
     asWorkspaceAuth(instanceID: string, redirect?: boolean): GitpodHostUrl {
-        return this.with(url => ({ pathname: `/api/auth/workspace-cookie/${instanceID}`, search: redirect ? "redirect" : "" }));
+        return this.with((url) => ({
+            pathname: `/api/auth/workspace-cookie/${instanceID}`,
+            search: redirect ? "redirect" : "",
+        }));
     }
 
     toString() {
@@ -125,7 +133,7 @@ export class GitpodHostUrl {
 
     toStringWoRootSlash() {
         let result = this.toString();
-        if (result.endsWith('/')) {
+        if (result.endsWith("/")) {
             result = result.slice(0, result.length - 1);
         }
         return result;
@@ -142,7 +150,7 @@ export class GitpodHostUrl {
             }
         }
 
-        const pathSegs = this.url.pathname.split("/")
+        const pathSegs = this.url.pathname.split("/");
         if (pathSegs.length > 3 && pathSegs[1] === "workspace") {
             return pathSegs[2];
         }
@@ -152,20 +160,36 @@ export class GitpodHostUrl {
 
     get blobServe(): boolean {
         const hostSegments = this.url.host.split(".");
-        if (hostSegments[0] === 'blobserve') {
+        if (hostSegments[0] === "blobserve") {
             return true;
         }
 
-        const pathSegments = this.url.pathname.split("/")
+        const pathSegments = this.url.pathname.split("/");
         return pathSegments[0] === "blobserve";
     }
 
     asSorry(message: string) {
-        return this.with({ pathname: '/sorry', hash: message });
+        return this.with({ pathname: "/sorry", hash: message });
     }
 
     asApiLogout(): GitpodHostUrl {
-        return this.withApi(url => ({ pathname: '/logout/' }));
+        return this.withApi((url) => ({ pathname: "/logout/" }));
+    }
+
+    asIDEProxy(): GitpodHostUrl {
+        const hostSegments = this.url.host.split(".");
+        if (hostSegments[0] === "ide") {
+            return this;
+        }
+        return this.with((url) => ({ host: "ide." + url.host }));
     }
 
+    asIDEMetrics(): GitpodHostUrl {
+        let newUrl: GitpodHostUrl = this;
+        const hostSegments = this.url.host.split(".");
+        if (hostSegments[0] !== "ide") {
+            newUrl = newUrl.asIDEProxy();
+        }
+        return newUrl.with((url) => ({ pathname: "/metrics-api" }));
+    }
 }

package/src/util/grpc.ts

@@ -4,7 +4,10 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
- export const defaultGRPCOptions = {
+import * as grpc from "@grpc/grpc-js";
+import { Status } from "@grpc/grpc-js/build/src/constants";
+
+export const defaultGRPCOptions = {
     "grpc.keepalive_timeout_ms": 10000,
     "grpc.keepalive_time_ms": 60000,
     "grpc.http2.min_time_between_pings_ms": 10000,
@@ -13,3 +16,89 @@
     "grpc.max_reconnect_backoff_ms": 5000,
     "grpc.max_receive_message_length": 1024 * 1024 * 16,
 };
+
+export type GrpcMethodType = "unary" | "client_stream" | "server_stream" | "bidi_stream";
+
+export interface IGrpcCallMetricsLabels {
+    service: string;
+    method: string;
+    type: GrpcMethodType;
+}
+
+export interface IGrpcCallMetricsLabelsWithCode extends IGrpcCallMetricsLabels {
+    code: string;
+}
+
+export const IClientCallMetrics = Symbol("IClientCallMetrics");
+
+export interface IClientCallMetrics {
+    started(labels: IGrpcCallMetricsLabels): void;
+    sent(labels: IGrpcCallMetricsLabels): void;
+    received(labels: IGrpcCallMetricsLabels): void;
+    handled(labels: IGrpcCallMetricsLabelsWithCode): void;
+}
+
+export function getGrpcMethodType(requestStream: boolean, responseStream: boolean): GrpcMethodType {
+    if (requestStream) {
+        if (responseStream) {
+            return "bidi_stream";
+        } else {
+            return "client_stream";
+        }
+    } else {
+        if (responseStream) {
+            return "server_stream";
+        } else {
+            return "unary";
+        }
+    }
+}
+
+export function createClientCallMetricsInterceptor(metrics: IClientCallMetrics): grpc.Interceptor {
+    return (options, nextCall): grpc.InterceptingCall => {
+        const methodDef = options.method_definition;
+        const method = methodDef.path.substring(methodDef.path.lastIndexOf("/") + 1);
+        const service = methodDef.path.substring(1, methodDef.path.length - method.length - 1);
+        const labels = {
+            service,
+            method,
+            type: getGrpcMethodType(options.method_definition.requestStream, options.method_definition.responseStream),
+        };
+        const requester = new grpc.RequesterBuilder()
+            .withStart((metadata, listener, next) => {
+                const newListener = new grpc.ListenerBuilder()
+                    .withOnReceiveStatus((status, next) => {
+                        try {
+                            metrics.handled({
+                                ...labels,
+                                code: Status[status.code],
+                            });
+                        } finally {
+                            next(status);
+                        }
+                    })
+                    .withOnReceiveMessage((message, next) => {
+                        try {
+                            metrics.received(labels);
+                        } finally {
+                            next(message);
+                        }
+                    })
+                    .build();
+                try {
+                    metrics.started(labels);
+                } finally {
+                    next(metadata, newListener);
+                }
+            })
+            .withSendMessage((message, next) => {
+                try {
+                    metrics.sent(labels);
+                } finally {
+                    next(message);
+                }
+            })
+            .build();
+        return new grpc.InterceptingCall(nextCall(options), requester);
+    };
+}

package/src/util/jaeger-client-types.ts

@@ -93,10 +93,10 @@ export interface SamplingDecision {
 
 // added by TypeFox
 export interface Sampler {
-    name(): string
+    name(): string;
     isSampled(operation: string, tags: any): boolean;
     onCreateSpan(span: opentracing.Span): SamplingDecision;
     onSetOperationName(span: opentracing.Span, operationName: string): SamplingDecision;
     onSetTag(span: opentracing.Span, key: string, value: any): SamplingDecision;
-    close(callback: () => void): void
+    close(callback: () => void): void;
 }

package/src/util/logging.spec.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 { suite, test } from "mocha-typescript";
+import { log } from "./logging";
+
+@suite
+class TestLogging {
+    @test public async testLogInfo_output() {
+        const testObj = {
+            null: null,
+            undefined: undefined,
+            empty: "",
+            foo: "bar",
+            number: 0,
+        };
+        log.info("info logging test", testObj);
+    }
+}
+module.exports = new TestLogging();