@gitpod/gitpod-protocol 0.1.5-pluggable-workspace-cluster.21 → 0.1.5-port-description-3059-fork.6

package/src/protocol.ts

@@ -6,6 +6,7 @@
 
 import { WorkspaceInstance, PortVisibility } from "./workspace-instance";
 import { RoleOrPermission } from "./permission";
+import { Project } from "./teams-projects-protocol";
 
 export interface UserInfo {
     name?: string
@@ -27,8 +28,6 @@ export interface User {
 
     identities: Identity[]
 
-    allowsMarketingCommunication: boolean;
-
     /**
      * Whether the user has been blocked to use our service, because of TOS violation for example.
      * Optional for backwards compatibility.
@@ -100,14 +99,23 @@ export interface AdditionalUserData {
     ideSettings?: IDESettings;
     // key is the name of the news, string the iso date when it was seen
     whatsNewSeen?: { [key: string]: string }
+    // key is the name of the OAuth client i.e. local app, string the iso date when it was approved
+    // TODO(rl): provide a management UX to allow rescinding of approval
+    oauthClientsApproved?: { [key: string]: string }
+    // to remember GH Orgs the user installed/updated the GH App for
+    knownGitHubOrgs?: string[];
 }
 
 export interface EmailNotificationSettings {
-    disallowTransactionalEmails?: boolean;
+    allowsChangelogMail?: boolean;
+    allowsDevXMail?: boolean;
+    allowsOnboardingMail?: boolean;
 }
 
 export type IDESettings = {
     defaultIde?: string
+    useDesktopIde?: boolean
+    defaultDesktopIde?: string
 }
 
 export interface UserPlatform {
@@ -129,14 +137,6 @@ export interface UserPlatform {
 }
 
 export interface UserFeatureSettings {
-    /**
-     * This field is used as marker to grant users a free trial for using private repositories,
-     * independent of any subscription or Chargebee.
-     *  - it is set when the user uses their first private repo
-     *  - whether the trial is expired or not is juged by the UserService
-     */
-    privateRepoTrialStartDate?: string;
-
     /**
      * Permanent feature flags are added to each and every workspace instance
      * this user starts.
@@ -372,11 +372,16 @@ export interface PendingGithubEvent {
 export interface Snapshot {
     id: string;
     creationTime: string;
+    availableTime?: string;
     originalWorkspaceId: string;
     bucketId: string;
     layoutData?: string;
+    state: SnapshotState;
+    message?: string;
 }
 
+export type SnapshotState = 'pending' | 'available' | 'error';
+
 export interface LayoutData {
     workspaceId: string;
     lastUpdatedTime: string;
@@ -389,6 +394,7 @@ export interface Workspace {
     contextURL: string;
     description: string;
     ownerId: string;
+    projectId?: string;
     context: WorkspaceContext;
     config: WorkspaceConfig;
 
@@ -552,15 +558,20 @@ export interface WorkspaceConfig {
     github?: GithubAppConfig;
     vscode?: VSCodeConfig;
 
+    /** deprecated. Enabled by default **/
+    experimentalNetwork?: boolean;
+
     /**
      * Where the config object originates from.
      *
      * repo - from the repository
+     * project-db - from the "Project" stored in the database
      * definitly-gp - from github.com/gitpod-io/definitely-gp
      * derived - computed based on analyzing the repository
+     * additional-content - config comes from additional content, usually provided through the project's configuration
      * default - our static catch-all default config
      */
-    _origin?: 'repo' | 'definitely-gp' | 'derived' | 'default';
+    _origin?: 'repo' | 'project-db' | 'definitely-gp' | 'derived' | 'additional-content' | 'default';
 
     /**
      * Set of automatically infered feature flags. That's not something the user can set, but
@@ -590,16 +601,13 @@ export namespace GithubAppPrebuildConfig {
 
 export type WorkspaceImageSource = WorkspaceImageSourceDocker | WorkspaceImageSourceReference;
 export interface WorkspaceImageSourceDocker {
-    // TODO: clean this up. We should have the commit and an ImageSource in here, not duplicate the whole thing again.
-    //       We have a ton of those objects in the database, thus cleaning this up means lengthy DB migrations. Yuck.
-    dockerFileHash: string
-    dockerFileSource: Commit
     dockerFilePath: string
+    dockerFileHash: string
+    dockerFileSource?: Commit
 }
 export namespace WorkspaceImageSourceDocker {
     export function is(obj: object): obj is WorkspaceImageSourceDocker {
         return 'dockerFileHash' in obj
-            && 'dockerFileSource' in obj
             && 'dockerFilePath' in obj;
     }
 }
@@ -628,6 +636,8 @@ export type PrebuiltWorkspaceState
 export interface PrebuiltWorkspace {
     id: string;
     cloneURL: string;
+    branch?: string;
+    projectId?: string;
     commit: string;
     buildWorkspaceId: string;
     creationTime: string;
@@ -674,6 +684,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 {
@@ -697,7 +709,7 @@ export interface TaskConfig {
     init?: string;
     prebuild?: string;
     command?: string;
-    env?: { [env: string]: string };
+    env?: { [env: string]: any };
     openIn?: 'bottom' | 'main' | 'left' | 'right';
     openMode?: 'split-top' | 'split-left' | 'split-right' | 'split-bottom' | 'tab-before' | 'tab-after';
 }
@@ -761,8 +773,10 @@ export namespace ExternalImageConfigFile {
 
 export interface WorkspaceContext {
     title: string;
+    /** This contains the URL portion of the contextURL (which might contain other modifiers as well). It's optional because it's not set for older workspaces. */
     normalizedContextURL?: string;
     forceCreateNewWorkspace?: boolean;
+    forceImageBuild?: boolean;
 }
 
 export namespace WorkspaceContext {
@@ -796,6 +810,29 @@ export namespace WithPrebuild {
     }
 }
 
+/**
+ * WithDefaultConfig contexts disable the download of the gitpod.yml from the repository
+ * and fall back to the built-in configuration.
+ */
+export interface WithDefaultConfig {
+    withDefaultConfig: true;
+}
+
+export namespace WithDefaultConfig {
+    export function is(context: any): context is WithDefaultConfig {
+        return context
+            && 'withDefaultConfig' in context
+            && context.withDefaultConfig;
+    }
+
+    export function mark(ctx: WorkspaceContext): WorkspaceContext & WithDefaultConfig {
+        return {
+            ...ctx,
+            withDefaultConfig: true
+        }
+    }
+}
+
 export interface SnapshotContext extends WorkspaceContext, WithSnapshot {
     snapshotId: string;
 }
@@ -810,6 +847,9 @@ export namespace SnapshotContext {
 
 export interface StartPrebuildContext extends WorkspaceContext {
     actual: WorkspaceContext;
+    commitHistory?: string[];
+    project?: Project;
+    branch?: string;
 }
 
 export namespace StartPrebuildContext {
@@ -879,6 +919,25 @@ export interface Commit {
     refType?: RefType
 }
 
+export interface AdditionalContentContext extends WorkspaceContext {
+
+    /**
+     * utf-8 encoded contents that will be copied on top of the workspace's filesystem
+     */
+    additionalFiles: {[filePath: string]: string};
+
+}
+
+export namespace AdditionalContentContext {
+    export function is(ctx: any): ctx is AdditionalContentContext {
+        return 'additionalFiles' in ctx;
+    }
+
+    export function hasDockerConfig(ctx: any, config: WorkspaceConfig): boolean {
+        return is(ctx) && ImageConfigFile.is(config.image) && !!ctx.additionalFiles[config.image.file];
+    }
+}
+
 export interface CommitContext extends WorkspaceContext, Commit {
     /** @deprecated Moved to .repository.cloneUrl, left here for backwards-compatibility for old workspace contextes in the DB */
     cloneUrl?: string
@@ -954,6 +1013,19 @@ export interface Repository {
         parent: Repository
     }
 }
+export interface Branch {
+    name: string;
+    commit: CommitInfo;
+    htmlUrl: string;
+}
+
+export interface CommitInfo {
+    author: string;
+    sha: string;
+    commitMessage: string;
+    authorAvatarUrl?: string;
+    authorDate?: string;
+}
 
 export namespace Repository {
     export function fullRepoName(repo: Repository): string {
@@ -996,6 +1068,7 @@ export interface WorkspaceCreationResult {
     runningWorkspacePrebuild?: {
         prebuildID: string
         workspaceID: string
+        instanceID: string
         starting: RunningWorkspacePrebuildStarting
         sameCluster: boolean
     }

package/src/snapshot-url.spec.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { SnapshotUrl } from ".";
+
+const expect = chai.expect
+
+@suite class TestSnapshotUrlParser {
+
+    @test public testPositive() {
+        const actual = SnapshotUrl.parse("workspaces/c362d434-6faa-4ce0-9ad4-91b4a87c4abe/3f0556f7-4afa-11e9-98d5-52f8983b9279.tar@gitpod-prodcopy-user-e1e28f18-0354-4a5d-b6b4-8879a2ff73fd");
+
+        expect(actual).to.deep.equal(<SnapshotUrl>{
+            bucketId: "gitpod-prodcopy-user-e1e28f18-0354-4a5d-b6b4-8879a2ff73fd",
+            filename: "3f0556f7-4afa-11e9-98d5-52f8983b9279.tar",
+            fullPath: "workspaces/c362d434-6faa-4ce0-9ad4-91b4a87c4abe/3f0556f7-4afa-11e9-98d5-52f8983b9279.tar",
+        });
+    }
+}
+module.exports = new TestSnapshotUrlParser()   // Only to circumvent no usage warning :-/

package/src/snapshot-url.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 interface SnapshotUrl {
+    bucketId: string;
+    fullPath: string;
+    filename: string;
+}
+export namespace SnapshotUrl {
+    export function parse(url: string): SnapshotUrl {
+        const parts = url.split("@");
+        if (parts.length !== 2) {
+            throw new Error(`cannot parse snapshot URL: ${url}`);
+        }
+        const [fullPath, bucketId] = parts;
+
+        const pathParts = fullPath.split("/");
+        if (pathParts.length < 1) {
+            throw new Error(`cannot parse snapshot URL: ${url}`);
+        }
+        const filename = pathParts[pathParts.length - 1];
+        return { bucketId, fullPath, filename };
+    }
+}

package/src/team-subscription-protocol.ts

@@ -4,8 +4,7 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import { Without } from "./util/without";
-import uuidv4 = require("uuid/v4");
+import { v4 as uuidv4 } from 'uuid';
 import { Subscription } from "./accounting-protocol";
 
 export interface TeamSubscription {
@@ -22,7 +21,7 @@ export interface TeamSubscription {
 }
 
 export namespace TeamSubscription {
-    export const create = (ts: Without<TeamSubscription, 'id'>): TeamSubscription => {
+    export const create = (ts: Omit<TeamSubscription, 'id'>): TeamSubscription => {
         const withId = ts as TeamSubscription;
         withId.id = uuidv4();
         return withId;
@@ -49,7 +48,7 @@ export type TeamSubscriptionSlotAssigned = TeamSubscriptionSlot & TeamSubscripti
 export type TeamSubscriptionSlotState = 'unassigned' | 'assigned' | 'deactivated' | 'cancelled';
 
 export namespace TeamSubscriptionSlot {
-    export const create = (ts: Without<TeamSubscriptionSlot, 'id'>): TeamSubscriptionSlot => {
+    export const create = (ts: Omit<TeamSubscriptionSlot, 'id'>): TeamSubscriptionSlot => {
         const withId = ts as TeamSubscriptionSlot;
         withId.id = uuidv4();
         return withId;
@@ -63,7 +62,7 @@ export namespace TeamSubscriptionSlot {
         slot.subscriptionId = undefined;
         slot.cancellationDate = cancellationDate;
     }
-    export const reactivate = (slot: TeamSubscriptionSlot, subscriptionId: string) => {
+    export const reactivate = (slot: TeamSubscriptionSlot, subscriptionId?: string) => {
         slot.subscriptionId = subscriptionId;
         slot.cancellationDate = undefined;
     }
@@ -83,6 +82,9 @@ export namespace TeamSubscriptionSlot {
         }
 
     }
+    export const isActive = (slot: TeamSubscriptionSlot): boolean => {
+        return !slot.cancellationDate;
+    }
 }
 
 /**

package/src/teams-projects-protocol.ts

@@ -0,0 +1,141 @@
+/**
+ * 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 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/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

@@ -7,7 +7,7 @@
 import { suite, test } from "mocha-typescript"
 import * as chai from "chai"
 import { generateWorkspaceID, colors, animals } from "./generate-workspace-id";
-import { workspaceIDRegex } from "./gitpod-host-url";
+import { GitpodHostUrl } from "./gitpod-host-url";
 
 const expect = chai.expect
 
@@ -15,8 +15,8 @@ const expect = chai.expect
 
     @test public async testGenerateWorkspaceId() {
         for (let i = 0; i < 100; i++) {
-            const name = await generateWorkspaceID();
-            expect(workspaceIDRegex.test(name), name).to.be.true;
+            const id = await generateWorkspaceID();
+            expect(new GitpodHostUrl().withWorkspacePrefix(id, "eu").workspaceId).to.equal(id);
         }
     }
 

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

@@ -48,6 +48,7 @@ export const colors = [
     'indigo',
     'ivory',
     'jade',
+    'kumquat',
     'lavender',
     'lime',
     'magenta',
@@ -172,6 +173,7 @@ export const colors = [
     'deer',
     'dingo',
     'dinosaur',
+    'dodo',
     'dog',
     'dolphin',
     'donkey',

package/src/util/gitpod-cookie.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.
+ */
+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.
+ * This is used by "gitpod.io" and "www.gitpod.io" to display different content/buttons.
+ */
+export const NAME = "gitpod-user";
+export const VALUE = "true";
+
+/**
+ * @param domain The domain the Gitpod installation is installed onto
+ * @returns
+ */
+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
+        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
+    };
+};
+
+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}=`);
+};