gapic-common 0.22.0 → 0.25.0

data/lib/gapic/rest/client_stub.rb

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 require "googleauth"
+require "gapic/logging_concerns"
 require "gapic/rest/faraday_middleware"
 require "gapic/universe_domain_concerns"
 require "faraday/retry"
@@ -28,9 +29,11 @@ module Gapic
     #
     class ClientStub
       include UniverseDomainConcerns
+      include LoggingConcerns
 
       ##
       # Initializes with an endpoint and credentials
+      #
       # @param endpoint [String] The endpoint of the API. Overrides any endpoint_template.
       # @param endpoint_template [String] The endpoint of the API, where the
       #   universe domain component of the hostname is marked by the string in
@@ -41,12 +44,14 @@ module Gapic
       #   Credentials to send with calls in form of a googleauth credentials object.
       #   (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
       # @param numeric_enums [Boolean] Whether to signal the server to JSON-encode enums as ints
-      #
       # @param raise_faraday_errors [Boolean]
       #   Whether to raise Faraday errors instead of wrapping them in `Gapic::Rest::Error`
       #   Added for backwards compatibility.
       #   Default is `true`. All REST clients (except for old versions of `google-cloud-compute-v1`)
       #   should explicitly set this parameter to `false`.
+      # @param logger [Logger,:default,nil] An explicit logger to use, or one
+      #   of the values `:default` (the default) to construct a default logger,
+      #   or `nil` to disable logging explicitly.
       #
       # @yield [Faraday::Connection]
       #
@@ -55,7 +60,10 @@ module Gapic
                      endpoint_template: nil,
                      universe_domain: nil,
                      numeric_enums: false,
-                     raise_faraday_errors: true
+                     raise_faraday_errors: true,
+                     logging_system: nil,
+                     service_name: nil,
+                     logger: :default
         setup_universe_domain universe_domain: universe_domain,
                               endpoint: endpoint,
                               endpoint_template: endpoint_template,
@@ -65,6 +73,12 @@ module Gapic
         endpoint_url = "https://#{endpoint_url}" unless /^https?:/.match? endpoint_url
         endpoint_url = endpoint_url.sub %r{/$}, ""
 
+        setup_logging logger: logger,
+                      system_name: logging_system,
+                      service: service_name,
+                      endpoint: endpoint_url,
+                      client_id: object_id
+
         @numeric_enums = numeric_enums
 
         @raise_faraday_errors = raise_faraday_errors
@@ -88,8 +102,8 @@ module Gapic
       # @param options [::Gapic::CallOptions,Hash] gapic options to be applied
       #     to the REST call. Currently only timeout and headers are supported.
       # @return [Faraday::Response]
-      def make_get_request uri:, params: {}, options: {}
-        make_http_request :get, uri: uri, body: nil, params: params, options: options
+      def make_get_request uri:, params: {}, options: {}, method_name: nil
+        make_http_request :get, uri: uri, body: nil, params: params, options: options, method_name: method_name
       end
 
       ##
@@ -100,8 +114,8 @@ module Gapic
       # @param options [::Gapic::CallOptions,Hash] gapic options to be applied
       #     to the REST call. Currently only timeout and headers are supported.
       # @return [Faraday::Response]
-      def make_delete_request uri:, params: {}, options: {}
-        make_http_request :delete, uri: uri, body: nil, params: params, options: options
+      def make_delete_request uri:, params: {}, options: {}, method_name: nil
+        make_http_request :delete, uri: uri, body: nil, params: params, options: options, method_name: method_name
       end
 
       ##
@@ -113,8 +127,8 @@ module Gapic
       # @param options [::Gapic::CallOptions,Hash] gapic options to be applied
       #     to the REST call. Currently only timeout and headers are supported.
       # @return [Faraday::Response]
-      def make_patch_request uri:, body:, params: {}, options: {}
-        make_http_request :patch, uri: uri, body: body, params: params, options: options
+      def make_patch_request uri:, body:, params: {}, options: {}, method_name: nil
+        make_http_request :patch, uri: uri, body: body, params: params, options: options, method_name: method_name
       end
 
       ##
@@ -126,8 +140,8 @@ module Gapic
       # @param options [::Gapic::CallOptions,Hash] gapic options to be applied
       #     to the REST call. Currently only timeout and headers are supported.
       # @return [Faraday::Response]
-      def make_post_request uri:, body: nil, params: {}, options: {}
-        make_http_request :post, uri: uri, body: body, params: params, options: options
+      def make_post_request uri:, body: nil, params: {}, options: {}, method_name: nil
+        make_http_request :post, uri: uri, body: body, params: params, options: options, method_name: method_name
       end
 
       ##
@@ -139,8 +153,8 @@ module Gapic
       # @param options [::Gapic::CallOptions,Hash] gapic options to be applied
       #     to the REST call. Currently only timeout and headers are supported.
       # @return [Faraday::Response]
-      def make_put_request uri:, body: nil, params: {}, options: {}
-        make_http_request :put, uri: uri, body: body, params: params, options: options
+      def make_put_request uri:, body: nil, params: {}, options: {}, method_name: nil
+        make_http_request :put, uri: uri, body: body, params: params, options: options, method_name: method_name
       end
 
       ##
@@ -154,27 +168,38 @@ module Gapic
       # @param is_server_streaming [Boolean] flag if method is streaming
       # @yieldparam chunk [String] The chunk of data received during server streaming.
       # @return [Faraday::Response]
-      def make_http_request verb, uri:, body:, params:, options:, is_server_streaming: false, &block
+      def make_http_request verb,
+                            uri:, body:, params:, options:,
+                            is_server_streaming: false, method_name: nil,
+                            &block
         # Converts hash and nil to an options object
         options = ::Gapic::CallOptions.new(**options.to_h) unless options.is_a? ::Gapic::CallOptions
         deadline = calculate_deadline options
         retried_exception = nil
         next_timeout = get_timeout deadline
+        request_id = LoggingConcerns.random_uuid4
+        try_number = 1
 
         begin
-          base_make_http_request(verb: verb, uri: uri, body: body,
-                                 params: params, metadata: options.metadata,
-                                 timeout: next_timeout,
-                                 is_server_streaming: is_server_streaming,
-                                 &block)
+          log_request method_name, request_id, try_number, body, options.metadata
+          response = base_make_http_request verb: verb, uri: uri, body: body,
+                                            params: params, metadata: options.metadata,
+                                            timeout: next_timeout,
+                                            is_server_streaming: is_server_streaming,
+                                            &block
+          log_response method_name, request_id, try_number, response, is_server_streaming
+          response
         rescue ::Faraday::TimeoutError => e
+          log_response method_name, request_id, try_number, e, is_server_streaming
           raise if @raise_faraday_errors
           raise Gapic::Rest::DeadlineExceededError.wrap_faraday_error e, root_cause: retried_exception
         rescue ::Faraday::Error => e
+          log_response method_name, request_id, try_number, e, is_server_streaming
           next_timeout = get_timeout deadline
 
           if check_retry?(next_timeout) && options.retry_policy.call(e)
             retried_exception = e
+            try_number += 1
             retry
           end
 
@@ -251,6 +276,54 @@ module Gapic
 
         timeout.positive?
       end
+
+      def log_request method_name, request_id, try_number, body, metadata
+        return unless stub_logger
+        stub_logger.info do |entry|
+          entry.set_system_name
+          entry.set_service
+          entry.set "rpcName", method_name
+          entry.set "retryAttempt", try_number
+          entry.set "requestId", request_id
+          entry.message = "Sending request to #{entry.service}.#{method_name} (try #{try_number})"
+        end
+        body = body.to_s
+        metadata = metadata.to_h rescue {}
+        return if body.empty? && metadata.empty?
+        stub_logger.debug do |entry|
+          entry.set "requestId", request_id
+          entry.set "request", body
+          entry.set "headers", metadata
+          entry.message = "(request payload as JSON)"
+        end
+      end
+
+      def log_response method_name, request_id, try_number, response, is_server_streaming
+        return unless stub_logger
+        stub_logger.info do |entry|
+          entry.set_system_name
+          entry.set_service
+          entry.set "rpcName", method_name
+          entry.set "retryAttempt", try_number
+          entry.set "requestId", request_id
+          if response.is_a? StandardError
+            entry.set "exception", response.to_s
+            entry.message = "Received error for #{entry.service}.#{method_name} (try #{try_number}): #{response}"
+          elsif is_server_streaming
+            entry.message = "Receiving stream for #{entry.service}.#{method_name} (try #{try_number})"
+          else
+            entry.message = "Received response for #{entry.service}.#{method_name} (try #{try_number})"
+          end
+        end
+        return if is_server_streaming || !response.respond_to?(:body)
+        body = response.body.to_s
+        return if body.empty?
+        stub_logger.debug do |entry|
+          entry.set "requestId", request_id
+          entry.set "response", body
+          entry.message = "(response payload as JSON)"
+        end
+      end
     end
   end
 end

data/lib/gapic/universe_domain_concerns.rb

@@ -60,11 +60,11 @@ module Gapic
       raise ArgumentError, "endpoint or endpoint_template is required" if endpoint.nil? && endpoint_template.nil?
       raise ArgumentError, "credentials is required" if credentials.nil?
 
-      # TODO: The env logic should live in google-cloud-env
       universe_domain ||= ENV["GOOGLE_CLOUD_UNIVERSE_DOMAIN"] || "googleapis.com"
       endpoint ||= endpoint_template.sub ENDPOINT_SUBSTITUTION, universe_domain
 
-      if credentials.respond_to?(:universe_domain) && credentials.universe_domain != universe_domain
+      if !(credentials.respond_to?(:disable_universe_domain_check) && credentials.disable_universe_domain_check) &&
+         credentials.respond_to?(:universe_domain) && credentials.universe_domain != universe_domain
         raise UniverseDomainMismatch,
               "Universe domain is #{universe_domain} but credentials are in #{credentials.universe_domain}"
       end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: gapic-common
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Google API Authors
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-22 00:00:00.000000000 Z
+date: 2025-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -84,14 +83,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-env
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: google-logging-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: google-protobuf
   requirement: !ruby/object:Gem::Requirement
@@ -118,15 +145,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.65'
+        version: '1.66'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.65'
-description: 
+        version: '1.66'
 email:
 - googleapis-packages@google.com
 executables: []
@@ -146,6 +172,9 @@ files:
 - lib/gapic/call_options/retry_policy.rb
 - lib/gapic/common.rb
 - lib/gapic/common/error.rb
+- lib/gapic/common/error_codes.rb
+- lib/gapic/common/polling_harness.rb
+- lib/gapic/common/retry_policy.rb
 - lib/gapic/common/version.rb
 - lib/gapic/config.rb
 - lib/gapic/config/method.rb
@@ -159,6 +188,7 @@ files:
 - lib/gapic/grpc/service_stub/rpc_call.rb
 - lib/gapic/grpc/status_details.rb
 - lib/gapic/headers.rb
+- lib/gapic/logging_concerns.rb
 - lib/gapic/lru_hash.rb
 - lib/gapic/operation.rb
 - lib/gapic/operation/retry_policy.rb
@@ -177,11 +207,10 @@ files:
 - lib/gapic/rest/transport_operation.rb
 - lib/gapic/stream_input.rb
 - lib/gapic/universe_domain_concerns.rb
-homepage: https://github.com/googleapis/gapic-generator-ruby
+homepage: https://github.com/googleapis/ruby-core-libraries
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -196,8 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Common code for GAPIC-generated API clients
 test_files: []