Refine workspace API #19138

csweichel · 2023-11-24T14:56:49Z

Description

This PR refines the workspace API aligning it with the next iteration of the server -> workspace runner interface.

It's the result of many hours of discussion between @svenefftinge, @akosyakov and @csweichel

How to Test

https://cw-refine-2e01273d5f.preview.gitpod-dev.com/workspaces

Workspace create should works like before

✅ Create workspace from dashboard
❌ From prebuild
✅ From snapshot
✅ Add multiple projects for repo, and create ws based on that repo

✅ workspace pin / rename / share should works

Summary generated by Copilot

`🤖[deprecated] Generated by Copilot at 6370502`

Refactor the public API for Gitpod by moving the EnvironmentVariable message to a top-level definition in envvar.proto.

Documentation

Preview status

gitpod:summary

Build Options

Build

/werft with-werft
Run the build with werft instead of GHA
leeway-no-cache
/werft no-test
Run Leeway with --dont-test

Publish

/werft publish-to-npm
/werft publish-to-jb-marketplace

Installer

analytics=segment
with-dedicated-emulation
workspace-feature-flags
Add desired feature flags to the end of the line above, space separated

Preview Environment / Integration Tests

/werft with-local-preview
If enabled this will build install/preview
/werft with-preview
/werft with-large-vm
/werft with-gce-vm
If enabled this will create the environment on GCE infra
/werft preemptible
Saves cost. Untick this only if you're really sure you need a non-preemtible machine.
with-integration-tests=all
Valid options are all, workspace, webapp, ide, jetbrains, vscode, ssh. If enabled, with-preview and with-large-vm will be enabled.
with-monitoring

/hold

mustard-mh · 2023-11-28T10:05:51Z

Migration is addressed here #19153

mustard-mh · 2023-11-28T15:17:26Z

I have tested changed methods (see PR description), could you take a look @akosyakov 🙏 ? Or I just approve and merge it?

akosyakov · 2023-11-28T20:33:24Z

@mustard-mh you tested both with FF on and off?

akosyakov · 2023-11-29T09:09:58Z

@mustard-mh Could you rebase please?

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

akosyakov · 2023-11-29T09:13:35Z

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

-
-  string name = 9;
+    // spec is the configuration of the workspace that's required for the to start the workspace
+    WorkspaceSpec spec = 4;


@mustard-mh do we have an issue already to support this path?

We have lots of TODOs for CreateAndStartWorkspace method, I will create an issue with TODOs list later. then decide if we need make them some standalone issues when we're going to implement it

ok, concern here it should be a primary way when we announce API

AlexTugarev

Tested the default behavior:

start/stop/restart/delete workspaces in different orgs
pin/share/snapshot workspace

AlexTugarev · 2023-11-29T10:52:35Z

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

-  //
-  // +optional defaults to the user's default region
-  string region = 8;
+  // owner is the ID of the Gitpod user to whom we'll bill this workspace and who we consider responsible for its content


nit: docs are swapped

Updated, thx! 👍

AlexTugarev · 2023-11-29T12:11:06Z

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}${


Is it always guaranteed that metadata is present?
Reading metadata! a lot let me think if we can add an assertion when setting the info value.

@AlexTugarev Yes, metadata is always in Workspace. We agreed to use ! in this situation here #19022 (comment)

cc @akosyakov

AlexTugarev · 2023-11-29T12:12:08Z

components/public-api/typescript-common/src/public-api-converter.ts

+                        value: new GitInitializer({
+                            remoteUri: arg.workspace.context.normalizedContextURL,
+                            upstreamRemoteUri: arg.workspace.context.upstreamRemoteURI,
+                            // TODO:


are those TODOs relevant?

No, we added lots of things in message Workspace, and it's the shape for the future (in next-gen). Add TODOs because we can't do convert currently

We will create issue for them #19138 (comment)

for initialisers we will need to look at it again, we may rather use new shapes instead of changing them back and forth

AlexTugarev

👍🏻

This reverts commit da0c590.

This reverts commit a6f4722.

* Revert "Revert "Refine workspace API (#19138)" (#19172)" This reverts commit a6f4722. * Update to workspace cases * Add new cases and fix * Add timeout * fixup * Remove requirement of editor * Update cases * Bump version * Update dashboard

csweichel requested a review from a team as a code owner November 24, 2023 14:56

roboquat added do-not-merge/hold size/XXL labels Nov 24, 2023

csweichel marked this pull request as draft November 24, 2023 14:56

roboquat added the do-not-merge/work-in-progress label Nov 24, 2023

github-actions bot added the team: team-experience label Nov 24, 2023

csweichel force-pushed the cw/refine-workspace-api branch from 6370502 to 49433ce Compare November 24, 2023 15:00

akosyakov assigned mustard-mh Nov 24, 2023

mustard-mh force-pushed the cw/refine-workspace-api branch from 49433ce to 94ea82b Compare November 28, 2023 14:26

mustard-mh marked this pull request as ready for review November 28, 2023 15:15

roboquat removed the do-not-merge/work-in-progress label Nov 28, 2023

akosyakov reviewed Nov 29, 2023

View reviewed changes

components/public-api/gitpod/v1/workspace.proto Outdated Show resolved Hide resolved

akosyakov reviewed Nov 29, 2023

View reviewed changes

mustard-mh force-pushed the cw/refine-workspace-api branch from 059127d to ec732e5 Compare November 29, 2023 10:25

csweichel and others added 4 commits November 29, 2023 10:35

Refine workspace API

a603152

Fix build

35dcd58

update proto

014b39b

fix rebase

bd69a05

mustard-mh force-pushed the cw/refine-workspace-api branch from ec732e5 to bd69a05 Compare November 29, 2023 10:41

mustard-mh added 3 commits November 29, 2023 10:46

fix rebase - 2

598a478

1

4e9733b

fix editor

2c5831d

AlexTugarev reviewed Nov 29, 2023

View reviewed changes

Update doc

77ad451

AlexTugarev approved these changes Nov 29, 2023

View reviewed changes

mustard-mh removed the do-not-merge/hold label Nov 29, 2023

roboquat merged commit da0c590 into main Nov 29, 2023

roboquat deleted the cw/refine-workspace-api branch November 29, 2023 14:15

mustard-mh added a commit that referenced this pull request Nov 30, 2023

Revert "Refine workspace API (#19138)"

8eff2b6

This reverts commit da0c590.

roboquat pushed a commit that referenced this pull request Nov 30, 2023

Revert "Refine workspace API (#19138)" (#19172)

a6f4722

This reverts commit da0c590.

mustard-mh added a commit that referenced this pull request Dec 1, 2023

Revert "Revert "Refine workspace API (#19138)" (#19172)"

3da336c

This reverts commit a6f4722.

mustard-mh mentioned this pull request Dec 1, 2023

Revert Refine workspace and fix bugs #19178

Merged

15 tasks

Refine workspace API #19138

Refine workspace API #19138

Uh oh!

Conversation

csweichel commented Nov 24, 2023 • edited by mustard-mh Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How to Test

🤖[deprecated] Generated by Copilot at 6370502

Documentation

Preview status

Build Options

Uh oh!

mustard-mh commented Nov 28, 2023

Uh oh!

mustard-mh commented Nov 28, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

akosyakov commented Nov 28, 2023

Uh oh!

akosyakov commented Nov 29, 2023

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlexTugarev left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mustard-mh Nov 29, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AlexTugarev left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

csweichel commented Nov 24, 2023 •

edited by mustard-mh

Loading

`🤖[deprecated] Generated by Copilot at 6370502`

mustard-mh commented Nov 28, 2023 •

edited

Loading

mustard-mh Nov 29, 2023 •

edited

Loading