feat(generator): selectively generate async methods for certain RPCs (#7540)

Author: dbolduc

generator/generator_config.proto

@@ -23,6 +23,13 @@ message ServiceConfiguration {
   repeated string omitted_rpcs = 4;
   string service_endpoint_env_var = 5;
   string emulator_endpoint_env_var = 6;
+  // Generating Async APIs is typically unnecessary for RPCs that are
+  // non-streaming, non-paginated, and not longrunning operations. If we need
+  // to generate an Async API for such an RPC, we can list it here.
+  //
+  // Only the Async API will be generated for RPCs listed both here and in
+  // `omitted_rpcs`.
+  repeated string gen_async_rpcs = 7;
 }
 
 message GeneratorConfiguration {

generator/integration_tests/generator_integration_test.cc

@@ -103,6 +103,8 @@ class GeneratorIntegrationTest : public testing::TestWithParam<std::string> {
     omit_rpc2_ = "Omitted2";
     service_endpoint_env_var_ = "GOLDEN_KITCHEN_SINK_ENDPOINT";
     emulator_endpoint_env_var_ = "GOLDEN_KITCHEN_SINK_EMULATOR_HOST";
+    gen_async_rpc1_ = "GetDatabase";
+    gen_async_rpc2_ = "DropDatabase";
 
     std::vector<std::string> args;
     // empty arg keeps first real arg from being ignored.
@@ -121,6 +123,8 @@ class GeneratorIntegrationTest : public testing::TestWithParam<std::string> {
                       service_endpoint_env_var_);
     args.emplace_back("--cpp_codegen_opt=emulator_endpoint_env_var=" +
                       emulator_endpoint_env_var_);
+    args.emplace_back("--cpp_codegen_opt=gen_async_rpc=" + gen_async_rpc1_);
+    args.emplace_back("--cpp_codegen_opt=gen_async_rpc=" + gen_async_rpc2_);
     args.emplace_back("generator/integration_tests/test.proto");
 
     std::vector<char const*> c_args;
@@ -145,6 +149,8 @@ class GeneratorIntegrationTest : public testing::TestWithParam<std::string> {
   std::string omit_rpc2_;
   std::string service_endpoint_env_var_;
   std::string emulator_endpoint_env_var_;
+  std::string gen_async_rpc1_;
+  std::string gen_async_rpc2_;
 };
 
 TEST_P(GeneratorIntegrationTest, CompareGeneratedToGolden) {

generator/integration_tests/golden/golden_thing_admin_client.cc

@@ -180,6 +180,20 @@ GoldenThingAdminClient::ListBackupOperations(std::string const& parent) {
   return connection_->ListBackupOperations(request);
 }
 
+future<StatusOr<google::test::admin::database::v1::Database>>
+GoldenThingAdminClient::AsyncGetDatabase(std::string const& name) {
+  google::test::admin::database::v1::GetDatabaseRequest request;
+  request.set_name(name);
+  return connection_->AsyncGetDatabase(request);
+}
+
+future<Status>
+GoldenThingAdminClient::AsyncDropDatabase(std::string const& database) {
+  google::test::admin::database::v1::DropDatabaseRequest request;
+  request.set_database(database);
+  return connection_->AsyncDropDatabase(request);
+}
+
 StreamRange<google::test::admin::database::v1::Database>
 GoldenThingAdminClient::ListDatabases(google::test::admin::database::v1::ListDatabasesRequest request) {
   return connection_->ListDatabases(std::move(request));
@@ -265,6 +279,16 @@ GoldenThingAdminClient::ListBackupOperations(google::test::admin::database::v1::
   return connection_->ListBackupOperations(std::move(request));
 }
 
+future<StatusOr<google::test::admin::database::v1::Database>>
+GoldenThingAdminClient::AsyncGetDatabase(google::test::admin::database::v1::GetDatabaseRequest const& request) {
+  return connection_->AsyncGetDatabase(request);
+}
+
+future<Status>
+GoldenThingAdminClient::AsyncDropDatabase(google::test::admin::database::v1::DropDatabaseRequest const& request) {
+  return connection_->AsyncDropDatabase(request);
+}
+
 GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
 }  // namespace golden
 }  // namespace cloud

generator/integration_tests/golden/golden_thing_admin_client.h

@@ -378,6 +378,26 @@ class GoldenThingAdminClient {
   StreamRange<google::longrunning::Operation>
   ListBackupOperations(std::string const& parent);
 
+  /**
+   * Gets the state of a Cloud Test database.
+   *
+   * @param name  Required. The name of the requested database. Values are of the form
+   *  `projects/<project>/instances/<instance>/databases/<database>`.
+   * @return [google::test::admin::database::v1::Database](https://github.com/googleapis/googleapis/blob/59f97e6044a1275f83427ab7962a154c00d915b5/generator/integration_tests/test.proto#L329)
+   */
+  future<StatusOr<google::test::admin::database::v1::Database>>
+  AsyncGetDatabase(std::string const& name);
+
+  /**
+   * Drops (aka deletes) a Cloud Test database.
+   * Completed backups for the database will be retained according to their
+   * `expire_time`.
+   *
+   * @param database  Required. The database to be dropped.
+   */
+  future<Status>
+  AsyncDropDatabase(std::string const& database);
+
   /**
    * Lists Cloud Test databases.
    *
@@ -613,6 +633,25 @@ class GoldenThingAdminClient {
   StreamRange<google::longrunning::Operation>
   ListBackupOperations(google::test::admin::database::v1::ListBackupOperationsRequest request);
 
+  /**
+   * Gets the state of a Cloud Test database.
+   *
+   * @param request [google::test::admin::database::v1::GetDatabaseRequest](https://github.com/googleapis/googleapis/blob/59f97e6044a1275f83427ab7962a154c00d915b5/generator/integration_tests/test.proto#L443)
+   * @return [google::test::admin::database::v1::Database](https://github.com/googleapis/googleapis/blob/59f97e6044a1275f83427ab7962a154c00d915b5/generator/integration_tests/test.proto#L329)
+   */
+  future<StatusOr<google::test::admin::database::v1::Database>>
+  AsyncGetDatabase(google::test::admin::database::v1::GetDatabaseRequest const& request);
+
+  /**
+   * Drops (aka deletes) a Cloud Test database.
+   * Completed backups for the database will be retained according to their
+   * `expire_time`.
+   *
+   * @param request [google::test::admin::database::v1::DropDatabaseRequest](https://github.com/googleapis/googleapis/blob/59f97e6044a1275f83427ab7962a154c00d915b5/generator/integration_tests/test.proto#L523)
+   */
+  future<Status>
+  AsyncDropDatabase(google::test::admin::database::v1::DropDatabaseRequest const& request);
+
  private:
   std::shared_ptr<GoldenThingAdminConnection> connection_;
 };

generator/integration_tests/golden/golden_thing_admin_connection.cc

@@ -172,6 +172,21 @@ StreamRange<google::longrunning::Operation> GoldenThingAdminConnection::ListBack
     });
 }
 
+future<StatusOr<google::test::admin::database::v1::Database>>
+GoldenThingAdminConnection::AsyncGetDatabase(
+    google::test::admin::database::v1::GetDatabaseRequest const&) {
+  return google::cloud::make_ready_future<
+    StatusOr<google::test::admin::database::v1::Database>>(
+    Status(StatusCode::kUnimplemented, "not implemented"));
+}
+
+future<Status>
+GoldenThingAdminConnection::AsyncDropDatabase(
+    google::test::admin::database::v1::DropDatabaseRequest const&) {
+  return google::cloud::make_ready_future(
+      Status(StatusCode::kUnimplemented, "not implemented"));
+}
+
 namespace {
 class GoldenThingAdminConnectionImpl : public GoldenThingAdminConnection {
  public:
@@ -532,6 +547,38 @@ class GoldenThingAdminConnectionImpl : public GoldenThingAdminConnection {
         });
   }
 
+  future<StatusOr<google::test::admin::database::v1::Database>>
+  AsyncGetDatabase(
+      google::test::admin::database::v1::GetDatabaseRequest const& request) override {
+    auto& stub = stub_;
+    return google::cloud::internal::AsyncRetryLoop(
+        retry_policy_prototype_->clone(), backoff_policy_prototype_->clone(),
+        idempotency_policy_->GetDatabase(request),
+        background_->cq(),
+        [stub](CompletionQueue& cq,
+               std::unique_ptr<grpc::ClientContext> context,
+               google::test::admin::database::v1::GetDatabaseRequest const& request) {
+          return stub->AsyncGetDatabase(cq, std::move(context), request);
+        },
+        request, __func__);
+  }
+
+  future<Status>
+  AsyncDropDatabase(
+      google::test::admin::database::v1::DropDatabaseRequest const& request) override {
+    auto& stub = stub_;
+    return google::cloud::internal::AsyncRetryLoop(
+        retry_policy_prototype_->clone(), backoff_policy_prototype_->clone(),
+        idempotency_policy_->DropDatabase(request),
+        background_->cq(),
+        [stub](CompletionQueue& cq,
+               std::unique_ptr<grpc::ClientContext> context,
+               google::test::admin::database::v1::DropDatabaseRequest const& request) {
+          return stub->AsyncDropDatabase(cq, std::move(context), request);
+        },
+        request, __func__);
+  }
+
  private:
   std::unique_ptr<google::cloud::BackgroundThreads> background_;
   std::shared_ptr<golden_internal::GoldenThingAdminStub> stub_;

generator/integration_tests/golden/golden_thing_admin_connection.h

@@ -102,6 +102,12 @@ class GoldenThingAdminConnection {
   virtual StreamRange<google::longrunning::Operation>
   ListBackupOperations(google::test::admin::database::v1::ListBackupOperationsRequest request);
 
+  virtual future<StatusOr<google::test::admin::database::v1::Database>>
+  AsyncGetDatabase(google::test::admin::database::v1::GetDatabaseRequest const& request);
+
+  virtual future<Status>
+  AsyncDropDatabase(google::test::admin::database::v1::DropDatabaseRequest const& request);
+
 };
 
 std::shared_ptr<GoldenThingAdminConnection> MakeGoldenThingAdminConnection(

generator/integration_tests/golden/internal/golden_kitchen_sink_auth_decorator.cc

@@ -25,7 +25,6 @@ namespace cloud {
 namespace golden_internal {
 GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
 
-
 GoldenKitchenSinkAuth::GoldenKitchenSinkAuth(
     std::shared_ptr<google::cloud::internal::GrpcAuthenticationStrategy> auth,
     std::shared_ptr<GoldenKitchenSinkStub> child)
@@ -81,6 +80,7 @@ StatusOr<google::test::admin::database::v1::ListServiceAccountKeysResponse> Gold
   if (!status.ok()) return status;
   return child_->ListServiceAccountKeys(context, request);
 }
+
 GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
 }  // namespace golden_internal
 }  // namespace cloud

generator/integration_tests/golden/internal/golden_kitchen_sink_auth_decorator.h

@@ -31,7 +31,6 @@ namespace cloud {
 namespace golden_internal {
 GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_BEGIN
 
-
 class GoldenKitchenSinkAuth : public GoldenKitchenSinkStub {
  public:
   ~GoldenKitchenSinkAuth() override = default;

generator/integration_tests/golden/internal/golden_thing_admin_auth_decorator.cc

@@ -207,6 +207,37 @@ StatusOr<google::test::admin::database::v1::ListBackupOperationsResponse> Golden
   return child_->ListBackupOperations(context, request);
 }
 
+future<StatusOr<google::test::admin::database::v1::Database>> GoldenThingAdminAuth::AsyncGetDatabase(
+      google::cloud::CompletionQueue& cq,
+      std::unique_ptr<grpc::ClientContext> context,
+      google::test::admin::database::v1::GetDatabaseRequest const& request) {
+  using ReturnType = StatusOr<google::test::admin::database::v1::Database>;
+  auto child = child_;
+  return auth_->AsyncConfigureContext(std::move(context)).then(
+      [cq, child, request](
+          future<StatusOr<std::unique_ptr<grpc::ClientContext>>> f) mutable {
+        auto context = f.get();
+        if (!context) {
+          return make_ready_future(ReturnType(std::move(context).status()));
+        }
+        return child->AsyncGetDatabase(cq, *std::move(context), request);
+      });
+}
+
+future<Status> GoldenThingAdminAuth::AsyncDropDatabase(
+      google::cloud::CompletionQueue& cq,
+      std::unique_ptr<grpc::ClientContext> context,
+      google::test::admin::database::v1::DropDatabaseRequest const& request) {
+  auto child = child_;
+  return auth_->AsyncConfigureContext(std::move(context)).then(
+      [cq, child, request](
+          future<StatusOr<std::unique_ptr<grpc::ClientContext>>> f) mutable {
+        auto context = f.get();
+        if (!context) return make_ready_future(std::move(context).status());
+        return child->AsyncDropDatabase(cq, *std::move(context), request);
+      });
+}
+
 future<StatusOr<google::longrunning::Operation>>
 GoldenThingAdminAuth::AsyncGetOperation(
     google::cloud::CompletionQueue& cq,
@@ -238,6 +269,7 @@ future<Status> GoldenThingAdminAuth::AsyncCancelOperation(
         return child->AsyncCancelOperation(cq, *std::move(context), request);
       });
 }
+
 GOOGLE_CLOUD_CPP_INLINE_NAMESPACE_END
 }  // namespace golden_internal
 }  // namespace cloud

generator/integration_tests/golden/internal/golden_thing_admin_auth_decorator.h

@@ -112,6 +112,16 @@ class GoldenThingAdminAuth : public GoldenThingAdminStub {
       grpc::ClientContext& context,
       google::test::admin::database::v1::ListBackupOperationsRequest const& request) override;
 
+  future<StatusOr<google::test::admin::database::v1::Database>> AsyncGetDatabase(
+      google::cloud::CompletionQueue& cq,
+      std::unique_ptr<grpc::ClientContext> context,
+      google::test::admin::database::v1::GetDatabaseRequest const& request) override;
+
+  future<Status> AsyncDropDatabase(
+      google::cloud::CompletionQueue& cq,
+      std::unique_ptr<grpc::ClientContext> context,
+      google::test::admin::database::v1::DropDatabaseRequest const& request) override;
+
   future<StatusOr<google::longrunning::Operation>> AsyncGetOperation(
       google::cloud::CompletionQueue& cq,
       std::unique_ptr<grpc::ClientContext> context,