[papi] migrate ListWorkspaces and WatchWorkspaceStatus #19022

mustard-mh · 2023-11-07T08:23:44Z

Description

Add ListWorkspaces proto
Update dashboard to use ListWorkspaces and WatchWorkspaceStatus

Summary generated by Copilot

`🤖 Generated by Copilot at d01aa12`

Added a new feature to list workspaces by organization ID and other filters. This involved adding new methods and types to the public API, the connect protocol, the workspace service, and the workspace database layer. The files workspace.proto, workspace_pb.ts, workspace.connect.go, workspace_connect.ts, workspace-service-api.ts, workspace-service.ts, workspace-db.ts, workspace-db-impl.ts, and workspace-db.spec.db.ts were modified or created to implement this feature. The files json-rpc-workspace-client.ts and workspace.proxy.connect.go were updated to use the new methods.

Related Issue(s)

Fixes #

How to test

Dashboard should work like before (except some field that we don't respond anymore. like workspace creationTime, context (git commit...))

Documentation

Preview status

Gitpod was successfully deployed to your preview environment.

🏷️ Name - hw-papi-list-ws
🔗 URL - hw-papi-list-ws.preview.gitpod-dev.com/workspaces.
📚 Documentation - See our internal documentation for information on how to interact with your preview environment.
📦 Version - hw-papi-list-ws-gha.19478
🗒️ 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

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

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

svenefftinge · 2023-11-07T20:13:49Z

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

+  // organization_id
+  string organization_id = 2;
+
+  optional bool pinned = 3;


for the admin case we need other filters as well as sorting. maybe we can generalize somehow?

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

components/public-api/typescript/src/gitpod/experimental/v1/dummy_connect.ts

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

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

components/dashboard/src/workspaces/WorkspaceEntry.tsx

components/dashboard/src/workspaces/CreateWorkspacePage.tsx

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

components/dashboard/src/data/workspaces/list-workspaces-query.ts

akosyakov · 2023-11-14T14:04:56Z

@mustard-mh Should not we invalidate react query caches?

mustard-mh · 2023-11-14T14:08:36Z

mustard-mh Should not we invalidate react query caches?

I see, I did but after rebase it turns into the same value

filiptronicek · 2023-11-15T08:34:38Z

components/dashboard/src/workspaces/WorkspaceEntry.tsx

+    // http[s]?:\/\/(?<project>.*?\/.*?\/.*?)[./]
+    const regex = /http[s]?:\/\/(?<host>.*?)\/(?<owner>.*?)\/(?<name>.*?)[./]/gm;
+    const result = regex.exec(ws.status.gitStatus.cloneUrl);
+    if (!result) {
+        return ws.contextUrl.replace("https://", "");
+    }
+    const { host, owner, name } = result.groups!;
+    return `${host}/${owner}/${name}`;


This looks a bit scary 😆. Could we instead fail or return an empty string if we cannot get it from the context URL? Not sure how this would support the deeply-nested GitLab repos, which are not just /owner/repo.

@filiptronicek Yes, it is, and for Gitlab it can be longer since it can define lots of subGroup.

But based on current shape of Workspace we only can do it like this. I'm not sure if we should change workspace shape or do other things

I'm still not sure that we shoudl parse like that or add something like Repository on Workspace? cc @svenefftinge

It looks good to me, and also is only used as a string to visualize.
I believe we have somewhere a function that translates the cloneURL to a shorter version.
IS this not just cutting off https:// and .git?

Do you mean ContextURL.getNormalizedURL ? I can't find other function that may have this feature. But it will only cut some built-in prefix out and won't trim .git.

context-parser is only working with server now. We can use it after (will we?) introduce ContextService in papi

I'll change to use ContextURL.getNormalizedURL here.

@svenefftinge for comment above ☝️

We have a RepoURL.parseRepoUrl function in server that does approximation parsing of owner and name. If that's what's needed, we could thing of pulling this out to protocol.

Otherwise, see RepositoryURL component in Dashboard if we just need a clean repo URL from a given clone URL.

components/dashboard/src/workspaces/WorkspaceEntry.tsx

filiptronicek · 2023-11-15T10:27:00Z

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

+  // search_term is a search term to filter workspaces by name
+  string search_term = 4;


What is this actually searching? Is this the ID, description, repo details or something different? I think the comment should make it clear.

to filter workspaces by name by name

gitpod/components/gitpod-db/src/typeorm/workspace-db-impl.ts

Line 221 in eaae6cc

qb.andWhere("ws.description LIKE :searchString", { searchString: `%${options.searchString}%` });

@mustard-mh in that case, can we please change to the following?

Suggested change

// search_term is a search term to filter workspaces by name

string search_term = 4;

// search_term is a search term to filter workspaces by description

string search_term = 4;

We named it name now 😄

You can check new Workspace shape in this proto file

Please keep it search_term and add a comment. The reason is that we want to stop creating a name from the context, but instead have no name and only when you pin a workspace you name it. So we should really search by git status information and name (and id as long as we expose it like we do).

Edit: ignore ☝️

@svenefftinge I don't understand. Do you mean to change comment that it can filter with git status , workspaceId and name?

Oh, sorry. I missunderstood your comment that you named it name now as if you had changed the property name. So looks good now and we can update the docs once we change the implementation. Thank you!

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

mustard-mh · 2023-11-16T10:01:00Z

Feedbacks addressed, @AlexTugarev could you help test again? 🙏

I have tested that watch and list is working in preview env

components/dashboard/src/workspaces/WorkspaceEntry.tsx

components/dashboard/src/workspaces/DeleteWorkspaceModal.tsx

AlexTugarev · 2023-11-16T12:05:45Z

When trying to rename a workspace item.

@mustard-mh, I broke it. The issue appears to be permanent. Cannot be resolved with a reload.

mustard-mh · 2023-11-16T12:16:37Z

When trying to rename a workspace item.

mustard-mh, I broke it. The issue appears to be permanent. Cannot be resolved with a reload.

🙏 @AlexTugarev Fixed 3fc7b78

mustard-mh · 2023-11-16T13:17:31Z

rebased to main

AlexTugarev

Workspace list was working fine in tests! Thanks!

Maybe test once more after rebase on main.

akosyakov · 2023-11-16T13:41:59Z

Dashboard should work like before (except some field that we don't respond anymore. like workspace creationTime, context (git commit...))

@mustard-mh just to double check we do test the loading screen? it is affected right?

mustard-mh · 2023-11-16T13:44:55Z

just to double check we do test the loading screen? it is affected right?

@akosyakov Yes, I tested it then found out that .aborted bug 🐛. Will double check after preview env is ready

AlexTugarev · 2023-11-16T15:55:13Z

#19057 just landed. @mustard-mh, would it make sense to bump cache version in dashboard?

mustard-mh · 2023-11-16T18:44:41Z

✅ Rebased again, double check that pin, share, status render (create)

/unhold

roboquat added do-not-merge/hold do-not-merge/work-in-progress size/L labels Nov 7, 2023

akosyakov reviewed Nov 7, 2023

View reviewed changes

components/server/src/workspace/workspace-service.ts Outdated Show resolved Hide resolved

svenefftinge reviewed Nov 7, 2023

View reviewed changes

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

svenefftinge reviewed Nov 7, 2023

View reviewed changes

roboquat added size/XL size/L and removed size/L size/XL labels Nov 8, 2023

mustard-mh force-pushed the hw/papi-list-ws branch from 1d1b7ae to bacbad2 Compare November 8, 2023 19:07

akosyakov reviewed Nov 8, 2023

View reviewed changes

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

akosyakov reviewed Nov 8, 2023

View reviewed changes

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

akosyakov reviewed Nov 8, 2023

View reviewed changes

components/public-api/typescript/src/gitpod/experimental/v1/dummy_connect.ts Outdated Show resolved Hide resolved

akosyakov reviewed Nov 8, 2023

View reviewed changes

components/server/src/api/workspace-service-api.ts Outdated Show resolved Hide resolved

roboquat added size/XXL and removed size/L labels Nov 9, 2023

mustard-mh force-pushed the hw/papi-list-ws branch from c7accf4 to 8d13c5c Compare November 9, 2023 23:34

mustard-mh changed the title ~~[papi] add ListWorkspaces API~~ [papi] add WorkspaceService proto Nov 10, 2023

akosyakov reviewed Nov 10, 2023

View reviewed changes

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

akosyakov reviewed Nov 10, 2023

View reviewed changes

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

akosyakov reviewed Nov 10, 2023

View reviewed changes

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

akosyakov reviewed Nov 10, 2023

View reviewed changes

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

akosyakov reviewed Nov 10, 2023

View reviewed changes

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

akosyakov reviewed Nov 10, 2023

View reviewed changes

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

akosyakov reviewed Nov 10, 2023

View reviewed changes

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

akosyakov reviewed Nov 10, 2023

View reviewed changes

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

akosyakov reviewed Nov 10, 2023

View reviewed changes

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

akosyakov reviewed Nov 10, 2023

View reviewed changes

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

akosyakov reviewed Nov 10, 2023

View reviewed changes

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

akosyakov reviewed Nov 14, 2023

View reviewed changes

components/dashboard/src/workspaces/WorkspaceEntry.tsx Outdated Show resolved Hide resolved

akosyakov reviewed Nov 14, 2023

View reviewed changes

components/dashboard/src/workspaces/CreateWorkspacePage.tsx Outdated Show resolved Hide resolved

akosyakov reviewed Nov 14, 2023

View reviewed changes

components/dashboard/src/data/workspaces/update-workspace-description-mutation.ts Outdated Show resolved Hide resolved

akosyakov reviewed Nov 14, 2023

View reviewed changes

components/dashboard/src/data/workspaces/list-workspaces-query.ts Show resolved Hide resolved

filiptronicek reviewed Nov 15, 2023

View reviewed changes

mustard-mh mentioned this pull request Nov 15, 2023

[public-api] migrate PrebuildService #19062

Merged

14 tasks

filiptronicek reviewed Nov 15, 2023

View reviewed changes

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

svenefftinge reviewed Nov 15, 2023

View reviewed changes

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

akosyakov reviewed Nov 16, 2023

View reviewed changes

components/dashboard/src/workspaces/WorkspaceEntry.tsx Outdated Show resolved Hide resolved

AlexTugarev reviewed Nov 16, 2023

View reviewed changes

components/dashboard/src/workspaces/DeleteWorkspaceModal.tsx Show resolved Hide resolved

mustard-mh force-pushed the hw/papi-list-ws branch from 3fc7b78 to 4003d1f Compare November 16, 2023 13:17

AlexTugarev approved these changes Nov 16, 2023

View reviewed changes

[papi] migrate ListWorkspaces and WatchWorkspaceStatus

b279dcb

mustard-mh force-pushed the hw/papi-list-ws branch from 4003d1f to b279dcb Compare November 16, 2023 17:56

bump up cache version

f81106e

roboquat removed the do-not-merge/hold label Nov 16, 2023

roboquat merged commit 4324fcb into main Nov 16, 2023
15 checks passed

roboquat deleted the hw/papi-list-ws branch November 16, 2023 18:44

mustard-mh mentioned this pull request Nov 29, 2023

Refine workspace API #19138

Merged

15 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[papi] migrate ListWorkspaces and WatchWorkspaceStatus #19022

[papi] migrate ListWorkspaces and WatchWorkspaceStatus #19022

mustard-mh commented Nov 7, 2023 •

edited

Loading

svenefftinge Nov 7, 2023

akosyakov commented Nov 14, 2023

mustard-mh commented Nov 14, 2023

filiptronicek Nov 15, 2023

mustard-mh Nov 15, 2023 •

edited

Loading

akosyakov Nov 15, 2023

svenefftinge Nov 15, 2023

mustard-mh Nov 15, 2023 •

edited

Loading

mustard-mh Nov 15, 2023

svenefftinge Nov 15, 2023

AlexTugarev Nov 16, 2023

filiptronicek Nov 15, 2023

mustard-mh Nov 15, 2023 •

edited

Loading

filiptronicek Nov 15, 2023

mustard-mh Nov 15, 2023 •

edited

Loading

svenefftinge Nov 16, 2023 •

edited

Loading

mustard-mh Nov 16, 2023

svenefftinge Nov 16, 2023

mustard-mh commented Nov 16, 2023 •

edited

Loading

AlexTugarev commented Nov 16, 2023 •

edited

Loading

mustard-mh commented Nov 16, 2023

mustard-mh commented Nov 16, 2023

AlexTugarev left a comment

akosyakov commented Nov 16, 2023

mustard-mh commented Nov 16, 2023

AlexTugarev commented Nov 16, 2023

mustard-mh commented Nov 16, 2023

		// search_term is a search term to filter workspaces by name
		string search_term = 4;

[papi] migrate ListWorkspaces and WatchWorkspaceStatus #19022

[papi] migrate ListWorkspaces and WatchWorkspaceStatus #19022

Conversation

mustard-mh commented Nov 7, 2023 • edited Loading

Description

🤖 Generated by Copilot at d01aa12

Related Issue(s)

How to test

Documentation

Preview status

Build Options

Choose a reason for hiding this comment

akosyakov commented Nov 14, 2023

mustard-mh commented Nov 14, 2023

Choose a reason for hiding this comment

mustard-mh Nov 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mustard-mh Nov 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mustard-mh Nov 15, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mustard-mh Nov 15, 2023 • edited Loading

Choose a reason for hiding this comment

svenefftinge Nov 16, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mustard-mh commented Nov 16, 2023 • edited Loading

AlexTugarev commented Nov 16, 2023 • edited Loading

mustard-mh commented Nov 16, 2023

mustard-mh commented Nov 16, 2023

AlexTugarev left a comment

Choose a reason for hiding this comment

akosyakov commented Nov 16, 2023

mustard-mh commented Nov 16, 2023

AlexTugarev commented Nov 16, 2023

mustard-mh commented Nov 16, 2023

mustard-mh commented Nov 7, 2023 •

edited

Loading

`🤖 Generated by Copilot at d01aa12`

mustard-mh Nov 15, 2023 •

edited

Loading

mustard-mh Nov 15, 2023 •

edited

Loading

mustard-mh Nov 15, 2023 •

edited

Loading

mustard-mh Nov 15, 2023 •

edited

Loading

svenefftinge Nov 16, 2023 •

edited

Loading

mustard-mh commented Nov 16, 2023 •

edited

Loading

AlexTugarev commented Nov 16, 2023 •

edited

Loading