impl(bq_driver): Add Log macros in bq_client_interface dir (#1169)

Author: NeerajDwivedii

google/cloud/odbc/bq_client_interface/datasets.cc

@@ -15,6 +15,7 @@
 #include "google/cloud/odbc/bq_client_interface/datasets.h"
 #include "google/cloud/odbc/internal/status_record_or.h"
 #include "google/cloud/bigquery/v2/minimal/internal/dataset_client.h"
+#include <absl/log/log.h>
 
 namespace google::cloud::odbc_bigquery_client_interface {
 
@@ -27,59 +28,82 @@ using ::google::cloud::bigquery_v2_minimal_internal::ListFormatDataset;
 using google::cloud::odbc_internal::StatusRecord;
 using google::cloud::odbc_internal::StatusRecordOr;
 
+#pragma clang attribute push(__attribute__((no_sanitize("memory"))), \
+                             apply_to = function)
 StatusRecordOr<Dataset> GetDataset(DatasetClient& dataset_client,
                                    std::string const& project_id,
                                    std::string const& dataset_id,
                                    Options const& options) {
   GetDatasetRequest request;
   request.set_project_id(project_id);
   request.set_dataset_id(dataset_id);
+  LOG(INFO) << "GetDataSet:: Request body: " << request.DebugString("");
 
-  return StatusRecordOr<Dataset>::ConvertFromStatusOr(
-      dataset_client.GetDataset(request, options));
+  auto response = dataset_client.GetDataset(request, options);
+  if (!response.ok()) {
+    LOG(WARNING) << "GetDataSet:: Request failed: " << response.status();
+    return StatusRecordOr<Dataset>::ConvertFromStatusOr(response.status());
+  }
+  LOG(INFO) << "GetDataSet:: Response body: "
+            << GetJsonRegResp<Dataset>(*response);
+  return StatusRecordOr<Dataset>::ConvertFromStatusOr(*response);
 }
+#pragma clang attribute pop
 
+#pragma clang attribute push(__attribute__((no_sanitize("memory"))), \
+                             apply_to = function)
 StatusRecordOr<std::vector<ListFormatDataset>> ListAllDatasets(
     DatasetClient& dataset_client, std::string const& project_id,
     Options const& options) {
   ListDatasetsRequest request;
   request.set_project_id(project_id);
   request.set_all_datasets(true);
-
+  LOG(INFO) << "ListAllDatasets:: Request body: " << request.DebugString("");
   StreamRange<ListFormatDataset> datasets_response =
       dataset_client.ListDatasets(request, options);
 
   std::vector<ListFormatDataset> datasets;
   for (auto const& dataset : datasets_response) {
     if (!dataset) {
+      LOG(ERROR) << "ListAllDatasets:: " << dataset.status().message();
       return StatusRecord::ConvertFrom(dataset.status());
     }
+    LOG(INFO) << "ListAllDatasets:: Response body: "
+              << GetJsonRegResp<ListFormatDataset>(*dataset);
     datasets.push_back(*dataset);
   }
 
   return datasets;
 }
+#pragma clang attribute pop
 
+#pragma clang attribute push(__attribute__((no_sanitize("memory"))), \
+                             apply_to = function)
 StatusRecordOr<std::vector<ListFormatDataset>> FilterDatasets(
     DatasetClient& dataset_client, std::string const& project_id,
     DatasetFilter const& dataset_filter, Options const& options) {
   ListDatasetsRequest request;
   request.set_project_id(project_id);
   request.set_all_datasets(dataset_filter.all);
   request.set_filter(dataset_filter.filter);
+  LOG(INFO) << "FilterDatasets:: Request body: " << request.DebugString("");
 
   StreamRange<ListFormatDataset> datasets_response =
       dataset_client.ListDatasets(request, options);
 
   std::vector<ListFormatDataset> datasets;
   for (auto const& dataset : datasets_response) {
     if (!dataset) {
+      LOG(ERROR) << "FilterDatasets:: " << dataset.status().message();
       return StatusRecord::ConvertFrom(dataset.status());
     }
+    LOG(INFO) << "FilterDatasets:: Response body: "
+              << GetJsonRegResp<ListFormatDataset>(*dataset);
     datasets.push_back(*dataset);
   }
 
   return datasets;
 }
+#pragma clang attribute pop
 
 }  // namespace google::cloud::odbc_bigquery_client_interface

google/cloud/odbc/bq_client_interface/datasets.h

@@ -29,6 +29,13 @@ struct DatasetFilter {
   bool all = false;
 };
 
+template <typename T>
+inline std::string GetJsonRegResp(T const& req_or_resp) {
+  nlohmann::json json_obj;
+  to_json(json_obj, req_or_resp);
+  return json_obj.dump(4);
+}
+
 // Returns detailed info for a specific Dataset.
 odbc_internal::StatusRecordOr<
     ::google::cloud::bigquery_v2_minimal_internal::Dataset>

google/cloud/odbc/bq_client_interface/jobs.cc

@@ -13,9 +13,11 @@
 // limitations under the License.
 
 #include "google/cloud/odbc/bq_client_interface/jobs.h"
+#include "google/cloud/odbc/bq_client_interface/datasets.h"
 #include "google/cloud/odbc/internal/status_record_or.h"
 #include "google/cloud/bigquery/v2/minimal/internal/job_client.h"
 #include "google/cloud/bigquery/v2/minimal/internal/job_request.h"
+#include <absl/log/log.h>
 #include <thread>
 
 namespace google::cloud::odbc_bigquery_client_interface {
@@ -106,6 +108,8 @@ std::vector<std::string> CreateKeysToFilterOut(
   return default_filtered_keys;
 }
 
+#pragma clang attribute push(__attribute__((no_sanitize("memory"))), \
+                             apply_to = function)
 StatusRecordOr<Job> GetJob(JobClient& job_client, std::string const& project_id,
                            std::string const& job_id,
                            std::string const& location,
@@ -114,20 +118,31 @@ StatusRecordOr<Job> GetJob(JobClient& job_client, std::string const& project_id,
   get_job_request.set_project_id(project_id);
   get_job_request.set_job_id(job_id);
   get_job_request.set_location(location);
+  LOG(INFO) << "GetJob:: Request body: " << get_job_request.DebugString("");
 
-  return StatusRecordOr<Job>::ConvertFromStatusOr(
-      job_client.GetJob(get_job_request, options));
+  auto response = job_client.GetJob(get_job_request, options);
+  if (!response.ok()) {
+    LOG(WARNING) << "GetJob:: Request failed: " << response.status();
+    return StatusRecordOr<Job>::ConvertFromStatusOr(response.status());
+  }
+  LOG(INFO) << "GetJob:: Response body: " << GetJsonRegResp<Job>(*response);
+  return StatusRecordOr<Job>::ConvertFromStatusOr(*response);
 }
+#pragma clang attribute pop
 
+#pragma clang attribute push(__attribute__((no_sanitize("memory"))), \
+                             apply_to = function)
 StatusRecordOr<std::vector<ListFormatJob>> ListAllJobs(
     JobClient& job_client, std::string const& project_id,
     std::string const& parent_job_id, Options const& options) {
   // Validate inputs
   if (project_id.empty()) {
+    LOG(ERROR) << "ListAllJobs:: project_id cannot be empty";
     return StatusRecord::ConvertFrom(
         Status(StatusCode::kInvalidArgument, "project_id cannot be empty"));
   }
   if (parent_job_id.empty()) {
+    LOG(ERROR) << "ListAllJobs:: parent_job_id cannot be empty";
     return StatusRecord::ConvertFrom(
         Status(StatusCode::kInvalidArgument, "parent_job_id cannot be empty"));
   }
@@ -138,21 +153,27 @@ StatusRecordOr<std::vector<ListFormatJob>> ListAllJobs(
   request.set_all_users(false);
   request.set_max_results(kMaxChildJobsResults);
   request.set_projection(Projection::Full());
-
+  LOG(INFO) << "ListAllJobs:: Request body: " << request.DebugString("");
   StreamRange<ListFormatJob> jobs_response =
       job_client.ListJobs(request, options);
 
   std::vector<ListFormatJob> jobs;
   for (auto const& job : jobs_response) {
     if (!job) {
+      LOG(ERROR) << "ListAllJobs:: " << job.status().message();
       return StatusRecord::ConvertFrom(job.status());
     }
+    LOG(INFO) << "ListAllJobs:: Response body: "
+              << GetJsonRegResp<ListFormatJob>(*job);
     jobs.push_back(*job);
   }
 
   return jobs;
 }
+#pragma clang attribute pop
 
+#pragma clang attribute push(__attribute__((no_sanitize("memory"))), \
+                             apply_to = function)
 StatusRecordOr<std::vector<ListFormatJob>> ListAllJobs(
     JobClient& job_client, std::string const& project_id,
     Options const& options) {
@@ -161,21 +182,28 @@ StatusRecordOr<std::vector<ListFormatJob>> ListAllJobs(
   request.set_all_users(false);
   request.set_max_results(kMaxChildJobsResults);
   request.set_projection(Projection::Full());
+  LOG(INFO) << "ListAllJobs:: Request body: " << request.DebugString("");
 
   StreamRange<ListFormatJob> jobs_response =
       job_client.ListJobs(request, options);
 
   std::vector<ListFormatJob> jobs;
   for (auto const& job : jobs_response) {
     if (!job) {
+      LOG(ERROR) << "ListAllJobs:: " << job.status().message();
       return StatusRecord::ConvertFrom(job.status());
     }
+    LOG(INFO) << "ListAllJobs:: Response body: "
+              << GetJsonRegResp<ListFormatJob>(*job);
     jobs.push_back(*job);
   }
 
   return jobs;
 }
+#pragma clang attribute pop
 
+#pragma clang attribute push(__attribute__((no_sanitize("memory"))), \
+                             apply_to = function)
 StatusRecordOr<std::vector<ListFormatJob>> FilterJobs(
     JobClient& job_client, std::string const& project_id,
     JobFilter const& job_filter, Options const& options) {
@@ -188,20 +216,27 @@ StatusRecordOr<std::vector<ListFormatJob>> FilterJobs(
   request.set_parent_job_id(job_filter.parent_job_id);
   request.set_projection(job_filter.projection);
 
+  LOG(INFO) << "FilterJobs:: Request body: " << request.DebugString("");
   StreamRange<ListFormatJob> jobs_response =
       job_client.ListJobs(request, options);
 
   std::vector<ListFormatJob> jobs;
   for (auto const& job : jobs_response) {
     if (!job) {
+      LOG(ERROR) << "FilterJobs:: " << job.status().message();
       return StatusRecord::ConvertFrom(job.status());
     }
+    LOG(INFO) << "FilterJobs:: Response body: "
+              << GetJsonRegResp<ListFormatJob>(*job);
     jobs.push_back(*job);
   }
 
   return jobs;
 }
+#pragma clang attribute pop
 
+#pragma clang attribute push(__attribute__((no_sanitize("memory"))), \
+                             apply_to = function)
 StatusRecordOr<Job> InsertJob(JobClient& job_client,
                               std::string const& project_id, Job const& job,
                               Options const& options) {
@@ -210,10 +245,19 @@ StatusRecordOr<Job> InsertJob(JobClient& job_client,
   request.set_job(job);
   request.set_json_filter_keys(CreateKeysToFilterOut(job));
 
-  return StatusRecordOr<Job>::ConvertFromStatusOr(
-      job_client.InsertJob(request, options));
+  LOG(INFO) << "InsertJob:: Request body: " << request.DebugString("");
+  auto response = job_client.InsertJob(request, options);
+  if (!response.ok()) {
+    LOG(WARNING) << "InsertJob:: Request failed: " << response.status();
+    return StatusRecordOr<Job>::ConvertFromStatusOr(response.status());
+  }
+  LOG(INFO) << "InsertJob: Response body: " << GetJsonRegResp<Job>(*response);
+  return StatusRecordOr<Job>::ConvertFromStatusOr(*response);
 }
+#pragma clang attribute pop
 
+#pragma clang attribute push(__attribute__((no_sanitize("memory"))), \
+                             apply_to = function)
 StatusRecordOr<Job> CancelJob(JobClient& job_client,
                               std::string const& project_id,
                               std::string const& job_id,
@@ -228,11 +272,19 @@ StatusRecordOr<Job> CancelJob(JobClient& job_client,
   if (!location.empty()) {
     request.set_location(location);
   }
-
-  return StatusRecordOr<Job>::ConvertFromStatusOr(
-      job_client.CancelJob(request, options));
+  LOG(INFO) << "CancelJob:: Request body: " << request.DebugString("");
+  auto response = job_client.CancelJob(request, options);
+  if (!response.ok()) {
+    LOG(WARNING) << "CancelJob:: Request failed: " << response.status();
+    return StatusRecordOr<Job>::ConvertFromStatusOr(response.status());
+  }
+  LOG(INFO) << "CancelJob:: Response body: " << GetJsonRegResp<Job>(*response);
+  return StatusRecordOr<Job>::ConvertFromStatusOr(*response);
 }
+#pragma clang attribute pop
 
+#pragma clang attribute push(__attribute__((no_sanitize("memory"))), \
+                             apply_to = function)
 StatusRecordOr<PostQueryResults> Query(JobClient& job_client,
                                        std::string const& project_id,
                                        QueryRequest const& query_request,
@@ -242,9 +294,18 @@ StatusRecordOr<PostQueryResults> Query(JobClient& job_client,
   post_query_request.set_query_request(query_request);
   post_query_request.set_json_filter_keys(CreateKeysToFilterOut(query_request));
 
-  return StatusRecordOr<PostQueryResults>::ConvertFromStatusOr(
-      job_client.Query(post_query_request, options));
+  LOG(INFO) << "Query:: Request body: " << post_query_request.DebugString("");
+  auto response = job_client.Query(post_query_request, options);
+  if (!response.ok()) {
+    LOG(WARNING) << "Query:: Request failed: " << response.status();
+    return StatusRecordOr<PostQueryResults>::ConvertFromStatusOr(
+        response.status());
+  }
+  LOG(INFO) << "Query:: Response body: "
+            << GetJsonRegResp<PostQueryResults>(*response);
+  return StatusRecordOr<PostQueryResults>::ConvertFromStatusOr(*response);
 }
+#pragma clang attribute pop
 
 StatusRecordOr<PostQueryResults> PostQuery(
     JobClient& job_client, PostQueryRequest const& post_query_request,
@@ -253,6 +314,8 @@ StatusRecordOr<PostQueryResults> PostQuery(
                post_query_request.query_request(), options);
 }
 
+#pragma clang attribute push(__attribute__((no_sanitize("memory"))), \
+                             apply_to = function)
 StatusRecordOr<GetQueryResults> GetAllQueryResults(
     JobClient& job_client, std::string const& project_id,
     std::string const& job_id, std::string const& location,
@@ -273,16 +336,20 @@ StatusRecordOr<GetQueryResults> GetAllQueryResults(
       std::string message = "The query timeout period of " +
                             std::to_string(timeout_ms.count()) +
                             "ms has expired";
+      LOG(ERROR) << "GetAllQueryResults:: " << message;
       return StatusRecord{SQLStates::k_HYT00(), message};
     }
     std::this_thread::sleep_for(chrono_ms(200));
     StatusOr<GetQueryResults> get_query_results_partial =
         job_client.QueryResults(get_query_results_request, options);
 
     if (!get_query_results_partial) {
+      LOG(ERROR) << "GetAllQueryResults::QueryResults:: "
+                 << get_query_results_partial.status().message();
       return StatusRecord::ConvertFrom(get_query_results_partial.status());
     }
-
+    LOG(INFO) << "GetAllQueryResults::QueryResults:: Response body: "
+              << get_query_results_partial->DebugString("");
     // If job_complete is false, there would be no rows and we should wait for
     // job completion
     if (!get_query_results_partial->job_complete &&
@@ -306,10 +373,14 @@ StatusRecordOr<GetQueryResults> GetAllQueryResults(
     get_query_results_request.set_page_token(
         get_query_results_partial->page_token);
   }
-
+  LOG(INFO) << "GetAllQueryResults:: Request body: "
+            << get_query_results_request.DebugString("");
   return get_query_results;
 }
+#pragma clang attribute pop
 
+#pragma clang attribute push(__attribute__((no_sanitize("memory"))), \
+                             apply_to = function)
 StatusRecordOr<GetQueryResults> FilterQueryResults(
     JobClient& job_client, std::string const& project_id,
     std::string const& job_id, std::string const& location,
@@ -325,8 +396,19 @@ StatusRecordOr<GetQueryResults> FilterQueryResults(
   get_query_results_request.set_max_results(query_results_filter.max_results);
   get_query_results_request.set_page_token(query_results_filter.page_token);
 
-  return StatusRecordOr<GetQueryResults>::ConvertFromStatusOr(
-      job_client.QueryResults(get_query_results_request, options));
+  LOG(INFO) << "FilterQueryResults:: Request body: "
+            << get_query_results_request.DebugString("");
+  auto response = job_client.QueryResults(get_query_results_request, options);
+  if (!response.ok()) {
+    LOG(WARNING) << "FilterQueryResults:: Request failed: "
+                 << response.status();
+    return StatusRecordOr<GetQueryResults>::ConvertFromStatusOr(
+        response.status());
+  }
+  LOG(INFO) << "FilterQueryResults::QueryResults:: Response body: "
+            << response->DebugString("");
+  return StatusRecordOr<GetQueryResults>::ConvertFromStatusOr(*response);
 }
+#pragma clang attribute pop
 
 }  // namespace google::cloud::odbc_bigquery_client_interface