Refine workspace API

components/dashboard/src/data/setup.tsx

@@ -31,7 +31,7 @@ import * as SSHClasses from "@gitpod/public-api/lib/gitpod/v1/ssh_pb";
 // This is used to version the cache
 // If data we cache changes in a non-backwards compatible way, increment this version
 // That will bust any previous cache versions a client may have stored
-const CACHE_VERSION = "10";
+const CACHE_VERSION = "11";
 
 export function noPersistence(queryKey: QueryKey): QueryKey {
     return [...queryKey, "no-persistence"];

components/dashboard/src/data/workspaces/toggle-workspace-pinned-mutation.ts

@@ -8,7 +8,7 @@ import { useMutation, useQueryClient } from "@tanstack/react-query";
 import { getGitpodService } from "../../service/service";
 import { getListWorkspacesQueryKey, ListWorkspacesQueryResult } from "./list-workspaces-query";
 import { useCurrentOrg } from "../organizations/orgs-query";
-import { Workspace } from "@gitpod/public-api/lib/gitpod/v1/workspace_pb";
+import { Workspace, WorkspaceMetadata } from "@gitpod/public-api/lib/gitpod/v1/workspace_pb";
 
 type ToggleWorkspacePinnedArgs = {
     workspaceId: string;
@@ -33,7 +33,10 @@ export const useToggleWorkspacedPinnedMutation = () => {
                         return info;
                     }
                     const workspace = new Workspace(info);
-                    workspace.pinned = !workspace.pinned;
+                    if (!workspace.metadata) {
+                        workspace.metadata = new WorkspaceMetadata();
+                    }
+                    workspace.metadata.pinned = !workspace.metadata.pinned;
                     return workspace;
                 });
             });

components/dashboard/src/data/workspaces/toggle-workspace-shared-mutation.ts

@@ -8,7 +8,7 @@ import { useMutation, useQueryClient } from "@tanstack/react-query";
 import { getGitpodService } from "../../service/service";
 import { getListWorkspacesQueryKey, ListWorkspacesQueryResult } from "./list-workspaces-query";
 import { useCurrentOrg } from "../organizations/orgs-query";
-import { AdmissionLevel, Workspace } from "@gitpod/public-api/lib/gitpod/v1/workspace_pb";
+import { AdmissionLevel, Workspace, WorkspaceSpec } from "@gitpod/public-api/lib/gitpod/v1/workspace_pb";
 
 type ToggleWorkspaceSharedArgs = {
     workspaceId: string;
@@ -44,9 +44,10 @@ export const useToggleWorkspaceSharedMutation = () => {
                     }
 
                     const workspace = new Workspace(info);
-                    if (workspace.status) {
-                        workspace.status.admission = level;
+                    if (!workspace.spec) {
+                        workspace.spec = new WorkspaceSpec();
                     }
+                    workspace.spec.admission = level;
                     return workspace;
                 });
             });

components/dashboard/src/data/workspaces/update-workspace-description-mutation.ts

@@ -8,7 +8,7 @@ import { useMutation, useQueryClient } from "@tanstack/react-query";
 import { getGitpodService } from "../../service/service";
 import { getListWorkspacesQueryKey, ListWorkspacesQueryResult } from "./list-workspaces-query";
 import { useCurrentOrg } from "../organizations/orgs-query";
-import { Workspace } from "@gitpod/public-api/lib/gitpod/v1/workspace_pb";
+import { Workspace, WorkspaceMetadata } from "@gitpod/public-api/lib/gitpod/v1/workspace_pb";
 
 type UpdateWorkspaceDescriptionArgs = {
     workspaceId: string;
@@ -36,7 +36,10 @@ export const useUpdateWorkspaceDescriptionMutation = () => {
                     // TODO: Once the update description response includes an updated record,
                     // we can return that instead of having to know what to merge manually (same for other mutations)
                     const workspace = new Workspace(info);
-                    workspace.name = newDescription;
+                    if (!workspace.metadata) {
+                        workspace.metadata = new WorkspaceMetadata();
+                    }
+                    workspace.metadata.name = newDescription;
                     return workspace;
                 });
             });

components/dashboard/src/service/json-rpc-workspace-client.ts

@@ -28,6 +28,10 @@ import {
     SendHeartBeatResponse,
     WorkspacePhase_Phase,
     GetWorkspaceDefaultImageResponse_Source,
+    ParseContextURLRequest,
+    ParseContextURLResponse,
+    UpdateWorkspaceRequest,
+    UpdateWorkspaceResponse,
 } from "@gitpod/public-api/lib/gitpod/v1/workspace_pb";
 import { converter } from "./public-api";
 import { getGitpodService } from "./service";
@@ -131,25 +135,25 @@ export class JsonRpcWorkspaceClient implements PromiseClient<typeof WorkspaceSer
         if (request.source?.case !== "contextUrl") {
             throw new ApplicationError(ErrorCodes.UNIMPLEMENTED, "not implemented");
         }
-        if (!request.organizationId || !uuidValidate(request.organizationId)) {
+        if (!request.metadata || !request.metadata.organizationId || !uuidValidate(request.metadata.organizationId)) {
             throw new ApplicationError(ErrorCodes.BAD_REQUEST, "organizationId is required");
         }
-        if (!request.editor) {
+        if (!request.source.value.editor?.name) {
             throw new ApplicationError(ErrorCodes.BAD_REQUEST, "editor is required");
         }
-        if (!request.source.value) {
+        if (!request.source.value.url) {
             throw new ApplicationError(ErrorCodes.BAD_REQUEST, "source is required");
         }
         const response = await getGitpodService().server.createWorkspace({
-            organizationId: request.organizationId,
+            organizationId: request.metadata.organizationId,
             ignoreRunningWorkspaceOnSameCommit: true,
-            contextUrl: request.source.value,
+            contextUrl: request.source.value.url,
             forceDefaultConfig: request.forceDefaultConfig,
-            workspaceClass: request.workspaceClass,
-            projectId: request.configurationId,
+            workspaceClass: request.source.value.workspaceClass,
+            projectId: request.metadata.configurationId,
             ideSettings: {
-                defaultIde: request.editor.name,
-                useLatestVersion: request.editor.version === "latest",
+                defaultIde: request.source.value.editor.name,
+                useLatestVersion: request.source.value.editor.version === "latest",
             },
         });
         const workspace = await this.getWorkspace({ workspaceId: response.createdWorkspaceId });
@@ -240,4 +244,18 @@ export class JsonRpcWorkspaceClient implements PromiseClient<typeof WorkspaceSer
         result.editorCredentials = credentials;
         return result;
     }
+
+    async updateWorkspace(
+        request: PartialMessage<UpdateWorkspaceRequest>,
+        _options?: CallOptions | undefined,
+    ): Promise<UpdateWorkspaceResponse> {
+        throw new ApplicationError(ErrorCodes.UNIMPLEMENTED, "not implemented");
+    }
+
+    async parseContextURL(
+        request: PartialMessage<ParseContextURLRequest>,
+        _options?: CallOptions | undefined,
+    ): Promise<ParseContextURLResponse> {
+        throw new ApplicationError(ErrorCodes.UNIMPLEMENTED, "not implemented");
+    }
 }

components/dashboard/src/start/StartWorkspace.tsx

@@ -28,6 +28,7 @@ import {
     StartWorkspaceResponse,
     Workspace,
     WorkspacePhase_Phase,
+    WorkspaceSpec_WorkspaceType,
 } from "@gitpod/public-api/lib/gitpod/v1/workspace_pb";
 import { PartialMessage } from "@bufbuild/protobuf";
 
@@ -169,7 +170,7 @@ export default class StartWorkspace extends React.Component<StartWorkspaceProps,
     componentDidUpdate(prevPros: StartWorkspaceProps, prevState: StartWorkspaceState) {
         const newPhase = this.state?.workspace?.status?.phase?.name;
         const oldPhase = prevState.workspace?.status?.phase?.name;
-        const type = !!this.state.workspace?.prebuild ? "prebuild" : "regular";
+        const type = this.state.workspace?.spec?.type === WorkspaceSpec_WorkspaceType.PREBUILD ? "prebuild" : "regular";
         if (newPhase !== oldPhase) {
             getGitpodService().server.trackEvent({
                 event: "status_rendered",
@@ -373,10 +374,10 @@ export default class StartWorkspace extends React.Component<StartWorkspaceProps,
         if (
             !error &&
             workspace.status.phase?.name === WorkspacePhase_Phase.STOPPED &&
-            !!this.state.workspace?.prebuild
+            this.state.workspace?.spec?.type === WorkspaceSpec_WorkspaceType.PREBUILD
         ) {
             // here we want to point to the original context, w/o any modifiers "workspace" was started with (as this might have been a manually triggered prebuild!)
-            const contextURL = this.state.workspace.contextUrl;
+            const contextURL = this.state.workspace.metadata?.originalContextUrl;
             if (contextURL) {
                 this.redirectTo(gitpodHostUrl.withContext(contextURL.toString()).toString());
             } else {
@@ -457,15 +458,20 @@ export default class StartWorkspace extends React.Component<StartWorkspaceProps,
 
     render() {
         const { error } = this.state;
-        const isPrebuild = this.state.workspace?.prebuild;
-        const withPrebuild = !!this.state.workspace?.prebuildId;
+        const isPrebuild = this.state.workspace?.spec?.type === WorkspaceSpec_WorkspaceType.PREBUILD;
+        let withPrebuild = false;
+        for (const initializer of this.state.workspace?.spec?.initializer?.specs ?? []) {
+            if (initializer.spec.case === "prebuild") {
+                withPrebuild = !!initializer.spec.value.prebuildId;
+            }
+        }
         let phase: StartPhase | undefined = StartPhase.Preparing;
         let title = undefined;
         let isStoppingOrStoppedPhase = false;
         let isError = error ? true : false;
         let statusMessage = !!error ? undefined : <p className="text-base text-gray-400">Preparing workspace …</p>;
-        const contextURL = this.state.workspace?.contextUrl;
-        const useLatest = this.state.workspace?.editor?.version === "latest";
+        const contextURL = this.state.workspace?.metadata?.originalContextUrl;
+        const useLatest = this.state.workspace?.spec?.editor?.version === "latest";
 
         switch (this.state?.workspace?.status?.phase?.name) {
             // unknown indicates an issue within the system in that it cannot determine the actual phase of

components/dashboard/src/workspaces/CreateWorkspacePage.tsx

@@ -37,7 +37,7 @@ import { SelectAccountModal } from "../user-settings/SelectAccountModal";
 import { settingsPathIntegrations } from "../user-settings/settings.routes";
 import { WorkspaceEntry } from "./WorkspaceEntry";
 import { AuthProviderType } from "@gitpod/public-api/lib/gitpod/v1/authprovider_pb";
-import { WorkspacePhase_Phase } from "@gitpod/public-api/lib/gitpod/v1/workspace_pb";
+import { WorkspaceMetadata, WorkspacePhase_Phase } from "@gitpod/public-api/lib/gitpod/v1/workspace_pb";
 import { Button } from "@podkit/buttons/Button";
 import { LoadingButton } from "@podkit/buttons/LoadingButton";
 import { CreateAndStartWorkspaceRequest } from "@gitpod/public-api/lib/gitpod/v1/workspace_pb";
@@ -172,7 +172,14 @@ export function CreateWorkspacePage() {
     const [selectAccountError, setSelectAccountError] = useState<SelectAccountPayload | undefined>(undefined);
 
     const createWorkspace = useCallback(
-        async (options?: Omit<PartialMessage<CreateAndStartWorkspaceRequest>, "contextUrl" | "organizationId">) => {
+        /**
+         * options will omit
+         * - source.url
+         * - source.workspaceClass
+         * - metadata.organizationId
+         * - metadata.configurationId
+         */
+        async (options?: PartialMessage<CreateAndStartWorkspaceRequest>) => {
             // add options from search params
             const opts = options || {};
 
@@ -192,16 +199,6 @@ export function CreateWorkspacePage() {
                 opts.forceDefaultConfig = true;
             }
 
-            if (!opts.workspaceClass) {
-                opts.workspaceClass = selectedWsClass;
-            }
-            if (!opts.editor) {
-                opts.editor = {
-                    name: selectedIde,
-                    version: useLatestIde ? "latest" : undefined,
-                };
-            }
-
             try {
                 if (createWorkspaceMutation.isStarting) {
                     console.log("Skipping duplicate createWorkspace call.");
@@ -210,14 +207,28 @@ export function CreateWorkspacePage() {
                 // we wait at least 5 secs
                 const timeout = new Promise((resolve) => setTimeout(resolve, 5000));
 
+                if (!opts.metadata) {
+                    opts.metadata = new WorkspaceMetadata();
+                }
+                opts.metadata.organizationId = organizationId;
+                opts.metadata.configurationId = selectedProjectID;
+
                 const result = await createWorkspaceMutation.createWorkspace({
                     source: {
                         case: "contextUrl",
-                        value: contextURL,
+                        value: {
+                            url: contextURL,
+                            workspaceClass: selectedWsClass,
+                            editor:
+                                opts.source?.case === "contextUrl" && opts.source.value.editor
+                                    ? opts.source.value.editor
+                                    : {
+                                          name: selectedIde,
+                                          version: useLatestIde ? "latest" : undefined,
+                                      },
+                        },
                     },
                     ...opts,
-                    organizationId,
-                    configurationId: selectedProjectID,
                 });
                 await storeAutoStartOptions();
                 await timeout;

components/dashboard/src/workspaces/DeleteWorkspaceModal.tsx

@@ -33,7 +33,7 @@ export const DeleteWorkspaceModal: FunctionComponent<Props> = ({ workspace, onCl
             areYouSureText="Are you sure you want to delete this workspace?"
             children={{
                 name: workspace.id,
-                description: workspace.name,
+                description: workspace.metadata?.name,
             }}
             buttonText="Delete Workspace"
             warningText={deleteWorkspace.isError ? "There was a problem deleting your workspace." : undefined}

components/dashboard/src/workspaces/RenameWorkspaceModal.tsx

@@ -16,7 +16,7 @@ type Props = {
 };
 export const RenameWorkspaceModal: FunctionComponent<Props> = ({ workspace, onClose }) => {
     const [errorMessage, setErrorMessage] = useState("");
-    const [description, setDescription] = useState(workspace.name || "");
+    const [description, setDescription] = useState(workspace.metadata?.name || "");
     const updateDescription = useUpdateWorkspaceDescriptionMutation();
 
     const updateWorkspaceDescription = useCallback(async () => {

components/dashboard/src/workspaces/WorkspaceEntry.tsx

@@ -27,8 +27,8 @@ export const WorkspaceEntry: FunctionComponent<Props> = ({ info, shortVersion })
     const workspace = info;
     const currentBranch = gitStatus?.branch || "<unknown>";
     const project = getProjectPath(workspace);
-    const normalizedContextUrl = workspace.contextUrl;
-    const normalizedContextUrlDescription = workspace.contextUrl; // Instead of showing nothing, we prefer to show the raw content instead
+    const normalizedContextUrl = workspace.metadata!.originalContextUrl;
+    const normalizedContextUrlDescription = workspace.metadata!.originalContextUrl; // Instead of showing nothing, we prefer to show the raw content instead
 
     const changeMenuState = (state: boolean) => {
         setMenuActive(state);
@@ -69,7 +69,7 @@ export const WorkspaceEntry: FunctionComponent<Props> = ({ info, shortVersion })
                 <>
                     <ItemField className="w-4/12 flex flex-col my-auto">
                         <div className="text-gray-500 dark:text-gray-400 overflow-ellipsis truncate">
-                            {workspace.name}
+                            {workspace.metadata!.name}
                         </div>
                         <a href={normalizedContextUrl}>
                             <div className="text-sm text-gray-400 dark:text-gray-500 overflow-ellipsis truncate hover:text-blue-600 dark:hover:text-blue-400">
@@ -105,5 +105,5 @@ export const WorkspaceEntry: FunctionComponent<Props> = ({ info, shortVersion })
 
 export function getProjectPath(ws: Workspace) {
     // TODO: Remove and call papi ContextService
-    return ws.contextUrl.replace("https://", "");
+    return ws.metadata!.originalContextUrl.replace("https://", "");
 }

components/dashboard/src/workspaces/WorkspaceOverflowMenu.tsx

@@ -60,15 +60,13 @@ export const WorkspaceEntryOverflowMenu: FunctionComponent<WorkspaceEntryOverflo
 
     const toggleShared = useCallback(() => {
         const newLevel =
-            workspace.status?.admission === AdmissionLevel.EVERYONE
-                ? AdmissionLevel.OWNER_ONLY
-                : AdmissionLevel.EVERYONE;
+            workspace.spec?.admission === AdmissionLevel.EVERYONE ? AdmissionLevel.OWNER_ONLY : AdmissionLevel.EVERYONE;
 
         toggleWorkspaceShared.mutate({
             workspaceId: workspace.id,
             level: newLevel,
         });
-    }, [toggleWorkspaceShared, workspace.id, workspace.status?.admission]);
+    }, [toggleWorkspaceShared, workspace.id, workspace.spec?.admission]);
 
     const togglePinned = useCallback(() => {
         toggleWorkspacePinned.mutate({
@@ -129,12 +127,12 @@ export const WorkspaceEntryOverflowMenu: FunctionComponent<WorkspaceEntryOverflo
     menuEntries.push(
         {
             title: "Share",
-            active: workspace.status?.admission === AdmissionLevel.EVERYONE,
+            active: workspace.spec?.admission === AdmissionLevel.EVERYONE,
             onClick: toggleShared,
         },
         {
             title: "Pin",
-            active: !!workspace.pinned,
+            active: !!workspace.metadata?.pinned,
             separator: true,
             onClick: togglePinned,
         },

components/dashboard/src/workspaces/Workspaces.tsx

@@ -47,14 +47,18 @@ const WorkspacesPage: FunctionComponent = () => {
     const { filteredActiveWorkspaces, filteredInactiveWorkspaces } = useMemo(() => {
         const filteredActiveWorkspaces = activeWorkspaces.filter(
             (info) =>
-                `${info.name}${info.id}${info.contextUrl}${info.status?.gitStatus?.cloneUrl}${info.status?.gitStatus?.branch}`
+                `${info.metadata!.name}${info.id}${info.metadata!.originalContextUrl}${
+                    info.status?.gitStatus?.cloneUrl
+                }${info.status?.gitStatus?.branch}`
                     .toLowerCase()
                     .indexOf(searchTerm.toLowerCase()) !== -1,
         );
 
         const filteredInactiveWorkspaces = inactiveWorkspaces.filter(
             (info) =>
-                `${info.name}${info.id}${info.contextUrl}${info.status?.gitStatus?.cloneUrl}${info.status?.gitStatus?.branch}`
+                `${info.metadata!.name}${info.id}${info.metadata!.originalContextUrl}${
+                    info.status?.gitStatus?.cloneUrl
+                }${info.status?.gitStatus?.branch}`
                     .toLowerCase()
                     .indexOf(searchTerm.toLowerCase()) !== -1,
         );
@@ -201,5 +205,5 @@ function isWorkspaceActive(info: Workspace): boolean {
     const twentyfourHoursAgo = hoursBefore(new Date().toISOString(), 24);
 
     const isStopped = info.status?.phase?.name === WorkspacePhase_Phase.STOPPED;
-    return info.pinned || !isStopped || isDateSmallerOrEqual(twentyfourHoursAgo, lastSessionStart);
+    return info.metadata!.pinned || !isStopped || isDateSmallerOrEqual(twentyfourHoursAgo, lastSessionStart);
 }

components/public-api/gitpod/v1/envvar.proto

@@ -142,9 +142,10 @@ message ResolveWorkspaceEnvironmentVariablesRequest {
 }
 
 message ResolveWorkspaceEnvironmentVariablesResponse {
-  message EnvironmentVariable {
-    string name = 1;
-    string value = 2;
-  }
   repeated EnvironmentVariable environment_variables = 1;
 }
+
+message EnvironmentVariable {
+  string name = 1;
+  string value = 2;
+}