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

package/src/messaging/node/connection.ts

@@ -65,13 +65,13 @@ export function toIWebSocket(webSocket: ws) {
         send: content => {
             if (webSocket.readyState !== ws.OPEN) {
                 if (sendsAfterOpen++ > 3) {
-                    log.error(`Repeated try to send on closed web socket (readyState was ${webSocket.readyState})`, { ws });
+                    //log.debug(`Repeated try to send on closed web socket (readyState was ${webSocket.readyState})`, { ws });
                 }
                 return;
             }
             webSocket.send(content, err => {
                 if (err) {
-                    log.error('Error in ws.send()', err, { ws });
+                    log.error('error in ws.send()', err, { ws });
                 }
             })
         },

package/src/messaging/proxy-factory.ts

@@ -158,7 +158,9 @@ export class JsonRpcProxyFactory<T extends object> implements ProxyHandler<T> {
      * methods calls.
      */
     protected onNotification(method: string, ...args: any[]): void {
-        this.target[method](...args);
+        if (this.target[method]) {
+            this.target[method](...args);
+        }
     }
 
     /**

package/src/permission.ts

@@ -16,6 +16,7 @@ export const Permissions = {
     "admin-api": undefined,
     "ide-settings": undefined,
     "new-workspace-cluster": undefined,
+    "teams-and-projects": undefined,
 };
 export type PermissionName = keyof (typeof Permissions);
 export const Roles = {"devops": undefined, "viewer": undefined, "admin": undefined };

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.
@@ -103,10 +102,14 @@ export interface AdditionalUserData {
     // 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 = {
@@ -392,6 +395,7 @@ export interface Workspace {
     contextURL: string;
     description: string;
     ownerId: string;
+    projectId?: string;
     context: WorkspaceContext;
     config: WorkspaceConfig;
 
@@ -559,12 +563,13 @@ export interface WorkspaceConfig {
      * 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
-     * context - explicitly passed as part of the context
+     * 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' | 'context';
+    _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
@@ -594,11 +599,8 @@ export namespace GithubAppPrebuildConfig {
 
 export type WorkspaceImageSource = WorkspaceImageSourceDocker | WorkspaceImageSourceReference;
 export interface WorkspaceImageSourceDocker {
-    dockerFileContentSHA?: string
     dockerFilePath: string
-    // deprecated we use dockerFileContentSHA to compute the baseRef
-    dockerFileHash?: string
-    // deprecated we use dockerFileContentSHA to compute the baseRef
+    dockerFileHash: string
     dockerFileSource?: Commit
 }
 export namespace WorkspaceImageSourceDocker {
@@ -632,6 +634,8 @@ export type PrebuiltWorkspaceState
 export interface PrebuiltWorkspace {
     id: string;
     cloneURL: string;
+    branch?: string;
+    projectId?: string;
     commit: string;
     buildWorkspaceId: string;
     creationTime: string;
@@ -701,7 +705,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';
 }
@@ -801,6 +805,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;
 }
@@ -816,6 +843,8 @@ export namespace SnapshotContext {
 export interface StartPrebuildContext extends WorkspaceContext {
     actual: WorkspaceContext;
     commitHistory?: string[];
+    project?: Project;
+    branch?: string;
 }
 
 export namespace StartPrebuildContext {
@@ -885,7 +914,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
@@ -898,6 +927,10 @@ 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 {
@@ -975,6 +1008,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 {
@@ -1017,6 +1063,7 @@ export interface WorkspaceCreationResult {
     runningWorkspacePrebuild?: {
         prebuildID: string
         workspaceID: string
+        instanceID: string
         starting: RunningWorkspacePrebuildStarting
         sameCluster: boolean
     }
@@ -1193,21 +1240,3 @@ export interface Terms {
     readonly content: string;
     readonly formElements?: object;
 }
-
-export interface Project {
-    id: string;
-    cloneUrl: string;
-    teamId: string;
-    appInstallationId: string;
-    creationTime: string;
-    /** This is a flag that triggers the HARD DELETION of this entity */
-    deleted?: boolean;
-}
-
-export interface Team {
-    id: string;
-    name: string;
-    creationTime: string;
-    /** This is a flag that triggers the HARD DELETION of this entity */
-    deleted?: boolean;
-}

package/src/team-subscription-protocol.ts

@@ -4,7 +4,6 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import { Without } from "./util/without";
 import uuidv4 = require("uuid/v4");
 import { Subscription } from "./accounting-protocol";
 
@@ -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;
@@ -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,129 @@
+/**
+ * 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 uuidv4 = require("uuid/v4");
+
+export interface ProjectConfig {
+    '.gitpod.yml': string;
+}
+
+export interface Project {
+    id: string;
+    name: string;
+    cloneUrl: string;
+    teamId?: string;
+    userId?: string;
+    appInstallationId: string;
+    config?: ProjectConfig;
+    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 interface PrebuildWithStatus {
+    info: PrebuildInfo;
+    status: PrebuiltWorkspaceState;
+}
+
+export interface PrebuildInfo {
+    id: string;
+    buildWorkspaceId: 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 {
+    wsid: string;
+    done: boolean;
+    didFinish?: boolean;
+}
+
+export interface Team {
+    id: string;
+    name: string;
+    slug: string;
+    creationTime: string;
+    /** 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

@@ -5,30 +5,9 @@
  */
 
 import Analytics = require("analytics-node");
+import { IAnalyticsWriter, IdentifyMessage, TrackMessage } from "../analytics";
 import { log } from './logging';
 
-export const IAnalyticsWriter = Symbol("IAnalyticsWriter");
-
-type Identity =
-    | { userId: string | number }
-    | { userId?: string | number; anonymousId: string | number };
-
-interface Message {
-    messageId?: string;
-}
-
-export type IdentifyMessage = Message & Identity & {
-    traits?: any;
-    timestamp?: Date;
-    context?: any;
-};
-
-export type TrackMessage = Message & Identity & {
-    event: string;
-    properties?: any;
-    timestamp?: Date;
-    context?: any;
-};
 
 export function newAnalyticsWriterFromEnv(): IAnalyticsWriter {
     switch (process.env.GITPOD_ANALYTICS_WRITER) {
@@ -41,14 +20,6 @@ export function newAnalyticsWriterFromEnv(): IAnalyticsWriter {
     }
 }
 
-export interface IAnalyticsWriter {
-
-    identify(msg: IdentifyMessage): void;
-
-    track(msg: TrackMessage): void;
-
-}
-
 class SegmentAnalyticsWriter implements IAnalyticsWriter {
 
     protected readonly analytics: Analytics;

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

@@ -173,6 +173,7 @@ export const colors = [
     'deer',
     'dingo',
     'dinosaur',
+    'dodo',
     'dog',
     'dolphin',
     'donkey',

package/src/util/gitpod-host-url.spec.ts

@@ -25,5 +25,25 @@ export class GitpodHostUrlTest {
     @test public async testWithoutWorkspacePrefix() {
         expect(GitpodHostUrl.fromWorkspaceUrl("https://3000-moccasin-ferret-155799b3.ws-eu02.gitpod-staging.com/").withoutWorkspacePrefix().toString()).to.equal("https://gitpod-staging.com/");
     }
+
+    @test public async testWithoutWorkspacePrefix2() {
+        expect(GitpodHostUrl.fromWorkspaceUrl("https://gitpod-staging.com/").withoutWorkspacePrefix().toString()).to.equal("https://gitpod-staging.com/");
+    }
+
+    @test public async testWithoutWorkspacePrefix3() {
+        expect(GitpodHostUrl.fromWorkspaceUrl("https://gray-rook-5523v5d8.ws-dev.my-branch-1234.staging.gitpod-dev.com/").withoutWorkspacePrefix().toString()).to.equal("https://my-branch-1234.staging.gitpod-dev.com/");
+    }
+
+    @test public async testWithoutWorkspacePrefix4() {
+        expect(GitpodHostUrl.fromWorkspaceUrl("https://my-branch-1234.staging.gitpod-dev.com/").withoutWorkspacePrefix().toString()).to.equal("https://my-branch-1234.staging.gitpod-dev.com/");
+    }
+
+    @test public async testWithoutWorkspacePrefix5() {
+        expect(GitpodHostUrl.fromWorkspaceUrl("https://abc-nice-brunch-4224.staging.gitpod-dev.com/").withoutWorkspacePrefix().toString()).to.equal("https://abc-nice-brunch-4224.staging.gitpod-dev.com/");
+    }
+
+    @test public async testWithoutWorkspacePrefix6() {
+        expect(GitpodHostUrl.fromWorkspaceUrl("https://gray-rook-5523v5d8.ws-dev.abc-nice-brunch-4224.staging.gitpod-dev.com/").withoutWorkspacePrefix().toString()).to.equal("https://abc-nice-brunch-4224.staging.gitpod-dev.com/");
+    }
 }
 module.exports = new GitpodHostUrlTest()

package/src/util/gitpod-host-url.ts

@@ -18,7 +18,7 @@ const basewoWkspaceIDRegex = "(([a-f][0-9a-f]{7}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f
 const workspaceIDRegex = RegExp(`^${basewoWkspaceIDRegex}$`);
 
 // this pattern matches URL prefixes of workspaces
-const workspaceUrlPrefixRegex = RegExp(`^([0-9]{4,6}-)?${basewoWkspaceIDRegex}\.`);
+const workspaceUrlPrefixRegex = RegExp(`^([0-9]{4,6}-)?${basewoWkspaceIDRegex}\\.`);
 
 export class GitpodHostUrl {
     readonly url: URL;

package/src/util/grpc.ts

@@ -0,0 +1,15 @@
+/**
+ * Copyright (c) 2021 Gitpod GmbH. All rights reserved.
+ * Licensed under the GNU Affero General Public License (AGPL).
+ * See License-AGPL.txt in the project root for license information.
+ */
+
+ export const defaultGRPCOptions = {
+    "grpc.keepalive_timeout_ms": 1000,
+    "grpc.keepalive_time_ms": 5000,
+    "grpc.http2.min_time_between_pings_ms": 1000,
+    "grpc.keepalive_permit_without_calls": 1,
+    "grpc-node.max_session_memory": 50,
+    "grpc.max_reconnect_backoff_ms": 5000,
+    "grpc.max_receive_message_length": 1024 * 1024 * 16,
+};

package/src/util/logging.ts

@@ -97,24 +97,32 @@ export namespace log {
     /**
      * Do not use in frontend.
      */
-    export function enableJSONLogging(componentArg: string, versionArg: string | undefined): void {
+    export function enableJSONLogging(componentArg: string, versionArg: string | undefined, logLevel?: LogrusLogLevel): void {
         component = componentArg;
         version = versionArg;
 
+        setLogLevel(logLevel);
+    }
+
+    export function setLogLevel(logLevel: LogrusLogLevel | undefined) {
         jsonLogging = true;
 
-        console.error = function (...args: any[]): void {
-            errorLog(true, args);
-        }
-        console.warn = function (...args: any[]): void {
-            warnLog(true, args);
-        }
-        console.info = function (...args: any[]): void {
-            infoLog(true, args);
-        }
-        console.debug = function (...args: any[]): void {
-            debugLog(true, args);
-        }
+        const noop = () => {};
+        const setLog = (logFunc: (calleViaConsole: boolean, args: any[]) => void, funcLvl: LogrusLogLevel): (() => void) => {
+            if (LogrusLogLevel.isGreatherOrEqual(funcLvl, logLevel)) {
+                return function (...args: any[]): void {
+                    logFunc(true, args);
+                };
+            } else {
+                return noop;
+            }
+        };
+
+        console.error = setLog(errorLog, "error");
+        console.warn = setLog(warnLog, "warning");
+        console.info = setLog(infoLog, "info");
+        console.debug = setLog(debugLog, "debug");
+
         console.log = console.info;
         // FIXME wrap also other console methods (e.g. trace())
     }
@@ -128,6 +136,10 @@ export namespace log {
         console.info = infoConsoleLog;
         console.debug = debugConsoleLog;
     }
+
+    export function setVersion(versionArg: string) {
+        version = versionArg;
+    }
 }
 
 function errorLog(calledViaConsole: boolean, args: any[]): void {
@@ -146,6 +158,45 @@ function debugLog(calledViaConsole: boolean, args: any[]): void {
     doLog(calledViaConsole, debugConsoleLog, 'DEBUG', args);
 }
 
+// Ref: https://github.com/sirupsen/logrus#level-logging
+export type LogrusLogLevel = keyof (typeof LogrusLogLevels);
+export const LogrusLogLevels = {
+    trace: true,
+    debug: true,
+    info: true,
+    warning: true,
+    error: true,
+    fatal: true,
+    panic: true,
+}
+export namespace LogrusLogLevel {
+    export function isGreatherOrEqual(lvl: LogrusLogLevel | undefined, ref: LogrusLogLevel | undefined): boolean {
+        if (lvl === undefined) {
+            return false;
+        }
+        if (ref === undefined) {
+            return true;
+        }
+        return getLevelArity(lvl) >= getLevelArity(ref);
+    }
+    function getLevelArity(lvl: LogrusLogLevel): number {
+        return Object.keys(LogrusLogLevels)
+            .findIndex((l) => l === lvl);
+    }
+    export function getFromEnv(): LogrusLogLevel | undefined {
+        const lvlStr = process.env.LOG_LEVEL;
+        if (!lvlStr) {
+            return undefined;
+        }
+        const lvl = lvlStr as LogrusLogLevel;
+        const exists = LogrusLogLevels[lvl]
+        if (!exists) {
+            return undefined;
+        }
+        return lvl;
+    }
+}
+
 // Source: https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#LogSeverity
 type GoogleLogSeverity = 'EMERGENCY' | 'ALERT' | 'CRITICAL' | 'ERROR' | 'WARNING' | 'INFO' | 'DEBUG';
 namespace GoogleLogSeverity {

package/src/workspace-cluster.ts

@@ -7,7 +7,6 @@
 import * as fs from 'fs';
 import { filePathTelepresenceAware } from './env';
 import { DeepPartial } from "./util/deep-partial";
-import { Without } from './util/without';
 import { PermissionName } from './permission';
 
 export interface WorkspaceCluster {
@@ -50,7 +49,7 @@ export interface TLSConfig {
 export namespace TLSConfig {
     export const loadFromBase64File = (path: string): string => fs.readFileSync(filePathTelepresenceAware(path)).toString("base64");
 }
-export type WorkspaceClusterWoTLS = Without<WorkspaceCluster, "tls">;
+export type WorkspaceClusterWoTLS = Omit<WorkspaceCluster, "tls">;
 export type WorkspaceManagerConnectionInfo = Pick<WorkspaceCluster, "name" | "url" | "tls">;
 
 export type AdmissionConstraint = AdmissionConstraintFeaturePreview | AdmissionConstraintHasRole;

package/src/workspace-instance.ts

@@ -23,16 +23,22 @@ export interface WorkspaceInstance {
     // The time an instance has switched phase to 'Running'
     startedTime?: string;
 
+    // The time an instance has switched phase to 'Stopping' */
+    stoppingTime?: string;
+
     // The time an instance has switched phase to 'Stopped' */
     stoppedTime?: string;
 
     // ideUrl is the URL at which the workspace is available on the internet
+    // Note: this is nitially empty, filled during starting process!
     ideUrl: string;
 
     // region is the name of the workspace cluster this instance runs in
+    // Note: this is nitially empty, filled during starting process!
     region: string;
 
     // workspaceImage is the name of the Docker image this instance runs
+    // Note: this is nitially empty, filled during starting process!
     workspaceImage: string;
 
     // status is the latest status of the instance that we're aware of
@@ -83,7 +89,7 @@ export interface WorkspaceInstanceStatus {
 // WorkspaceInstancePhase describes a high-level state of a workspace instance
 export type WorkspaceInstancePhase =
     // unknown indicates an issue within the system in that it cannot determine the actual phase of
-	// a workspace. This phase is usually accompanied by an error.
+    // a workspace. This phase is usually accompanied by an error.
     "unknown" |
 
     // Preparing means that we haven't actually started the workspace instance just yet, but rather
@@ -91,21 +97,21 @@ export type WorkspaceInstancePhase =
     "preparing" |
 
     // Pending means the workspace does not yet consume resources in the cluster, but rather is looking for
-	// some space within the cluster. If for example the cluster needs to scale up to accomodate the
-	// workspace, the workspace will be in Pending state until that happened.
+    // some space within the cluster. If for example the cluster needs to scale up to accomodate the
+    // workspace, the workspace will be in Pending state until that happened.
     "pending" |
 
     // Creating means the workspace is currently being created. Thati includes downloading the images required
-	// to run the workspace over the network. The time spent in this phase varies widely and depends on the current
-	// network speed, image size and cache states.
+    // to run the workspace over the network. The time spent in this phase varies widely and depends on the current
+    // network speed, image size and cache states.
     "creating" |
 
     // Initializing is the phase in which the workspace is executing the appropriate workspace initializer (e.g. Git
-	// clone or backup download). After this phase one can expect the workspace to either be Running or Failed.
+    // clone or backup download). After this phase one can expect the workspace to either be Running or Failed.
     "initializing" |
 
     // Running means the workspace is able to actively perform work, either by serving a user through Theia,
-	// or as a headless workspace.
+    // or as a headless workspace.
     "running" |
 
     // Interrupted is an exceptional state where the container should be running but is temporarily unavailable.