@gitpod/gitpod-protocol 0.1.5-ps-commit-email-fork.0 → 0.1.5-release-2022.6.1.0

package/src/workspace-cluster.ts

@@ -4,10 +4,10 @@
  * See License-AGPL.txt in the project root for license information.
  */
 
-import * as fs from 'fs';
-import { filePathTelepresenceAware } from './env';
+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 {
     // Name of the workspace cluster.
@@ -32,7 +32,11 @@ export interface WorkspaceCluster {
 
     // True if this bridge should control this cluster
     govern: boolean;
+
+    // An optional set of constraints that limit who can start workspaces on the cluster
+    admissionConstraints?: AdmissionConstraint[];
 }
+
 export type WorkspaceClusterState = "available" | "cordoned" | "draining";
 export interface TLSConfig {
     // the CA shared between client and server (base64 encoded)
@@ -43,11 +47,34 @@ export interface TLSConfig {
     crt: string;
 }
 export namespace TLSConfig {
-    export const loadFromBase64File = (path: string): string => fs.readFileSync(filePathTelepresenceAware(path)).toString("base64");
+    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
+    | AdmissionConstraintHasPermission
+    | AdmissionConstraintHasUserLevel
+    | AdmissionConstraintHasMoreResources;
+export type AdmissionConstraintFeaturePreview = { type: "has-feature-preview" };
+export type AdmissionConstraintHasPermission = { type: "has-permission"; permission: PermissionName };
+export type AdmissionConstraintHasUserLevel = { type: "has-user-level"; level: string };
+export type AdmissionConstraintHasMoreResources = { type: "has-more-resources" };
+
+export namespace AdmissionConstraint {
+    export function is(o: any): o is AdmissionConstraint {
+        return !!o && "type" in o;
+    }
+    export function isHasPermissionConstraint(o: any): o is AdmissionConstraintHasPermission {
+        return is(o) && o.type === "has-permission";
+    }
+    export function hasPermission(ac: AdmissionConstraint, permission: PermissionName): boolean {
+        return isHasPermissionConstraint(ac) && ac.permission === permission;
+    }
+}
+
 export const WorkspaceClusterDB = Symbol("WorkspaceClusterDB");
 export interface WorkspaceClusterDB {
     /**
@@ -73,8 +100,8 @@ export interface WorkspaceClusterDB {
      * Lists all WorkspaceClusterWoTls for which the given predicate is true (does not return TLS for size/speed concerns)
      * @param predicate
      */
-    findFiltered(predicate: DeepPartial<WorkspaceClusterFilter>): Promise<WorkspaceClusterWoTls[]>;
+    findFiltered(predicate: DeepPartial<WorkspaceClusterFilter>): Promise<WorkspaceClusterWoTLS[]>;
 }
 export interface WorkspaceClusterFilter extends Pick<WorkspaceCluster, "state" | "govern" | "url"> {
     minScore: number;
-}
+}

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
@@ -45,6 +51,23 @@ export interface WorkspaceInstance {
 
     // instance is hard-deleted on the database and about to be collected by db-sync
     readonly deleted?: boolean;
+
+    /**
+     * Contains information about the image build, if there was any
+     */
+    imageBuildInfo?: ImageBuildInfo;
+
+    /**
+     * workspace class, also known as workspace size, determines the type of
+     * resources that are provided to the workspace.
+     */
+    workspaceClass?: string;
+
+    /**
+     * Identifies the team or user to which this instance's runtime should be attributed to
+     * (e.g. for usage analytics or billing purposes).
+     */
+    usageAttributionId?: string;
 }
 
 // WorkspaceInstanceStatus describes the current state of a workspace instance
@@ -83,53 +106,55 @@ 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.
-    "unknown" |
+    // 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
-    // are still preparing for launch. This means we're building the Docker image for the workspace.
-    "preparing" |
+    // are still preparing for launch.
+    | "preparing"
+
+    // Building means that we are building the Docker image for the workspace. A workspace will enter this phase only
+    // if an image build is required for that workspace.
+    | "building"
 
     // 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.
-    "pending" |
+    // 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.
-    "creating" |
+    // 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.
-    "initializing" |
+    // 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.
-    "running" |
+    // or as a headless workspace.
+    | "running"
 
     // Interrupted is an exceptional state where the container should be running but is temporarily unavailable.
     // When in this state, we expect it to become running or stopping anytime soon.
-    "interrupted" |
+    | "interrupted"
 
     // Stopping means that the workspace is currently shutting down. It could go to stopped every moment.
-    "stopping" |
+    | "stopping"
 
     // Stopped means the workspace ended regularly because it was shut down.
-    "stopped";
+    | "stopped";
 
 export interface WorkspaceInstanceConditions {
     // Failed contains the reason the workspace failed to operate. If this field is empty, the workspace has not failed.
-    failed?: string
+    // failed contains technical details for the failure of the workspace.
+    failed?: string;
 
     // timeout contains the reason the workspace has timed out. If this field is empty, the workspace has not timed out.
-    timeout?: string
+    timeout?: string;
 
     // PullingImages marks if the workspace is currently pulling its images. This condition can only be set during PhaseCreating
-    pullingImages?: boolean
-
-    // ServiceExists denotes if the workspace theia-/ports- services exist. This condition will be true if either of the two services exist.
-    serviceExists?: boolean
+    pullingImages?: boolean;
 
     // deployed marks that a workspace instance was sent/deployed at a workspace manager
     deployed?: boolean;
@@ -139,22 +164,28 @@ export interface WorkspaceInstanceConditions {
 
     // ISO8601 timestamp when the first user activity was registered in the frontend. Only set if the workspace is running.
     firstUserActivity?: string;
+
+    // headlessTaskFailed indicates that a headless workspace task failed
+    // headlessTaskFailed is only set if:
+    //  * this workspace is headless
+    //  * the task being run returned a non 0 exit status code
+    headlessTaskFailed?: string;
+
+    // stopped_by_request is true if the workspace was stopped using a StopWorkspace call
+    stoppedByRequest?: boolean;
 }
 
 // AdmissionLevel describes who can access a workspace instance and its ports.
-export type AdmissionLevel = 'owner_only' | 'everyone';
+export type AdmissionLevel = "owner_only" | "everyone";
 
 // PortVisibility describes how a port can be accessed
-export type PortVisibility = 'public' | 'private';
+export type PortVisibility = "public" | "private";
 
 // WorkspaceInstancePort describes a port exposed on a workspace instance
 export interface WorkspaceInstancePort {
     // The outward-facing port number
     port: number;
 
-    // An optional inward-facing port number. If not present we'll use port.
-    targetPort?: number;
-
     // The visiblity of this port. Optional for backwards compatibility.
     visibility?: PortVisibility;
 
@@ -174,19 +205,25 @@ export interface WorkspaceInstanceRepoStatus {
     uncommitedFiles?: string[];
 
     // the total number of uncommited files
-    totalUncommitedFiles?: number
+    totalUncommitedFiles?: number;
 
     // untrackedFiles is the list of untracked files in the workspace, possibly truncated
     untrackedFiles?: string[];
 
     // the total number of untracked files
-    totalUntrackedFiles?: number
+    totalUntrackedFiles?: number;
 
     // unpushedCommits is the list of unpushed changes in the workspace, possibly truncated
     unpushedCommits?: string[];
 
     // the total number of unpushed changes
-    totalUnpushedCommits?: number
+    totalUnpushedCommits?: number;
+}
+
+// ConfigurationIdeConfig ide config of WorkspaceInstanceConfiguration
+export interface ConfigurationIdeConfig {
+    useLatest?: boolean;
+    desktopIdeAlias?: string;
 }
 
 // WorkspaceInstanceConfiguration contains all per-instance configuration
@@ -200,4 +237,27 @@ export interface WorkspaceInstanceConfiguration {
 
     // ideImage is the ref of the IDE image this instance uses.
     ideImage: string;
+
+    // desktopIdeImage is the ref of the desktop IDE image this instance uses.
+    desktopIdeImage?: string;
+
+    // supervisorImage is the ref of the supervisor image this instance uses.
+    supervisorImage?: string;
+
+    ideConfig?: ConfigurationIdeConfig;
+}
+
+/**
+ * Holds information about the image build (if there was one) for this WorkspaceInstance
+ */
+export interface ImageBuildInfo {
+    log?: ImageBuildLogInfo;
+}
+
+/**
+ * Holds information about how to access logs for this an image build
+ */
+export interface ImageBuildLogInfo {
+    url: string;
+    headers: { [key: string]: string };
 }

package/src/wsready.ts

@@ -1,10 +1,10 @@
 /**
- * Copyright (c) 2021 Gitpod GmbH. All rights reserved.
+ * Copyright (c) 2022 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.
  */
 
-// generated using github.com/32leaves/bel on 2021-04-20 10:08:58.0197329 +0000 UTC m=+0.008313436
+// generated using github.com/32leaves/bel on 2022-05-18 18:19:49.011672619 +0000 UTC m=+0.006607361
 // DO NOT MODIFY
 
 export enum WorkspaceInitSource {
@@ -13,5 +13,5 @@ export enum WorkspaceInitSource {
     WorkspaceInitFromOther = "from-other",
 }
 export interface WorkspaceReadyMessage {
-    source: WorkspaceInitSource
+    source: WorkspaceInitSource;
 }