google-cloud-spanner 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7eb1575c3244eb459d8379345e2dea6f19c925bbeb526ff969aa07a34428c94
-  data.tar.gz: 9c8c0b2d99074ec99ff38125ccbf89713f0d7c5441445650b96b5a969b09629a
+  metadata.gz: 01dd371ff37296529b691fd13961d7e7681e63480a88202b9e958a8c28bc480b
+  data.tar.gz: 9915fdf52be7508c55380b193a9586a35c702617080d3bf93a9f53b37b62be84
 SHA512:
-  metadata.gz: ba900cc5a539d55baead3d8825472b05b40ab19adc3062dfb93c7cf1713805b9619c2cbd7b115f3e2e61f79371e4c53eb8a225f8cd1f7a3dc1c30f72e1590cc7
-  data.tar.gz: 1639fd79b6bd30af238b2d002852bec94e4f29aa581594758169180e15e6b335f86c5a6cac1fa9a13a7fef02edc105ea46eb4867a02c59bf0a069c142d8799e2
+  metadata.gz: 0a34c4eeaaf84abe4d311350a155b22190c7dbc426a48719df4ad553692d841aa1a2d3a72d7f043b2fef7b3fa87a81cda69f965f5eef58a8ce17a77bf186a48e
+  data.tar.gz: 36062397079b8960916575b9188c0ad10f376d27b7d194a20e7f4c6e69f29eeb018b499576209bf1b2d2985725233db5de3e233ff840b5c93790d15b9b4204ab

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Release History
 
+### 2.2.0 / 2020-09-15
+
+#### Features
+
+* quota_project can be set via library configuration
+* Support numeric type.
+
+#### Bug Fixes
+
+* retry or resume eos and rst_stream errors
+
 ### 2.1.0 / 2020-08-05
 
 #### Features

data/lib/google-cloud-spanner.rb

@@ -174,6 +174,7 @@ Google::Cloud.configure.add_config! :spanner do |config|
                     allow_nil: true
   config.add_alias! :keyfile, :credentials
   config.add_field! :scope, default_scopes, match: [String, Array]
+  config.add_field! :quota_project, nil, match: String
   config.add_field! :timeout, nil, match: Integer
   config.add_field! :endpoint, "spanner.googleapis.com", match: String
   config.add_field! :emulator_host, default_emulator, match: String, allow_nil: true

data/lib/google/cloud/spanner/convert.rb

@@ -17,6 +17,7 @@ require "time"
 require "date"
 require "stringio"
 require "base64"
+require "bigdecimal"
 require "google/cloud/spanner/data"
 
 module Google
@@ -67,6 +68,9 @@ module Google
               Google::Protobuf::Value.new bool_value: false
             when Integer
               Google::Protobuf::Value.new string_value: obj.to_s
+            # BigDecimal must be put before Numeric.
+            when BigDecimal
+              Google::Protobuf::Value.new string_value: obj.to_s("F")
             when Numeric
               if obj == Float::INFINITY
                 Google::Protobuf::Value.new string_value: "Infinity"
@@ -125,6 +129,9 @@ module Google
               :BOOL
             when Integer
               :INT64
+            # BigDecimal must be put before Numeric.
+            when BigDecimal
+              :NUMERIC
             when Numeric
               :FLOAT64
             when Time
@@ -214,6 +221,8 @@ module Google
               end
             when :STRUCT
               Data.from_grpc value.list_value.values, type.struct_type.fields
+            when :NUMERIC
+              BigDecimal value.string_value
             end
           end
 

data/lib/google/cloud/spanner/results.rb

@@ -41,6 +41,8 @@ module Google
       #   end
       #
       class Results
+        RST_STREAM_INTERNAL_ERROR = "Received RST_STREAM".freeze
+        EOS_INTERNAL_ERROR = "Received unexpected EOS on DATA frame from server".freeze
         ##
         # The read timestamp chosen for single-use snapshots (read-only
         # transactions).
@@ -107,12 +109,24 @@ module Google
           buffer_upper_bound = 10
           chunked_value = nil
           resume_token = nil
+          should_resume_request = false
+          should_retry_request = false
 
           # Cannot call Enumerator#each because it won't return the first
           # value that was already identified when calling Enumerator#peek.
           # Iterate only using Enumerator#next and break on StopIteration.
           loop do
             begin
+              if should_resume_request
+                @enum = resume_request(resume_token)
+                buffered_responses = []
+                should_resume_request = false
+              elsif should_retry_request
+                @enum = retry_request()
+                buffered_responses = []
+                should_retry_request = false
+              end
+
               grpc = @enum.next
               # metadata should be set before the first iteration...
               @metadata ||= grpc.metadata
@@ -143,28 +157,36 @@ module Google
                 # Flush the buffered responses now that they are all handled
                 buffered_responses = []
               end
-            rescue GRPC::Cancelled, GRPC::DeadlineExceeded, GRPC::Internal,
-                   GRPC::ResourceExhausted, GRPC::Unauthenticated,
-                   GRPC::Unavailable, GRPC::Core::CallError => err
-              if resume_token.nil? || resume_token.empty?
-                # Re-raise if the resume_token is not a valid value.
-                # This can happen if the buffer was flushed.
-                raise Google::Cloud::Error.from_error(err)
-              end
+            # TODO: once the generated client throws only Google Cloud errors, remove
+            # the GRPC errors from the rescue block
+            rescue GRPC::Aborted,
+              GRPC::Cancelled,
+              GRPC::DeadlineExceeded,
+              GRPC::Internal,
+              GRPC::ResourceExhausted,
+              GRPC::Unauthenticated,
+              GRPC::Unavailable,
+              GRPC::Core::CallError,
+              Google::Cloud::AbortedError,
+              Google::Cloud::CanceledError,
+              Google::Cloud::DeadlineExceededError,
+              Google::Cloud::InternalError,
+              Google::Cloud::ResourceExhaustedError,
+              Google::Cloud::UnauthenticatedError,
+              Google::Cloud::UnavailableError => err
 
-              # Resume the stream from the last known resume_token
-              if @execute_query_options
-                @enum = @service.execute_streaming_sql \
-                  @session_path, @sql,
-                  @execute_query_options.merge(resume_token: resume_token)
+              if resumable?(resume_token)
+                should_resume_request = true
+              elsif retryable?(err)
+                should_retry_request = true
+              elsif err.is_a?(Google::Cloud::Error)
+                raise err
               else
-                @enum = @service.streaming_read_table \
-                  @session_path, @table, @columns,
-                  @read_options.merge(resume_token: resume_token)
+                raise Google::Cloud::Error.from_error(err)
               end
 
-              # Flush the buffered responses to reset to the resume_token
-              buffered_responses = []
+            # TODO: once the generated client throws only Google Cloud errors, remove
+            # this rescue block (for GRPC::BadStatus)
             rescue GRPC::BadStatus => err
               raise Google::Cloud::Error.from_error(err)
             rescue StopIteration
@@ -198,6 +220,60 @@ module Google
 
         # rubocop:enable all
 
+        ##
+        # @private
+        # Checks if a request can be resumed by inspecting the resume token
+        def resumable? resume_token
+          resume_token && !resume_token.empty?
+        end
+
+        ##
+        # @private
+        # Checks if a request can be retried. This is based on the error returned.
+        # Retryable errors are:
+        #   - Unavailable error
+        #   - Internal EOS error
+        #   - Internal RST_STREAM error
+        def retryable? err
+          err.instance_of?(Google::Cloud::UnavailableError) ||
+            err.instance_of?(GRPC::Unavailable) ||
+            (err.instance_of?(Google::Cloud::InternalError) && err.message.include?(EOS_INTERNAL_ERROR)) ||
+            (err.instance_of?(GRPC::Internal) && err.details.include?(EOS_INTERNAL_ERROR)) ||
+            (err.instance_of?(Google::Cloud::InternalError) && err.message.include?(RST_STREAM_INTERNAL_ERROR)) ||
+            (err.instance_of?(GRPC::Internal) && err.details.include?(RST_STREAM_INTERNAL_ERROR))
+        end
+
+        ##
+        # @private
+        # Resumes a request, by re-executing it with a resume token.
+        def resume_request resume_token
+          if @execute_query_options
+            @service.execute_streaming_sql(
+              @session_path,
+              @sql,
+              @execute_query_options.merge(resume_token: resume_token)
+            )
+          else
+            @service.streaming_read_table(
+              @session_path,
+              @table,
+              @columns,
+              @read_options.merge(resume_token: resume_token)
+            )
+          end
+        end
+
+        ##
+        # @private
+        # Retries a request, by re-executing it from scratch.
+        def retry_request
+          if @execute_query_options
+            @service.execute_streaming_sql @session_path, @sql, @execute_query_options
+          else
+            @service.streaming_read_table @session_path, @table, @columns, @read_options
+          end
+        end
+
         ##
         # @private
         # Get row count from stats. This will be the exact row count for DML

data/lib/google/cloud/spanner/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Spanner
-      VERSION = "2.1.0".freeze
+      VERSION = "2.2.0".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-spanner
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2020-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -329,7 +329,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Spanner API