Skip to content

Added headers for CRR Cascaded #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SylvainSenechal wants to merge 2 commits into
base: development/1.0
Choose a base branch
from
Open

Added headers for CRR Cascaded #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4b968a8
Add new headers for CRR Cascaded
SylvainSenechal May 21, 2026
a072957
Bump version to 1.0.9
SylvainSenechal May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions models/backbeatRoutes/commonStructures.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
$version: "2.0"
namespace cloudserver.backbeatRoutes

@error("client")
@httpError(409)
structure ConflictException {
@required
message: String
}

/// Streaming blob type for binary data transfer
@streaming
@requiresLength
Expand Down
13 changes: 10 additions & 3 deletions models/backbeatRoutes/putMetadata.smithy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ namespace cloudserver.backbeatRoutes
@http(method: "PUT", uri: "/_/backbeat/metadata/{Bucket}/{Key+}")
operation PutMetadata {
input: PutMetadataInput,
output: PutMetadataOutput
output: PutMetadataOutput,
errors: [ConflictException]
Copy link
Copy Markdown
Contributor

@maeldonn maeldonn Jun 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should also be added to putData

}

structure PutMetadataInput {
Expand Down Expand Up @@ -33,12 +34,18 @@ structure PutMetadataInput {

@httpHeader("X-Scal-Request-Uids")
RequestUids: String,


@httpHeader("x-scal-micro-version-id")
MicroVersionId: String,
Copy link
Copy Markdown
Contributor

@francoisferrand francoisferrand Jun 1, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: to make the semantic explicit, field could be name something like IfMicroVersionIdOlderThan (i.e. semantics is part of the API)

Copy link
Copy Markdown
Contributor Author

@SylvainSenechal SylvainSenechal Jun 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leaving for now, what do other ppl think about the naming ?

Copy link
Copy Markdown
Contributor

@francoisferrand francoisferrand Jun 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@scality/raving-robots WDYT?

Copy link
Copy Markdown
Contributor

@maeldonn maeldonn Jun 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

x-scal-micro-version-id is simpler and easier to understand.


@httpPayload
Body: Blob
}

structure PutMetadataOutput {
/// Version ID of the stored metadata
versionId: String
versionId: String,

@httpHeader("x-scal-micro-version-id-exists")
MicroVersionIdExists: Boolean
Copy link
Copy Markdown
Contributor

@francoisferrand francoisferrand Jun 3, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: when it exists, should it return just a bool or actually the value itself ?(previous or current, not sure what we need)

Copy link
Copy Markdown
Contributor

@maeldonn maeldonn Jun 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be a bool

Copy link
Copy Markdown
Contributor

@maeldonn maeldonn Jun 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be x-scal-replication-loop to differentiate between a success write and a loop skip.

}
10 changes: 8 additions & 2 deletions models/backbeatRoutes/putdata.smithy
View file
Open in desktop
Comment thread
maeldonn marked this conversation as resolved.
Copy link
Copy Markdown
Contributor Author

@SylvainSenechal SylvainSenechal May 29, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First I added some tests in this codebase, but they were too functional and not really oriented toward just testing the client itself. + we already have test testing the client itself for putData/putMetadata

So I added the tests in Cloudserver : They are functional tests using CloudserverClient with the micro version id, testing 409 error, actual api behavior etc. I think they are better in cloudserver than in here

Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ structure PutDataInput {
@httpHeader("X-Scal-Request-Uids")
RequestUids: String,

@httpHeader("x-scal-source-version-id")
Copy link
Copy Markdown
Contributor

@francoisferrand francoisferrand Jun 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why "source" ? you usual header is x-scal-version-id I think, should stick to it ?

Copy link
Copy Markdown
Contributor

@francoisferrand francoisferrand Jun 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be marked as "optional" : if not set, we should keep previous/existing behavior (no conflict detection etc)

Copy link
Copy Markdown
Contributor

@maeldonn maeldonn Jun 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be confirmed, but I think it's optional by default.

VersionId: String,

@httpPayload
@default("")
Body: StreamingBlob
Expand All @@ -45,7 +48,10 @@ structure PutDataOutput {

@httpHeader("x-amz-server-side-encryption-customer-algorithm")
SSECustomerAlgorithm: String,

@httpHeader("x-amz-server-side-encryption-aws-kms-key-id")
SSEKMSKeyId: String
SSEKMSKeyId: String,

@httpHeader("x-scal-micro-version-id")
ExistingMicroVersionId: String
Copy link
Copy Markdown
Contributor

@francoisferrand francoisferrand Jun 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just MicroVersionId, consistent with the x-scal header

}
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@scality/cloudserverclient",
"version": "1.0.8",
"version": "1.0.9",
"engines": {
"node": ">=20"
},
Expand Down
Loading