google-cloud-firestore 2.0.0 → 2.4.1

data/lib/google/cloud/firestore/query_listener.rb

@@ -41,17 +41,21 @@ module Google
       #   listener.stop
       #
       class QueryListener
+        include MonitorMixin
         ##
         # @private
         # Creates the watch stream and listener object.
         def initialize query, &callback
+          super() # to init MonitorMixin
+
           @query = query
           raise ArgumentError if @query.nil?
 
           @callback = callback
           raise ArgumentError if @callback.nil?
+          @error_callbacks = []
 
-          @listener = Watch::Listener.for_query query, &callback
+          @listener = Watch::Listener.for_query self, query, &callback
         end
 
         ##
@@ -112,6 +116,83 @@ module Google
         def stopped?
           @listener.stopped?
         end
+
+        ##
+        # Register to be notified of errors when raised.
+        #
+        # If an unhandled error has occurred the listener will attempt to
+        # recover from the error and resume listening.
+        #
+        # Multiple error handlers can be added.
+        #
+        # @yield [callback] The block to be called when an error is raised.
+        # @yieldparam [Exception] error The error raised.
+        #
+        # @example
+        #   require "google/cloud/firestore"
+        #
+        #   firestore = Google::Cloud::Firestore.new
+        #
+        #   # Create a query
+        #   query = firestore.col(:cities).order(:population, :desc)
+        #
+        #   listener = query.listen do |snapshot|
+        #     puts "The query snapshot has #{snapshot.docs.count} documents "
+        #     puts "and has #{snapshot.changes.count} changes."
+        #   end
+        #
+        #   # Register to be notified when unhandled errors occur.
+        #   listener.on_error do |error|
+        #     puts error
+        #   end
+        #
+        #   # When ready, stop the listen operation and close the stream.
+        #   listener.stop
+        #
+        def on_error &block
+          raise ArgumentError, "on_error must be called with a block" unless block_given?
+          synchronize { @error_callbacks << block }
+        end
+
+        ##
+        # The most recent unhandled error to occur while listening for changes.
+        #
+        # If an unhandled error has occurred the listener will attempt to
+        # recover from the error and resume listening.
+        #
+        # @return [Exception, nil] error The most recent error raised.
+        #
+        # @example
+        #   require "google/cloud/firestore"
+        #
+        #   firestore = Google::Cloud::Firestore.new
+        #
+        #   # Create a query
+        #   query = firestore.col(:cities).order(:population, :desc)
+        #
+        #   listener = query.listen do |snapshot|
+        #     puts "The query snapshot has #{snapshot.docs.count} documents "
+        #     puts "and has #{snapshot.changes.count} changes."
+        #   end
+        #
+        #   # If an error was raised, it can be retrieved here:
+        #   listener.last_error #=> nil
+        #
+        #   # When ready, stop the listen operation and close the stream.
+        #   listener.stop
+        #
+        def last_error
+          synchronize { @last_error }
+        end
+
+        # @private Pass the error to user-provided error callbacks.
+        def error! error
+          error_callbacks = synchronize do
+            @last_error = error
+            @error_callbacks.dup
+          end
+          error_callbacks.each { |error_callback| error_callback.call error }
+        end
       end
     end
   end

data/lib/google/cloud/firestore/transaction.rb

@@ -321,7 +321,7 @@ module Google
 
           doc_path = coalesce_doc_path_argument doc
 
-          @writes << Convert.writes_for_create(doc_path, data)
+          @writes << Convert.write_for_create(doc_path, data)
 
           nil
         end
@@ -422,7 +422,7 @@ module Google
 
           doc_path = coalesce_doc_path_argument doc
 
-          @writes << Convert.writes_for_set(doc_path, data, merge: merge)
+          @writes << Convert.write_for_set(doc_path, data, merge: merge)
 
           nil
         end
@@ -526,8 +526,8 @@ module Google
 
           doc_path = coalesce_doc_path_argument doc
 
-          @writes << Convert.writes_for_update(doc_path, data,
-                                               update_time: update_time)
+          @writes << Convert.write_for_update(doc_path, data,
+                                              update_time: update_time)
 
           nil
         end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Firestore
-      VERSION = "2.0.0".freeze
+      VERSION = "2.4.1".freeze
     end
   end
 end

data/lib/google/cloud/firestore/watch/inventory.rb

@@ -127,6 +127,8 @@ module Google
           end
 
           def current_docs
+            # Reverse the results for Query#limit_to_last queries since that method reversed the order_by directions.
+            return @tree.keys.reverse if @query&.limit_type == :last
             @tree.keys
           end
 

data/lib/google/cloud/firestore/watch/listener.rb

@@ -30,7 +30,7 @@ module Google
         class Listener
           include MonitorMixin
 
-          def self.for_doc_ref doc_ref, &callback
+          def self.for_doc_ref parent, doc_ref, &callback
             raise ArgumentError if doc_ref.nil?
             raise ArgumentError if callback.nil?
 
@@ -44,10 +44,10 @@ module Google
               )
             )
 
-            new nil, doc_ref, doc_ref.client, init_listen_req, &callback
+            new parent, nil, doc_ref, doc_ref.client, init_listen_req, &callback
           end
 
-          def self.for_query query, &callback
+          def self.for_query parent, query, &callback
             raise ArgumentError if query.nil?
             raise ArgumentError if callback.nil?
 
@@ -61,12 +61,13 @@ module Google
               )
             )
 
-            new query, nil, query.client, init_listen_req, &callback
+            new parent, query, nil, query.client, init_listen_req, &callback
           end
 
-          def initialize query, doc_ref, client, init_listen_req, &callback
+          def initialize parent, query, doc_ref, client, init_listen_req, &callback
             super() # to init MonitorMixin
 
+            @parent = parent
             @query = query
             @doc_ref = doc_ref
             @client = client
@@ -119,6 +120,8 @@ module Google
 
           def send_callback query_snp
             @callback.call query_snp
+          rescue StandardError => e
+            @parent.error! e
           end
 
           def start_listening!
@@ -270,25 +273,29 @@ module Google
             @request_queue.push self
           rescue GRPC::Cancelled, GRPC::DeadlineExceeded, GRPC::Internal,
                  GRPC::ResourceExhausted, GRPC::Unauthenticated,
-                 GRPC::Unavailable, GRPC::Core::CallError
+                 GRPC::Unavailable, GRPC::Core::CallError => e
             # Restart the stream with an incremental back for a retriable error.
             # Also when GRPC raises the internal CallError.
 
-            # Re-raise if retried more than the max
-            raise err if @backoff[:current] > @backoff[:max]
-
-            # Sleep with incremental backoff before restarting
-            sleep @backoff[:delay]
+            # Raise if retried more than the max
+            if @backoff[:current] > @backoff[:max]
+              @parent.error! e
+              raise e
+            else
+              # Sleep with incremental backoff before restarting
+              sleep @backoff[:delay]
 
-            # Update increment backoff delay and retry counter
-            @backoff[:delay] *= @backoff[:mod]
-            @backoff[:current] += 1
+              # Update increment backoff delay and retry counter
+              @backoff[:delay] *= @backoff[:mod]
+              @backoff[:current] += 1
 
-            retry
+              retry
+            end
           rescue RestartStream
             retry
           rescue StandardError => e
-            raise Google::Cloud::Error.from_error(e)
+            @parent.error! e
+            raise e
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Google Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2021-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -269,7 +269,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 Firestore API