gapic-common 0.13.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b5964ec91020c76501e2424be598b345a114a16515fe209135e46f552100d4e
-  data.tar.gz: 4a08e08fe15b6c6d6a3ad3097895a7d01bcfe3377f1392946a0cfe671ca97fdf
+  metadata.gz: 5902b53f0f5a46b4682ff855fb89a6a3162af38523fa273f273abeeeed0d3a3d
+  data.tar.gz: a1e9bb69d31725768f00b152efcaf29042657fbb304c2ba2f25de485831fe187
 SHA512:
-  metadata.gz: a0270a8d4933fda1f6297233f3465ae4fed20d34ebbf4bb766f228fe13746b5508c97179eb7c0b763d104c52079f59765b514c32a1d6cb2d61196791f007595a
-  data.tar.gz: 437633278a8640eee28a975c7821270b11c2127c72970e0259c29b5b643db37b8d394ac5ae1cd80cb367e10c1384311cc018e0a276804dfda7d8a91f9fffb13a
+  metadata.gz: 84d77cc3d943714b8a3578ecabf3fea3a321dfe0929ee108233d4dcd8fede90a37be21a81e121142739aa3dca102ffff0826a003906bec16f03749beddf59ab2
+  data.tar.gz: 27e2815be724399a4c01ca1d47c7b2e9291ee4583018251f45a2a0162f1d5cd8298d0ca3b8a4cf90fc4ba6f2e410240439e61a22a66fbeae89c5a3e9dc223879

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Release History
 
+### 0.15.0 (2022-11-17)
+
+#### Features
+
+* retry policy now works for REST calls
+
+### 0.14.0 (2022-11-08)
+
+#### Features
+
+* add support for different types of credentials to REST 
+#### Bug Fixes
+
+* deadlock fix ([#845](https://github.com/googleapis/gapic-generator-ruby/issues/845)) 
+
 ### 0.13.0 (2022-10-26)
 
 #### Features

data/lib/gapic/call_options/error_codes.rb

@@ -0,0 +1,71 @@
+# Copyright 2019 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Gapic
+  class CallOptions
+    ##
+    # @private
+    # The gRPC error codes and their HTTP mapping
+    #
+    module ErrorCodes
+      # @private
+      # See https://grpc.github.io/grpc/core/md_doc_statuscodes.html for a
+      # list of error codes.
+      error_code_mapping = [
+        "OK",
+        "CANCELLED",
+        "UNKNOWN",
+        "INVALID_ARGUMENT",
+        "DEADLINE_EXCEEDED",
+        "NOT_FOUND",
+        "ALREADY_EXISTS",
+        "PERMISSION_DENIED",
+        "RESOURCE_EXHAUSTED",
+        "FAILED_PRECONDITION",
+        "ABORTED",
+        "OUT_OF_RANGE",
+        "UNIMPLEMENTED",
+        "INTERNAL",
+        "UNAVAILABLE",
+        "DATA_LOSS",
+        "UNAUTHENTICATED"
+      ].freeze
+
+      # @private
+      ERROR_STRING_MAPPING = error_code_mapping.each_with_index.to_h.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
+      end
+    end
+  end
+end

data/lib/gapic/call_options/retry_policy.rb

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "gapic/call_options/error_codes"
+
 module Gapic
   class CallOptions
     ##
@@ -101,38 +103,12 @@ module Gapic
         [retry_codes, initial_delay, multiplier, max_delay].hash
       end
 
-      # @private
-      # See https://grpc.github.io/grpc/core/md_doc_statuscodes.html for a
-      # list of error codes.
-      ERROR_CODE_MAPPING = [
-        "OK",
-        "CANCELLED",
-        "UNKNOWN",
-        "INVALID_ARGUMENT",
-        "DEADLINE_EXCEEDED",
-        "NOT_FOUND",
-        "ALREADY_EXISTS",
-        "PERMISSION_DENIED",
-        "RESOURCE_EXHAUSTED",
-        "FAILED_PRECONDITION",
-        "ABORTED",
-        "OUT_OF_RANGE",
-        "UNIMPLEMENTED",
-        "INTERNAL",
-        "UNAVAILABLE",
-        "DATA_LOSS",
-        "UNAUTHENTICATED"
-      ].freeze
-
-      # @private
-      ERROR_STRING_MAPPING = ERROR_CODE_MAPPING.each_with_index.each_with_object({}) do |(str, num), hash|
-        hash[str] = num
-      end.freeze
-
       private
 
       def retry? error
-        error.is_a?(::GRPC::BadStatus) && retry_codes.include?(error.code)
+        (error.is_a?(::GRPC::BadStatus) && retry_codes.include?(error.code)) ||
+          (error.respond_to?(:response_status) &&
+            retry_codes.include?(ErrorCodes.grpc_error_for(error.response_status)))
       end
 
       def delay!
@@ -145,7 +121,7 @@ module Gapic
         Array(input_codes).map do |obj|
           case obj
           when String
-            ERROR_STRING_MAPPING[obj]
+            ErrorCodes::ERROR_STRING_MAPPING[obj]
           when Integer
             obj
           end

data/lib/gapic/call_options.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require "gapic/call_options/error_codes"
 require "gapic/call_options/retry_policy"
 
 module Gapic

data/lib/gapic/common/version.rb

@@ -14,6 +14,6 @@
 
 module Gapic
   module Common
-    VERSION = "0.13.0".freeze
+    VERSION = "0.15.0".freeze
   end
 end

data/lib/gapic/rest/client_stub.rb

@@ -125,21 +125,65 @@ module Gapic
       # @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
       # @param params [Hash] query string parameters for the request
-      # @param options [::Gapic::CallOptions,Hash] gapic options to be applied
-      #     to the REST call. Currently only timeout and headers are supported.
+      # @param options [::Gapic::CallOptions,Hash] gapic options to be applied to the REST call.
+      # @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
+        # 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
+
+        begin
+          base_make_http_request(verb,
+                                 uri: uri,
+                                 body: body,
+                                 params: params,
+                                 metadata: options.metadata,
+                                 timeout: next_timeout,
+                                 is_server_streaming: is_server_streaming,
+                                 &block)
+        rescue ::Faraday::Error => e
+          next_timeout = get_timeout deadline
+
+          if next_timeout&.positive? && 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
+        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
+      # @param params [Hash] query string parameters for the request
+      # @param metadata [Hash] additional headers for the request
       # @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
+      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
-        options = ::Gapic::CallOptions.new(**options.to_h) unless options.is_a? ::Gapic::CallOptions
+
         @connection.send verb, uri do |req|
           req.params = params if params.any?
           req.body = body unless body.nil?
-          req.headers = req.headers.merge options.metadata
-          req.options.timeout = options.timeout if options.timeout&.positive?
+          req.headers = req.headers.merge metadata
+          req.options.timeout = timeout if timeout&.positive?
           if is_server_streaming
             req.options.on_data = proc do |chunk, _overall_received_bytes|
               yield chunk
@@ -147,6 +191,18 @@ module Gapic
           end
         end
       end
+
+      def calculate_deadline options
+        return if options.timeout.nil?
+        return if options.timeout.negative?
+
+        Process.clock_gettime(Process::CLOCK_MONOTONIC) + options.timeout
+      end
+
+      def get_timeout deadline
+        return if deadline.nil?
+        deadline - Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      end
     end
   end
 end

data/lib/gapic/rest/faraday_middleware.rb

@@ -18,22 +18,43 @@ module Gapic
     # Registers the middleware with Faraday
     module FaradayMiddleware
       ##
+      # @private
       # Request middleware that constructs the Authorization HTTP header
       # using ::Google::Auth::Credentials
       #
       class GoogleAuthorization < Faraday::Middleware
         ##
+        # @private
         # @param app [#call]
-        # @param credentials [::Google::Auth::Credentials]
+        # @param credentials [Google::Auth::Credentials, Signet::OAuth2::Client, Symbol, Proc]
+        #   Provides the means for authenticating requests made by
+        #   the client. This parameter can be many types:
+        #   * A `Google::Auth::Credentials` uses a the properties of its represented keyfile for authenticating requests
+        #     made by this client.
+        #   * A `Signet::OAuth2::Client` object used to apply the OAuth credentials.
+        #   * A `Proc` will be used as an updater_proc for the auth token.
+        #   * A `Symbol` is treated as a signal that authentication is not required.
+        #
         def initialize app, credentials
-          @credentials = credentials
+          @updater_proc = case credentials
+                          when Symbol
+                            credentials
+                          else
+                            updater_proc = credentials.updater_proc if credentials.respond_to? :updater_proc
+                            updater_proc ||= credentials if credentials.is_a? Proc
+                            raise ArgumentError, "invalid credentials (#{credentials.class})" if updater_proc.nil?
+                            updater_proc
+                          end
           super app
         end
 
+        # @private
         # @param env [Faraday::Env]
         def call env
-          auth_hash = @credentials.client.apply({})
-          env.request_headers["Authorization"] = auth_hash[:authorization]
+          unless @updater_proc.is_a? Symbol
+            auth_hash = @updater_proc.call({})
+            env.request_headers["Authorization"] = auth_hash[:authorization]
+          end
 
           @app.call env
         end

data/lib/gapic/rest/grpc_transcoder/http_binding.rb

@@ -15,6 +15,7 @@
 module Gapic
   module Rest
     class GrpcTranscoder
+      ##
       # @private
       # A single binding for GRPC-REST transcoding of a request
       # It includes a uri template with bound field parameters, a HTTP method type,
@@ -25,7 +26,8 @@ module Gapic
       # @attribute [r] template
       #   @return [String] The URI template for the request.
       # @attribute [r] field_bindings
-      #   @return [Array<FieldBinding>] The field bindings for the URI template variables.
+      #   @return [Array<Gapic::Rest::GrpcTranscoder::HttpBinding::FieldBinding>]
+      #     The field bindings for the URI template variables.
       # @attribute [r] body
       #   @return [String] The body template for the request.
       class HttpBinding
@@ -41,6 +43,57 @@ module Gapic
           @body = body
         end
 
+        ##
+        # @private
+        # Creates a new HttpBinding.
+        #
+        # @param uri_method [Symbol] The rest verb for the binding.
+        # @param uri_template [String] The string with uri template for the binding.
+        #   This string will be expanded with the parameters from variable bindings.
+        # @param matches [Array<Array>] Variable bindings in an array. Every element
+        #   of the array is an [Array] triplet, where:
+        #   - the first element is a [String] field path (e.g. `foo.bar`) in the request
+        #     to bind to
+        #   - the second element is a [Regexp] to match the field value
+        #   - the third element is a [Boolean] whether the slashes in the field value
+        #     should be preserved (as opposed to escaped) when expanding the uri template.
+        # @param body [String, Nil] The body template, e.g. `*` or a field path.
+        #
+        # @return [Gapic::Rest::GrpcTranscoder::HttpBinding] The new binding.
+        def self.create_with_validation uri_method:, uri_template:, matches: [], body: nil
+          template = uri_template
+
+          matches.each do |name, _regex, _preserve_slashes|
+            unless uri_template =~ /({#{Regexp.quote name}})/
+              err_msg = "Binding configuration is incorrect: missing parameter in the URI template.\n" \
+                        "Parameter `#{name}` is specified for matching but there is no corresponding parameter " \
+                        "`{#{name}}` in the URI template."
+              raise ::Gapic::Common::Error, err_msg
+            end
+
+            template = template.gsub "{#{name}}", ""
+          end
+
+          if template =~ /{([a-zA-Z_.]+)}/
+            err_name = Regexp.last_match[1]
+            err_msg = "Binding configuration is incorrect: missing match configuration.\n" \
+                      "Parameter `{#{err_name}}` is specified in the URI template but there is no " \
+                      "corresponding match configuration for `#{err_name}`."
+            raise ::Gapic::Common::Error, err_msg
+          end
+
+          if body&.include? "."
+            raise ::Gapic::Common::Error,
+                  "Provided body template `#{body}` points to a field in a sub-message. This is not supported."
+          end
+
+          field_bindings = matches.map do |name, regex, preserve_slashes|
+            HttpBinding::FieldBinding.new name, regex, preserve_slashes
+          end
+
+          HttpBinding.new uri_method, uri_template, field_bindings, body
+        end
+
         # A single binding for a field of a request message.
         # @attribute [r] field_path
         #   @return [String] The path of the bound field, e.g. `foo.bar`.

data/lib/gapic/rest/grpc_transcoder.rb

@@ -44,36 +44,11 @@ module Gapic
       #
       # @return [Gapic::Rest::GrpcTranscoder] The updated transcoder.
       def with_bindings uri_method:, uri_template:, matches: [], body: nil
-        template = uri_template
-
-        matches.each do |name, _regex, _preserve_slashes|
-          unless uri_template =~ /({#{Regexp.quote name}})/
-            err_msg = "Binding configuration is incorrect: missing parameter in the URI template.\n" \
-                      "Parameter `#{name}` is specified for matching but there is no corresponding parameter " \
-                      "`{#{name}}` in the URI template."
-            raise ::Gapic::Common::Error, err_msg
-          end
-
-          template = template.gsub "{#{name}}", ""
-        end
-
-        if template =~ /{([a-zA-Z_.]+)}/
-          err_name = Regexp.last_match[1]
-          err_msg = "Binding configuration is incorrect: missing match configuration.\n" \
-                    "Parameter `{#{err_name}}` is specified in the URI template but there is no " \
-                    "corresponding match configuration for `#{err_name}`."
-          raise ::Gapic::Common::Error, err_msg
-        end
-
-        if body&.include? "."
-          raise ::Gapic::Common::Error,
-                "Provided body template `#{body}` points to a field in a sub-message. This is not supported."
-        end
-
-        field_bindings = matches.map do |name, regex, preserve_slashes|
-          HttpBinding::FieldBinding.new name, regex, preserve_slashes
-        end
-        GrpcTranscoder.new @bindings + [HttpBinding.new(uri_method, uri_template, field_bindings, body)]
+        binding = HttpBinding.create_with_validation(uri_method: uri_method,
+                                                     uri_template: uri_template,
+                                                     matches: matches,
+                                                     body: body)
+        GrpcTranscoder.new @bindings + [binding]
       end
 
       ##

data/lib/gapic/rest/threaded_enumerator.rb

@@ -44,6 +44,7 @@ module Gapic
 
         Thread.new do
           yield @in_q, @out_q
+          @out_q.enq nil
         rescue StandardError => e
           @out_q.push e
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gapic-common
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Google API Authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-26 00:00:00.000000000 Z
+date: 2022-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -288,6 +288,7 @@ files:
 - RELEASING.md
 - lib/gapic-common.rb
 - lib/gapic/call_options.rb
+- lib/gapic/call_options/error_codes.rb
 - lib/gapic/call_options/retry_policy.rb
 - lib/gapic/common.rb
 - lib/gapic/common/error.rb