@gitpod/gitpod-protocol 0.1.5-me-ingress.20 → 0.1.5-me-test3.3

package/src/gitpod-service.ts

@@ -5,31 +5,52 @@
  */
 
 import {
-    User, WorkspaceInfo, WorkspaceCreationResult, WorkspaceInstanceUser,
-    WhitelistedRepository, WorkspaceImageBuild, AuthProviderInfo, Branding, CreateWorkspaceMode,
-    Token, UserEnvVarValue, ResolvePluginsParams, PreparePluginUploadParams, Terms,
-    ResolvedPlugins, Configuration, InstallPluginsParams, UninstallPluginParams, UserInfo, GitpodTokenType,
-    GitpodToken, AuthProviderEntry, GuessGitTokenScopesParams, GuessedGitTokenScopes
-} from './protocol';
+    User,
+    WorkspaceInfo,
+    WorkspaceCreationResult,
+    WorkspaceInstanceUser,
+    WhitelistedRepository,
+    WorkspaceImageBuild,
+    AuthProviderInfo,
+    CreateWorkspaceMode,
+    Token,
+    UserEnvVarValue,
+    Terms,
+    Configuration,
+    UserInfo,
+    GitpodTokenType,
+    GitpodToken,
+    AuthProviderEntry,
+    GuessGitTokenScopesParams,
+    GuessedGitTokenScopes,
+    ProjectEnvVar,
+} from "./protocol";
 import {
-    Team, TeamMemberInfo,
-    TeamMembershipInvite, Project, TeamMemberRole, PrebuildWithStatus, StartPrebuildResult, PartialProject
-} from './teams-projects-protocol';
-import { JsonRpcProxy, JsonRpcServer } from './messaging/proxy-factory';
-import { Disposable, CancellationTokenSource } from 'vscode-jsonrpc';
-import { HeadlessLogUrls } from './headless-workspace-log';
-import { WorkspaceInstance, WorkspaceInstancePort, WorkspaceInstancePhase } from './workspace-instance';
-import { AdminServer } from './admin-protocol';
-import { GitpodHostUrl } from './util/gitpod-host-url';
-import { WebSocketConnectionProvider } from './messaging/browser/connection';
-import { PermissionName } from './permission';
-import { LicenseService } from './license-protocol';
-import { Emitter } from './util/event';
-import { AccountStatement, CreditAlert } from './accounting-protocol';
-import { GithubUpgradeURL, PlanCoupon } from './payment-protocol';
-import { TeamSubscription, TeamSubscriptionSlot, TeamSubscriptionSlotResolved } from './team-subscription-protocol';
-import { RemotePageMessage, RemoteTrackMessage, RemoteIdentifyMessage } from './analytics';
-import { IDEServer } from './ide-protocol';
+    Team,
+    TeamMemberInfo,
+    TeamMembershipInvite,
+    Project,
+    TeamMemberRole,
+    PrebuildWithStatus,
+    StartPrebuildResult,
+    PartialProject,
+} from "./teams-projects-protocol";
+import { JsonRpcProxy, JsonRpcServer } from "./messaging/proxy-factory";
+import { Disposable, CancellationTokenSource } from "vscode-jsonrpc";
+import { HeadlessLogUrls } from "./headless-workspace-log";
+import { WorkspaceInstance, WorkspaceInstancePort, WorkspaceInstancePhase } from "./workspace-instance";
+import { AdminServer } from "./admin-protocol";
+import { GitpodHostUrl } from "./util/gitpod-host-url";
+import { WebSocketConnectionProvider } from "./messaging/browser/connection";
+import { PermissionName } from "./permission";
+import { LicenseService } from "./license-protocol";
+import { Emitter } from "./util/event";
+import { AccountStatement, CreditAlert } from "./accounting-protocol";
+import { GithubUpgradeURL, PlanCoupon } from "./payment-protocol";
+import { TeamSubscription, TeamSubscriptionSlot, TeamSubscriptionSlotResolved } from "./team-subscription-protocol";
+import { RemotePageMessage, RemoteTrackMessage, RemoteIdentifyMessage } from "./analytics";
+import { IDEServer } from "./ide-protocol";
+import { InstallationAdminSettings, TelemetryData } from "./installation-admin-protocol";
 
 export interface GitpodClient {
     onInstanceUpdate(instance: WorkspaceInstance): void;
@@ -45,7 +66,7 @@ export interface GitpodClient {
     //#endregion
 }
 
-export const GitpodServer = Symbol('GitpodServer');
+export const GitpodServer = Symbol("GitpodServer");
 export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer, LicenseService, IDEServer {
     // User related API
     getLoggedInUser(): Promise<User>;
@@ -55,7 +76,6 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     getOwnAuthProviders(): Promise<AuthProviderEntry[]>;
     updateOwnAuthProvider(params: GitpodServer.UpdateOwnAuthProviderParams): Promise<AuthProviderEntry>;
     deleteOwnAuthProvider(params: GitpodServer.DeleteOwnAuthProviderParams): Promise<void>;
-    getBranding(): Promise<Branding>;
     getConfiguration(): Promise<Configuration>;
     getToken(query: GitpodServer.GetTokenSearchOptions): Promise<Token | undefined>;
     getGitpodTokenScopes(tokenHash: string): Promise<string[]>;
@@ -72,8 +92,15 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     getWorkspaceOwner(workspaceId: string): Promise<UserInfo | undefined>;
     getWorkspaceUsers(workspaceId: string): Promise<WorkspaceInstanceUser[]>;
     getFeaturedRepositories(): Promise<WhitelistedRepository[]>;
+    getSuggestedContextURLs(): Promise<string[]>;
+    /**
+     * **Security:**
+     * Sensitive information like an owner token is erased, since it allows access for all team members.
+     * If you need to access an owner token use `getOwnerToken` instead.
+     */
     getWorkspace(id: string): Promise<WorkspaceInfo>;
     isWorkspaceOwner(workspaceId: string): Promise<boolean>;
+    getOwnerToken(workspaceId: string): Promise<string>;
 
     /**
      * Creates and starts a workspace for the given context URL.
@@ -126,6 +153,11 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     resetGenericInvite(inviteId: string): Promise<TeamMembershipInvite>;
     deleteTeam(teamId: string, userId: string): Promise<void>;
 
+    // Admin Settings
+    adminGetSettings(): Promise<InstallationAdminSettings>;
+    adminUpdateSettings(settings: InstallationAdminSettings): Promise<void>;
+    adminGetTelemetryData(): Promise<TelemetryData>;
+
     // Projects
     getProviderRepositoriesForUser(params: GetProviderRepositoriesParams): Promise<ProviderRepository[]>;
     createProject(params: CreateProjectParams): Promise<Project>;
@@ -142,10 +174,13 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     guessRepositoryConfiguration(cloneUrl: string): Promise<string | undefined>;
     setProjectConfiguration(projectId: string, configString: string): Promise<void>;
     updateProjectPartial(partialProject: PartialProject): Promise<void>;
+    setProjectEnvironmentVariable(projectId: string, name: string, value: string, censored: boolean): Promise<void>;
+    getProjectEnvironmentVariables(projectId: string): Promise<ProjectEnvVar[]>;
+    deleteProjectEnvironmentVariable(variableId: string): Promise<void>;
 
     // content service
-    getContentBlobUploadUrl(name: string): Promise<string>
-    getContentBlobDownloadUrl(name: string): Promise<string>
+    getContentBlobUploadUrl(name: string): Promise<string>;
+    getContentBlobDownloadUrl(name: string): Promise<string>;
 
     // Gitpod token
     getGitpodTokens(): Promise<GitpodToken[]>;
@@ -154,6 +189,7 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
 
     // misc
     sendFeedback(feedback: string): Promise<string | undefined>;
+    isGitHubAppEnabled(): Promise<boolean>;
     registerGithubApp(installationId: string): Promise<void>;
 
     /**
@@ -182,15 +218,6 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
      */
     getLayout(workspaceId: string): Promise<string | undefined>;
 
-    /**
-     * @param params
-     * @returns promise resolves to an URL to be used for the upload
-     */
-    preparePluginUpload(params: PreparePluginUploadParams): Promise<string>
-    resolvePlugins(workspaceId: string, params: ResolvePluginsParams): Promise<ResolvedPlugins>;
-    installUserPlugins(params: InstallPluginsParams): Promise<boolean>;
-    uninstallUserPlugin(params: UninstallPluginParams): Promise<boolean>;
-
     guessGitTokenScopes(params: GuessGitTokenScopesParams): Promise<GuessedGitTokenScopes>;
 
     /**
@@ -222,9 +249,13 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
 
     tsGet(): Promise<TeamSubscription[]>;
     tsGetSlots(): Promise<TeamSubscriptionSlotResolved[]>;
-    tsGetUnassignedSlot(teamSubscriptionId: string): Promise<TeamSubscriptionSlot | undefined>
+    tsGetUnassignedSlot(teamSubscriptionId: string): Promise<TeamSubscriptionSlot | undefined>;
     tsAddSlots(teamSubscriptionId: string, quantity: number): Promise<void>;
-    tsAssignSlot(teamSubscriptionId: string, teamSubscriptionSlotId: string, identityStr: string | undefined): Promise<void>
+    tsAssignSlot(
+        teamSubscriptionId: string,
+        teamSubscriptionSlotId: string,
+        identityStr: string | undefined,
+    ): Promise<void>;
     tsReassignSlot(teamSubscriptionId: string, teamSubscriptionSlotId: string, newIdentityStr: string): Promise<void>;
     tsDeactivateSlot(teamSubscriptionId: string, teamSubscriptionSlotId: string): Promise<void>;
     tsReactivateSlot(teamSubscriptionId: string, teamSubscriptionSlotId: string): Promise<void>;
@@ -239,6 +270,16 @@ export interface GitpodServer extends JsonRpcServer<GitpodClient>, AdminServer,
     identifyUser(event: RemoteIdentifyMessage): Promise<void>;
 }
 
+export interface RateLimiterError {
+    method?: string;
+
+    /**
+     * Retry after this many seconds, earliest.
+     * cmp.: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
+     */
+    retryAfter: number;
+}
+
 export interface CreateProjectParams {
     name: string;
     slug?: string;
@@ -267,7 +308,7 @@ export interface ProviderRepository {
     account: string;
     accountAvatarUrl: string;
     cloneUrl: string;
-    updatedAt: string;
+    updatedAt?: string;
     installationId?: number;
     installationUpdatedAt?: string;
 
@@ -281,15 +322,28 @@ export interface ClientHeaderFields {
     clientRegion?: string;
 }
 
-export const WorkspaceTimeoutValues = ["30m", "60m", "180m"] as const;
-
-export const createServiceMock = function <C extends GitpodClient, S extends GitpodServer>(methods: Partial<JsonRpcProxy<S>>): GitpodServiceImpl<C, S> {
+export const WORKSPACE_TIMEOUT_DEFAULT_SHORT = "short";
+export const WORKSPACE_TIMEOUT_DEFAULT_LONG = "long";
+export const WORKSPACE_TIMEOUT_EXTENDED = "extended";
+export const WORKSPACE_TIMEOUT_EXTENDED_ALT = "180m"; // for backwards compatibility since the IDE uses this
+export const WorkspaceTimeoutValues = [
+    WORKSPACE_TIMEOUT_DEFAULT_SHORT,
+    WORKSPACE_TIMEOUT_DEFAULT_LONG,
+    WORKSPACE_TIMEOUT_EXTENDED,
+    WORKSPACE_TIMEOUT_EXTENDED_ALT,
+] as const;
+
+export const createServiceMock = function <C extends GitpodClient, S extends GitpodServer>(
+    methods: Partial<JsonRpcProxy<S>>,
+): GitpodServiceImpl<C, S> {
     return new GitpodServiceImpl<C, S>(createServerMock(methods));
-}
+};
 
-export const createServerMock = function <C extends GitpodClient, S extends GitpodServer>(methods: Partial<JsonRpcProxy<S>>): JsonRpcProxy<S> {
-    methods.setClient = methods.setClient || (() => { });
-    methods.dispose = methods.dispose || (() => { });
+export const createServerMock = function <C extends GitpodClient, S extends GitpodServer>(
+    methods: Partial<JsonRpcProxy<S>>,
+): JsonRpcProxy<S> {
+    methods.setClient = methods.setClient || (() => {});
+    methods.dispose = methods.dispose || (() => {});
     return new Proxy<JsonRpcProxy<S>>(methods as any as JsonRpcProxy<S>, {
         // @ts-ignore
         get: (target: S, property: keyof S) => {
@@ -298,25 +352,25 @@ export const createServerMock = function <C extends GitpodClient, S extends Gitp
                 throw new Error(`Method ${property} not implemented`);
             }
             return result;
-        }
+        },
     });
-}
+};
 
 type WorkspaceTimeoutDurationTuple = typeof WorkspaceTimeoutValues;
 export type WorkspaceTimeoutDuration = WorkspaceTimeoutDurationTuple[number];
 
 export interface SetWorkspaceTimeoutResult {
-    resetTimeoutOnWorkspaces: string[]
+    resetTimeoutOnWorkspaces: string[];
 }
 
 export interface GetWorkspaceTimeoutResult {
-    duration: WorkspaceTimeoutDuration
-    canChange: boolean
+    duration: WorkspaceTimeoutDuration;
+    canChange: boolean;
 }
 
 export interface StartWorkspaceResult {
-    instanceID: string
-    workspaceURL?: string
+    instanceID: string;
+    workspaceURL?: string;
 }
 
 export namespace GitpodServer {
@@ -360,23 +414,23 @@ export namespace GitpodServer {
         readonly roundTripTime?: number;
     }
     export interface UpdateOwnAuthProviderParams {
-        readonly entry: AuthProviderEntry.UpdateEntry | AuthProviderEntry.NewEntry
+        readonly entry: AuthProviderEntry.UpdateEntry | AuthProviderEntry.NewEntry;
     }
     export interface DeleteOwnAuthProviderParams {
-        readonly id: string
+        readonly id: string;
     }
     export type AdmissionLevel = "owner" | "everyone";
     export type PinAction = "pin" | "unpin" | "toggle";
     export interface GenerateNewGitpodTokenOptions {
-        name?: string
-        type: GitpodTokenType
-        scopes?: string[]
+        name?: string;
+        type: GitpodTokenType;
+        scopes?: string[];
     }
 }
 
-export const GitpodServerPath = '/gitpod';
+export const GitpodServerPath = "/gitpod";
 
-export const GitpodServerProxy = Symbol('GitpodServerProxy');
+export const GitpodServerProxy = Symbol("GitpodServerProxy");
 export type GitpodServerProxy<S extends GitpodServer> = JsonRpcProxy<S>;
 
 export class GitpodCompositeClient<Client extends GitpodClient> implements GitpodClient {
@@ -384,12 +438,14 @@ export class GitpodCompositeClient<Client extends GitpodClient> implements Gitpo
 
     public registerClient(client: Partial<Client>): Disposable {
         this.clients.push(client);
-        const index = this.clients.length;
         return {
             dispose: () => {
-                this.clients.slice(index, 1);
-            }
-        }
+                const index = this.clients.indexOf(client);
+                if (index > -1) {
+                    this.clients.splice(index, 1);
+                }
+            },
+        };
     }
 
     onInstanceUpdate(instance: WorkspaceInstance): void {
@@ -398,7 +454,7 @@ export class GitpodCompositeClient<Client extends GitpodClient> implements Gitpo
                 try {
                     client.onInstanceUpdate(instance);
                 } catch (error) {
-                    console.error(error)
+                    console.error(error);
                 }
             }
         }
@@ -410,19 +466,22 @@ export class GitpodCompositeClient<Client extends GitpodClient> implements Gitpo
                 try {
                     client.onPrebuildUpdate(update);
                 } catch (error) {
-                    console.error(error)
+                    console.error(error);
                 }
             }
         }
     }
 
-    onWorkspaceImageBuildLogs(info: WorkspaceImageBuild.StateInfo, content: WorkspaceImageBuild.LogContent | undefined): void {
+    onWorkspaceImageBuildLogs(
+        info: WorkspaceImageBuild.StateInfo,
+        content: WorkspaceImageBuild.LogContent | undefined,
+    ): void {
         for (const client of this.clients) {
             if (client.onWorkspaceImageBuildLogs) {
                 try {
                     client.onWorkspaceImageBuildLogs(info, content);
                 } catch (error) {
-                    console.error(error)
+                    console.error(error);
                 }
             }
         }
@@ -434,7 +493,7 @@ export class GitpodCompositeClient<Client extends GitpodClient> implements Gitpo
                 try {
                     client.notifyDidOpenConnection();
                 } catch (error) {
-                    console.error(error)
+                    console.error(error);
                 }
             }
         }
@@ -446,7 +505,7 @@ export class GitpodCompositeClient<Client extends GitpodClient> implements Gitpo
                 try {
                     client.notifyDidCloseConnection();
                 } catch (error) {
-                    console.error(error)
+                    console.error(error);
                 }
             }
         }
@@ -458,17 +517,16 @@ export class GitpodCompositeClient<Client extends GitpodClient> implements Gitpo
                 try {
                     client.onCreditAlert(creditAlert);
                 } catch (error) {
-                    console.error(error)
+                    console.error(error);
                 }
             }
         }
     }
-
 }
 
 export type GitpodService = GitpodServiceImpl<GitpodClient, GitpodServer>;
 
-const hasWindow = (typeof window !== 'undefined');
+const hasWindow = typeof window !== "undefined";
 const phasesOrder: Record<WorkspaceInstancePhase, number> = {
     unknown: 0,
     preparing: 1,
@@ -478,44 +536,41 @@ const phasesOrder: Record<WorkspaceInstancePhase, number> = {
     running: 5,
     interrupted: 6,
     stopping: 7,
-    stopped: 8
+    stopped: 8,
 };
 export class WorkspaceInstanceUpdateListener {
     private readonly onDidChangeEmitter = new Emitter<void>();
     readonly onDidChange = this.onDidChangeEmitter.event;
 
-    private source: 'sync' | 'update' = 'sync';
+    private source: "sync" | "update" = "sync";
 
     get info(): WorkspaceInfo {
         return this._info;
     }
 
-    constructor(
-        private readonly service: GitpodService,
-        private _info: WorkspaceInfo
-    ) {
+    constructor(private readonly service: GitpodService, private _info: WorkspaceInfo) {
         service.registerClient({
-            onInstanceUpdate: instance => {
+            onInstanceUpdate: (instance) => {
                 if (this.isOutOfOrder(instance)) {
                     return;
                 }
                 this.cancelSync();
                 this._info.latestInstance = instance;
-                this.source = 'update';
+                this.source = "update";
                 this.onDidChangeEmitter.fire(undefined);
             },
             notifyDidOpenConnection: () => {
                 this.sync();
-            }
+            },
         });
         if (hasWindow) {
             // learn about page lifecycle here: https://developers.google.com/web/updates/2018/07/page-lifecycle-api
-            window.document.addEventListener('visibilitychange', async () => {
-                if (window.document.visibilityState === 'visible') {
+            window.document.addEventListener("visibilitychange", async () => {
+                if (window.document.visibilityState === "visible") {
                     this.sync();
                 }
             });
-            window.addEventListener('pageshow', e => {
+            window.addEventListener("pageshow", (e) => {
                 if (e.persisted) {
                     this.sync();
                 }
@@ -543,12 +598,12 @@ export class WorkspaceInstanceUpdateListener {
                     return;
                 }
                 this._info = info;
-                this.source = 'sync';
+                this.source = "sync";
                 this.onDidChangeEmitter.fire(undefined);
             } catch (e) {
-                console.error('failed to sync workspace instance:', e)
+                console.error("failed to sync workspace instance:", e);
             }
-        })
+        });
     }
     private cancelSync(): void {
         if (this.syncTokenSource) {
@@ -565,7 +620,7 @@ export class WorkspaceInstanceUpdateListener {
         if (instance.workspaceId !== this._info.workspace.id) {
             return true;
         }
-        if (this.source === 'update') {
+        if (this.source === "update") {
             return false;
         }
         if (instance.id !== this.info.latestInstance?.id) {
@@ -573,15 +628,13 @@ export class WorkspaceInstanceUpdateListener {
         }
         return phasesOrder[instance.status.phase] < phasesOrder[this.info.latestInstance.status.phase];
     }
-
 }
 
 export interface GitpodServiceOptions {
-    onReconnect?: () => (void | Promise<void>)
+    onReconnect?: () => void | Promise<void>;
 }
 
 export class GitpodServiceImpl<Client extends GitpodClient, Server extends GitpodServer> {
-
     private readonly compositeClient = new GitpodCompositeClient<Client>();
 
     constructor(public readonly server: JsonRpcProxy<Server>, private options?: GitpodServiceOptions) {
@@ -596,7 +649,8 @@ export class GitpodServiceImpl<Client extends GitpodClient, Server extends Gitpo
 
     private readonly instanceListeners = new Map<string, Promise<WorkspaceInstanceUpdateListener>>();
     listenToInstance(workspaceId: string): Promise<WorkspaceInstanceUpdateListener> {
-        const listener = this.instanceListeners.get(workspaceId) ||
+        const listener =
+            this.instanceListeners.get(workspaceId) ||
             (async () => {
                 const info = await this.server.getWorkspace(workspaceId);
                 return new WorkspaceInstanceUpdateListener(this, info);
@@ -612,26 +666,25 @@ export class GitpodServiceImpl<Client extends GitpodClient, Server extends Gitpo
     }
 }
 
-export function createGitpodService<C extends GitpodClient, S extends GitpodServer>(serverUrl: string | Promise<string>) {
+export function createGitpodService<C extends GitpodClient, S extends GitpodServer>(
+    serverUrl: string | Promise<string>,
+) {
     const toWsUrl = (serverUrl: string) => {
-        return new GitpodHostUrl(serverUrl)
-            .asWebsocket()
-            .withApi({ pathname: GitpodServerPath })
-            .toString();
+        return new GitpodHostUrl(serverUrl).asWebsocket().withApi({ pathname: GitpodServerPath }).toString();
     };
     let url: string | Promise<string>;
     if (typeof serverUrl === "string") {
         url = toWsUrl(serverUrl);
     } else {
-        url = serverUrl.then(url => toWsUrl(url));
+        url = serverUrl.then((url) => toWsUrl(url));
     }
 
     const connectionProvider = new WebSocketConnectionProvider();
-    let onReconnect = () => { };
+    let onReconnect = () => {};
     const gitpodServer = connectionProvider.createProxy<S>(url, undefined, {
-        onListening: socket => {
+        onListening: (socket) => {
             onReconnect = () => socket.reconnect();
-        }
+        },
     });
     return new GitpodServiceImpl<C, S>(gitpodServer, { onReconnect });
-}
+}

package/src/headless-workspace-log.ts

@@ -4,6 +4,32 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
+export enum HeadlessWorkspaceEventType {
+    LogOutput = "log-output",
+    FinishedSuccessfully = "finish-success",
+    FinishedButFailed = "finish-fail",
+    AbortedTimedOut = "aborted-timeout",
+    Aborted = "aborted",
+    Failed = "failed",
+    Started = "started",
+}
+export namespace HeadlessWorkspaceEventType {
+    export function isRunning(t: HeadlessWorkspaceEventType) {
+        return t === HeadlessWorkspaceEventType.LogOutput;
+    }
+    export function didFinish(t: HeadlessWorkspaceEventType) {
+        return (
+            t === HeadlessWorkspaceEventType.FinishedButFailed || t === HeadlessWorkspaceEventType.FinishedSuccessfully
+        );
+    }
+}
+
+export interface HeadlessWorkspaceEvent {
+    workspaceID: string;
+    text: string;
+    type: HeadlessWorkspaceEventType;
+}
+
 export interface HeadlessLogUrls {
     // A map of id to URL
     streams: { [streamID: string]: string };
@@ -11,4 +37,4 @@ export interface HeadlessLogUrls {
 
 /** cmp. @const HEADLESS_LOG_STREAM_STATUS_CODE_REGEX */
 export const HEADLESS_LOG_STREAM_STATUS_CODE = "X-LogStream-StatusCode";
-export const HEADLESS_LOG_STREAM_STATUS_CODE_REGEX = /X-LogStream-StatusCode: ([0-9]{3})/;
+export const HEADLESS_LOG_STREAM_STATUS_CODE_REGEX = /X-LogStream-StatusCode: ([0-9]{3})/;

package/src/ide-frontend-service.ts

@@ -7,7 +7,7 @@
 import { Event } from "./util/event";
 import { Disposable } from "./util/disposable";
 
-export type IDEFrontendState = 'init' | 'ready' | 'terminated';
+export type IDEFrontendState = "init" | "ready" | "terminated";
 
 export interface IDEFrontendService {
     readonly state: IDEFrontendState;
@@ -25,4 +25,4 @@ export interface IDEFrontendService {
      * confirmation dialogs for stopped workspaces.
      */
     start(): Disposable;
-}
+}

package/src/ide-protocol.ts

@@ -29,6 +29,28 @@ export interface IDEOptions {
      * The default desktop IDE when the user has not specified one.
      */
     defaultDesktopIde: string;
+
+    /**
+     * Client specific IDE options.
+     */
+    clients?: { [id: string]: IDEClient };
+}
+
+export interface IDEClient {
+    /**
+     * The default desktop IDE when the user has not specified one.
+     */
+    defaultDesktopIDE?: string;
+
+    /**
+     * Desktop IDEs supported by the client.
+     */
+    desktopIDEs?: string[];
+
+    /**
+     * Steps to install the client on user machine.
+     */
+    installationSteps?: string[];
 }
 
 export interface IDEOption {
@@ -45,12 +67,12 @@ export interface IDEOption {
     /**
      * The type of the IDE, currently 'browser' or 'desktop'.
      */
-    type: 'browser' | 'desktop';
+    type: "browser" | "desktop";
 
     /**
-    * The logo for the IDE. That could be a key in (see
-    * components/dashboard/src/images/ideLogos.ts) or a URL.
-    */
+     * The logo for the IDE. That could be a key in (see
+     * components/dashboard/src/images/ideLogos.ts) or a URL.
+     */
     logo: string;
 
     /**
@@ -71,8 +93,8 @@ export interface IDEOption {
     notes?: string[];
 
     /**
-    * If `true` this IDE option is not visible in the IDE preferences.
-    */
+     * If `true` this IDE option is not visible in the IDE preferences.
+     */
     hidden?: boolean;
 
     /**
@@ -80,6 +102,11 @@ export interface IDEOption {
      */
     image: string;
 
+    /**
+     * The latest image ref to the IDE image, this image ref always resolve to digest.
+     */
+    latestImage?: string;
+
     /**
      * When this is `true`, the tag of this image is resolved to the latest
      * image digest regularly.