Skip to content

Commit

Permalink
refactor(pubsub): rename SchemaStub (#10064)
Browse files Browse the repository at this point in the history 
Use the name that the generator will use: `SchemaServiceStub`.
  • Loading branch information
@coryan
coryan authored Oct 18, 2022
1 parent 8cf365b commit 9eee84e
Show file tree
Hide file tree
Showing 17 changed files with 98 additions and 85 deletions.
14 changes: 8 additions & 6 deletions google/cloud/pubsub/internal/schema_auth_decorator.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,39 +20,41 @@ namespace cloud {
namespace pubsub_internal {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN

StatusOr<google::pubsub::v1::Schema> SchemaAuth::CreateSchema(
StatusOr<google::pubsub::v1::Schema> SchemaServiceAuth::CreateSchema(
grpc::ClientContext& context,
google::pubsub::v1::CreateSchemaRequest const& request) {
auto status = auth_->ConfigureContext(context);
if (!status.ok()) return status;
return child_->CreateSchema(context, request);
}

StatusOr<google::pubsub::v1::Schema> SchemaAuth::GetSchema(
StatusOr<google::pubsub::v1::Schema> SchemaServiceAuth::GetSchema(
grpc::ClientContext& context,
google::pubsub::v1::GetSchemaRequest const& request) {
auto status = auth_->ConfigureContext(context);
if (!status.ok()) return status;
return child_->GetSchema(context, request);
}

StatusOr<google::pubsub::v1::ListSchemasResponse> SchemaAuth::ListSchemas(
StatusOr<google::pubsub::v1::ListSchemasResponse>
SchemaServiceAuth::ListSchemas(
grpc::ClientContext& context,
google::pubsub::v1::ListSchemasRequest const& request) {
auto status = auth_->ConfigureContext(context);
if (!status.ok()) return status;
return child_->ListSchemas(context, request);
}

Status SchemaAuth::DeleteSchema(
Status SchemaServiceAuth::DeleteSchema(
grpc::ClientContext& context,
google::pubsub::v1::DeleteSchemaRequest const& request) {
auto status = auth_->ConfigureContext(context);
if (!status.ok()) return status;
return child_->DeleteSchema(context, request);
}

StatusOr<google::pubsub::v1::ValidateSchemaResponse> SchemaAuth::ValidateSchema(
StatusOr<google::pubsub::v1::ValidateSchemaResponse>
SchemaServiceAuth::ValidateSchema(
grpc::ClientContext& context,
google::pubsub::v1::ValidateSchemaRequest const& request) {
auto status = auth_->ConfigureContext(context);
Expand All @@ -61,7 +63,7 @@ StatusOr<google::pubsub::v1::ValidateSchemaResponse> SchemaAuth::ValidateSchema(
}

StatusOr<google::pubsub::v1::ValidateMessageResponse>
SchemaAuth::ValidateMessage(
SchemaServiceAuth::ValidateMessage(
grpc::ClientContext& context,
google::pubsub::v1::ValidateMessageRequest const& request) {
auto status = auth_->ConfigureContext(context);
Expand Down
10 changes: 5 additions & 5 deletions google/cloud/pubsub/internal/schema_auth_decorator.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ namespace pubsub_internal {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN

/**
* A Decorator for `SchemaStub` that logs each request and response.
* A Decorator for `SchemaServiceStub` that logs each request and response.
*/
class SchemaAuth : public SchemaStub {
class SchemaServiceAuth : public SchemaServiceStub {
public:
SchemaAuth(
SchemaServiceAuth(
std::shared_ptr<google::cloud::internal::GrpcAuthenticationStrategy> auth,
std::shared_ptr<SchemaStub> child)
std::shared_ptr<SchemaServiceStub> child)
: auth_(std::move(auth)), child_(std::move(child)) {}

StatusOr<google::pubsub::v1::Schema> CreateSchema(
Expand All @@ -56,7 +56,7 @@ class SchemaAuth : public SchemaStub {

private:
std::shared_ptr<google::cloud::internal::GrpcAuthenticationStrategy> auth_;
std::shared_ptr<SchemaStub> child_;
std::shared_ptr<SchemaServiceStub> child_;
};

GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
Expand Down
12 changes: 6 additions & 6 deletions google/cloud/pubsub/internal/schema_auth_test.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ TEST(SchemaAuthTest, CreateSchema) {
auto mock = std::make_shared<pubsub_testing::MockSchemaStub>();
EXPECT_CALL(*mock, CreateSchema)
.WillOnce(Return(Status(StatusCode::kPermissionDenied, "uh-oh")));
auto under_test = SchemaAuth(MakeTypicalMockAuth(), mock);
auto under_test = SchemaServiceAuth(MakeTypicalMockAuth(), mock);
grpc::ClientContext ctx;
google::pubsub::v1::CreateSchemaRequest request;
auto auth_failure = under_test.CreateSchema(ctx, request);
Expand All @@ -51,7 +51,7 @@ TEST(SchemaAuthTest, GetSchema) {
auto mock = std::make_shared<pubsub_testing::MockSchemaStub>();
EXPECT_CALL(*mock, GetSchema)
.WillOnce(Return(Status(StatusCode::kPermissionDenied, "uh-oh")));
auto under_test = SchemaAuth(MakeTypicalMockAuth(), mock);
auto under_test = SchemaServiceAuth(MakeTypicalMockAuth(), mock);
grpc::ClientContext ctx;
google::pubsub::v1::GetSchemaRequest request;
auto auth_failure = under_test.GetSchema(ctx, request);
Expand All @@ -67,7 +67,7 @@ TEST(SchemaAuthTest, ListSchemas) {
auto mock = std::make_shared<pubsub_testing::MockSchemaStub>();
EXPECT_CALL(*mock, ListSchemas)
.WillOnce(Return(Status(StatusCode::kPermissionDenied, "uh-oh")));
auto under_test = SchemaAuth(MakeTypicalMockAuth(), mock);
auto under_test = SchemaServiceAuth(MakeTypicalMockAuth(), mock);
grpc::ClientContext ctx;
google::pubsub::v1::ListSchemasRequest request;
auto auth_failure = under_test.ListSchemas(ctx, request);
Expand All @@ -83,7 +83,7 @@ TEST(SchemaAuthTest, DeleteSchema) {
auto mock = std::make_shared<pubsub_testing::MockSchemaStub>();
EXPECT_CALL(*mock, DeleteSchema)
.WillOnce(Return(Status(StatusCode::kPermissionDenied, "uh-oh")));
auto under_test = SchemaAuth(MakeTypicalMockAuth(), mock);
auto under_test = SchemaServiceAuth(MakeTypicalMockAuth(), mock);
grpc::ClientContext ctx;
google::pubsub::v1::DeleteSchemaRequest request;
auto auth_failure = under_test.DeleteSchema(ctx, request);
Expand All @@ -99,7 +99,7 @@ TEST(SchemaAuthTest, ValidateSchema) {
auto mock = std::make_shared<pubsub_testing::MockSchemaStub>();
EXPECT_CALL(*mock, ValidateSchema)
.WillOnce(Return(Status(StatusCode::kPermissionDenied, "uh-oh")));
auto under_test = SchemaAuth(MakeTypicalMockAuth(), mock);
auto under_test = SchemaServiceAuth(MakeTypicalMockAuth(), mock);
grpc::ClientContext ctx;
google::pubsub::v1::ValidateSchemaRequest request;
auto auth_failure = under_test.ValidateSchema(ctx, request);
Expand All @@ -115,7 +115,7 @@ TEST(SchemaAuthTest, ValidateMessage) {
auto mock = std::make_shared<pubsub_testing::MockSchemaStub>();
EXPECT_CALL(*mock, ValidateMessage)
.WillOnce(Return(Status(StatusCode::kPermissionDenied, "uh-oh")));
auto under_test = SchemaAuth(MakeTypicalMockAuth(), mock);
auto under_test = SchemaServiceAuth(MakeTypicalMockAuth(), mock);
grpc::ClientContext ctx;
google::pubsub::v1::ValidateMessageRequest request;
auto auth_failure = under_test.ValidateMessage(ctx, request);
Expand Down
13 changes: 7 additions & 6 deletions google/cloud/pubsub/internal/schema_logging_decorator.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN

using ::google::cloud::internal::LogWrapper;

StatusOr<google::pubsub::v1::Schema> SchemaLogging::CreateSchema(
StatusOr<google::pubsub::v1::Schema> SchemaServiceLogging::CreateSchema(
grpc::ClientContext& context,
google::pubsub::v1::CreateSchemaRequest const& request) {
return LogWrapper(
Expand All @@ -33,7 +33,7 @@ StatusOr<google::pubsub::v1::Schema> SchemaLogging::CreateSchema(
context, request, __func__, tracing_options_);
}

StatusOr<google::pubsub::v1::Schema> SchemaLogging::GetSchema(
StatusOr<google::pubsub::v1::Schema> SchemaServiceLogging::GetSchema(
grpc::ClientContext& context,
google::pubsub::v1::GetSchemaRequest const& request) {
return LogWrapper(
Expand All @@ -44,7 +44,8 @@ StatusOr<google::pubsub::v1::Schema> SchemaLogging::GetSchema(
context, request, __func__, tracing_options_);
}

StatusOr<google::pubsub::v1::ListSchemasResponse> SchemaLogging::ListSchemas(
StatusOr<google::pubsub::v1::ListSchemasResponse>
SchemaServiceLogging::ListSchemas(
grpc::ClientContext& context,
google::pubsub::v1::ListSchemasRequest const& request) {
return LogWrapper(
Expand All @@ -55,7 +56,7 @@ StatusOr<google::pubsub::v1::ListSchemasResponse> SchemaLogging::ListSchemas(
context, request, __func__, tracing_options_);
}

Status SchemaLogging::DeleteSchema(
Status SchemaServiceLogging::DeleteSchema(
grpc::ClientContext& context,
google::pubsub::v1::DeleteSchemaRequest const& request) {
return LogWrapper(
Expand All @@ -67,7 +68,7 @@ Status SchemaLogging::DeleteSchema(
}

StatusOr<google::pubsub::v1::ValidateSchemaResponse>
SchemaLogging::ValidateSchema(
SchemaServiceLogging::ValidateSchema(
grpc::ClientContext& context,
google::pubsub::v1::ValidateSchemaRequest const& request) {
return LogWrapper(
Expand All @@ -79,7 +80,7 @@ SchemaLogging::ValidateSchema(
}

StatusOr<google::pubsub::v1::ValidateMessageResponse>
SchemaLogging::ValidateMessage(
SchemaServiceLogging::ValidateMessage(
grpc::ClientContext& context,
google::pubsub::v1::ValidateMessageRequest const& request) {
return LogWrapper(
Expand Down
10 changes: 5 additions & 5 deletions google/cloud/pubsub/internal/schema_logging_decorator.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ namespace pubsub_internal {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN

/**
* A Decorator for `SchemaStub` that logs each request and response.
* A Decorator for `SchemaServiceStub` that logs each request and response.
*/
class SchemaLogging : public SchemaStub {
class SchemaServiceLogging : public SchemaServiceStub {
public:
SchemaLogging(std::shared_ptr<SchemaStub> child,
TracingOptions tracing_options)
SchemaServiceLogging(std::shared_ptr<SchemaServiceStub> child,
TracingOptions tracing_options)
: child_(std::move(child)),
tracing_options_(std::move(tracing_options)) {}

Expand All @@ -55,7 +55,7 @@ class SchemaLogging : public SchemaStub {
google::pubsub::v1::ValidateMessageRequest const& request) override;

private:
std::shared_ptr<SchemaStub> child_;
std::shared_ptr<SchemaServiceStub> child_;
TracingOptions tracing_options_;
};

Expand Down
18 changes: 12 additions & 6 deletions google/cloud/pubsub/internal/schema_logging_test.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ TEST_F(SchemaLoggingTest, CreateSchema) {
auto mock = std::make_shared<pubsub_testing::MockSchemaStub>();
EXPECT_CALL(*mock, CreateSchema)
.WillOnce(Return(make_status_or(google::pubsub::v1::Schema{})));
SchemaLogging stub(mock, TracingOptions{}.SetOptions("single_line_mode"));
SchemaServiceLogging stub(mock,
TracingOptions{}.SetOptions("single_line_mode"));
grpc::ClientContext context;
google::pubsub::v1::CreateSchemaRequest request;
auto status = stub.CreateSchema(context, request);
Expand All @@ -54,7 +55,8 @@ TEST_F(SchemaLoggingTest, GetSchema) {
auto mock = std::make_shared<pubsub_testing::MockSchemaStub>();
EXPECT_CALL(*mock, GetSchema)
.WillOnce(Return(make_status_or(google::pubsub::v1::Schema{})));
SchemaLogging stub(mock, TracingOptions{}.SetOptions("single_line_mode"));
SchemaServiceLogging stub(mock,
TracingOptions{}.SetOptions("single_line_mode"));
grpc::ClientContext context;
google::pubsub::v1::GetSchemaRequest request;
auto status = stub.GetSchema(context, request);
Expand All @@ -67,7 +69,8 @@ TEST_F(SchemaLoggingTest, ListSchemas) {
EXPECT_CALL(*mock, ListSchemas)
.WillOnce(
Return(make_status_or(google::pubsub::v1::ListSchemasResponse{})));
SchemaLogging stub(mock, TracingOptions{}.SetOptions("single_line_mode"));
SchemaServiceLogging stub(mock,
TracingOptions{}.SetOptions("single_line_mode"));
grpc::ClientContext context;
google::pubsub::v1::ListSchemasRequest request;
auto status = stub.ListSchemas(context, request);
Expand All @@ -78,7 +81,8 @@ TEST_F(SchemaLoggingTest, ListSchemas) {
TEST_F(SchemaLoggingTest, DeleteSchema) {
auto mock = std::make_shared<pubsub_testing::MockSchemaStub>();
EXPECT_CALL(*mock, DeleteSchema).WillOnce(Return(Status{}));
SchemaLogging stub(mock, TracingOptions{}.SetOptions("single_line_mode"));
SchemaServiceLogging stub(mock,
TracingOptions{}.SetOptions("single_line_mode"));
grpc::ClientContext context;
google::pubsub::v1::DeleteSchemaRequest request;
auto status = stub.DeleteSchema(context, request);
Expand All @@ -91,7 +95,8 @@ TEST_F(SchemaLoggingTest, ValidateSchema) {
EXPECT_CALL(*mock, ValidateSchema)
.WillOnce(
Return(make_status_or(google::pubsub::v1::ValidateSchemaResponse{})));
SchemaLogging stub(mock, TracingOptions{}.SetOptions("single_line_mode"));
SchemaServiceLogging stub(mock,
TracingOptions{}.SetOptions("single_line_mode"));
grpc::ClientContext context;
google::pubsub::v1::ValidateSchemaRequest request;
auto status = stub.ValidateSchema(context, request);
Expand All @@ -104,7 +109,8 @@ TEST_F(SchemaLoggingTest, ValidateMessage) {
EXPECT_CALL(*mock, ValidateMessage)
.WillOnce(Return(
make_status_or(google::pubsub::v1::ValidateMessageResponse{})));
SchemaLogging stub(mock, TracingOptions{}.SetOptions("single_line_mode"));
SchemaServiceLogging stub(mock,
TracingOptions{}.SetOptions("single_line_mode"));
grpc::ClientContext context;
google::pubsub::v1::ValidateMessageRequest request;
auto status = stub.ValidateMessage(context, request);
Expand Down
20 changes: 11 additions & 9 deletions google/cloud/pubsub/internal/schema_metadata_decorator.cc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,56 +20,58 @@ namespace cloud {
namespace pubsub_internal {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN

SchemaMetadata::SchemaMetadata(std::shared_ptr<SchemaStub> child)
SchemaServiceMetadata::SchemaServiceMetadata(
std::shared_ptr<SchemaServiceStub> child)
: child_(std::move(child)),
x_goog_api_client_(google::cloud::internal::ApiClientHeader()) {}

StatusOr<google::pubsub::v1::Schema> SchemaMetadata::CreateSchema(
StatusOr<google::pubsub::v1::Schema> SchemaServiceMetadata::CreateSchema(
grpc::ClientContext& context,
google::pubsub::v1::CreateSchemaRequest const& request) {
SetMetadata(context, "parent=" + request.parent());
return child_->CreateSchema(context, request);
}

StatusOr<google::pubsub::v1::Schema> SchemaMetadata::GetSchema(
StatusOr<google::pubsub::v1::Schema> SchemaServiceMetadata::GetSchema(
grpc::ClientContext& context,
google::pubsub::v1::GetSchemaRequest const& request) {
SetMetadata(context, "name=" + request.name());
return child_->GetSchema(context, request);
}

StatusOr<google::pubsub::v1::ListSchemasResponse> SchemaMetadata::ListSchemas(
StatusOr<google::pubsub::v1::ListSchemasResponse>
SchemaServiceMetadata::ListSchemas(
grpc::ClientContext& context,
google::pubsub::v1::ListSchemasRequest const& request) {
SetMetadata(context, "parent=" + request.parent());
return child_->ListSchemas(context, request);
}

Status SchemaMetadata::DeleteSchema(
Status SchemaServiceMetadata::DeleteSchema(
grpc::ClientContext& context,
google::pubsub::v1::DeleteSchemaRequest const& request) {
SetMetadata(context, "name=" + request.name());
return child_->DeleteSchema(context, request);
}

StatusOr<google::pubsub::v1::ValidateSchemaResponse>
SchemaMetadata::ValidateSchema(
SchemaServiceMetadata::ValidateSchema(
grpc::ClientContext& context,
google::pubsub::v1::ValidateSchemaRequest const& request) {
SetMetadata(context, "parent=" + request.parent());
return child_->ValidateSchema(context, request);
}

StatusOr<google::pubsub::v1::ValidateMessageResponse>
SchemaMetadata::ValidateMessage(
SchemaServiceMetadata::ValidateMessage(
grpc::ClientContext& context,
google::pubsub::v1::ValidateMessageRequest const& request) {
SetMetadata(context, "parent=" + request.parent());
return child_->ValidateMessage(context, request);
}

void SchemaMetadata::SetMetadata(grpc::ClientContext& context,
std::string const& request_params) {
void SchemaServiceMetadata::SetMetadata(grpc::ClientContext& context,
std::string const& request_params) {
context.AddMetadata("x-goog-request-params", request_params);
context.AddMetadata("x-goog-api-client", x_goog_api_client_);
auto const& options = internal::CurrentOptions();
Expand Down
8 changes: 4 additions & 4 deletions google/cloud/pubsub/internal/schema_metadata_decorator.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ namespace pubsub_internal {
GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN

/**
* A Decorator for `SchemaStub` that logs each request and response.
* A Decorator for `SchemaServiceStub` that logs each request and response.
*/
class SchemaMetadata : public SchemaStub {
class SchemaServiceMetadata : public SchemaServiceStub {
public:
explicit SchemaMetadata(std::shared_ptr<SchemaStub> child);
explicit SchemaServiceMetadata(std::shared_ptr<SchemaServiceStub> child);

StatusOr<google::pubsub::v1::Schema> CreateSchema(
grpc::ClientContext& context,
Expand All @@ -55,7 +55,7 @@ class SchemaMetadata : public SchemaStub {
void SetMetadata(grpc::ClientContext& context,
std::string const& request_params);

std::shared_ptr<SchemaStub> child_;
std::shared_ptr<SchemaServiceStub> child_;
std::string x_goog_api_client_;
};

Expand Down
Loading

0 comments on commit 9eee84e

Please sign in to comment.