Adding ConfigurationServiceAPI #19020

selfcontained · 2023-11-06T20:56:34Z

Description

Adds the ConfigurationService api that is meant to be a replacement for existing Projects apis. Internally it uses the existing ProjectService. The following methods are included in this PR:

CreateConfiguration
GetConfiguration
ListConfigurations
DeleteConfiguration

Update* method(s) will be implemented in a followup PR.

The initial consumer of these endpoints will just be the new Repo Config UIs. Existing UI that uses the project apis will continue to use them and won't be migrated over these apis since they'll be removed once we release the repo config uis.

Summary generated by Copilot

`🤖 Generated by Copilot at 9e5879e`

This pull request adds the Configuration service to the public API, which allows managing project configurations composed of prebuild settings and workspace settings. It also adds the ability to search for projects by name or cloneUrl in the projectDb. It updates the public-api-converter and its tests to handle the new types related to the Configuration service. It generates the necessary files for the gRPC-Go, Connect-Go, and Connect-ES clients and servers from the configuration.proto file. It implements the ConfigurationServiceHandler interface in the configuration-service-api.ts file using the ProjectsService and the PublicAPIConverter.

Related Issue(s)

Fixes EXP-877

How to test

ListConfigurations and GetConfiguration are integrated into the Dashboard UI in this PR.
You can verify them by using the Repositories link from the Org Menu in the top left.
Create a new Config (still says project in the copy for now).
It should navigate you to the Detail page, which exercises the GetConfiguration method.
Navigate back to the list and ensure you see the new configuration, which exercises the ListConfigurations method.
Create/Delete will be integrated into the new UIs in followups.

Documentation

Preview status

Gitpod was successfully deployed to your preview environment.

🏷️ Name - brad-config-service
🔗 URL - brad-config-service.preview.gitpod-dev.com/workspaces.
📚 Documentation - See our internal documentation for information on how to interact with your preview environment.
📦 Version - brad-config-service-gha.19593
🗒️ 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/api/configuration-service-api.ts

… imports are for

selfcontained · 2023-11-07T22:57:04Z

components/dashboard/src/data/setup.tsx

@@ -16,6 +16,11 @@ import { Message } from "@bufbuild/protobuf";
 import { ReactQueryDevtools } from "@tanstack/react-query-devtools";
 import { FunctionComponent } from "react";
 import debounce from "lodash.debounce";
+// Need to import all the protobuf classes we want to support for hydration


I swapped these to imports for consistency and I think it makes it a bit clearer what we're importing and why. It seems to work fine this way, not sure if there was another reason you had used require's @svenefftinge?

Normally I think imports are more desirable as they allow for static analysis (and allow for tree-shaking unused exports). In this case we're importing everything anyways, so that benefit is probably moot, but I think the consistency of imports at the beginning of the module is still valuable for readability. Happy to adjust back if we don't want that though.

selfcontained · 2023-11-07T23:32:50Z

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

+  string organization_id = 1;
+  string name = 2;
+  string clone_url = 3;
+}


@svenefftinge I dropped the workspace/prebuild settings from this create request for now just to reduce some of the scope of the changes in here and not hold up the basics. I do think it would be nice to support though since you'd most likely want to set those during create if you were using this as a consumer of the api directly.

akosyakov · 2023-11-08T08:01:22Z

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

+            .where(
+                new Brackets((qb) => {
+                    qb.where("project.cloneUrl LIKE :searchTerm", { searchTerm: `%${searchTerm}%` }).orWhere(
+                        "project.name LIKE :searchTerm",


Any potential performance implications here on some existing UI?

It does not seem we have an index of project name but on clone URL? Do we need to add one? cc @geropl

In this case I don't think an index would help since it has a leading wildcard in the search. It would be helpful for sorting by name though, which we would like to have on the new list UI.

akosyakov

looks good

not sure about perf implications of the search by name. it seems we use it on admin UI.

filiptronicek

Looks good. Left a few non-blocking comments

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

components/dashboard/src/repositories/detail/RepositoryName.tsx

filiptronicek · 2023-11-08T12:54:37Z

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

+
+    async listConfigurations(req: ListConfigurationsRequest, context: HandlerContext) {
+        if (!req.organizationId) {
+            throw new ApplicationError(ErrorCodes.BAD_REQUEST, "organizationId is required");


@selfcontained what do you think about throwing with the argument names as specified in protobuf instead of their JS mutations?

As an example, we could have organization_id here instead, which corresponds to what its name is in GetConfigurationRequest.

Good call. It would be nice to have some level of abstraction around validation here that also handled that detail for us. I'll adjust these to use the protobuf field names though.

akosyakov · 2023-11-08T14:27:42Z

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

+}
+
+message PrebuildSettings {
+  optional bool enabled = 1;


please remove optional, please see today discussions https://gitpod.slack.com/archives/C0463A2KQUU/p1699445663922319?thread_ts=1699369894.114879&cid=C0463A2KQUU

selfcontained · 2023-11-08T20:41:41Z

/unhold

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

akosyakov reviewed Nov 7, 2023

View reviewed changes

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

selfcontained added 4 commits November 7, 2023 21:06

adding ConfigurationServiceAPI

be79c16

binding config service api to server

52b2b00

use getConfiguration in dashboard

1c4f56f

adding missing binding

82c6986

selfcontained force-pushed the brad/config-service branch from 8006716 to 82c6986 Compare November 7, 2023 21:07

selfcontained added 3 commits November 7, 2023 21:35

use ApplicationError's

c0f998f

add protobuf classes to query client hydration

3fea4ee

fixing pagination param & query

46701c4

selfcontained force-pushed the brad/config-service branch from b818b0e to 46701c4 Compare November 7, 2023 22:34

changing to import statements for consistency and clarity on what the…

d279b8f

… imports are for

selfcontained commented Nov 7, 2023

View reviewed changes

selfcontained added 2 commits November 7, 2023 23:01

cleanup

a6311e4

dropping config settings for create for now

0a92325

selfcontained commented Nov 7, 2023

View reviewed changes

selfcontained marked this pull request as ready for review November 7, 2023 23:33

selfcontained requested a review from a team as a code owner November 7, 2023 23:33

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

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

akosyakov reviewed Nov 8, 2023

View reviewed changes

akosyakov approved these changes Nov 8, 2023

View reviewed changes

filiptronicek approved these changes Nov 8, 2023

View reviewed changes

akosyakov reviewed Nov 8, 2023

View reviewed changes

selfcontained added 4 commits November 8, 2023 14:56

use protobuf field names in error messages

2bebf9e

removing optional on fields

2673380

fixing converters to account for non-optional (undefined) fields

1a608c3

update test

3783994

selfcontained added 3 commits November 8, 2023 18:42

adding more tests for findProjectsBySearchTerm

2090769

fixing test to use offset correctly

3f8fb9a

convert pagination args correctly

01731fe

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

roboquat merged commit df7929c into main Nov 8, 2023
16 checks passed

roboquat deleted the brad/config-service branch November 8, 2023 20:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding ConfigurationServiceAPI #19020

Adding ConfigurationServiceAPI #19020

selfcontained commented Nov 6, 2023 •

edited by github-actions bot

Loading

selfcontained Nov 7, 2023

selfcontained Nov 7, 2023

akosyakov Nov 8, 2023

akosyakov Nov 8, 2023

selfcontained Nov 8, 2023

akosyakov left a comment

filiptronicek left a comment

filiptronicek Nov 8, 2023

selfcontained Nov 8, 2023

akosyakov Nov 8, 2023

selfcontained commented Nov 8, 2023

Adding ConfigurationServiceAPI #19020

Adding ConfigurationServiceAPI #19020

Conversation

selfcontained commented Nov 6, 2023 • edited by github-actions bot Loading

Description

🤖 Generated by Copilot at 9e5879e

Related Issue(s)

How to test

Documentation

Preview status

Build Options

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

akosyakov left a comment

Choose a reason for hiding this comment

filiptronicek left a 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

selfcontained commented Nov 8, 2023

selfcontained commented Nov 6, 2023 •

edited by github-actions bot

Loading

`🤖 Generated by Copilot at 9e5879e`