feat(storage): Synchronous gRPC Interceptor #16176
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| // Copyright 2026 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| #include "google/cloud/storage/internal/feature_tracker.h" | ||
| #include "google/cloud/storage/internal/base64.h" | ||
| #include "google/cloud/storage/options.h" | ||
| #include "google/cloud/options.h" | ||
| #include <memory> | ||
| #include <vector> | ||
|
|
||
| namespace google { | ||
| namespace cloud { | ||
| namespace storage { | ||
| GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN | ||
| namespace internal { | ||
|
|
||
| std::string EncodeFeatureTrackerBitmask(std::uint32_t mask) { | ||
| if (mask == 0) return {}; | ||
|
|
||
| std::vector<std::uint8_t> bytes; | ||
| for (int i = 0; i < 4; ++i) { | ||
| auto b = static_cast<std::uint8_t>((mask >> (24 - i * 8)) & 0xFF); | ||
| if (!bytes.empty() || b != 0) { | ||
| bytes.push_back(b); | ||
| } | ||
| } | ||
| return Base64Encode(bytes); | ||
| } | ||
|
|
||
| Options SetupFeatureTracker(Options opts) { | ||
| if (opts.has<EnableFeatureReportsOption>() && | ||
| !opts.get<EnableFeatureReportsOption>()) { | ||
| return std::move(opts); | ||
| } | ||
| if (opts.has<FeatureTrackerOption>()) return std::move(opts); | ||
|
|
||
| std::uint32_t mask = 0; | ||
| // Add checks for configuration-driven options here as they are introduced. | ||
| opts.set<FeatureTrackerOption>(std::make_shared<FeatureTracker>(mask)); | ||
| return std::move(opts); | ||
| } | ||
|
|
||
| } // namespace internal | ||
| GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END | ||
| } // namespace storage | ||
| } // namespace cloud | ||
| } // namespace google |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| // Copyright 2026 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // https://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| #ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_STORAGE_INTERNAL_FEATURE_TRACKER_H | ||
| #define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_STORAGE_INTERNAL_FEATURE_TRACKER_H | ||
|
|
||
| #include "google/cloud/storage/version.h" | ||
| #include "google/cloud/options.h" | ||
| #include <atomic> | ||
| #include <cstdint> | ||
| #include <memory> | ||
| #include <string> | ||
|
|
||
| namespace google { | ||
| namespace cloud { | ||
| namespace storage { | ||
| GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN | ||
| namespace internal { | ||
|
|
||
| inline constexpr auto kFeatureTrackerHeaderName = "x-goog-storage-cpp-features"; | ||
|
|
||
| // Tracked features represented as bit positions in a bitmask. | ||
| enum class TrackedFeature : std::uint32_t { | ||
| // Operation-Driven Optimizations | ||
| kMultiStreamInMRD = 0, | ||
| kPCU = 1, | ||
|
|
||
| // Configuration-Driven Options | ||
| kGrpcDirectPathEnforced = 2, | ||
| kJsonReads = 3, | ||
| }; | ||
|
|
||
| // Converts a feature bitmask to a Base64-encoded string, stripping leading | ||
| // zero bytes to maintain compact representation. | ||
| std::string EncodeFeatureTrackerBitmask(std::uint32_t mask); | ||
|
|
||
| // A thread-safe state object that can be shared between operation connections | ||
| // (like ObjectDescriptorImpl) and RPC factories (like OpenStreamFactory) | ||
| // to track which features are adopted during an operation. | ||
| class FeatureTracker { | ||
| public: | ||
| FeatureTracker() = default; | ||
| explicit FeatureTracker(std::uint32_t initial) : mask_(initial) {} | ||
|
|
||
| void RegisterFeature(TrackedFeature feature) { | ||
| mask_.fetch_or(1U << static_cast<std::uint32_t>(feature), | ||
| std::memory_order_relaxed); | ||
| } | ||
|
|
||
| std::uint32_t GetMask() const { | ||
| return mask_.load(std::memory_order_relaxed); | ||
| } | ||
|
|
||
| std::string HeaderValue() const { | ||
| return EncodeFeatureTrackerBitmask(GetMask()); | ||
| } | ||
|
|
||
| private: | ||
| std::atomic<std::uint32_t> mask_{0}; | ||
| }; | ||
|
|
||
| struct FeatureTrackerOption { | ||
| using Type = std::shared_ptr<FeatureTracker>; | ||
| }; | ||
|
|
||
| // Evaluates client configuration options, creates a shared FeatureTracker | ||
| // initialized with configuration-driven feature flags (if any), and stores it | ||
| // into the Options list under FeatureTrackerOption. | ||
| Options SetupFeatureTracker(Options opts); | ||
|
|
||
| } // namespace internal | ||
| GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END | ||
| } // namespace storage | ||
| } // namespace cloud | ||
| } // namespace google | ||
|
|
||
| #endif // GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_STORAGE_INTERNAL_FEATURE_TRACKER_H | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,7 +15,9 @@ | |
| #ifndef GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_STORAGE_INTERNAL_GRPC_CONFIGURE_CLIENT_CONTEXT_H | ||
| #define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_STORAGE_INTERNAL_GRPC_CONFIGURE_CLIENT_CONTEXT_H | ||
|
|
||
| #include "google/cloud/storage/internal/feature_tracker.h" | ||
| #include "google/cloud/storage/internal/generic_request.h" | ||
| #include "google/cloud/storage/options.h" | ||
| #include "google/cloud/storage/internal/object_requests.h" | ||
| #include "google/cloud/storage/version.h" | ||
| #include "google/cloud/grpc_options.h" | ||
|
|
@@ -71,6 +73,20 @@ void ApplyQueryParameters(grpc::ClientContext& ctx, Options const& options, | |
| ctx.AddMetadata("x-goog-fieldmask", | ||
| request.template GetOption<storage::Fields>().value()); | ||
| } | ||
| bool const enable_reports = | ||
| !options.has<storage::EnableFeatureReportsOption>() || | ||
| options.get<storage::EnableFeatureReportsOption>(); | ||
| if (enable_reports && | ||
| options.has<storage::internal::FeatureTrackerOption>()) { | ||
| auto const& tracker = | ||
| options.get<storage::internal::FeatureTrackerOption>(); | ||
| if (tracker) { | ||
| auto const val = tracker->HeaderValue(); | ||
| if (!val.empty()) { | ||
| ctx.AddMetadata(storage::internal::kFeatureTrackerHeaderName, val); | ||
| } | ||
| } | ||
| } | ||
|
Comment on lines
+76
to
+89
There was a problem hiding this comment. Use the centralized auto const val = storage::internal::FeatureTrackerHeaderValue(options);
if (!val.empty()) {
ctx.AddMetadata(storage::internal::kFeatureTrackerHeaderName, val);
}References
|
||
| internal::ConfigureContext(ctx, options); | ||
| } | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,6 +15,9 @@ | |
| #include "google/cloud/storage/internal/rest/stub.h" | ||
| #include "google/cloud/storage/internal/bucket_access_control_parser.h" | ||
| #include "google/cloud/storage/internal/bucket_metadata_parser.h" | ||
| #include "google/cloud/storage/internal/feature_tracker.h" | ||
| #include "google/cloud/storage/options.h" | ||
| #include "google/cloud/storage/internal/base64.h" | ||
| #include "google/cloud/storage/internal/bucket_requests.h" | ||
| #include "google/cloud/storage/internal/generate_message_boundary.h" | ||
| #include "google/cloud/storage/internal/hmac_key_metadata_parser.h" | ||
|
|
@@ -116,6 +119,18 @@ void AddCustomHeaders(Options const& options, RestRequestBuilder& builder) { | |
|
|
||
| Status AddHeaders(Options const& options, RestRequestBuilder& builder) { | ||
| AddCustomHeaders(options, builder); | ||
| bool const enable_reports = | ||
| !options.has<EnableFeatureReportsOption>() || | ||
| options.get<EnableFeatureReportsOption>(); | ||
| if (enable_reports && options.has<FeatureTrackerOption>()) { | ||
| auto const& tracker = options.get<FeatureTrackerOption>(); | ||
| if (tracker) { | ||
| auto const val = tracker->HeaderValue(); | ||
| if (!val.empty()) { | ||
| builder.AddHeader(kFeatureTrackerHeaderName, val); | ||
| } | ||
| } | ||
| } | ||
|
Comment on lines
+122
to
+133
There was a problem hiding this comment. Use the centralized auto const val = FeatureTrackerHeaderValue(options);
if (!val.empty()) {
builder.AddHeader(kFeatureTrackerHeaderName, val);
}References
|
||
| return {}; | ||
| } | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To adhere to the repository style guide regarding factoring out duplicated code (which appears 3 or more times in non-test files), we should introduce a helper function
FeatureTrackerHeaderValueto centralize the logic of checkingEnableFeatureReportsOptionand retrieving the header value.References