@gitpod/gitpod-protocol 0.1.5-v0.6.0-beta4 → 0.1.5-vn-6525.75

package/src/protocol.ts

@@ -6,28 +6,28 @@
 
 import { WorkspaceInstance, PortVisibility } from "./workspace-instance";
 import { RoleOrPermission } from "./permission";
+import { Project } from "./teams-projects-protocol";
+import { createHash } from "crypto";
 
 export interface UserInfo {
-    name?: string
+    name?: string;
 }
 
 export interface User {
     /** The user id */
-    id: string
+    id: string;
 
     /** The timestamp when the user entry was created */
-    creationDate: string
+    creationDate: string;
 
-    avatarUrl?: string
+    avatarUrl?: string;
 
-    name?: string
+    name?: string;
 
     /** Optional for backwards compatibility */
-    fullName?: string
+    fullName?: string;
 
-    identities: Identity[]
-
-    allowsMarketingCommunication: boolean;
+    identities: Identity[];
 
     /**
      * Whether the user has been blocked to use our service, because of TOS violation for example.
@@ -35,11 +35,6 @@ export interface User {
      */
     blocked?: boolean;
 
-    /**
-     * whether this user can run workspaces in privileged mode
-     */
-    privileged?: boolean;
-
     /** A map of random settings that alter the behaviour of Gitpod on a per-user basis */
     featureFlags?: UserFeatureSettings;
 
@@ -54,29 +49,27 @@ export interface User {
 
 export namespace User {
     export function is(data: any): data is User {
-        return data
-            && data.hasOwnProperty('id')
-            && data.hasOwnProperty('identities')
+        return data && data.hasOwnProperty("id") && data.hasOwnProperty("identities");
     }
     export function getIdentity(user: User, authProviderId: string): Identity | undefined {
-        return user.identities.find(id => id.authProviderId === authProviderId);
+        return user.identities.find((id) => id.authProviderId === authProviderId);
     }
     export function censor(user: User): User {
         const res = { ...user };
-        delete (res.additionalData);
-        res.identities = res.identities.map(i => {
-            delete (i.tokens);
+        delete res.additionalData;
+        res.identities = res.identities.map((i) => {
+            delete i.tokens;
 
             // The user field is not in the Identity shape, but actually exists on DBIdentity.
             // Trying to push this object out via JSON RPC will fail because of the cyclic nature
             // of this field.
-            delete ((i as any).user);
+            delete (i as any).user;
             return i;
         });
         return res;
     }
     export function getPrimaryEmail(user: User): string {
-        const identities = user.identities.filter(i => !!i.primaryEmail);
+        const identities = user.identities.filter((i) => !!i.primaryEmail);
         if (identities.length <= 0) {
             throw new Error(`No identity with primary email for user: ${user.id}!`);
         }
@@ -103,15 +96,30 @@ export interface AdditionalUserData {
     emailNotificationSettings?: EmailNotificationSettings;
     featurePreview?: boolean;
     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[];
+
+    // 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
-}
+    defaultIde?: string;
+    useDesktopIde?: boolean;
+    defaultDesktopIde?: string;
+    useLatestVersion?: boolean;
+};
 
 export interface UserPlatform {
     uid: string;
@@ -132,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.
@@ -151,15 +151,30 @@ export interface UserFeatureSettings {
  * The values of this type MUST MATCH enum values in WorkspaceFeatureFlag from ws-manager/client/core_pb.d.ts
  * If they don't we'll break things during workspace startup.
  */
-export const WorkspaceFeatureFlags = { "privileged": undefined, "registry_facade": undefined, "full_workspace_backup": undefined, "fixed_resources": undefined, "user_namespace": undefined };
-export type NamedWorkspaceFeatureFlag = keyof (typeof WorkspaceFeatureFlags);
-
-export interface UserEnvVarValue {
-    id?: string;
+export const WorkspaceFeatureFlags = {
+    full_workspace_backup: undefined,
+    fixed_resources: undefined,
+    persistent_volume_claim: undefined,
+};
+export type NamedWorkspaceFeatureFlag = keyof typeof WorkspaceFeatureFlags;
+
+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;
@@ -167,26 +182,50 @@ 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
+        //      value/*     = 1
+        //      */value     = 2
+        //      */*         = 3
+        //      #/#         = 4 (used for env vars passed through the URL)
+        // the lower the score, the higher the precedence.
+        const [ownerPattern, repoPattern] = splitRepositoryPattern(value.repositoryPattern);
+        let score = 0;
+        if (repoPattern == "*") {
+            score += 1;
+        }
+        if (ownerPattern == "*") {
+            score += 2;
+        }
+        if (ownerPattern == "#" || repoPattern == "#") {
+            score = 4;
+        }
+        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 => {
+        let result = vars.filter((e) => {
             const [ownerPattern, repoPattern] = splitRepositoryPattern(e.repositoryPattern);
-            if (ownerPattern !== '*' && ownerPattern !== '#' && (!!owner && ownerPattern !== owner.toLocaleLowerCase())) {
+            if (ownerPattern !== "*" && ownerPattern !== "#" && !!owner && ownerPattern !== owner.toLocaleLowerCase()) {
                 return false;
             }
-            if (repoPattern !== '*' && repoPattern !== '#' && (!!repo && repoPattern !== repo.toLocaleLowerCase())) {
+            if (repoPattern !== "*" && repoPattern !== "#" && !!repo && repoPattern !== repo.toLocaleLowerCase()) {
                 return false;
             }
             return true;
         });
 
         const resmap = new Map<string, T[]>();
-        result.forEach(e => {
-            const l = (resmap.get(e.name) || []);
+        result.forEach((e) => {
+            const l = resmap.get(e.name) || [];
             l.push(e);
             resmap.set(e.name, l);
         });
@@ -207,25 +246,7 @@ export namespace UserEnvVar {
             let minscore = 10;
             let bestCandidate: T | undefined;
             for (const e of candidates) {
-                // We use a score to enforce precedence:
-                //      value/value = 0
-                //      value/*     = 1
-                //      */value     = 2
-                //      */*         = 3
-                //      #/#         = 4 (used for env vars passed through the URL)
-                // the lower the score, the higher the precedence.
-                const [ownerPattern, repoPattern] = splitRepositoryPattern(e.repositoryPattern);
-                let score = 0;
-                if (repoPattern == "*") {
-                    score += 1;
-                }
-                if (ownerPattern == '*') {
-                    score += 2;
-                }
-                if (ownerPattern == "#" || repoPattern == "#") {
-                    score = 4;
-                }
-
+                const score = UserEnvVar.score(e);
                 if (!bestCandidate || score < minscore) {
                     minscore = score;
                     bestCandidate = e;
@@ -237,47 +258,47 @@ export namespace UserEnvVar {
         return result;
     }
 
-    function splitRepositoryPattern(repositoryPattern: string): string[] {
-        const patterns = repositoryPattern.split('/');
-        const repoPattern = patterns.pop() || "";
-        const ownerPattern = patterns.join('/');
+    // 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.slice(1).join("/");
+        const ownerPattern = patterns[0];
         return [ownerPattern, repoPattern];
     }
 }
 
 export interface GitpodToken {
-
     /** Hash value (SHA256) of the token (primary key). */
-    tokenHash: string
+    tokenHash: string;
 
     /** Human readable name of the token */
-    name?: string
+    name?: string;
 
     /** Token kind */
-    type: GitpodTokenType
+    type: GitpodTokenType;
 
     /** The user the token belongs to. */
-    user: User
+    user: User;
 
     /** Scopes (e.g. limition to read-only) */
-    scopes: string[]
+    scopes: string[];
 
     /** Created timestamp */
-    created: string
+    created: string;
 
     // token is deleted on the database and about to be collected by db-sync
-    deleted?: boolean
+    deleted?: boolean;
 }
 
 export enum GitpodTokenType {
     API_AUTH_TOKEN = 0,
-    MACHINE_AUTH_TOKEN = 1
+    MACHINE_AUTH_TOKEN = 1,
 }
 
 export interface OneTimeSecret {
-    id: string
+    id: string;
 
-    value: string
+    value: string;
 
     expirationTime: string;
 
@@ -309,13 +330,12 @@ export type IdentityLookup = Pick<Identity, "authProviderId" | "authId">;
 
 export namespace Identity {
     export function is(data: any): data is Identity {
-        return data.hasOwnProperty('authProviderId')
-            && data.hasOwnProperty('authId')
-            && data.hasOwnProperty('authName')
+        return (
+            data.hasOwnProperty("authProviderId") && data.hasOwnProperty("authId") && data.hasOwnProperty("authName")
+        );
     }
     export function equals(id1: IdentityLookup, id2: IdentityLookup) {
-        return id1.authProviderId === id2.authProviderId
-            && id1.authId === id2.authId
+        return id1.authProviderId === id2.authProviderId && id1.authId === id2.authId;
     }
 }
 
@@ -371,11 +391,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;
@@ -388,6 +413,7 @@ export interface Workspace {
     contextURL: string;
     description: string;
     ownerId: string;
+    projectId?: string;
     context: WorkspaceContext;
     config: WorkspaceConfig;
 
@@ -402,13 +428,13 @@ export interface Workspace {
      * The resolved, fix name of the workspace image. We only use this
      * to access the logs during an image build.
      */
-    imageNameResolved?: string
+    imageNameResolved?: string;
 
     /**
      * The resolved/built fixed named of the base image. This field is only set if the workspace
      * already has its base image built.
      */
-    baseImageNameResolved?: string
+    baseImageNameResolved?: string;
 
     shareable?: boolean;
     pinned?: boolean;
@@ -445,17 +471,16 @@ export type WorkspaceSoftDeletion = "user" | "gc";
 export type WorkspaceType = "regular" | "prebuild" | "probe";
 
 export namespace Workspace {
-
     export function getFullRepositoryName(ws: Workspace): string | undefined {
         if (CommitContext.is(ws.context)) {
-            return ws.context.repository.owner + '/' + ws.context.repository.name
+            return ws.context.repository.owner + "/" + ws.context.repository.name;
         }
         return undefined;
     }
 
     export function getFullRepositoryUrl(ws: Workspace): string | undefined {
         if (CommitContext.is(ws.context)) {
-            return `https://${ws.context.repository.host}/${getFullRepositoryName(ws)}`
+            return `https://${ws.context.repository.host}/${getFullRepositoryName(ws)}`;
         }
         return undefined;
     }
@@ -489,41 +514,36 @@ export namespace Workspace {
     }
 }
 
-export interface PreparePluginUploadParams {
-    fullPluginName: string;
-}
-
-export interface ResolvePluginsParams {
-    config?: WorkspaceConfig
-    builtins?: ResolvedPlugins
-    vsxRegistryUrl?: string
+export interface GuessGitTokenScopesParams {
+    host: string;
+    repoUrl: string;
+    gitCommand: string;
+    currentToken: GitToken;
 }
 
-export interface InstallPluginsParams {
-    pluginIds: string[]
+export interface GitToken {
+    token: string;
+    user: string;
+    scopes: string[];
 }
 
-export interface UninstallPluginParams {
-    pluginId: string;
+export interface GuessedGitTokenScopes {
+    message?: string;
+    scopes?: string[];
 }
 
-export type ResolvedPluginKind = 'user' | 'workspace' | 'builtin';
-
-export interface ResolvedPlugins {
-    [pluginId: string]: ResolvedPlugin | undefined
+export interface VSCodeConfig {
+    extensions?: string[];
 }
 
-export interface ResolvedPlugin {
-    fullPluginName: string;
+export interface RepositoryCloneInformation {
     url: string;
-    kind: ResolvedPluginKind;
-}
-
-export interface VSCodeConfig {
-    extensions?: string[];
+    checkoutLocation?: string;
 }
 
 export interface WorkspaceConfig {
+    mainConfiguration?: string;
+    additionalRepositories?: RepositoryCloneInformation[];
     image?: ImageConfig;
     ports?: PortConfig[];
     tasks?: TaskConfig[];
@@ -532,16 +552,21 @@ export interface WorkspaceConfig {
     gitConfig?: { [config: string]: string };
     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
@@ -551,37 +576,33 @@ export interface WorkspaceConfig {
 }
 
 export interface GithubAppConfig {
-    prebuilds?: GithubAppPrebuildConfig
+    prebuilds?: GithubAppPrebuildConfig;
 }
 export interface GithubAppPrebuildConfig {
-    master?: boolean
-    branches?: boolean
-    pullRequests?: boolean
-    pullRequestsFromForks?: boolean
-    addCheck?: boolean
-    addBadge?: boolean
-    addLabel?: boolean | string
-    addComment?: boolean
+    master?: boolean;
+    branches?: boolean;
+    pullRequests?: boolean;
+    pullRequestsFromForks?: boolean;
+    addCheck?: boolean | "prevent-merge-on-error";
+    addBadge?: boolean;
+    addLabel?: boolean | string;
+    addComment?: boolean;
 }
 export namespace GithubAppPrebuildConfig {
     export function is(obj: boolean | GithubAppPrebuildConfig): obj is GithubAppPrebuildConfig {
-        return !(typeof obj === 'boolean');
+        return !(typeof obj === "boolean");
     }
 }
 
 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
+    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;
+        return "dockerFileHash" in obj && "dockerFilePath" in obj;
     }
 }
 export interface WorkspaceImageSourceReference {
@@ -590,36 +611,41 @@ export interface WorkspaceImageSourceReference {
 }
 export namespace WorkspaceImageSourceReference {
     export function is(obj: object): obj is WorkspaceImageSourceReference {
-        return 'baseImageResolved' in obj;
+        return "baseImageResolved" in obj;
     }
 }
 
-export type PrebuiltWorkspaceState
+export type PrebuiltWorkspaceState =
     // the prebuild is queued and may start at anytime
-    = "queued"
+    | "queued"
     // the workspace prebuild is currently running (i.e. there's a workspace pod deployed)
     | "building"
-    // the prebuild failed due to some issue with the system (e.g. missed a message, could not start workspace)
+    // the prebuild was aborted
     | "aborted"
     // the prebuild timed out
     | "timeout"
-    // the prebuild has finished and a snapshot is available
-    | "available";
+    // the prebuild has finished (even if a headless task failed) and a snapshot is available
+    | "available"
+    // the prebuild (headless workspace) failed due to some system error
+    | "failed";
 
 export interface PrebuiltWorkspace {
     id: string;
     cloneURL: string;
+    branch?: string;
+    projectId?: string;
     commit: string;
     buildWorkspaceId: string;
     creationTime: string;
     state: PrebuiltWorkspaceState;
+    statusVersion: number;
     error?: string;
     snapshot?: string;
 }
 
 export namespace PrebuiltWorkspace {
     export function isDone(pws: PrebuiltWorkspace) {
-        return pws.state === "available" || pws.state === "timeout" || pws.state === 'aborted';
+        return pws.state === "available" || pws.state === "timeout" || pws.state === "aborted";
     }
 
     export function isAvailable(pws: PrebuiltWorkspace) {
@@ -638,27 +664,33 @@ export interface PrebuiltWorkspaceUpdatable {
     repo: string;
     isResolved: boolean;
     installationId: string;
+    /**
+     * the commitSHA of the commit that triggered the prebuild
+     */
+    commitSHA?: string;
     issue?: string;
     contextUrl?: string;
 }
 
 export interface WhitelistedRepository {
-    url: string
-    name: string
-    description?: string
-    avatar?: string
+    url: string;
+    name: string;
+    description?: string;
+    avatar?: string;
 }
 
-export type PortOnOpen = 'open-browser' | 'open-preview' | 'notify' | 'ignore';
+export type PortOnOpen = "open-browser" | "open-preview" | "notify" | "ignore";
 
 export interface PortConfig {
     port: number;
     onOpen?: PortOnOpen;
     visibility?: PortVisibility;
+    description?: string;
+    name?: string;
 }
 export namespace PortConfig {
     export function is(config: any): config is PortConfig {
-        return config && ('port' in config) && (typeof config.port === 'number');
+        return config && "port" in config && typeof config.port === "number";
     }
 }
 
@@ -668,7 +700,7 @@ export interface PortRangeConfig {
 }
 export namespace PortRangeConfig {
     export function is(config: any): config is PortRangeConfig {
-        return config && ('port' in config) && (typeof config.port === 'string' || config.port instanceof String);
+        return config && "port" in config && (typeof config.port === "string" || config.port instanceof String);
     }
 }
 
@@ -678,33 +710,32 @@ export interface TaskConfig {
     init?: string;
     prebuild?: string;
     command?: string;
-    env?: { [env: string]: string };
-    openIn?: 'bottom' | 'main' | 'left' | 'right';
-    openMode?: 'split-top' | 'split-left' | 'split-right' | 'split-bottom' | 'tab-before' | 'tab-after';
+    env?: { [env: string]: any };
+    openIn?: "bottom" | "main" | "left" | "right";
+    openMode?: "split-top" | "split-left" | "split-right" | "split-bottom" | "tab-before" | "tab-after";
 }
 
 export namespace TaskConfig {
     export function is(config: any): config is TaskConfig {
-        return config
-            && ('command' in config || 'init' in config || 'before' in config);
+        return config && ("command" in config || "init" in config || "before" in config);
     }
 }
 
 export namespace WorkspaceImageBuild {
-    export type Phase = 'BaseImage' | 'GitpodLayer' | 'Error' | 'Done';
+    export type Phase = "BaseImage" | "GitpodLayer" | "Error" | "Done";
     export interface StateInfo {
-        phase: Phase
-        currentStep?: number
-        maxSteps?: number
+        phase: Phase;
+        currentStep?: number;
+        maxSteps?: number;
     }
     export interface LogContent {
-        text: string
-        upToLine?: number
-        isDiff?: boolean
+        text: string;
+        upToLine?: number;
+        isDiff?: boolean;
     }
     export type LogCallback = (info: StateInfo, content: LogContent | undefined) => void;
     export namespace LogLine {
-        export const DELIMITER = '\r\n';
+        export const DELIMITER = "\r\n";
         export const DELIMITER_REGEX = /\r?\n/;
     }
 }
@@ -713,20 +744,18 @@ export type ImageConfig = ImageConfigString | ImageConfigFile;
 export type ImageConfigString = string;
 export namespace ImageConfigString {
     export function is(config: ImageConfig | undefined): config is ImageConfigString {
-        return typeof config === 'string';
+        return typeof config === "string";
     }
-
 }
 export interface ImageConfigFile {
     // Path to the Dockerfile relative to repository root
-    file: string,
+    file: string;
     // Path to the docker build context relative to repository root
-    context?: string
+    context?: string;
 }
 export namespace ImageConfigFile {
     export function is(config: ImageConfig | undefined): config is ImageConfigFile {
-        return typeof config === 'object'
-            && 'file' in config;
+        return typeof config === "object" && "file" in config;
     }
 }
 export interface ExternalImageConfigFile extends ImageConfigFile {
@@ -734,22 +763,21 @@ export interface ExternalImageConfigFile extends ImageConfigFile {
 }
 export namespace ExternalImageConfigFile {
     export function is(config: any | undefined): config is ExternalImageConfigFile {
-        return typeof config === 'object'
-            && 'file' in config
-            && 'externalSource' in config;
+        return typeof config === "object" && "file" in config && "externalSource" in config;
     }
 }
 
 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 {
     export function is(context: any): context is WorkspaceContext {
-        return context
-            && 'title' in context;
+        return context && "title" in context;
     }
 }
 
@@ -758,22 +786,38 @@ export interface WithSnapshot {
 }
 export namespace WithSnapshot {
     export function is(context: any): context is WithSnapshot {
-        return context
-            && 'snapshotBucketId' in context;
+        return context && "snapshotBucketId" in context;
     }
 }
 
-export interface WithPrebuild {
-    snapshotBucketId: string;
+export interface WithPrebuild extends WithSnapshot {
     prebuildWorkspaceId: string;
     wasPrebuilt: true;
 }
 export namespace WithPrebuild {
     export function is(context: any): context is WithPrebuild {
-        return context
-            && 'snapshotBucketId' in context
-            && 'prebuildWorkspaceId' in context
-            && 'wasPrebuilt' in context;
+        return context && WithSnapshot.is(context) && "prebuildWorkspaceId" in context && "wasPrebuilt" in context;
+    }
+}
+
+/**
+ * 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,
+        };
     }
 }
 
@@ -783,20 +827,24 @@ export interface SnapshotContext extends WorkspaceContext, WithSnapshot {
 
 export namespace SnapshotContext {
     export function is(context: any): context is SnapshotContext {
-        return context
-            && WithSnapshot.is(context)
-            && 'snapshotId' in context;
+        return context && WithSnapshot.is(context) && "snapshotId" in context;
     }
 }
 
 export interface StartPrebuildContext extends WorkspaceContext {
     actual: WorkspaceContext;
+    commitHistory?: string[];
+    additionalRepositoryCommitHistories?: {
+        cloneUrl: string;
+        commitHistory: string[];
+    }[];
+    project?: Project;
+    branch?: string;
 }
 
 export namespace StartPrebuildContext {
     export function is(context: any): context is StartPrebuildContext {
-        return context
-            && 'actual' in context;
+        return context && "actual" in context;
     }
 }
 
@@ -808,33 +856,39 @@ export interface PrebuiltWorkspaceContext extends WorkspaceContext {
 
 export namespace PrebuiltWorkspaceContext {
     export function is(context: any): context is PrebuiltWorkspaceContext {
-        return context
-            && 'originalContext' in context
-            && 'prebuiltWorkspace' in context;
+        return context && "originalContext" in context && "prebuiltWorkspace" in context;
+    }
+}
+
+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 {
     export function is(context: any): context is WithEnvvarsContext {
-        return context
-            && 'envvars' in context
+        return context && "envvars" in context;
     }
 }
 
 export interface WorkspaceProbeContext extends WorkspaceContext {
-    responseURL: string
-    responseToken: string
+    responseURL: string;
+    responseToken: string;
 }
 
 export namespace WorkspaceProbeContext {
     export function is(context: any): context is WorkspaceProbeContext {
-        return context
-            && 'responseURL' in context
-            && 'responseToken' in context;
+        return context && "responseURL" in context && "responseToken" in context;
     }
 }
 
@@ -846,30 +900,80 @@ export namespace RefType {
         }
         // This fallback is meant to handle the cases where (for historic reasons) ref is present but refType is missing
         return commit.refType || "branch";
-    }
+    };
 }
 
 export interface Commit {
-    repository: Repository
-    revision: string
+    repository: Repository;
+    revision: string;
 
     // Might contain either a branch or a tag (determined by refType)
-    ref?: string
+    ref?: string;
 
     // refType is only set if ref is present (and not for old workspaces, before this feature was added)
-    refType?: RefType
+    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 interface CommitContext extends WorkspaceContext, Commit {
+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, GitCheckoutInfo {
     /** @deprecated Moved to .repository.cloneUrl, left here for backwards-compatibility for old workspace contextes in the DB */
-    cloneUrl?: string
+    cloneUrl?: string;
+
+    /**
+     * The clone and checkout information for additional repositories in case of multi-repo projects.
+     */
+    additionalRepositoryCheckoutInfo?: GitCheckoutInfo[];
+}
+
+export namespace CommitContext {
+    /**
+     * Creates a hash for all the commits of the CommitContext and all sub-repo commit infos.
+     * The hash is max 255 chars long.
+     * @param commitContext
+     * @returns hash for commitcontext
+     */
+    export function computeHash(commitContext: CommitContext): string {
+        // for single commits we use the revision to be backward compatible.
+        if (
+            !commitContext.additionalRepositoryCheckoutInfo ||
+            commitContext.additionalRepositoryCheckoutInfo.length === 0
+        ) {
+            return commitContext.revision;
+        }
+        const hasher = createHash("sha256");
+        hasher.update(commitContext.revision);
+        for (const info of commitContext.additionalRepositoryCheckoutInfo) {
+            hasher.update(info.revision);
+        }
+        return hasher.digest("hex");
+    }
+}
+
+export interface GitCheckoutInfo extends Commit {
+    checkoutLocation?: string;
+    upstreamRemoteURI?: string;
+    localBranch?: string;
 }
 
 export namespace CommitContext {
     export function is(commit: any): commit is CommitContext {
-        return WorkspaceContext.is(commit)
-            && 'repository' in commit
-            && 'revision' in commit
+        return WorkspaceContext.is(commit) && "repository" in commit && "revision" in commit;
     }
 }
 
@@ -877,17 +981,14 @@ export interface PullRequestContext extends CommitContext {
     nr: number;
     ref: string;
     base: {
-        repository: Repository
-        ref: string
-    }
+        repository: Repository;
+        ref: string;
+    };
 }
 
 export namespace PullRequestContext {
     export function is(ctx: any): ctx is PullRequestContext {
-        return CommitContext.is(ctx)
-            && 'nr' in ctx
-            && 'ref' in ctx
-            && 'base' in ctx
+        return CommitContext.is(ctx) && "nr" in ctx && "ref" in ctx && "base" in ctx;
     }
 }
 
@@ -899,10 +1000,7 @@ export interface IssueContext extends CommitContext {
 
 export namespace IssueContext {
     export function is(ctx: any): ctx is IssueContext {
-        return CommitContext.is(ctx)
-            && 'nr' in ctx
-            && 'ref' in ctx
-            && 'localBranch' in ctx
+        return CommitContext.is(ctx) && "nr" in ctx && "ref" in ctx && "localBranch" in ctx;
     }
 }
 
@@ -913,9 +1011,7 @@ export interface NavigatorContext extends CommitContext {
 
 export namespace NavigatorContext {
     export function is(ctx: any): ctx is NavigatorContext {
-        return CommitContext.is(ctx)
-            && 'path' in ctx
-            && 'isFile' in ctx
+        return CommitContext.is(ctx) && "path" in ctx && "isFile" in ctx;
     }
 }
 
@@ -924,6 +1020,8 @@ export interface Repository {
     owner: string;
     name: string;
     cloneUrl: string;
+    /* Optional kind to differentiate between repositories of orgs/groups/projects and personal repos. */
+    repoKind?: string;
     description?: string;
     avatarUrl?: string;
     webUrl?: string;
@@ -932,8 +1030,21 @@ export interface Repository {
     private?: boolean;
     fork?: {
         // The direct parent of this fork
-        parent: 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 {
@@ -945,21 +1056,25 @@ export namespace Repository {
 export interface WorkspaceInstancePortsChangedEvent {
     type: "PortsChanged";
     instanceID: string;
-    portsOpened: number[]
-    portsClosed: number[]
+    portsOpened: number[];
+    portsClosed: number[];
 }
 
 export namespace WorkspaceInstancePortsChangedEvent {
-
     export function is(data: any): data is WorkspaceInstancePortsChangedEvent {
         return data && data.type == "PortsChanged";
     }
-
 }
 
 export interface WorkspaceInfo {
-    workspace: Workspace
-    latestInstance?: WorkspaceInstance
+    workspace: Workspace;
+    latestInstance?: WorkspaceInstance;
+}
+
+export namespace WorkspaceInfo {
+    export function lastActiveISODate(info: WorkspaceInfo): string {
+        return info.latestInstance?.creationTime || info.workspace.creationTime;
+    }
 }
 
 export type RunningWorkspaceInfo = WorkspaceInfo & { latestInstance: WorkspaceInstance };
@@ -969,34 +1084,36 @@ export interface WorkspaceCreationResult {
     workspaceURL?: string;
     existingWorkspaces?: WorkspaceInfo[];
     runningWorkspacePrebuild?: {
-        prebuildID: string
-        workspaceID: string
-        starting: RunningWorkspacePrebuildStarting
-        sameCluster: boolean
-    }
+        prebuildID: string;
+        workspaceID: string;
+        instanceID: string;
+        starting: RunningWorkspacePrebuildStarting;
+        sameCluster: boolean;
+    };
     runningPrebuildWorkspaceID?: string;
 }
-export type RunningWorkspacePrebuildStarting = 'queued' | 'starting' | 'running';
+export type RunningWorkspacePrebuildStarting = "queued" | "starting" | "running";
 
 export enum CreateWorkspaceMode {
     // Default returns a running prebuild if there is any, otherwise creates a new workspace (using a prebuild if one is available)
-    Default = 'default',
+    Default = "default",
     // ForceNew creates a new workspace irrespective of any running prebuilds. This mode is guaranteed to actually create a workspace - but may degrade user experience as currently runnig prebuilds are ignored.
-    ForceNew = 'force-new',
+    ForceNew = "force-new",
     // UsePrebuild polls the database waiting for a currently running prebuild to become available. This mode exists to handle the db-sync delay.
-    UsePrebuild = 'use-prebuild',
+    UsePrebuild = "use-prebuild",
     // SelectIfRunning returns a list of currently running workspaces for the context URL if there are any, otherwise falls back to Default mode
-    SelectIfRunning = 'select-if-running',
+    SelectIfRunning = "select-if-running",
 }
 
 export namespace WorkspaceCreationResult {
     export function is(data: any): data is WorkspaceCreationResult {
-        return data && (
-            'createdWorkspaceId' in data
-            || 'existingWorkspaces' in data
-            || 'runningWorkspacePrebuild' in data
-            || 'runningPrebuildWorkspaceID' in data
-        )
+        return (
+            data &&
+            ("createdWorkspaceId" in data ||
+                "existingWorkspaces" in data ||
+                "runningWorkspacePrebuild" in data ||
+                "runningPrebuildWorkspaceID" in data)
+        );
     }
 }
 
@@ -1030,6 +1147,12 @@ export interface AuthProviderInfo {
         readonly default: string[];
         readonly publicRepo: string[];
         readonly privateRepo: string[];
+    };
+}
+
+export namespace AuthProviderInfo {
+    export function isGitHubEnterprise(info?: AuthProviderInfo): boolean {
+        return !!info && info.authProviderType === "GitHub" && info.host !== "github.com";
     }
 }
 
@@ -1042,6 +1165,8 @@ export interface AuthProviderEntry {
     readonly status: AuthProviderEntry.Status;
 
     readonly oauth: OAuth2Config;
+    /** A random string that is to change whenever oauth changes (enforced on DB level) */
+    readonly oauthRevision?: string;
 }
 
 export interface OAuth2Config {
@@ -1054,47 +1179,27 @@ export interface OAuth2Config {
     readonly scopeSeparator?: string;
 
     readonly settingsUrl?: string;
-    readonly authorizationParams?: { [key: string]: string }
+    readonly authorizationParams?: { [key: string]: string };
     readonly configURL?: string;
 }
 
 export namespace AuthProviderEntry {
     export type Type = "GitHub" | "GitLab" | string;
     export type Status = "pending" | "verified";
-    export type NewEntry = Pick<AuthProviderEntry, "ownerId" | "host" | "type">;
-    export type UpdateEntry = Pick<AuthProviderEntry, "id" | "ownerId"> & Pick<OAuth2Config, "clientId" | "clientSecret">;
-}
-
-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 type NewEntry = Pick<AuthProviderEntry, "ownerId" | "host" | "type"> & {
+        clientId?: string;
+        clientSecret?: string;
+    };
+    export type UpdateEntry = Pick<AuthProviderEntry, "id" | "ownerId"> &
+        Pick<OAuth2Config, "clientId" | "clientSecret">;
+    export function redact(entry: AuthProviderEntry): AuthProviderEntry {
+        return {
+            ...entry,
+            oauth: {
+                ...entry.oauth,
+                clientSecret: "redacted",
+            },
+        };
     }
 }