Add bucket quota apis #5

SylvainSenechal · 2025-12-16T16:20:14Z

SylvainSenechal · 2025-12-16T16:28:11Z

package.json

  "description": "Smithy-generated TypeScript client for Cloudserver's internal APIs",
  "main": "dist/index.js",
  "types": "dist/index.d.ts",
+  "exports": {


This will allow importing with subpath, for example

import { BucketQuotaClient } from '@scality/cloudserverclient/quota'

SylvainSenechal · 2025-12-16T16:29:12Z

service/cloudserverBucketQuota.smithy

+
+namespace cloudserver.bucketquota
+
+use aws.protocols#restXml


We have to create a new separate service, as the other client is json, but the quota apis are xml.
And anyways it might just be better for code organisation.

src/clients/bucketQuota.ts

SylvainSenechal · 2025-12-16T16:50:55Z

.github/actions/setup-smithy/action.yml

-      env:
-        SMITHY_VERSION: '1.61.0'
      run: |
+        # Extract Smithy version from smithy-build.json


Not directly related with the pr, but this is nicer as we will only have one source of truth for smithy version.
I could definitely see someone updating smithy version here and forgetting about updating it in smithy-build.json

src/clients/bucketQuota.ts

francoisferrand · 2025-12-19T08:22:01Z

src/clients/bucketQuota.ts

+import { CloudserverClientConfig } from '../../build/smithy/cloudserver/typescript-codegen';
+
+export class BucketQuotaClient {
+    private client: CloudserverBucketQuota;


ok to introduce a wrapper (c.f. previous point) ; however, this specific wrapper changes the overall "form" of the API, which does not look like AWS sdk v3 code : looks more like v2.

I wonder if it would not be better to wrap the command objects (GetBucketQuotaCommand, UpdateBucketQuotaCommand...) then send them as usual?

(this could also make it more seamless to have combined "s3" + quotas client: just need to write our own client whose send() method supports both s3 & quota api ?)

I removed the wrapper, it should be clearer now

src/clients/bucketQuota.ts

francoisferrand · 2025-12-19T08:31:23Z

src/clients/backbeatRoutes.ts

@@ -0,0 +1,18 @@
+import { 


so now moving to separate clients for each service?
→ in that case, this specific client must be renamed ("BackeatRoutesClient" ?), as it does not cover all cloudserver routes...

even if each client is available "separately", may be good to keep an "aggregated" cloudserver client:

for retro-compatibility, avoid breaking change (e.g. allow easily bumping in backbeat)

for ease of use & discoverability

Yeah I decided to split the client, anyways we are kinda forced to do it because of the json vs xml clients.
But also, as I added the other clients, I realized we start to have a few of them :

quotas

s3extended

backbeat routes

backbeat apis

And I believe most of the time, the utilisation of these apis will not be mixed. So now we have a clearer separation, and also the way these clients are exported, users will be able to import part of the client only (I added an example for bucket quota) :

import { BucketQuotaClient, CloudserverBucketQuotaClientConfig, GetBucketQuotaCommand } from '@scality/cloudserverclient/clients/bucketQuota';

The only thing that I'm not very satisfied with, is the client named "cloudserver". The 3 others are quite clear in what they do
one is for quotas, one for the apis calling backbeat, and one for extending s3 regular apis.
But the "cloudserver" one, it contains 80% of backbeat routes //backbeat/.., but it turns out it also contains a few other things :
for example
//metadata/default/attributes

So now, I don't know exactly whats the best naming strategy for the cloudserver client, for now I kept it as "cloudserver"

I think CloudserverBackbeatRoutes is the way : a bit weird, but it is really what this is, for lack of anything better (the routes in cloudserver "designed" for backbeat)...

This would however break compatibility with (existing) backbeat? So we need to decide very soon, to avoid breaking...

francoisferrand · 2025-12-19T08:33:30Z

models/quotas/updateBucketQuota.smithy

+
+@http(method: "PUT", uri: "/{Bucket}?quota=true")
+@idempotent
+operation UpdateBucketQuota {


keep same conventions as AWS (and http/rest in general) ?

Suggested change

operation UpdateBucketQuota {

operation PutBucketQuota {

I kept the same names as the ones from the doc, do you confirm you wanna change it ?
Right now :

cloudserver : bucketUpdateQuota

documentation for clients : UpdateBucketQuota

Here : UpdateBucketQuota

🤷‍♂️ let's ask for a vote from the team in the channel?

tests/testQuotaApis.test.ts

bert-e · 2026-01-05T10:30:07Z

Hello sylvainsenechal,

My role is to assist you with the merge of this
pull request. Please type @bert-e help to get information
on this process, or consult the user documentation.

Available options

name	description	privileged	authored
`/after_pull_request`	Wait for the given pull request id to be merged before continuing with the current one.
`/bypass_author_approval`	Bypass the pull request author's approval	⭐
`/bypass_build_status`	Bypass the build and test status	⭐
`/bypass_commit_size`	Bypass the check on the size of the changeset `TBA`	⭐
`/bypass_incompatible_branch`	Bypass the check on the source branch prefix	⭐
`/bypass_jira_check`	Bypass the Jira issue check	⭐
`/bypass_peer_approval`	Bypass the pull request peers' approval	⭐
`/bypass_leader_approval`	Bypass the pull request leaders' approval	⭐
`/approve`	Instruct Bert-E that the author has approved the pull request.		✍️
`/create_pull_requests`	Allow the creation of integration pull requests.
`/create_integration_branches`	Allow the creation of integration branches.
`/no_octopus`	Prevent Wall-E from doing any octopus merge and use multiple consecutive merge instead
`/unanimity`	Change review acceptance criteria from `one reviewer at least` to `all reviewers`
`/wait`	Instruct Bert-E not to run until further notice.

Available commands

name	description	privileged
`/help`	Print Bert-E's manual in the pull request.
`/status`	Print Bert-E's current status in the pull request `TBA`
`/clear`	Remove all comments from Bert-E from the history `TBA`
`/retry`	Re-start a fresh build `TBA`
`/build`	Re-start a fresh build `TBA`
`/force_reset`	Delete integration branches & pull requests, and restart merge process from the beginning.
`/reset`	Try to remove integration branches unless there are commits on them which do not appear on the source branch.

Status report is not available.

bert-e · 2026-01-05T10:30:11Z

Incorrect fix version

The Fix Version/s in issue CLDSRVCLT-4 contains:

None

Considering where you are trying to merge, I ignored possible hotfix versions and I expected to find:

1.0.1

Please check the Fix Version/s of CLDSRVCLT-4, or the target
branch of this pull request.

.github/workflows/release.yml

francoisferrand · 2026-01-12T08:57:22Z

.github/workflows/release.yml

          registry-url: 'https://registry.npmjs.org'

      - name: Publish to npm with provenance
        run: npm publish --provenance --tag latest


Should the tag not be ${{ needs.build.outputs.version }} ?

Suggested change

run: npm publish --provenance --tag ${{ needs.build.outputs.version }}

or even not be set at all ?

Suggested change

run: npm publish --provenance

I have not much experience with npm publish, but looking at the docs the default is latest already; and the docs explicitly states:

Publishing a package sets the latest tag to the published version unless the --tag option is used. For example, npm publish --tag=beta.

(oops, wrong PR I guess : did you forget to rebase?)

francoisferrand · 2026-01-12T09:03:15Z

src/clients/bucketQuota.ts

+    DeleteBucketQuotaCommandOutput,
+} from '../../build/smithy/cloudserverBucketQuota/typescript-codegen';
+
+export class BucketQuotaClient extends CloudserverBucketQuotaClient {


can/should we have a dedicated "quota client", or somehow "merge" all clients to have a single one?
(i.e. have a generic "CloudserverClient which extends both S3Client, CloudserverBucketQuotaClient, CloudserverBackbeatRoutesClient [...])

francoisferrand

please rebase &

ISSUE: CLDSRVCLT-4

…organize folders ISSUE: CLDSRVCLT-4

ISSUE: CLDSRVCLT-4

francoisferrand · 2026-01-12T17:35:48Z

package.json

 {
  "name": "@scality/cloudserverclient",
-  "version": "1.0.0",
+  "version": "1.1.0",


1.1.0 should be on 1.1 branch...

SylvainSenechal commented Dec 16, 2025

View reviewed changes

src/clients/bucketQuota.ts Outdated Show resolved Hide resolved

SylvainSenechal force-pushed the improvement/CLDSRVCLT-4 branch from 5170901 to 48729a4 Compare December 16, 2025 16:49

SylvainSenechal commented Dec 16, 2025

View reviewed changes

SylvainSenechal requested review from a team, benzekrimaha and delthas December 16, 2025 17:00

SylvainSenechal marked this pull request as ready for review December 16, 2025 17:00

DarkIsDude approved these changes Dec 17, 2025

View reviewed changes

src/clients/bucketQuota.ts Show resolved Hide resolved

SylvainSenechal force-pushed the improvement/CLDSRVCLT-4 branch 4 times, most recently from 6e52335 to 3768de7 Compare December 17, 2025 14:34

francoisferrand reviewed Dec 19, 2025

View reviewed changes

src/clients/bucketQuota.ts Outdated Show resolved Hide resolved

francoisferrand reviewed Dec 19, 2025

View reviewed changes

tests/testQuotaApis.test.ts Show resolved Hide resolved

SylvainSenechal force-pushed the improvement/CLDSRVCLT-7 branch 2 times, most recently from e09c5a5 to b433100 Compare December 19, 2025 10:24

SylvainSenechal force-pushed the improvement/CLDSRVCLT-4 branch 5 times, most recently from d2aa0ac to e099139 Compare December 30, 2025 16:00

SylvainSenechal force-pushed the improvement/CLDSRVCLT-7 branch from b433100 to ffa94b0 Compare January 5, 2026 10:27

Base automatically changed from improvement/CLDSRVCLT-7 to development/1.0 January 5, 2026 10:29

SylvainSenechal requested a review from francoisferrand January 6, 2026 17:00

francoisferrand reviewed Jan 12, 2026

View reviewed changes

.github/workflows/release.yml Outdated Show resolved Hide resolved

francoisferrand reviewed Jan 12, 2026

View reviewed changes

francoisferrand approved these changes Jan 12, 2026

View reviewed changes

SylvainSenechal added 2 commits January 12, 2026 15:20

added quotas apis

6063ef5

ISSUE: CLDSRVCLT-4

extract smithy version from smithy-build for single source version

c882857

ISSUE: CLDSRVCLT-4

SylvainSenechal force-pushed the improvement/CLDSRVCLT-4 branch 5 times, most recently from 7d23727 to d809ead Compare January 12, 2026 15:41

added example for bucket quota client

96dd338

ISSUE: CLDSRVCLT-4

SylvainSenechal force-pushed the improvement/CLDSRVCLT-4 branch from d809ead to 89416f7 Compare January 12, 2026 17:21

SylvainSenechal added 4 commits January 12, 2026 18:32

refactor client : renamed cloudserver as backbeatRoutes client and re…

677bfd9

…organize folders ISSUE: CLDSRVCLT-4

added cloudserver global client to wrap all other clients

d1aeca4

ISSUE: CLDSRVCLT-4

added cloudserver global client example

7f476de

ISSUE: CLDSRVCLT-4

bump version to 1.1.0

a7c2a3c

ISSUE: CLDSRVCLT-4

SylvainSenechal force-pushed the improvement/CLDSRVCLT-4 branch from 89416f7 to a7c2a3c Compare January 12, 2026 17:33

francoisferrand reviewed Jan 12, 2026

View reviewed changes


	run: npm publish --provenance --tag ${{ needs.build.outputs.version }}

Add bucket quota apis #5

Are you sure you want to change the base?

Add bucket quota apis #5

Uh oh!

Conversation

SylvainSenechal commented Dec 16, 2025 • edited by francoisferrand Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SylvainSenechal Jan 6, 2026 • 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!

francoisferrand Jan 12, 2026 • 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!

Uh oh!

bert-e commented Jan 5, 2026

Hello sylvainsenechal,

Uh oh!

bert-e commented Jan 5, 2026

Incorrect fix version

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

francoisferrand Jan 12, 2026 • 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!

francoisferrand left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

SylvainSenechal commented Dec 16, 2025 •

edited by francoisferrand

Loading

SylvainSenechal Jan 6, 2026 •

edited

Loading

francoisferrand Jan 12, 2026 •

edited

Loading

francoisferrand Jan 12, 2026 •

edited

Loading