Rename database APIs #8143

rynowak · 2024-12-17T01:02:05Z

Description

This change renames the database APIs to have clearer names.

Type of change

This pull request is a minor refactor, code cleanup, test improvement, or other maintenance task and doesn't change the functionality of Radius (issue link optional).

Contributor checklist

Please verify that the PR meets the following requirements, where applicable:

An overview of proposed schema changes is included in a linked GitHub issue.
A design document PR is created in the design-notes repository, if new APIs are being introduced.
If applicable, design document has been reviewed and approved by Radius maintainers/approvers.
A PR for the samples repository is created, if existing samples are affected by the changes in this PR.
A PR for the documentation repository is created, if the changes in this PR affect the documentation or any user facing updates are made.
A PR for the recipes repository is created, if existing recipes are affected by the changes in this PR.

codecov · 2024-12-17T01:14:13Z

Codecov Report

Attention: Patch coverage is 53.69650% with 238 lines in your changes missing coverage. Please review.

Project coverage is 59.49%. Comparing base (c4c1c00) to head (4b37085).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
pkg/ucp/database/postgres/postgresclient.go	0.00%	48 Missing ⚠️
pkg/ucp/server/server.go	0.00%	18 Missing ⚠️
pkg/ucp/database/apiserverstore/apiserverclient.go	59.52%	17 Missing ⚠️
pkg/ucp/database/etcdstore/etcdclient.go	60.52%	15 Missing ⚠️
pkg/ucp/frontend/api/server.go	0.00%	15 Missing ⚠️
pkg/ucp/database/inmemory/client.go	64.86%	13 Missing ⚠️
pkg/ucp/database/options.go	0.00%	13 Missing ⚠️
pkg/armrpc/frontend/controller/controller.go	20.00%	8 Missing ⚠️
pkg/armrpc/frontend/controller/operation.go	0.00%	8 Missing ⚠️
pkg/server/apiservice.go	0.00%	6 Missing ⚠️
... and 34 more

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #8143      +/-   ##
==========================================
+ Coverage   59.47%   59.49%   +0.01%     
==========================================
  Files         577      580       +3     
  Lines       38644    39008     +364     
==========================================
+ Hits        22984    23207     +223     
- Misses      13994    14085      +91     
- Partials     1666     1716      +50

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

This change renames the database APIs to have clearer names. Signed-off-by: Ryan Nowak <[email protected]>

radius-functional-tests · 2024-12-17T02:52:10Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	rynowak/radius
Commit ref	`2f319af`
Unique ID	func4468a8e1b8
Image tag	pr-func4468a8e1b8

Click here to see the list of tools in the current test run

gotestsum 1.12.0
KinD: v0.20.0
Dapr:
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.3.0
Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-func4468a8e1b8
Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-func4468a8e1b8
dynamic-rp test image location: ghcr.io/radius-project/dev/dynamic-rp:pr-func4468a8e1b8
controller test image location: ghcr.io/radius-project/dev/controller:pr-func4468a8e1b8
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-func4468a8e1b8
deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting ucp-cloud functional tests...
⌛ Starting corerp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

ytimocin · 2024-12-17T06:09:59Z

cmd/ucpd/cmd/root.go

@@ -26,7 +26,7 @@ import (
 	runtimelog "sigs.k8s.io/controller-runtime/pkg/log"

 	"github.com/radius-project/radius/pkg/armrpc/hostoptions"
-	"github.com/radius-project/radius/pkg/ucp/dataprovider"
+	"github.com/radius-project/radius/pkg/ucp/databaseprovider"


Do we have both database and databaseprovider folders under ucp? I think this is the best practice, right? I am asking because I would create database under ucp and then provider under database.

I'm planning to rearrange these in the next PR 👍

I think it's a big improvement to name the package databaseprovider instead of provider. You'll notice that everywhere we reference these, they get aliased to something else.

ytimocin · 2024-12-17T06:13:03Z

pkg/armrpc/asyncoperation/worker/service.go

 	queue "github.com/radius-project/radius/pkg/ucp/queue/client"
-	qprovider "github.com/radius-project/radius/pkg/ucp/queue/provider"
+	"github.com/radius-project/radius/pkg/ucp/queue/queueprovider"


Like here the queueprovider is under ucp/queue. I believe that this can be renamed to ucp/queue/provider but it is not in the scope of this PR.

I'm planning to rearrange these in the next PR 👍

ytimocin · 2024-12-17T06:38:34Z

pkg/armrpc/hostoptions/providerconfig.go

+	"github.com/radius-project/radius/pkg/ucp/databaseprovider"
+	"github.com/radius-project/radius/pkg/ucp/queue/queueprovider"
+	"github.com/radius-project/radius/pkg/ucp/secret/secretprovider"


So, we renamed the queue/provider and secret/provider to queue/queueprovider and secret/secretprovider but kept databaseprovider under ucp. 🤨

I'm planning to rearrange these in the next PR 👍

radius-functional-tests · 2024-12-17T17:44:16Z

Radius functional test overview

🔍 Go to test action run

Name	Value
Repository	rynowak/radius
Commit ref	`4b37085`
Unique ID	func7e9e5e284e
Image tag	pr-func7e9e5e284e

Click here to see the list of tools in the current test run

gotestsum 1.12.0
KinD: v0.20.0
Dapr:
Azure KeyVault CSI driver: 1.4.2
Azure Workload identity webhook: 1.3.0
Bicep recipe location ghcr.io/radius-project/dev/test/testrecipes/test-bicep-recipes/<name>:pr-func7e9e5e284e
Terraform recipe location http://tf-module-server.radius-test-tf-module-server.svc.cluster.local/<name>.zip (in cluster)
applications-rp test image location: ghcr.io/radius-project/dev/applications-rp:pr-func7e9e5e284e
dynamic-rp test image location: ghcr.io/radius-project/dev/dynamic-rp:pr-func7e9e5e284e
controller test image location: ghcr.io/radius-project/dev/controller:pr-func7e9e5e284e
ucp test image location: ghcr.io/radius-project/dev/ucpd:pr-func7e9e5e284e
deployment-engine test image location: ghcr.io/radius-project/deployment-engine:latest

Test Status

⌛ Building Radius and pushing container images for functional tests...
✅ Container images build succeeded
⌛ Publishing Bicep Recipes for functional tests...
✅ Recipe publishing succeeded
⌛ Starting corerp-cloud functional tests...
⌛ Starting ucp-cloud functional tests...
✅ ucp-cloud functional tests succeeded
✅ corerp-cloud functional tests succeeded

rynowak requested review from a team as code owners December 17, 2024 01:02

rynowak temporarily deployed to publish-bicep December 17, 2024 01:02 — with GitHub Actions Inactive

Rename database APIs

2f319af

This change renames the database APIs to have clearer names. Signed-off-by: Ryan Nowak <[email protected]>

rynowak force-pushed the rynowak/rename-database branch from 757e5b3 to 2f319af Compare December 17, 2024 02:00

rynowak temporarily deployed to publish-bicep December 17, 2024 02:00 — with GitHub Actions Inactive

rynowak temporarily deployed to functional-tests December 17, 2024 02:51 — with GitHub Actions Inactive

ytimocin reviewed Dec 17, 2024

View reviewed changes

Merge branch 'main' into rynowak/rename-database

4b37085

rynowak temporarily deployed to publish-bicep December 17, 2024 17:39 — with GitHub Actions Inactive

rynowak temporarily deployed to functional-tests December 17, 2024 17:42 — with GitHub Actions Inactive

ytimocin approved these changes Dec 17, 2024

View reviewed changes

rynowak merged commit 6281a2f into radius-project:main Dec 17, 2024
29 checks passed

rynowak deleted the rynowak/rename-database branch December 17, 2024 18:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rename database APIs #8143

Rename database APIs #8143

rynowak commented Dec 17, 2024

codecov bot commented Dec 17, 2024 •

edited

Loading

radius-functional-tests bot commented Dec 17, 2024 •

edited

Loading

ytimocin Dec 17, 2024

rynowak Dec 17, 2024

ytimocin Dec 17, 2024

rynowak Dec 17, 2024

ytimocin Dec 17, 2024

rynowak Dec 17, 2024

radius-functional-tests bot commented Dec 17, 2024 •

edited

Loading

Rename database APIs #8143

Rename database APIs #8143

Conversation

rynowak commented Dec 17, 2024

Description

Type of change

Contributor checklist

codecov bot commented Dec 17, 2024 • edited Loading

Codecov Report

radius-functional-tests bot commented Dec 17, 2024 • edited Loading

Radius functional test overview

Test Status

ytimocin Dec 17, 2024

Choose a reason for hiding this comment

rynowak Dec 17, 2024

Choose a reason for hiding this comment

ytimocin Dec 17, 2024

Choose a reason for hiding this comment

rynowak Dec 17, 2024

Choose a reason for hiding this comment

ytimocin Dec 17, 2024

Choose a reason for hiding this comment

rynowak Dec 17, 2024

Choose a reason for hiding this comment

radius-functional-tests bot commented Dec 17, 2024 • edited Loading

Radius functional test overview

Test Status

codecov bot commented Dec 17, 2024 •

edited

Loading

radius-functional-tests bot commented Dec 17, 2024 •

edited

Loading

radius-functional-tests bot commented Dec 17, 2024 •

edited

Loading