Skip to content
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

fix(common): use original options when resuming streaming RPCs #8404

Closed
wants to merge 1 commit into from
Closed

fix(common): use original options when resuming streaming RPCs #8404

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion google/cloud/internal/resumable_streaming_read_rpc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_INTERNAL_RESUMABLE_STREAMING_READ_RPC_H

#include "google/cloud/internal/streaming_read_rpc.h"
#include "google/cloud/options.h"
#include "google/cloud/version.h"
#include <chrono>
#include <memory>
Expand Down Expand Up @@ -81,16 +82,21 @@ class ResumableStreamingReadRpc : public StreamingReadRpc<ResponseType> {
backoff_policy_prototype_(std::move(backoff_policy)),
sleeper_(std::move(sleeper)),
stream_factory_(std::move(stream_factory)),
options_(internal::CurrentOptions()),
updater_(std::move(updater)),
request_(std::move(request)),
impl_(stream_factory_(request_)) {}

ResumableStreamingReadRpc(ResumableStreamingReadRpc&&) = delete;
ResumableStreamingReadRpc& operator=(ResumableStreamingReadRpc&&) = delete;

void Cancel() override { impl_->Cancel(); }
void Cancel() override {
internal::OptionsSpan span(options_);
impl_->Cancel();
}

absl::variant<Status, ResponseType> Read() override {
internal::OptionsSpan span(options_);
auto response = impl_->Read();
if (absl::holds_alternative<ResponseType>(response)) {
updater_(absl::get<ResponseType>(response), request_);
Expand Down Expand Up @@ -128,6 +134,7 @@ class ResumableStreamingReadRpc : public StreamingReadRpc<ResponseType> {
}

StreamingRpcMetadata GetRequestMetadata() const override {
internal::OptionsSpan span(options_);
return impl_ ? impl_->GetRequestMetadata() : StreamingRpcMetadata{};
}

Expand All @@ -136,6 +143,7 @@ class ResumableStreamingReadRpc : public StreamingReadRpc<ResponseType> {
std::unique_ptr<BackoffPolicy const> const backoff_policy_prototype_;
Sleeper sleeper_;
StreamFactory<ResponseType, RequestType> const stream_factory_;
Options const options_;
RequestUpdater<ResponseType, RequestType> const updater_;
RequestType request_;
std::unique_ptr<StreamingReadRpc<ResponseType>> impl_;
Expand Down
26 changes: 26 additions & 0 deletions google/cloud/internal/resumable_streaming_read_rpc_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ struct FakeResponse {
std::string token;
};

struct FakeOption {
using Type = std::string;
};

using ReadReturn = absl::variant<Status, FakeResponse>;

class MockStreamingReadRpc : public StreamingReadRpc<FakeResponse> {
Expand Down Expand Up @@ -105,6 +109,7 @@ TEST(ResumableStreamingReadRpc, ResumeWithPartials) {
MockStub mock;
EXPECT_CALL(mock, StreamingRead)
.WillOnce([](FakeRequest const& request) {
EXPECT_EQ("create-time", internal::CurrentOptions().get<FakeOption>());
EXPECT_EQ(request.key, "test-key");
EXPECT_THAT(request.token, IsEmpty());
auto stream = absl::make_unique<MockStreamingReadRpc>();
Expand All @@ -115,6 +120,7 @@ TEST(ResumableStreamingReadRpc, ResumeWithPartials) {
return stream;
})
.WillOnce([](FakeRequest const& request) {
EXPECT_EQ("create-time", internal::CurrentOptions().get<FakeOption>());
EXPECT_EQ(request.key, "test-key");
EXPECT_THAT(request.token, "token-2");
auto stream = absl::make_unique<MockStreamingReadRpc>();
Expand All @@ -123,6 +129,7 @@ TEST(ResumableStreamingReadRpc, ResumeWithPartials) {
.WillOnce(Return(StreamSuccess()));
return stream;
});
internal::OptionsSpan create_span(Options{}.set<FakeOption>("create-time"));
auto reader = MakeResumableStreamingReadRpc<FakeResponse, FakeRequest>(
DefaultRetryPolicy(), DefaultBackoffPolicy(),
[](std::chrono::milliseconds) {},
Expand All @@ -131,6 +138,7 @@ TEST(ResumableStreamingReadRpc, ResumeWithPartials) {
},
DefaultUpdater, FakeRequest{"test-key", {}});

internal::OptionsSpan use_span(Options{}.set<FakeOption>("use-time"));
std::vector<std::string> values;
for (;;) {
auto v = reader->Read();
Expand All @@ -148,16 +156,19 @@ TEST(ResumableStreamingReadRpc, TooManyTransientFailures) {
MockStub mock;
EXPECT_CALL(mock, StreamingRead)
.WillOnce([](FakeRequest const&) {
EXPECT_EQ("create-time", internal::CurrentOptions().get<FakeOption>());
auto stream = absl::make_unique<MockStreamingReadRpc>();
EXPECT_CALL(*stream, Read).WillOnce(Return(TransientFailure()));
return stream;
})
.WillOnce([](FakeRequest const&) {
EXPECT_EQ("create-time", internal::CurrentOptions().get<FakeOption>());
auto stream = absl::make_unique<MockStreamingReadRpc>();
EXPECT_CALL(*stream, Read).WillOnce(Return(TransientFailure()));
return stream;
})
.WillOnce([](FakeRequest const&) {
EXPECT_EQ("create-time", internal::CurrentOptions().get<FakeOption>());
// Event though this stream ends with a failure it will be resumed
// because its successful Read() resets the retry policy.
auto stream = absl::make_unique<MockStreamingReadRpc>();
Expand All @@ -167,20 +178,25 @@ TEST(ResumableStreamingReadRpc, TooManyTransientFailures) {
return stream;
})
.WillOnce([](FakeRequest const&) {
EXPECT_EQ("create-time", internal::CurrentOptions().get<FakeOption>());
auto stream = absl::make_unique<MockStreamingReadRpc>();
EXPECT_CALL(*stream, Read).WillOnce(Return(TransientFailure()));
return stream;
})
.WillOnce([](FakeRequest const&) {
EXPECT_EQ("create-time", internal::CurrentOptions().get<FakeOption>());
auto stream = absl::make_unique<MockStreamingReadRpc>();
EXPECT_CALL(*stream, Read).WillOnce(Return(TransientFailure()));
return stream;
})
.WillOnce([](FakeRequest const&) {
EXPECT_EQ("create-time", internal::CurrentOptions().get<FakeOption>());
auto stream = absl::make_unique<MockStreamingReadRpc>();
EXPECT_CALL(*stream, Read).WillOnce(Return(TransientFailure()));
return stream;
});

internal::OptionsSpan create_span(Options{}.set<FakeOption>("create-time"));
auto reader = MakeResumableStreamingReadRpc<FakeResponse, FakeRequest>(
DefaultRetryPolicy(), DefaultBackoffPolicy(),
[](std::chrono::milliseconds) {},
Expand All @@ -189,6 +205,7 @@ TEST(ResumableStreamingReadRpc, TooManyTransientFailures) {
},
DefaultUpdater, FakeRequest{"test-key", {}});

internal::OptionsSpan use_span(Options{}.set<FakeOption>("use-time"));
std::vector<std::string> values;
for (;;) {
auto v = reader->Read();
Expand All @@ -207,6 +224,7 @@ TEST(ResumableStreamingReadRpc, PermanentFailure) {
MockStub mock;
EXPECT_CALL(mock, StreamingRead)
.WillOnce([](FakeRequest const&) {
EXPECT_EQ("create-time", internal::CurrentOptions().get<FakeOption>());
// Event though this stream ends with a failure it will be resumed
// because its successful Read() resets the retry policy.
auto stream = absl::make_unique<MockStreamingReadRpc>();
Expand All @@ -216,10 +234,13 @@ TEST(ResumableStreamingReadRpc, PermanentFailure) {
return stream;
})
.WillOnce([](FakeRequest const&) {
EXPECT_EQ("create-time", internal::CurrentOptions().get<FakeOption>());
auto stream = absl::make_unique<MockStreamingReadRpc>();
EXPECT_CALL(*stream, Read).WillOnce(Return(PermanentFailure()));
return stream;
});

internal::OptionsSpan create_span(Options{}.set<FakeOption>("create-time"));
auto reader = MakeResumableStreamingReadRpc<FakeResponse, FakeRequest>(
DefaultRetryPolicy(), DefaultBackoffPolicy(),
[](std::chrono::milliseconds) {},
Expand All @@ -228,6 +249,7 @@ TEST(ResumableStreamingReadRpc, PermanentFailure) {
},
DefaultUpdater, FakeRequest{"test-key", {}});

internal::OptionsSpan use_span(Options{}.set<FakeOption>("use-time"));
std::vector<std::string> values;
for (;;) {
auto v = reader->Read();
Expand All @@ -245,10 +267,13 @@ TEST(ResumableStreamingReadRpc, PermanentFailure) {
TEST(ResumableStreamingReadRpc, PermanentFailureAtStart) {
MockStub mock;
EXPECT_CALL(mock, StreamingRead).WillOnce([](FakeRequest const&) {
EXPECT_EQ("create-time", internal::CurrentOptions().get<FakeOption>());
auto stream = absl::make_unique<MockStreamingReadRpc>();
EXPECT_CALL(*stream, Read).WillOnce(Return(PermanentFailure()));
return stream;
});

internal::OptionsSpan create_span(Options{}.set<FakeOption>("create-time"));
auto reader = MakeResumableStreamingReadRpc<FakeResponse, FakeRequest>(
DefaultRetryPolicy(), DefaultBackoffPolicy(),
[](std::chrono::milliseconds) {},
Expand All @@ -257,6 +282,7 @@ TEST(ResumableStreamingReadRpc, PermanentFailureAtStart) {
},
DefaultUpdater, FakeRequest{"test-key", {}});

internal::OptionsSpan use_span(Options{}.set<FakeOption>("use-time"));
std::vector<std::string> values;
for (;;) {
auto v = reader->Read();
Expand Down