gapic-common 0.15.1 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd16594f62fa1e7145513111074f9fb1ad6988ac38fcd0c7b7a63d119269e66d
-  data.tar.gz: 3c0921a7825bbab864a9a8fb370cd24def7493c2af050545e71d0dc22a4f980e
+  metadata.gz: 1e75598e117f5f4e8829498d534e4a9106ad28d60b49537e556c094bb73aec6d
+  data.tar.gz: cdbc7ea9f2135123e54cd65eaa964da0bac013a380a5517266666cb780fe272b
 SHA512:
-  metadata.gz: b2b26d265c79563ff7bc28b74f3be6536df070d4bf7ed3e347d734ffadd867cb44f3dfac8f8a6b624f2786a0942643d92c5bdbc2610e3b0f1072f39b7337eef6
-  data.tar.gz: c02d9dfc4f98dc243d67a910e8a855a18333c3258f515e973962848c46812c9df52008fa942027592b451dce0e4b739fe7bf4553a81bf3bb649a71741c2da484
+  metadata.gz: 29a7d283e612f3b63771a00c4b9ef6dbfeed924fd49acde80296df0868af30e4dfa28644db6af5b79eb9a55466d6d583d583e4fd390b19c0fbcb4bf8241db795
+  data.tar.gz: e930d32eae8b3fd68ffc4452a2d9462c6f3ad762abc769a8eaef0df7a8f554d2a0c4b2e8b5c476dc82ee795382c869cba0e0ab765fe614558f945d8e938790c3

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Release History
 
+### 0.16.0 (2022-12-12)
+
+#### Features
+
+* custom regapic exception wrapping ([#866](https://github.com/googleapis/gapic-generator-ruby/issues/866)) 
+
 ### 0.15.1 (2022-11-18)
 
 #### Bug Fixes

data/lib/gapic/call_options/error_codes.rb

@@ -45,26 +45,29 @@ module Gapic
       # @private
       ERROR_STRING_MAPPING = error_code_mapping.each_with_index.to_h.freeze
 
+      # @private
+      HTTP_GRPC_CODE_MAP = {
+        400 => 3, # InvalidArgumentError
+        401 => 16, # UnauthenticatedError
+        403 => 7, # PermissionDeniedError
+        404 => 5, # NotFoundError
+        409 => 6, # AlreadyExistsError
+        412 => 9, # FailedPreconditionError
+        429 => 8, # ResourceExhaustedError
+        499 => 1, # CanceledError
+        500 => 13, # InternalError
+        501 => 12, # UnimplementedError
+        503 => 14, # UnavailableError
+        504 => 4 # DeadlineExceededError
+      }.freeze
+
       # @private
       # Converts http error codes into corresponding gRPC ones
       def self.grpc_error_for http_error_code
         return 2 unless http_error_code
 
         # The http status codes mapped to their error classes.
-        {
-          400 => 3, # InvalidArgumentError
-          401 => 16, # UnauthenticatedError
-          403 => 7, # PermissionDeniedError
-          404 => 5, # NotFoundError
-          409 => 6, # AlreadyExistsError
-          412 => 9, # FailedPreconditionError
-          429 => 8, # ResourceExhaustedError
-          499 => 1, # CanceledError
-          500 => 13, # InternalError
-          501 => 12, # UnimplementedError
-          503 => 14, # UnavailableError
-          504 => 4 # DeadlineExceededError
-        }[http_error_code] || 2 # UnknownError
+        HTTP_GRPC_CODE_MAP[http_error_code] || 2 # UnknownError
       end
     end
   end

data/lib/gapic/common/version.rb

@@ -14,6 +14,6 @@
 
 module Gapic
   module Common
-    VERSION = "0.15.1".freeze
+    VERSION = "0.16.0".freeze
   end
 end

data/lib/gapic/rest/client_stub.rb

@@ -34,9 +34,15 @@ module Gapic
       #   (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`.
+      #
       # @yield [Faraday::Connection]
       #
-      def initialize endpoint:, credentials:, numeric_enums: false
+      def initialize endpoint:, credentials:, numeric_enums: false, raise_faraday_errors: true
         @endpoint = endpoint
         @endpoint = "https://#{endpoint}" unless /^https?:/.match? endpoint
         @endpoint = @endpoint.sub %r{/$}, ""
@@ -44,6 +50,8 @@ module Gapic
         @credentials = credentials
         @numeric_enums = numeric_enums
 
+        @raise_faraday_errors = raise_faraday_errors
+
         @connection = Faraday.new url: @endpoint do |conn|
           conn.headers = { "Content-Type" => "application/json" }
           conn.request :google_authorization, @credentials unless @credentials.is_a? ::Symbol
@@ -137,35 +145,31 @@ module Gapic
         next_timeout = get_timeout deadline
 
         begin
-          base_make_http_request(verb,
-                                 uri: uri,
-                                 body: body,
-                                 params: params,
-                                 metadata: options.metadata,
+          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)
+        rescue ::Faraday::TimeoutError => e
+          raise if @raise_faraday_errors
+          raise Gapic::Rest::DeadlineExceededError.wrap_faraday_error e, root_cause: retried_exception
         rescue ::Faraday::Error => e
           next_timeout = get_timeout deadline
 
-          if next_timeout&.positive? && options.retry_policy.call(e)
+          if check_retry?(next_timeout) && options.retry_policy.call(e)
             retried_exception = e
             retry
           end
 
-          unless next_timeout&.positive?
-            raise Gapic::GRPC::DeadlineExceededError.new e.message, root_cause: retried_exception
-          end
-
-          raise e
+          raise if @raise_faraday_errors
+          raise ::Gapic::Rest::Error.wrap_faraday_error e
         end
       end
 
-      private
-
       ##
       # @private
       # Sends a http request via Faraday
+      #
       # @param verb [Symbol] http verb
       # @param uri [String] uri to send this request to
       # @param body [String, nil] a body to send with the request, nil for requests without a body
@@ -174,7 +178,8 @@ 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 base_make_http_request verb, uri:, body:, params:, metadata:, timeout:, is_server_streaming: false
+      def base_make_http_request verb:, uri:, body:, params:, metadata:,
+                                 timeout:, is_server_streaming: false
         if @numeric_enums && (!params.key?("$alt") || params["$alt"] == "json")
           params = params.merge({ "$alt" => "json;enum-encoding=int" })
         end
@@ -192,6 +197,14 @@ module Gapic
         end
       end
 
+      private
+
+      ##
+      # Calculates deadline
+      #
+      # @param options [Gapic::CallOptions] call options for this call
+      #
+      # @return [Numeric, nil] Deadline against a POSIX clock_gettime()
       def calculate_deadline options
         return if options.timeout.nil?
         return if options.timeout.negative?
@@ -199,10 +212,28 @@ module Gapic
         Process.clock_gettime(Process::CLOCK_MONOTONIC) + options.timeout
       end
 
+      ##
+      # Calculates timeout (seconds) to use as a Faraday timeout
+      #
+      # @param deadline [Numeric, nil] deadline
+      #
+      # @return [Numeric, nil] Timeout (seconds)
       def get_timeout deadline
         return if deadline.nil?
         deadline - Process.clock_gettime(Process::CLOCK_MONOTONIC)
       end
+
+      ##
+      # Whether the timeout should be retried
+      #
+      # @param timeout [Numeric, nil]
+      #
+      # @return [Boolean] whether the timeout should be retried
+      def check_retry? timeout
+        return true if timeout.nil?
+
+        timeout.positive?
+      end
     end
   end
 end

data/lib/gapic/rest/error.rb

@@ -55,6 +55,17 @@ module Gapic
         #
         # @return [ Gapic::Rest::Error]
         def wrap_faraday_error err
+          message, status_code, status, details, headers = parse_faraday_error err
+          Gapic::Rest::Error.new message, status_code, status: status, details: details, headers: headers
+        end
+
+        ##
+        # @private
+        # Tries to get the error information from Faraday error
+        #
+        # @param err [Faraday::Error] the Faraday error to extract information from
+        # @return [Array(String, String, String, String, String)]
+        def parse_faraday_error err
           message = err.message
           status_code = err.response_status
           status = nil
@@ -67,7 +78,7 @@ module Gapic
             status_code = code unless code.nil?
           end
 
-          Gapic::Rest::Error.new message, status_code, status: status, details: details, headers: headers
+          [message, status_code, status, details, headers]
         end
 
         private
@@ -133,5 +144,62 @@ module Gapic
         end
       end
     end
+
+    ##
+    # An error class that represents DeadlineExceeded error for Rest
+    # with an optional retry root cause.
+    #
+    # If the deadline for making a call was exceeded during the rest calls,
+    # this exception is thrown wrapping Faraday::TimeoutError.
+    #
+    # If there were other exceptions retried before that, the last one will be
+    # saved as a "root_cause".
+    #
+    # @!attribute [r] root_cause
+    #   @return [Object, nil] The exception that was being retried
+    #     when the Faraday::TimeoutError error occured.
+    #
+    class DeadlineExceededError < Error
+      attr_reader :root_cause
+
+      ##
+      # @private
+      # @param message [String, nil] error message
+      # @param status_code [Integer, nil] HTTP status code of this error
+      # @param status [String, nil] The text representation of status as parsed from the response body
+      # @param details [Object, nil] Details data of this error
+      # @param headers [Object, nil] Http headers data of this error
+      # @param root_cause [Object, nil] The exception that was being retried
+      #   when the Faraday::TimeoutError occured.
+      #
+      def initialize message, status_code, status: nil, details: nil, headers: nil, root_cause: nil
+        super message, status_code, status: status, details: details, headers: headers
+        @root_cause = root_cause
+      end
+
+      class << self
+        ##
+        # @private
+        # This creates a new error message wrapping the Faraday's one. Additionally
+        # it tries to parse and set a detailed message and an error code from
+        # from the Google Cloud's response body
+        #
+        # @param err [Faraday::TimeoutError] the Faraday error to wrap
+        #
+        # @param root_cause [Object, nil] The exception that was being retried
+        #   when the Faraday::TimeoutError occured.
+        #
+        # @return [ Gapic::Rest::DeadlineExceededError]
+        def wrap_faraday_error err, root_cause: nil
+          message, status_code, status, details, headers = parse_faraday_error err
+          Gapic::Rest::DeadlineExceededError.new message,
+                                                 status_code,
+                                                 status: status,
+                                                 details: details,
+                                                 headers: headers,
+                                                 root_cause: root_cause
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gapic-common
 version: !ruby/object:Gem::Version
-  version: 0.15.1
+  version: 0.16.0
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2022-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday