@gitpod/gitpod-protocol 0.1.5-upgrade-code.5 → 0.1.5-vn-implement-jetbrains-terminals.0

package/src/teams-projects-protocol.ts

@@ -0,0 +1,147 @@
+/**
+ * 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 { PrebuiltWorkspaceState } from "./protocol";
+import { v4 as uuidv4 } from 'uuid';
+import { DeepPartial } from "./util/deep-partial";
+
+export interface ProjectConfig {
+    '.gitpod.yml': string;
+}
+
+export interface ProjectSettings {
+    useIncrementalPrebuilds?: boolean;
+}
+
+export interface Project {
+    id: string;
+    name: string;
+    slug?: string;
+    cloneUrl: string;
+    teamId?: string;
+    userId?: string;
+    appInstallationId: string;
+    config?: ProjectConfig;
+    settings?: ProjectSettings;
+    creationTime: string;
+    /** This is a flag that triggers the HARD DELETION of this entity */
+    deleted?: boolean;
+    markedDeleted?: boolean;
+}
+
+export namespace Project {
+    export const create = (project: Omit<Project, 'id' | 'creationTime'>): Project => {
+        return {
+            ...project,
+            id: uuidv4(),
+            creationTime: new Date().toISOString()
+        };
+    }
+
+    export interface Overview {
+        branches: BranchDetails[];
+    }
+
+    export namespace Overview {
+        export function is(data?: any): data is Project.Overview {
+            return Array.isArray(data?.branches);
+        }
+    }
+
+    export interface BranchDetails {
+        name: string;
+        url: string;
+        isDefault: boolean;
+
+        // Latest commit
+        changeTitle: string;
+        changeDate?: string;
+        changeAuthor?: string;
+        changeAuthorAvatar?: string;
+        changePR?: string;
+        changeUrl?: string;
+        changeHash: string;
+    }
+}
+
+export type PartialProject = DeepPartial<Project> & Pick<Project, 'id'>;
+
+export interface PrebuildWithStatus {
+    info: PrebuildInfo;
+    status: PrebuiltWorkspaceState;
+    error?: string;
+}
+
+export interface PrebuildInfo {
+    id: string;
+    buildWorkspaceId: string;
+    basedOnPrebuildId?: string;
+
+    teamId?: string;
+    userId?: string;
+
+    projectId: string;
+    projectName: string;
+
+    cloneUrl: string;
+    branch: string;
+
+    startedAt: string;
+    startedBy: string;
+    startedByAvatar?: string;
+
+    changeTitle: string;
+    changeDate: string;
+    changeAuthor: string;
+    changeAuthorAvatar?: string;
+    changePR?: string;
+    changeUrl?: string;
+    changeHash: string;
+}
+export namespace PrebuildInfo {
+    export function is(data?: any): data is PrebuildInfo {
+        return typeof data === "object" && ["id", "buildWorkspaceId", "projectId", "branch"].every(p => p in data);
+    }
+}
+
+export interface StartPrebuildResult {
+    prebuildId: string;
+    wsid: string;
+    done: boolean;
+}
+
+export interface Team {
+    id: string;
+    name: string;
+    slug: string;
+    creationTime: string;
+    markedDeleted?: boolean;
+    /** This is a flag that triggers the HARD DELETION of this entity */
+    deleted?: boolean;
+}
+
+export type TeamMemberRole = "owner" | "member";
+
+export interface TeamMemberInfo {
+    userId: string;
+    fullName?: string;
+    primaryEmail?: string;
+    avatarUrl?: string;
+    role: TeamMemberRole;
+    memberSince: string;
+}
+
+export interface TeamMembershipInvite {
+    id: string;
+    teamId: string;
+    role: TeamMemberRole;
+    creationTime: string;
+    invalidationTime: string;
+    invitedEmail?: string;
+
+    /** This is a flag that triggers the HARD DELETION of this entity */
+    deleted?: boolean;
+}

package/src/util/analytics.ts

@@ -0,0 +1,87 @@
+/**
+ * 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 Analytics = require("analytics-node");
+import { IAnalyticsWriter, IdentifyMessage, TrackMessage, PageMessage } from "../analytics";
+import { log } from './logging';
+
+
+export function newAnalyticsWriterFromEnv(): IAnalyticsWriter {
+    switch (process.env.GITPOD_ANALYTICS_WRITER) {
+        case "segment":
+            return new SegmentAnalyticsWriter(process.env.GITPOD_ANALYTICS_SEGMENT_KEY || "");
+        case "log":
+            return new LogAnalyticsWriter();
+        default:
+            return new NoAnalyticsWriter();
+    }
+}
+
+class SegmentAnalyticsWriter implements IAnalyticsWriter {
+
+    protected readonly analytics: Analytics;
+
+    constructor(writeKey: string) {
+        this.analytics = new Analytics(writeKey);
+    }
+
+        identify(msg: IdentifyMessage) {
+        try {
+            this.analytics.identify(msg, (err: Error) => {
+                if (err) {
+                    log.warn("analytics.identify failed", err);
+                }
+            });
+        } catch (err) {
+            log.warn("analytics.identify failed", err);
+        }
+    }
+
+    track(msg: TrackMessage) {
+        try {
+            this.analytics.track(msg, (err: Error) => {
+                if (err) {
+                    log.warn("analytics.track failed", err);
+                }
+            });
+        } catch (err) {
+            log.warn("analytics.track failed", err);
+        }
+    }
+
+    page(msg: PageMessage) {
+        try{
+            this.analytics.page(msg, (err: Error) => {
+                if (err) {
+                    log.warn("analytics.page failed", err);
+                }
+            });
+        } catch (err) {
+            log.warn("analytics.page failed", err);
+        }
+    }
+
+}
+
+class LogAnalyticsWriter implements IAnalyticsWriter {
+
+    identify(msg: IdentifyMessage): void {
+        log.debug("analytics identify", msg);
+    }
+    track(msg: TrackMessage): void {
+        log.debug("analytics track", msg);
+    }
+    page(msg: PageMessage): void {
+        log.debug("analytics page", msg);
+    }
+
+}
+
+class NoAnalyticsWriter implements IAnalyticsWriter {
+    identify(msg: IdentifyMessage): void {}
+    track(msg: TrackMessage): void {}
+    page(msg: PageMessage): void {}
+}

package/src/util/deferred.ts

@@ -19,7 +19,7 @@ export class Deferred<T> {
     promise = new Promise<T>((resolve, reject) => {
         this.resolve = (o) => {
             this.isResolved = true;
-            resolve(o)
+            resolve(o as any)
             clearTimeout(this.timer)
         };
         this.reject = (e) => {

package/src/util/garbage-collected-cache.ts

@@ -4,6 +4,8 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
+import { repeat } from "./repeat";
+
 
 interface CacheEntry<T> {
     key: string;
@@ -13,13 +15,13 @@ interface CacheEntry<T> {
 
 export class GarbageCollectedCache<T> {
     protected readonly store = new Map<string, CacheEntry<T>>();
-    
+
     constructor(
         protected readonly defaultMaxAgeSeconds: number,
         protected readonly gcIntervalSeconds: number) {
         this.regularlyCollectGarbage();
     }
-    
+
     public set(key: string, value: T) {
         const oldValue = this.store.get(key);
         if (oldValue) {
@@ -41,8 +43,12 @@ export class GarbageCollectedCache<T> {
         return entry.value;
     }
 
+    public delete(key: string) {
+        this.store.delete(key);
+    }
+
     protected regularlyCollectGarbage() {
-        setInterval(() => this.collectGarbage(), this.gcIntervalSeconds * 1000);
+        repeat(() => this.collectGarbage(), this.gcIntervalSeconds * 1000);
     }
 
     protected collectGarbage() {

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

@@ -0,0 +1,48 @@
+/**
+ * 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 { suite, test } from "mocha-typescript"
+import * as chai from "chai"
+import { generateWorkspaceID, colors, animals } from "./generate-workspace-id";
+import { GitpodHostUrl } from "./gitpod-host-url";
+
+const expect = chai.expect
+
+@suite class TestGenerateWorkspaceId {
+
+    @test public async testGenerateWorkspaceId() {
+        for (let i = 0; i < 100; i++) {
+            const id = await generateWorkspaceID();
+            expect(new GitpodHostUrl().withWorkspacePrefix(id, "eu").workspaceId).to.equal(id);
+        }
+    }
+
+    @test public testLongestName() {
+        const longestColor = colors.sort((a, b) => b.length - a.length)[0];
+        const longestAnimal = animals.sort((a, b) => b.length - a.length)[0];
+        const longestName = `${longestColor}-${longestAnimal}-12345678`;
+        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()