@gitpod/gitpod-protocol 0.1.5-svenefftinge-patch-1.3 → 0.1.5-tarun-telemetry-users.1

package/src/protocol.ts

@@ -28,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.
@@ -106,14 +104,21 @@ 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 {
-    disallowTransactionalEmails?: boolean;
+    allowsChangelogMail?: boolean;
+    allowsDevXMail?: boolean;
+    allowsOnboardingMail?: boolean;
 }
 
 export type IDESettings = {
     defaultIde?: string
+    useDesktopIde?: boolean
+    defaultDesktopIde?: string
 }
 
 export interface UserPlatform {
@@ -135,14 +140,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.
@@ -157,12 +154,23 @@ export interface UserFeatureSettings {
 export const WorkspaceFeatureFlags = { "full_workspace_backup": undefined, "fixed_resources": undefined };
 export type NamedWorkspaceFeatureFlag = keyof (typeof WorkspaceFeatureFlags);
 
-export interface UserEnvVarValue {
-    id?: string;
+export interface EnvVarWithValue {
     name: string;
-    repositoryPattern: string;
     value: string;
 }
+
+export interface ProjectEnvVarWithValue extends EnvVarWithValue {
+    id: string;
+    projectId: string;
+    censored: boolean;
+}
+
+export type ProjectEnvVar = Omit<ProjectEnvVarWithValue, 'value'>;
+
+export interface UserEnvVarValue extends EnvVarWithValue {
+    id?: string;
+    repositoryPattern: string; // DEPRECATED: Use ProjectEnvVar instead of repositoryPattern - https://github.com/gitpod-com/gitpod/issues/5322
+}
 export interface UserEnvVar extends UserEnvVarValue {
     id: string;
     userId: string;
@@ -171,10 +179,12 @@ export interface UserEnvVar extends UserEnvVarValue {
 
 export namespace UserEnvVar {
 
+    // DEPRECATED: Use ProjectEnvVar instead of repositoryPattern - https://github.com/gitpod-com/gitpod/issues/5322
     export function normalizeRepoPattern(pattern: string) {
         return pattern.toLocaleLowerCase();
     }
 
+    // DEPRECATED: Use ProjectEnvVar instead of repositoryPattern - https://github.com/gitpod-com/gitpod/issues/5322
     export function score(value: UserEnvVarValue): number {
         // We use a score to enforce precedence:
         //      value/value = 0
@@ -197,6 +207,7 @@ export namespace UserEnvVar {
         return score;
     }
 
+    // DEPRECATED: Use ProjectEnvVar instead of repositoryPattern - https://github.com/gitpod-com/gitpod/issues/5322
     export function filter<T extends UserEnvVarValue>(vars: T[], owner: string, repo: string): T[] {
         let result = vars.filter(e => {
             const [ownerPattern, repoPattern] = splitRepositoryPattern(e.repositoryPattern);
@@ -244,10 +255,11 @@ export namespace UserEnvVar {
         return result;
     }
 
+    // DEPRECATED: Use ProjectEnvVar instead of repositoryPattern - https://github.com/gitpod-com/gitpod/issues/5322
     export function splitRepositoryPattern(repositoryPattern: string): string[] {
         const patterns = repositoryPattern.split('/');
-        const repoPattern = patterns.pop() || "";
-        const ownerPattern = patterns.join('/');
+        const repoPattern = patterns.slice(1).join('/')
+        const ownerPattern = patterns[0];
         return [ownerPattern, repoPattern];
     }
 }
@@ -378,11 +390,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;
@@ -559,16 +576,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' | 'additional-content' | '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
@@ -585,7 +606,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
@@ -681,6 +702,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 {
@@ -704,7 +727,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';
 }
@@ -768,6 +791,7 @@ 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;
@@ -867,8 +891,20 @@ export namespace PrebuiltWorkspaceContext {
     }
 }
 
+export interface WithReferrerContext extends WorkspaceContext {
+    referrer: string
+    referrerIde?: string
+}
+
+export namespace WithReferrerContext {
+    export function is(context: any): context is WithReferrerContext {
+        return context
+            && 'referrer' in context;
+    }
+}
+
 export interface WithEnvvarsContext extends WorkspaceContext {
-    envvars: UserEnvVarValue[];
+    envvars: EnvVarWithValue[];
 }
 
 export namespace WithEnvvarsContext {
@@ -913,7 +949,7 @@ export interface Commit {
     refType?: RefType
 }
 
-export interface AdditionalContentContext {
+export interface AdditionalContentContext extends WorkspaceContext {
 
     /**
      * utf-8 encoded contents that will be copied on top of the workspace's filesystem
@@ -1007,6 +1043,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 {
@@ -1153,39 +1202,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/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,7 +4,7 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import uuidv4 = require("uuid/v4");
+import { v4 as uuidv4 } from 'uuid';
 import { Subscription } from "./accounting-protocol";
 
 export interface TeamSubscription {

package/src/teams-projects-protocol.ts

@@ -5,17 +5,31 @@
  */
 
 import { PrebuiltWorkspaceState } from "./protocol";
-import uuidv4 = require("uuid/v4");
+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;
+    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 {
@@ -26,21 +40,77 @@ export namespace Project {
             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 interface ProjectInfo extends Project {
-    lastPrebuild?: PrebuildInfo;
+export type PartialProject = DeepPartial<Project> & Pick<Project, 'id'>;
+
+export interface PrebuildWithStatus {
+    info: PrebuildInfo;
+    status: PrebuiltWorkspaceState;
+    error?: string;
 }
 
 export interface PrebuildInfo {
     id: string;
-    teamId: string;
-    project: string;
+    buildWorkspaceId: string;
+    basedOnPrebuildId?: string;
+
+    teamId?: string;
+    userId?: string;
+
+    projectId: string;
+    projectName: string;
+
     cloneUrl: string;
     branch: string;
+
     startedAt: string;
     startedBy: string;
-    status: PrebuiltWorkspaceState;
+    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 {
@@ -48,6 +118,7 @@ export interface Team {
     name: string;
     slug: string;
     creationTime: string;
+    markedDeleted?: boolean;
     /** This is a flag that triggers the HARD DELETION of this entity */
     deleted?: boolean;
 }

package/src/util/analytics.ts

@@ -5,7 +5,7 @@
  */
 
 import Analytics = require("analytics-node");
-import { IAnalyticsWriter, IdentifyMessage, TrackMessage } from "../analytics";
+import { IAnalyticsWriter, IdentifyMessage, TrackMessage, PageMessage } from "../analytics";
 import { log } from './logging';
 
 
@@ -52,6 +52,18 @@ class SegmentAnalyticsWriter implements IAnalyticsWriter {
         }
     }
 
+    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 {
@@ -62,10 +74,14 @@ class LogAnalyticsWriter implements IAnalyticsWriter {
     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;
@@ -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

@@ -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-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}=`);
+};

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;
@@ -85,27 +85,27 @@ export class GitpodHostUrl {
     }
 
     asDashboard(): GitpodHostUrl {
-        return this.with(url => ({ pathname: '/workspaces/' }));
+        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: '/access-control/' }));
+        return this.with(url => ({ pathname: '/integrations' }));
     }
 
     asSettings(): GitpodHostUrl {
-        return this.with(url => ({ pathname: '/settings/' }));
+        return this.with(url => ({ pathname: '/settings' }));
     }
 
-    asGraphQLApi(): GitpodHostUrl {
-        return this.with(url => ({ pathname: '/graphql/' }));
+    asPreferences(): GitpodHostUrl {
+        return this.with(url => ({ pathname: '/preferences' }));
     }
 
     asStart(workspaceId = this.workspaceId): GitpodHostUrl {
@@ -150,7 +150,7 @@ export class GitpodHostUrl {
         return undefined;
     }
 
-    get blobServe(): boolean {
+    get blobServe(): boolean {
         const hostSegments = this.url.host.split(".");
         if (hostSegments[0] === 'blobserve') {
             return true;