Skip to content

Commit 03d3e63

Browse files
coryancoryan
authored
cleanup: explicit options in SetMetadata() (#13073)
Change the generated `SetMetadata()` helpers to receive the `google::cloud::Options const&` parameter explicitly. I am planning to generate `*Stub` functions to use explicit options. I am also planning to convert one function type (async, longrunning, streaming) at a time.
1 parent 36d368d commit 03d3e63

589 files changed

Lines changed: 6094 additions & 5271 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎generator/integration_tests/golden/v1/internal/golden_kitchen_sink_metadata_decorator.cc‎

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -48,63 +48,63 @@ StatusOr<google::test::admin::database::v1::GenerateAccessTokenResponse>
4848
GoldenKitchenSinkMetadata::GenerateAccessToken(
4949
grpc::ClientContext& context,
5050
google::test::admin::database::v1::GenerateAccessTokenRequest const& request) {
51-
SetMetadata(context, absl::StrCat("name=", internal::UrlEncode(request.name())));
51+
SetMetadata(context, internal::CurrentOptions(), absl::StrCat("name=", internal::UrlEncode(request.name())));
5252
return child_->GenerateAccessToken(context, request);
5353
}
5454

5555
StatusOr<google::test::admin::database::v1::GenerateIdTokenResponse>
5656
GoldenKitchenSinkMetadata::GenerateIdToken(
5757
grpc::ClientContext& context,
5858
google::test::admin::database::v1::GenerateIdTokenRequest const& request) {
59-
SetMetadata(context);
59+
SetMetadata(context, internal::CurrentOptions());
6060
return child_->GenerateIdToken(context, request);
6161
}
6262

6363
StatusOr<google::test::admin::database::v1::WriteLogEntriesResponse>
6464
GoldenKitchenSinkMetadata::WriteLogEntries(
6565
grpc::ClientContext& context,
6666
google::test::admin::database::v1::WriteLogEntriesRequest const& request) {
67-
SetMetadata(context);
67+
SetMetadata(context, internal::CurrentOptions());
6868
return child_->WriteLogEntries(context, request);
6969
}
7070

7171
StatusOr<google::test::admin::database::v1::ListLogsResponse>
7272
GoldenKitchenSinkMetadata::ListLogs(
7373
grpc::ClientContext& context,
7474
google::test::admin::database::v1::ListLogsRequest const& request) {
75-
SetMetadata(context, absl::StrCat("parent=", internal::UrlEncode(request.parent())));
75+
SetMetadata(context, internal::CurrentOptions(), absl::StrCat("parent=", internal::UrlEncode(request.parent())));
7676
return child_->ListLogs(context, request);
7777
}
7878

7979
StatusOr<google::test::admin::database::v1::ListServiceAccountKeysResponse>
8080
GoldenKitchenSinkMetadata::ListServiceAccountKeys(
8181
grpc::ClientContext& context,
8282
google::test::admin::database::v1::ListServiceAccountKeysRequest const& request) {
83-
SetMetadata(context, absl::StrCat("name=", internal::UrlEncode(request.name())));
83+
SetMetadata(context, internal::CurrentOptions(), absl::StrCat("name=", internal::UrlEncode(request.name())));
8484
return child_->ListServiceAccountKeys(context, request);
8585
}
8686

8787
Status
8888
GoldenKitchenSinkMetadata::DoNothing(
8989
grpc::ClientContext& context,
9090
google::protobuf::Empty const& request) {
91-
SetMetadata(context);
91+
SetMetadata(context, internal::CurrentOptions());
9292
return child_->DoNothing(context, request);
9393
}
9494

9595
Status
9696
GoldenKitchenSinkMetadata::Deprecated2(
9797
grpc::ClientContext& context,
9898
google::test::admin::database::v1::GenerateAccessTokenRequest const& request) {
99-
SetMetadata(context);
99+
SetMetadata(context, internal::CurrentOptions());
100100
return child_->Deprecated2(context, request);
101101
}
102102

103103
std::unique_ptr<google::cloud::internal::StreamingReadRpc<google::test::admin::database::v1::Response>>
104104
GoldenKitchenSinkMetadata::StreamingRead(
105105
std::shared_ptr<grpc::ClientContext> context,
106106
google::test::admin::database::v1::Request const& request) {
107-
SetMetadata(*context);
107+
SetMetadata(*context, internal::CurrentOptions());
108108
return child_->StreamingRead(std::move(context), request);
109109
}
110110

@@ -113,7 +113,7 @@ std::unique_ptr<::google::cloud::internal::StreamingWriteRpc<
113113
google::test::admin::database::v1::Response>>
114114
GoldenKitchenSinkMetadata::StreamingWrite(
115115
std::shared_ptr<grpc::ClientContext> context) {
116-
SetMetadata(*context);
116+
SetMetadata(*context, internal::CurrentOptions());
117117
return child_->StreamingWrite(std::move(context));
118118
}
119119

@@ -123,7 +123,7 @@ std::unique_ptr<::google::cloud::AsyncStreamingReadWriteRpc<
123123
GoldenKitchenSinkMetadata::AsyncStreamingReadWrite(
124124
google::cloud::CompletionQueue const& cq,
125125
std::shared_ptr<grpc::ClientContext> context) {
126-
SetMetadata(*context);
126+
SetMetadata(*context, internal::CurrentOptions());
127127
return child_->AsyncStreamingReadWrite(cq, std::move(context));
128128
}
129129

@@ -169,9 +169,9 @@ GoldenKitchenSinkMetadata::ExplicitRouting1(
169169
routing_id_matcher->AppendParam(request, params);
170170

171171
if (params.empty()) {
172-
SetMetadata(context);
172+
SetMetadata(context, internal::CurrentOptions());
173173
} else {
174-
SetMetadata(context, absl::StrJoin(params, "&"));
174+
SetMetadata(context, internal::CurrentOptions(), absl::StrJoin(params, "&"));
175175
}
176176
return child_->ExplicitRouting1(context, request);
177177
}
@@ -196,9 +196,9 @@ GoldenKitchenSinkMetadata::ExplicitRouting2(
196196
}
197197

198198
if (params.empty()) {
199-
SetMetadata(context);
199+
SetMetadata(context, internal::CurrentOptions());
200200
} else {
201-
SetMetadata(context, absl::StrJoin(params, "&"));
201+
SetMetadata(context, internal::CurrentOptions(), absl::StrJoin(params, "&"));
202202
}
203203
return child_->ExplicitRouting2(context, request);
204204
}
@@ -209,7 +209,7 @@ GoldenKitchenSinkMetadata::AsyncStreamingRead(
209209
google::cloud::CompletionQueue const& cq,
210210
std::shared_ptr<grpc::ClientContext> context,
211211
google::test::admin::database::v1::Request const& request) {
212-
SetMetadata(*context);
212+
SetMetadata(*context, internal::CurrentOptions());
213213
return child_->AsyncStreamingRead(cq, std::move(context), request);
214214
}
215215

@@ -218,22 +218,23 @@ std::unique_ptr<::google::cloud::internal::AsyncStreamingWriteRpc<
218218
GoldenKitchenSinkMetadata::AsyncStreamingWrite(
219219
google::cloud::CompletionQueue const& cq,
220220
std::shared_ptr<grpc::ClientContext> context) {
221-
SetMetadata(*context);
221+
SetMetadata(*context, internal::CurrentOptions());
222222
return child_->AsyncStreamingWrite(cq, std::move(context));
223223
}
224224

225225
void GoldenKitchenSinkMetadata::SetMetadata(grpc::ClientContext& context,
226+
Options const& options,
226227
std::string const& request_params) {
227228
context.AddMetadata("x-goog-request-params", request_params);
228-
SetMetadata(context);
229+
SetMetadata(context, options);
229230
}
230231

231-
void GoldenKitchenSinkMetadata::SetMetadata(grpc::ClientContext& context) {
232+
void GoldenKitchenSinkMetadata::SetMetadata(grpc::ClientContext& context,
233+
Options const& options) {
232234
for (auto const& kv : fixed_metadata_) {
233235
context.AddMetadata(kv.first, kv.second);
234236
}
235237
context.AddMetadata("x-goog-api-client", api_client_header_);
236-
auto const& options = internal::CurrentOptions();
237238
if (options.has<UserProjectOption>()) {
238239
context.AddMetadata(
239240
"x-goog-user-project", options.get<UserProjectOption>());

‎generator/integration_tests/golden/v1/internal/golden_kitchen_sink_metadata_decorator.h‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
#define GOOGLE_CLOUD_CPP_GENERATOR_INTEGRATION_TESTS_GOLDEN_V1_INTERNAL_GOLDEN_KITCHEN_SINK_METADATA_DECORATOR_H
2121

2222
#include "generator/integration_tests/golden/v1/internal/golden_kitchen_sink_stub.h"
23+
#include "google/cloud/options.h"
2324
#include "google/cloud/version.h"
2425
#include <map>
2526
#include <memory>
@@ -106,8 +107,9 @@ class GoldenKitchenSinkMetadata : public GoldenKitchenSinkStub {
106107

107108
private:
108109
void SetMetadata(grpc::ClientContext& context,
110+
Options const& options,
109111
std::string const& request_params);
110-
void SetMetadata(grpc::ClientContext& context);
112+
void SetMetadata(grpc::ClientContext& context, Options const& options);
111113

112114
std::shared_ptr<GoldenKitchenSinkStub> child_;
113115
std::multimap<std::string, std::string> fixed_metadata_;

‎generator/integration_tests/golden/v1/internal/golden_thing_admin_metadata_decorator.cc‎

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ StatusOr<google::test::admin::database::v1::ListDatabasesResponse>
4848
GoldenThingAdminMetadata::ListDatabases(
4949
grpc::ClientContext& context,
5050
google::test::admin::database::v1::ListDatabasesRequest const& request) {
51-
SetMetadata(context, absl::StrCat("parent=", internal::UrlEncode(request.parent())));
51+
SetMetadata(context, internal::CurrentOptions(), absl::StrCat("parent=", internal::UrlEncode(request.parent())));
5252
return child_->ListDatabases(context, request);
5353
}
5454

@@ -57,15 +57,15 @@ GoldenThingAdminMetadata::AsyncCreateDatabase(
5757
google::cloud::CompletionQueue& cq,
5858
std::shared_ptr<grpc::ClientContext> context,
5959
google::test::admin::database::v1::CreateDatabaseRequest const& request) {
60-
SetMetadata(*context, absl::StrCat("parent=", internal::UrlEncode(request.parent())));
60+
SetMetadata(*context, internal::CurrentOptions(), absl::StrCat("parent=", internal::UrlEncode(request.parent())));
6161
return child_->AsyncCreateDatabase(cq, std::move(context), request);
6262
}
6363

6464
StatusOr<google::test::admin::database::v1::Database>
6565
GoldenThingAdminMetadata::GetDatabase(
6666
grpc::ClientContext& context,
6767
google::test::admin::database::v1::GetDatabaseRequest const& request) {
68-
SetMetadata(context, absl::StrCat("name=", internal::UrlEncode(request.name())));
68+
SetMetadata(context, internal::CurrentOptions(), absl::StrCat("name=", internal::UrlEncode(request.name())));
6969
return child_->GetDatabase(context, request);
7070
}
7171

@@ -74,7 +74,7 @@ GoldenThingAdminMetadata::AsyncUpdateDatabaseDdl(
7474
google::cloud::CompletionQueue& cq,
7575
std::shared_ptr<grpc::ClientContext> context,
7676
google::test::admin::database::v1::UpdateDatabaseDdlRequest const& request) {
77-
SetMetadata(*context, absl::StrCat("database=", internal::UrlEncode(request.database())));
77+
SetMetadata(*context, internal::CurrentOptions(), absl::StrCat("database=", internal::UrlEncode(request.database())));
7878
return child_->AsyncUpdateDatabaseDdl(cq, std::move(context), request);
7979
}
8080

@@ -119,9 +119,9 @@ GoldenThingAdminMetadata::DropDatabase(
119119
database_matcher->AppendParam(request, params);
120120

121121
if (params.empty()) {
122-
SetMetadata(context);
122+
SetMetadata(context, internal::CurrentOptions());
123123
} else {
124-
SetMetadata(context, absl::StrJoin(params, "&"));
124+
SetMetadata(context, internal::CurrentOptions(), absl::StrJoin(params, "&"));
125125
}
126126
return child_->DropDatabase(context, request);
127127
}
@@ -130,31 +130,31 @@ StatusOr<google::test::admin::database::v1::GetDatabaseDdlResponse>
130130
GoldenThingAdminMetadata::GetDatabaseDdl(
131131
grpc::ClientContext& context,
132132
google::test::admin::database::v1::GetDatabaseDdlRequest const& request) {
133-
SetMetadata(context, absl::StrCat("database=", internal::UrlEncode(request.database())));
133+
SetMetadata(context, internal::CurrentOptions(), absl::StrCat("database=", internal::UrlEncode(request.database())));
134134
return child_->GetDatabaseDdl(context, request);
135135
}
136136

137137
StatusOr<google::iam::v1::Policy>
138138
GoldenThingAdminMetadata::SetIamPolicy(
139139
grpc::ClientContext& context,
140140
google::iam::v1::SetIamPolicyRequest const& request) {
141-
SetMetadata(context, absl::StrCat("resource=", internal::UrlEncode(request.resource())));
141+
SetMetadata(context, internal::CurrentOptions(), absl::StrCat("resource=", internal::UrlEncode(request.resource())));
142142
return child_->SetIamPolicy(context, request);
143143
}
144144

145145
StatusOr<google::iam::v1::Policy>
146146
GoldenThingAdminMetadata::GetIamPolicy(
147147
grpc::ClientContext& context,
148148
google::iam::v1::GetIamPolicyRequest const& request) {
149-
SetMetadata(context, absl::StrCat("resource=", internal::UrlEncode(request.resource())));
149+
SetMetadata(context, internal::CurrentOptions(), absl::StrCat("resource=", internal::UrlEncode(request.resource())));
150150
return child_->GetIamPolicy(context, request);
151151
}
152152

153153
StatusOr<google::iam::v1::TestIamPermissionsResponse>
154154
GoldenThingAdminMetadata::TestIamPermissions(
155155
grpc::ClientContext& context,
156156
google::iam::v1::TestIamPermissionsRequest const& request) {
157-
SetMetadata(context, absl::StrCat("resource=", internal::UrlEncode(request.resource())));
157+
SetMetadata(context, internal::CurrentOptions(), absl::StrCat("resource=", internal::UrlEncode(request.resource())));
158158
return child_->TestIamPermissions(context, request);
159159
}
160160

@@ -163,39 +163,39 @@ GoldenThingAdminMetadata::AsyncCreateBackup(
163163
google::cloud::CompletionQueue& cq,
164164
std::shared_ptr<grpc::ClientContext> context,
165165
google::test::admin::database::v1::CreateBackupRequest const& request) {
166-
SetMetadata(*context, absl::StrCat("parent=", internal::UrlEncode(request.parent())));
166+
SetMetadata(*context, internal::CurrentOptions(), absl::StrCat("parent=", internal::UrlEncode(request.parent())));
167167
return child_->AsyncCreateBackup(cq, std::move(context), request);
168168
}
169169

170170
StatusOr<google::test::admin::database::v1::Backup>
171171
GoldenThingAdminMetadata::GetBackup(
172172
grpc::ClientContext& context,
173173
google::test::admin::database::v1::GetBackupRequest const& request) {
174-
SetMetadata(context, absl::StrCat("name=", internal::UrlEncode(request.name())));
174+
SetMetadata(context, internal::CurrentOptions(), absl::StrCat("name=", internal::UrlEncode(request.name())));
175175
return child_->GetBackup(context, request);
176176
}
177177

178178
StatusOr<google::test::admin::database::v1::Backup>
179179
GoldenThingAdminMetadata::UpdateBackup(
180180
grpc::ClientContext& context,
181181
google::test::admin::database::v1::UpdateBackupRequest const& request) {
182-
SetMetadata(context, absl::StrCat("backup.name=", internal::UrlEncode(request.backup().name())));
182+
SetMetadata(context, internal::CurrentOptions(), absl::StrCat("backup.name=", internal::UrlEncode(request.backup().name())));
183183
return child_->UpdateBackup(context, request);
184184
}
185185

186186
Status
187187
GoldenThingAdminMetadata::DeleteBackup(
188188
grpc::ClientContext& context,
189189
google::test::admin::database::v1::DeleteBackupRequest const& request) {
190-
SetMetadata(context, absl::StrCat("name=", internal::UrlEncode(request.name())));
190+
SetMetadata(context, internal::CurrentOptions(), absl::StrCat("name=", internal::UrlEncode(request.name())));
191191
return child_->DeleteBackup(context, request);
192192
}
193193

194194
StatusOr<google::test::admin::database::v1::ListBackupsResponse>
195195
GoldenThingAdminMetadata::ListBackups(
196196
grpc::ClientContext& context,
197197
google::test::admin::database::v1::ListBackupsRequest const& request) {
198-
SetMetadata(context, absl::StrCat("parent=", internal::UrlEncode(request.parent())));
198+
SetMetadata(context, internal::CurrentOptions(), absl::StrCat("parent=", internal::UrlEncode(request.parent())));
199199
return child_->ListBackups(context, request);
200200
}
201201

@@ -204,23 +204,23 @@ GoldenThingAdminMetadata::AsyncRestoreDatabase(
204204
google::cloud::CompletionQueue& cq,
205205
std::shared_ptr<grpc::ClientContext> context,
206206
google::test::admin::database::v1::RestoreDatabaseRequest const& request) {
207-
SetMetadata(*context, absl::StrCat("parent=", internal::UrlEncode(request.parent())));
207+
SetMetadata(*context, internal::CurrentOptions(), absl::StrCat("parent=", internal::UrlEncode(request.parent())));
208208
return child_->AsyncRestoreDatabase(cq, std::move(context), request);
209209
}
210210

211211
StatusOr<google::test::admin::database::v1::ListDatabaseOperationsResponse>
212212
GoldenThingAdminMetadata::ListDatabaseOperations(
213213
grpc::ClientContext& context,
214214
google::test::admin::database::v1::ListDatabaseOperationsRequest const& request) {
215-
SetMetadata(context, absl::StrCat("parent=", internal::UrlEncode(request.parent())));
215+
SetMetadata(context, internal::CurrentOptions(), absl::StrCat("parent=", internal::UrlEncode(request.parent())));
216216
return child_->ListDatabaseOperations(context, request);
217217
}
218218

219219
StatusOr<google::test::admin::database::v1::ListBackupOperationsResponse>
220220
GoldenThingAdminMetadata::ListBackupOperations(
221221
grpc::ClientContext& context,
222222
google::test::admin::database::v1::ListBackupOperationsRequest const& request) {
223-
SetMetadata(context, absl::StrCat("parent=", internal::UrlEncode(request.parent())));
223+
SetMetadata(context, internal::CurrentOptions(), absl::StrCat("parent=", internal::UrlEncode(request.parent())));
224224
return child_->ListBackupOperations(context, request);
225225
}
226226

@@ -229,7 +229,7 @@ GoldenThingAdminMetadata::AsyncLongRunningWithoutRouting(
229229
google::cloud::CompletionQueue& cq,
230230
std::shared_ptr<grpc::ClientContext> context,
231231
google::test::admin::database::v1::RestoreDatabaseRequest const& request) {
232-
SetMetadata(*context);
232+
SetMetadata(*context, internal::CurrentOptions());
233233
return child_->AsyncLongRunningWithoutRouting(cq, std::move(context), request);
234234
}
235235

@@ -238,7 +238,7 @@ GoldenThingAdminMetadata::AsyncGetDatabase(
238238
google::cloud::CompletionQueue& cq,
239239
std::shared_ptr<grpc::ClientContext> context,
240240
google::test::admin::database::v1::GetDatabaseRequest const& request) {
241-
SetMetadata(*context, absl::StrCat("name=", internal::UrlEncode(request.name())));
241+
SetMetadata(*context, internal::CurrentOptions(), absl::StrCat("name=", internal::UrlEncode(request.name())));
242242
return child_->AsyncGetDatabase(cq, std::move(context), request);
243243
}
244244

@@ -284,9 +284,9 @@ GoldenThingAdminMetadata::AsyncDropDatabase(
284284
database_matcher->AppendParam(request, params);
285285

286286
if (params.empty()) {
287-
SetMetadata(*context);
287+
SetMetadata(*context, internal::CurrentOptions());
288288
} else {
289-
SetMetadata(*context, absl::StrJoin(params, "&"));
289+
SetMetadata(*context, internal::CurrentOptions(), absl::StrJoin(params, "&"));
290290
}
291291
return child_->AsyncDropDatabase(cq, std::move(context), request);
292292
}
@@ -296,30 +296,33 @@ GoldenThingAdminMetadata::AsyncGetOperation(
296296
google::cloud::CompletionQueue& cq,
297297
std::shared_ptr<grpc::ClientContext> context,
298298
google::longrunning::GetOperationRequest const& request) {
299-
SetMetadata(*context, absl::StrCat("name=", internal::UrlEncode(request.name())));
299+
SetMetadata(*context, internal::CurrentOptions(),
300+
absl::StrCat("name=", internal::UrlEncode(request.name())));
300301
return child_->AsyncGetOperation(cq, std::move(context), request);
301302
}
302303

303304
future<Status> GoldenThingAdminMetadata::AsyncCancelOperation(
304305
google::cloud::CompletionQueue& cq,
305306
std::shared_ptr<grpc::ClientContext> context,
306307
google::longrunning::CancelOperationRequest const& request) {
307-
SetMetadata(*context, absl::StrCat("name=", internal::UrlEncode(request.name())));
308+
SetMetadata(*context, internal::CurrentOptions(),
309+
absl::StrCat("name=", internal::UrlEncode(request.name())));
308310
return child_->AsyncCancelOperation(cq, std::move(context), request);
309311
}
310312

311313
void GoldenThingAdminMetadata::SetMetadata(grpc::ClientContext& context,
314+
Options const& options,
312315
std::string const& request_params) {
313316
context.AddMetadata("x-goog-request-params", request_params);
314-
SetMetadata(context);
317+
SetMetadata(context, options);
315318
}
316319

317-
void GoldenThingAdminMetadata::SetMetadata(grpc::ClientContext& context) {
320+
void GoldenThingAdminMetadata::SetMetadata(grpc::ClientContext& context,
321+
Options const& options) {
318322
for (auto const& kv : fixed_metadata_) {
319323
context.AddMetadata(kv.first, kv.second);
320324
}
321325
context.AddMetadata("x-goog-api-client", api_client_header_);
322-
auto const& options = internal::CurrentOptions();
323326
if (options.has<UserProjectOption>()) {
324327
context.AddMetadata(
325328
"x-goog-user-project", options.get<UserProjectOption>());

0 commit comments

Comments
 (0)