@gitpod/gitpod-protocol 0.1.5-se-external-config.13 → 0.1.5-se-workspace-for-teams.5

package/lib/wsready.js

@@ -6,7 +6,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WorkspaceInitSource = void 0;
-// generated using github.com/32leaves/bel on 2021-06-09 13:14:02.32194335 +0000 UTC m=+0.009503424
+// generated using github.com/32leaves/bel on 2021-08-03 10:42:32.582603295 +0000 UTC m=+0.005734479
 // DO NOT MODIFY
 var WorkspaceInitSource;
 (function (WorkspaceInitSource) {

package/lib/wsready.js.map

@@ -1 +1 @@
-{"version":3,"file":"wsready.js","sourceRoot":"","sources":["../src/wsready.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,mGAAmG;AACnG,gBAAgB;AAEhB,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC3B,8DAAuC,CAAA;IACvC,kEAA2C,CAAA;IAC3C,4DAAqC,CAAA;AACzC,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B"}
+{"version":3,"file":"wsready.js","sourceRoot":"","sources":["../src/wsready.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,oGAAoG;AACpG,gBAAgB;AAEhB,IAAY,mBAIX;AAJD,WAAY,mBAAmB;IAC3B,8DAAuC,CAAA;IACvC,kEAA2C,CAAA;IAC3C,4DAAqC,CAAA;AACzC,CAAC,EAJW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAI9B"}

package/package.json

@@ -6,19 +6,22 @@
     "jaeger-client": "3.17.2",
     "js-yaml": "^3.10.0",
     "opentracing": "^0.14.4",
-    "prom-client": "^10.2.0",
+    "prom-client": "^13.2.0",
     "random-number-csprng": "^1.0.2",
-    "reconnecting-websocket": "^4.2.0",
+    "reconnecting-websocket": "^4.4.0",
     "reflect-metadata": "^0.1.10",
     "uuid": "^3.3.3",
+    "vscode-jsonrpc": "^5.0.1",
+    "vscode-languageserver-protocol": "3.15.3",
     "vscode-uri": "^1.0.1",
     "vscode-ws-jsonrpc": "^0.2.0",
-    "ws": "^5.2.2"
+    "ws": "^7.4.6"
   },
   "devDependencies": {
     "@types/analytics-node": "^3.1.4",
     "@types/chai-subset": "^1.3.1",
     "@types/js-yaml": "^3.10.1",
+    "@types/mocha": "^5.2.7",
     "@types/random-number-csprng": "^1.0.0",
     "@types/uuid": "^3.4.5",
     "@types/ws": "^5.1.2",
@@ -29,7 +32,7 @@
     "rimraf": "^2.6.2",
     "ts-node": "^9.0.0",
     "typescript": "~4.1.2",
-    "typescript-json-schema": "^0.43.0",
+    "typescript-json-schema": "^0.50.1",
     "typescript-parser": "^2.6.1"
   },
   "files": [
@@ -45,9 +48,9 @@
     "build": "tsc",
     "clean": "rimraf lib",
     "prepare": "yarn run clean && yarn run build",
-    "test": "mocha --opts mocha.opts '**/*.spec.ts'",
+    "test": "mocha --opts mocha.opts './**/*.spec.ts' --exclude './node_modules/**'",
     "watch": "leeway exec --package .:lib --transitive-dependencies --filter-type yarn --components --parallel -- tsc -w --preserveWatchOutput"
   },
   "types": "./lib/index.d.ts",
-  "version": "0.1.5-se-external-config.13"
+  "version": "0.1.5-se-workspace-for-teams.5"
 }

package/pkg-yarn.lock

@@ -4,7 +4,7 @@
 
 "@gitpod/gitpod-protocol@0.1.5":
   version "0.1.5"
-  resolved "file:///tmp/cache/dc30594bc8e7acf833a60875a372fc93952f3ab6.tar.gz"
+  resolved "file:///tmp/cache/546be1ec8ab4c413a119c49a2a3ebe96936f599e.tar.gz"
   dependencies:
     ajv "^6.5.4"
     analytics-node "^4.0.1"
@@ -12,12 +12,14 @@
     jaeger-client "3.17.2"
     js-yaml "^3.10.0"
     opentracing "^0.14.4"
-    prom-client "^10.2.0"
+    prom-client "^13.2.0"
     random-number-csprng "^1.0.2"
-    reconnecting-websocket "^4.2.0"
+    reconnecting-websocket "^4.4.0"
     reflect-metadata "^0.1.10"
     uuid "^3.3.3"
+    vscode-jsonrpc "^5.0.1"
+    vscode-languageserver-protocol "3.15.3"
     vscode-uri "^1.0.1"
     vscode-ws-jsonrpc "^0.2.0"
-    ws "^5.2.2"
+    ws "^7.4.6"
 

package/src/accounting-protocol.ts

@@ -5,7 +5,6 @@
  */
 
  import * as uuidv4 from 'uuid/v4';
-import { Without } from "./util/without";
 import { User } from './protocol';
 import { oneMonthLater } from './util/timeutil';
 
@@ -47,7 +46,7 @@ export interface AccountEntry {
     description?: object;
 }
 export namespace AccountEntry {
-    export function create<T extends AccountEntry>(entry: Without<T, 'uid'>): T {
+    export function create<T extends AccountEntry>(entry: Omit<T, 'uid'>): T {
         const result = entry as T;
         result.uid = uuidv4();
         return result;
@@ -164,7 +163,7 @@ export namespace AssignedTeamSubscription {
 }
 
 export namespace Subscription {
-    export function create(newSubscription: Without<Subscription, 'uid'>) {
+    export function create(newSubscription: Omit<Subscription, 'uid'>) {
         const subscription = newSubscription as Subscription;
         subscription.uid = uuidv4();
         return subscription;
@@ -193,9 +192,6 @@ export namespace Subscription {
     export function isDowngraded(s: Subscription) {
         return s.paymentData && s.paymentData.downgradeDate;
     };
-    export function isCancelled(s: Subscription) {
-        return !!s.cancellationDate;
-    };
     export function calculateCurrentPeriod(startDate: string, now: Date) {
         let nextStartDate = startDate;
         do {
@@ -215,7 +211,7 @@ export interface Period {
 
 export type MaybePeriod = Period | undefined;
 
-export type AccountEntryFixedPeriod = Without<AccountEntry, 'uid'> & { expiryDate: string };
+export type AccountEntryFixedPeriod = Omit<AccountEntry, 'uid'> & { expiryDate: string };
 export interface AccountStatement extends Period {
     userId: string;
     /**

package/src/admin-protocol.ts

@@ -5,7 +5,6 @@
  */
 
 import { User, Workspace, NamedWorkspaceFeatureFlag } from "./protocol";
-import { Without } from "./util/without";
 import { WorkspaceInstance, WorkspaceInstancePhase } from "./workspace-instance";
 import { RoleOrPermission } from "./permission";
 import { AccountStatement } from "./accounting-protocol";
@@ -66,7 +65,7 @@ export interface AdminModifyPermanentWorkspaceFeatureFlagRequest {
     }[]
 }
 
-export interface WorkspaceAndInstance extends Without<Workspace, "id"|"creationTime">, Without<WorkspaceInstance, "id"|"creationTime"> {
+export interface WorkspaceAndInstance extends Omit<Workspace, "id"|"creationTime">, Omit<WorkspaceInstance, "id"|"creationTime"> {
     workspaceId: string;
     workspaceCreationTime: string;
     instanceId: string;

package/src/analytics.ts

@@ -0,0 +1,39 @@
+/**
+ * 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.
+ */
+
+
+export const IAnalyticsWriter = Symbol("IAnalyticsWriter");
+
+type Identity =
+    | { userId: string | number }
+    | { userId?: string | number; anonymousId: string | number };
+
+interface Message {
+    messageId?: string;
+}
+
+export type IdentifyMessage = Message & Identity & {
+    traits?: any;
+    timestamp?: Date;
+    context?: any;
+};
+
+export type TrackMessage = Message & Identity & {
+    event: string;
+    properties?: any;
+    timestamp?: Date;
+    context?: any;
+};
+
+export type RemoteTrackMessage = Omit<TrackMessage, "timestamp" | "userId" | "anonymousId">;
+
+export interface IAnalyticsWriter {
+
+    identify(msg: IdentifyMessage): void;
+
+    track(msg: TrackMessage): void;
+
+}

package/src/context-url.spec.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 * as chai from 'chai';
+import { suite, test } from 'mocha-typescript';
+import { ContextURL } from './context-url';
+const expect = chai.expect;
+
+@suite
+export class ContextUrlTest {
+
+    @test public parseContextUrl_withEnvVar() {
+        const actual = ContextURL.parseToURL("passedin=test%20value/https://github.com/gitpod-io/gitpod-test-repo");
+        expect(actual?.host).to.equal("github.com");
+        expect(actual?.pathname).to.equal("/gitpod-io/gitpod-test-repo");
+    }
+
+    @test public parseContextUrl_withEnvVar_withoutSchema() {
+        const actual = ContextURL.parseToURL("passedin=test%20value/github.com/gitpod-io/gitpod-test-repo");
+        expect(actual?.host).to.equal("github.com");
+        expect(actual?.pathname).to.equal("/gitpod-io/gitpod-test-repo");
+    }
+
+    @test public parseContextUrl_withPrebuild() {
+        const actual = ContextURL.parseToURL("prebuild/https://github.com/gitpod-io/gitpod-test-repo");
+        expect(actual?.host).to.equal("github.com");
+        expect(actual?.pathname).to.equal("/gitpod-io/gitpod-test-repo");
+    }
+
+    @test public parseContextUrl_withPrebuild_withoutSchema() {
+        const actual = ContextURL.parseToURL("prebuild/github.com/gitpod-io/gitpod-test-repo");
+        expect(actual?.host).to.equal("github.com");
+        expect(actual?.pathname).to.equal("/gitpod-io/gitpod-test-repo");
+    }
+}
+module.exports = new ContextUrlTest()

package/src/context-url.ts

@@ -0,0 +1,51 @@
+/**
+ * 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.
+ */
+
+export namespace ContextURL {
+  export const INCREMENTAL_PREBUILD_PREFIX = "incremental-prebuild";
+  export const PREBUILD_PREFIX = "prebuild";
+  export const IMAGEBUILD_PREFIX = "imagebuild";
+
+  /**
+   * The field "contextUrl" might contain prefixes like:
+   *  - envvar1=value1/...
+   *  - prebuild/...
+   * This is the analogon to the (Prefix)ContextParser structure in "server".
+   */
+  export function parseToURL(contextUrl: string | undefined): URL | undefined {
+    if (contextUrl === undefined) {
+      return undefined;
+    }
+
+    const segments = contextUrl.split("/");
+    if (segments.length === 1) {
+      return new URL(segments[0]);  // this might be something, we just try
+    }
+
+    const segmentsToURL = (offset: number): URL => {
+      let rest = segments.slice(offset).join("/");
+      if (!rest.startsWith("http")) {
+        rest = 'https://' + rest;
+      }
+      return new URL(rest);
+    };
+
+
+    const firstSegment = segments[0];
+    if (firstSegment === PREBUILD_PREFIX ||
+        firstSegment === INCREMENTAL_PREBUILD_PREFIX ||
+        firstSegment === IMAGEBUILD_PREFIX) {
+      return segmentsToURL(1);
+    }
+
+    // check for env vars
+    if (firstSegment.indexOf("=") !== -1) {
+      return segmentsToURL(1);
+    }
+
+    return segmentsToURL(0);
+  }
+}

package/src/email-protocol.ts

@@ -4,7 +4,6 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import { Without } from "./util/without";
 import uuidv4 = require("uuid/v4");
 
 export type EMailState = "scheduledInternal"
@@ -59,7 +58,7 @@ export type EMail = {
 } & EMailStatus;
 
 export namespace EMail {
-    export const create = (ts: Without<EMail, 'uid'>): EMail => {
+    export const create = (ts: Omit<EMail, 'uid'>): EMail => {
         const withId = ts as EMail;
         withId.uid = uuidv4();
         return withId;

package/src/env.ts

@@ -13,18 +13,19 @@ const legacyStagenameTranslation: { [key: string]: KubeStage } = {
     "dev": "dev"
 }
 
+export function translateLegacyStagename(kubeStage: string): KubeStage {
+    const stage = legacyStagenameTranslation[kubeStage];
+    if (!stage) {
+        throw new Error(`Invalid KUBE_STAGE: ${kubeStage}`);
+    }
+
+    return stage;
+}
+
 @injectable()
 export abstract class AbstractComponentEnv {
-    readonly kubeStage: KubeStage = getEnvVarParsed('KUBE_STAGE', (kubeStage) => {
-        const stage = legacyStagenameTranslation[kubeStage];
-        if (!stage) {
-            throw new Error(`Environment variable invalid: KUBE_STAGE=${kubeStage}`);
-        }
-
-        return stage;
-    });
+    readonly kubeStage: KubeStage = getEnvVarParsed('KUBE_STAGE', translateLegacyStagename);
     readonly kubeNamespace: string = getEnvVar('KUBE_NAMESPACE');
-    readonly version: string = getEnvVar('VERSION');
 
     readonly installationLongname: string = getEnvVar("GITPOD_INSTALLATION_LONGNAME")
     readonly installationShortname: string = getEnvVar("GITPOD_INSTALLATION_SHORTNAME")

package/src/gitpod-service.ts

@@ -9,11 +9,15 @@ import {
     WhitelistedRepository, WorkspaceImageBuild, AuthProviderInfo, Branding, CreateWorkspaceMode,
     Token, UserEnvVarValue, ResolvePluginsParams, PreparePluginUploadParams, Terms,
     ResolvedPlugins, Configuration, InstallPluginsParams, UninstallPluginParams, UserInfo, GitpodTokenType,
-    GitpodToken, AuthProviderEntry, GuessGitTokenScopesParams, GuessedGitTokenScopes, Team
+    GitpodToken, AuthProviderEntry, GuessGitTokenScopesParams, GuessedGitTokenScopes
 } from './protocol';
+import {
+    Team, TeamMemberInfo,
+    TeamMembershipInvite, Project, TeamMemberRole, PrebuildWithStatus, StartPrebuildResult
+} from './teams-projects-protocol';
 import { JsonRpcProxy, JsonRpcServer } from './messaging/proxy-factory';
 import { Disposable, CancellationTokenSource } from 'vscode-jsonrpc';
-import { HeadlessLogEvent } from './headless-workspace-log';
+import { HeadlessLogUrls } from './headless-workspace-log';
 import { WorkspaceInstance, WorkspaceInstancePort, WorkspaceInstancePhase } from './workspace-instance';
 import { AdminServer } from './admin-protocol';
 import { GitpodHostUrl } from './util/gitpod-host-url';
@@ -24,11 +28,13 @@ import { Emitter } from './util/event';
 import { AccountStatement, CreditAlert } from './accounting-protocol';
 import { GithubUpgradeURL, PlanCoupon } from './payment-protocol';
 import { TeamSubscription, TeamSubscriptionSlot, TeamSubscriptionSlotResolved } from './team-subscription-protocol';
+import { RemoteTrackMessage } from './analytics';
 
 export interface GitpodClient {
     onInstanceUpdate(instance: WorkspaceInstance): void;
     onWorkspaceImageBuildLogs: WorkspaceImageBuild.LogCallback;
-    onHeadlessWorkspaceLogs(evt: HeadlessLogEvent): void;
+
+    onPrebuildUpdate(update: PrebuildWithStatus): void;
 
     onCreditAlert(creditAlert: CreditAlert): void;
 
@@ -51,6 +57,7 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     getBranding(): Promise<Branding>;
     getConfiguration(): Promise<Configuration>;
     getToken(query: GitpodServer.GetTokenSearchOptions): Promise<Token | undefined>;
+    getGitpodTokenScopes(tokenHash: string): Promise<string[]>;
     /**
      * @deprecated
      */
@@ -82,8 +89,8 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     updateWorkspaceUserPin(id: string, action: GitpodServer.PinAction): Promise<void>;
     sendHeartBeat(options: GitpodServer.SendHeartBeatOptions): Promise<void>;
     watchWorkspaceImageBuildLogs(workspaceId: string): Promise<void>;
-    watchHeadlessWorkspaceLogs(workspaceId: string): Promise<void>;
     isPrebuildDone(pwsid: string): Promise<boolean>;
+    getHeadlessLog(instanceId: string): Promise<HeadlessLogUrls>;
 
     // Workspace timeout
     setWorkspaceTimeout(workspaceId: string, duration: WorkspaceTimeoutDuration): Promise<SetWorkspaceTimeoutResult>;
@@ -101,14 +108,34 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     getUserStorageResource(options: GitpodServer.GetUserStorageResourceOptions): Promise<string>;
     updateUserStorageResource(options: GitpodServer.UpdateUserStorageResourceOptions): Promise<void>;
 
-    // user env vars
+    // User env vars
     getEnvVars(): Promise<UserEnvVarValue[]>;
     getAllEnvVars(): Promise<UserEnvVarValue[]>;
     setEnvVar(variable: UserEnvVarValue): Promise<void>;
     deleteEnvVar(variable: UserEnvVarValue): Promise<void>;
 
-    // teams and projects
+    // Teams
     getTeams(): Promise<Team[]>;
+    getTeamMembers(teamId: string): Promise<TeamMemberInfo[]>;
+    createTeam(name: string): Promise<Team>;
+    joinTeam(inviteId: string): Promise<Team>;
+    setTeamMemberRole(teamId: string, userId: string, role: TeamMemberRole): Promise<void>;
+    removeTeamMember(teamId: string, userId: string): Promise<void>;
+    getGenericInvite(teamId: string): Promise<TeamMembershipInvite>;
+    resetGenericInvite(inviteId: string): Promise<TeamMembershipInvite>;
+
+    // Projects
+    getProviderRepositoriesForUser(params: GetProviderRepositoriesParams): Promise<ProviderRepository[]>;
+    createProject(params: CreateProjectParams): Promise<Project>;
+    deleteProject(projectId: string): Promise<void>;
+    getTeamProjects(teamId: string): Promise<Project[]>;
+    getUserProjects(): Promise<Project[]>;
+    getProjectOverview(projectId: string): Promise<Project.Overview | undefined>;
+    findPrebuilds(params: FindPrebuildsParams): Promise<PrebuildWithStatus[]>;
+    triggerPrebuild(projectId: string, branchName: string | null): Promise<StartPrebuildResult>;
+    setProjectConfiguration(projectId: string, configString: string): Promise<void>;
+    fetchProjectRepositoryConfiguration(projectId: string): Promise<string | undefined>;
+    guessProjectConfiguration(projectId: string): Promise<string | undefined>;
 
     // content service
     getContentBlobUploadUrl(name: string): Promise<string>
@@ -196,6 +223,43 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
 
     getGithubUpgradeUrls(): Promise<GithubUpgradeURL[]>;
 
+    /**
+     * Analytics
+     */
+    trackEvent(event: RemoteTrackMessage): Promise<void>;
+}
+
+export interface CreateProjectParams {
+    name: string;
+    account: string;
+    provider: string;
+    cloneUrl: string;
+    teamId?: string;
+    userId?: string;
+    appInstallationId: string;
+}
+export interface FindPrebuildsParams {
+    projectId: string;
+    branch?: string;
+    latest?: boolean;
+    prebuildId?: string;
+    // default: 30
+    limit?: number;
+}
+export interface GetProviderRepositoriesParams {
+    provider: string;
+    hints?: { installationId: string } | object;
+}
+export interface ProviderRepository {
+    name: string;
+    account: string;
+    accountAvatarUrl: string;
+    cloneUrl: string;
+    updatedAt: string;
+    installationId?: number;
+    installationUpdatedAt?: string;
+
+    inUse?: boolean;
 }
 
 export const WorkspaceTimeoutValues = ["30m", "60m", "180m"] as const;
@@ -208,6 +272,7 @@ export const createServerMock = function <C extends GitpodClient, S extends Gitp
     methods.setClient = methods.setClient || (() => { });
     methods.dispose = methods.dispose || (() => { });
     return new Proxy<JsonRpcProxy<S>>(methods as any as JsonRpcProxy<S>, {
+        // @ts-ignore
         get: (target: S, property: keyof S) => {
             const result = target[property];
             if (!result) {
@@ -240,6 +305,8 @@ export namespace GitpodServer {
         limit?: number;
         searchString?: string;
         pinnedOnly?: boolean;
+        projectId?: string | string[];
+        includeWithoutProject?: boolean;
     }
     export interface GetAccountStatementOptions {
         date?: string;
@@ -247,6 +314,7 @@ export namespace GitpodServer {
     export interface CreateWorkspaceOptions {
         contextUrl: string;
         mode?: CreateWorkspaceMode;
+        forceDefaultConfig?: boolean;
     }
     export interface StartWorkspaceOptions {
         forceDefaultImage: boolean;
@@ -315,11 +383,11 @@ export class GitpodCompositeClient<Client extends GitpodClient> implements Gitpo
         }
     }
 
-    onWorkspaceImageBuildLogs(info: WorkspaceImageBuild.StateInfo, content: WorkspaceImageBuild.LogContent | undefined): void {
+    onPrebuildUpdate(update: PrebuildWithStatus): void {
         for (const client of this.clients) {
-            if (client.onWorkspaceImageBuildLogs) {
+            if (client.onPrebuildUpdate) {
                 try {
-                    client.onWorkspaceImageBuildLogs(info, content);
+                    client.onPrebuildUpdate(update);
                 } catch (error) {
                     console.error(error)
                 }
@@ -327,11 +395,11 @@ export class GitpodCompositeClient<Client extends GitpodClient> implements Gitpo
         }
     }
 
-    onHeadlessWorkspaceLogs(evt: HeadlessLogEvent): void {
+    onWorkspaceImageBuildLogs(info: WorkspaceImageBuild.StateInfo, content: WorkspaceImageBuild.LogContent | undefined): void {
         for (const client of this.clients) {
-            if (client.onHeadlessWorkspaceLogs) {
+            if (client.onWorkspaceImageBuildLogs) {
                 try {
-                    client.onHeadlessWorkspaceLogs(evt);
+                    client.onWorkspaceImageBuildLogs(info, content);
                 } catch (error) {
                     console.error(error)
                 }

package/src/headless-workspace-log.ts

@@ -22,21 +22,17 @@ export namespace HeadlessWorkspaceEventType {
     }
 }
 
-export interface HeadlessLogEvent {
+export interface HeadlessWorkspaceEvent {
     workspaceID: string;
     text: string;
     type: HeadlessWorkspaceEventType;
 }
 
-export enum TheiaHeadlessLogType {
-    TaskLogLabel = "workspaceTaskOutput",
-    TaskFailedLabel = "workspaceTaskFailed",
-    TaskSuccessfulLabel = "workspaceTaskDone"
+export interface HeadlessLogUrls {
+    // A map of id to URL
+    streams: { [streamID: string]: string };
 }
 
-export interface TheiaHeadlessLogMessage {
-    type: TheiaHeadlessLogType;
-    data?: string;
-    error?: string;
-    snapshotURL?: string;
-}
+/** cmp. @const HEADLESS_LOG_STREAM_STATUS_CODE_REGEX */
+export const HEADLESS_LOG_STREAM_STATUS_CODE = "X-LogStream-StatusCode";
+export const HEADLESS_LOG_STREAM_STATUS_CODE_REGEX = /X-LogStream-StatusCode: ([0-9]{3})/;

package/src/index.ts

@@ -15,3 +15,5 @@ export * from './permission';
 export * from './admin-protocol';
 export * from './email-protocol';
 export * from './headless-workspace-log';
+export * from './context-url';
+export * from './teams-projects-protocol';

package/src/messaging/client-call-metrics.ts

@@ -0,0 +1,97 @@
+/**
+ * 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 { injectable } from 'inversify';
+import * as prometheusClient from 'prom-client';
+
+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;
+}
+
+@injectable()
+export class PrometheusClientCallMetrics implements IClientCallMetrics {
+
+	readonly startedCounter: prometheusClient.Counter<string>;
+	readonly sentCounter: prometheusClient.Counter<string>;
+	readonly receivedCounter: prometheusClient.Counter<string>;
+	readonly handledCounter: prometheusClient.Counter<string>;
+
+	constructor() {
+		this.startedCounter = new prometheusClient.Counter({
+			name: 'grpc_client_started_total',
+			help: 'Total number of RPCs started on the client.',
+			labelNames: ['grpc_service', 'grpc_method', 'grpc_type'],
+			registers: [prometheusClient.register]
+		});
+		this.sentCounter = new prometheusClient.Counter({
+			name: 'grpc_client_msg_sent_total',
+			help: ' Total number of gRPC stream messages sent by the client.',
+			labelNames: ['grpc_service', 'grpc_method', 'grpc_type'],
+			registers: [prometheusClient.register]
+		});
+		this.receivedCounter = new prometheusClient.Counter({
+			name: 'grpc_client_msg_received_total',
+			help: 'Total number of RPC stream messages received by the client.',
+			labelNames: ['grpc_service', 'grpc_method', 'grpc_type'],
+			registers: [prometheusClient.register]
+		});
+		this.handledCounter = new prometheusClient.Counter({
+			name: 'grpc_client_handled_total',
+			help: 'Total number of RPCs completed by the client, regardless of success or failure.',
+			labelNames: ['grpc_service', 'grpc_method', 'grpc_type', 'grpc_code'],
+			registers: [prometheusClient.register]
+		});
+	}
+
+	started(labels: IGrpcCallMetricsLabels): void {
+		this.startedCounter.inc({
+			grpc_service: labels.service,
+			grpc_method: labels.method,
+			grpc_type: labels.type
+		});
+	}
+
+	sent(labels: IGrpcCallMetricsLabels): void {
+		this.sentCounter.inc({
+			grpc_service: labels.service,
+			grpc_method: labels.method,
+			grpc_type: labels.type
+		});
+	}
+
+	received(labels: IGrpcCallMetricsLabels): void {
+		this.receivedCounter.inc({
+			grpc_service: labels.service,
+			grpc_method: labels.method,
+			grpc_type: labels.type
+		});
+	}
+
+	handled(labels: IGrpcCallMetricsLabelsWithCode): void {
+		this.handledCounter.inc({
+			grpc_service: labels.service,
+			grpc_method: labels.method,
+			grpc_type: labels.type,
+			grpc_code: labels.code
+		});
+	}
+}

package/src/messaging/error.ts

@@ -34,6 +34,9 @@ export namespace ErrorCodes {
     // 460 Context Parse Error (custom status code)
     export const CONTEXT_PARSE_ERROR = 460;
 
+    // 461 Invalid gitpod yml
+    export const INVALID_GITPOD_YML = 461;
+
     // 450 Payment error
     export const PAYMENT_ERROR = 450;