[dashboard] integrate v2 WorkspaceService.getWorkspace #18884

akosyakov · 2023-10-06T11:15:01Z

Description

This PR integrates V2 WorkspaceService.getWorkspace in the dashboard. The migration will be done in 2 steps:

First the dashboard code is changed to use gRPC shapes, but under the hood still JSON-RPC service is used. The PR should strive to minimal changes in the UI component code of the dashboard. It is not feature flagged, and the quality control happens on the PR.
Second traffic is shifted to the actual gRPC service using a feature flag. It will done first for internal users and after confirming functionality for all users.

Summary generated by Copilot

`🤖 Generated by Copilot at 6e11f42`

This pull request adds experimental support for a new WorkspaceService API that allows managing workspaces using different RPC frameworks. It introduces a new proto file that defines the service and its messages, and several generated files that provide client and server implementations for Go, TypeScript, and web browsers using Connect, gRPC, and gRPC-Web.

Related Issue(s)

Part of EXP-643

How to test

Start, stop and restart a workspace, check that the start page works well.
Trigger a prebuild and check that logs from prebuild are streamed still.
Start, stop and restart a workspace from the prebuild, check that the start page works well.

Documentation

Preview status

Gitpod was successfully deployed to your preview environment.

🏷️ Name - ak-public-26583c8c5c
🔗 URL - ak-public-26583c8c5c.preview.gitpod-dev.com/workspaces.
📚 Documentation - See our internal documentation for information on how to interact with your preview environment.
📦 Version - ak-public_api_v2_get_workspace-gha.18619
🗒️ Logs - GCP Logs Explorer

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
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

akosyakov · 2023-10-16T09:32:39Z

/gh run recreate-vm=true

Comment triggered a workflow run

Started workflow run: 6531719748

recreate_vm: true

components/dashboard/src/service/public-api.ts

components/dashboard/src/start/StartWorkspace.tsx

geropl · 2023-10-17T09:04:02Z

components/gitpod-protocol/src/public-api-converter.ts

+            const metadata: HeadersInit = {};
+            metadata[applicationErrorCode] = String(reason.code);
+            metadata[applicationErrorData] = JSON.stringify(reason.data);
+            if (reason.code === ErrorCodes.NOT_FOUND) {


geropl · 2023-10-17T09:06:26Z

components/gitpod-protocol/package.json

@@ -57,6 +57,8 @@
        "exit": true
    },
    "dependencies": {
+        "@connectrpc/connect": "1.1.2",
+        "@gitpod/public-api": "0.1.5",


Hm, this dependenciy feels a bit weird. What's the reason to not put the converter into the typescript lib exported by public-api? 🤔

You mean reverse dependency? I don't think public-api should pull gitpod-protocol.
We need some place where we share converter between dashboard and server.

Yes, probably not the single package that we have there now that contains the connect types.
But maybe having a separate one next to it... not sure if it's worth it though. Also can't pinpoint why it feels weird to me. 🙃

geropl · 2023-10-17T09:08:35Z

components/server/src/api/workspace-service-api.ts

+    private readonly apiConverter: PublicAPIConverter;
+
+    async getWorkspace(req: GetWorkspaceRequest, context: HandlerContext): Promise<GetWorkspaceResponse> {
+        const info = await this.workspaceService.getWorkspace(context.user.id, req.id);


Let's talk about context.user in the sync. IMO we should try to avoid this when implementing the new API. 👍

geropl · 2023-10-17T09:33:32Z

There is one glitch: When stopping a workspace the displayed status is stuck on "stopping", and never changes to "stopped" (consistently). Dashboard updates fine in parallel, as well as does this on reload.

geropl · 2023-10-17T09:33:54Z

Everything else works as expected! 🎉 Nice work @akosyakov ! 💪

akosyakov · 2023-10-17T20:01:04Z

/gh run recreate-vm=true

Comment triggered a workflow run

Started workflow run: 6552203451

recreate_vm: true

akosyakov · 2023-10-17T21:02:38Z

There is one glitch: When stopping a workspace the displayed status is stuck on "stopping", and never changes to "stopped" (consistently). Dashboard updates fine in parallel, as well as does this on reload.

@geropl I tried but I could not reproduce it.

geropl · 2023-10-18T08:20:43Z

/gh run recreate-vm=true

Comment triggered a workflow run

Started workflow run: 6558168925

recreate_vm: true

geropl

@akosyakov It works now! 🎉

akosyakov · 2023-10-18T08:50:04Z

/unhold

roboquat added do-not-merge/hold do-not-merge/work-in-progress size/XL size/XXL and removed size/XL labels Oct 6, 2023

akosyakov force-pushed the ak/public_api_v2_get_workspace branch from 5522f52 to 0e146dd Compare October 6, 2023 12:44

akosyakov force-pushed the ak/public_api_v2_get_workspace branch 2 times, most recently from df9024b to 9f8afad Compare October 16, 2023 08:25

akosyakov changed the base branch from main to ak/get_workspace_v2 October 16, 2023 09:01

akosyakov changed the title ~~[public-api] add v2 WorkspaceService.getWorkspace~~ [dashboard] integrate v2 WorkspaceService.getWorkspace Oct 16, 2023

akosyakov force-pushed the ak/public_api_v2_get_workspace branch from 9f8afad to 20a6d13 Compare October 16, 2023 09:10

akosyakov force-pushed the ak/public_api_v2_get_workspace branch 3 times, most recently from db84465 to ef8fe77 Compare October 16, 2023 20:43

Base automatically changed from ak/get_workspace_v2 to main October 17, 2023 08:06

akosyakov force-pushed the ak/public_api_v2_get_workspace branch 2 times, most recently from 3f8d83b to 17a2c6a Compare October 17, 2023 08:39

akosyakov marked this pull request as ready for review October 17, 2023 08:41

akosyakov requested a review from a team as a code owner October 17, 2023 08:41

roboquat removed the do-not-merge/work-in-progress label Oct 17, 2023

github-actions bot added the team: team-experience label Oct 17, 2023

geropl reviewed Oct 17, 2023

View reviewed changes

components/dashboard/src/service/public-api.ts Outdated Show resolved Hide resolved

geropl reviewed Oct 17, 2023

View reviewed changes

components/dashboard/src/start/StartWorkspace.tsx Outdated Show resolved Hide resolved

geropl reviewed Oct 17, 2023

View reviewed changes

akosyakov force-pushed the ak/public_api_v2_get_workspace branch 2 times, most recently from 8a717a9 to ab9722a Compare October 17, 2023 20:36

[dashboard] integrate v2 WorkspaceService.getWorkspace

211745a

akosyakov force-pushed the ak/public_api_v2_get_workspace branch from ab9722a to 211745a Compare October 17, 2023 20:53

svenefftinge approved these changes Oct 18, 2023

View reviewed changes

geropl approved these changes Oct 18, 2023

View reviewed changes

roboquat removed the do-not-merge/hold label Oct 18, 2023

roboquat merged commit c7f8c35 into main Oct 18, 2023

roboquat deleted the ak/public_api_v2_get_workspace branch October 18, 2023 08:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[dashboard] integrate v2 WorkspaceService.getWorkspace #18884

[dashboard] integrate v2 WorkspaceService.getWorkspace #18884

akosyakov commented Oct 6, 2023 •

edited

Loading

akosyakov commented Oct 16, 2023 •

edited by github-actions bot

Loading

geropl Oct 17, 2023

geropl Oct 17, 2023

akosyakov Oct 17, 2023

geropl Oct 17, 2023

geropl Oct 17, 2023

geropl commented Oct 17, 2023

geropl commented Oct 17, 2023

akosyakov commented Oct 17, 2023 •

edited by github-actions bot

Loading

akosyakov commented Oct 17, 2023

geropl commented Oct 18, 2023 •

edited by github-actions bot

Loading

geropl left a comment

akosyakov commented Oct 18, 2023

[dashboard] integrate v2 WorkspaceService.getWorkspace #18884

[dashboard] integrate v2 WorkspaceService.getWorkspace #18884

Conversation

akosyakov commented Oct 6, 2023 • edited Loading

Description

🤖 Generated by Copilot at 6e11f42

Related Issue(s)

How to test

Documentation

Preview status

Build Options

akosyakov commented Oct 16, 2023 • edited by github-actions bot Loading

Comment triggered a workflow run

geropl Oct 17, 2023

Choose a reason for hiding this comment

geropl Oct 17, 2023

Choose a reason for hiding this comment

akosyakov Oct 17, 2023

Choose a reason for hiding this comment

geropl Oct 17, 2023

Choose a reason for hiding this comment

geropl Oct 17, 2023

Choose a reason for hiding this comment

geropl commented Oct 17, 2023

geropl commented Oct 17, 2023

akosyakov commented Oct 17, 2023 • edited by github-actions bot Loading

Comment triggered a workflow run

akosyakov commented Oct 17, 2023

geropl commented Oct 18, 2023 • edited by github-actions bot Loading

Comment triggered a workflow run

geropl left a comment

Choose a reason for hiding this comment

akosyakov commented Oct 18, 2023

akosyakov commented Oct 6, 2023 •

edited

Loading

`🤖 Generated by Copilot at 6e11f42`

akosyakov commented Oct 16, 2023 •

edited by github-actions bot

Loading

akosyakov commented Oct 17, 2023 •

edited by github-actions bot

Loading

geropl commented Oct 18, 2023 •

edited by github-actions bot

Loading