google-cloud-firestore 2.11.0 → 2.13.0

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

@@ -0,0 +1,80 @@
+# Copyright 2023 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 Google
+  module Cloud
+    module Firestore
+      ##
+      # @private Implements 5/5/5 ramp-up via Token Bucket algorithm.
+      #
+      # 5/5/5 is a ramp up strategy that starts with a budget of 500 operations per
+      # second. Additionally, every 5 minutes, the maximum budget can increase by
+      # 50%. Thus, at 5:01 into a long bulk-writing process, the maximum budget
+      # becomes 750 operations per second. At 10:01, the budget becomes 1,125
+      # operations per second.
+      #
+      class RateLimiter
+        DEFAULT_STARTING_MAXIMUM_OPS_PER_SECOND = 500.0
+        DEFAULT_PHASE_LENGTH = 300.0
+
+        attr_reader :bandwidth
+
+        ##
+        # Initialize the object
+        def initialize starting_ops: nil, phase_length: nil
+          @start_time = time
+          @last_fetched = time
+          @bandwidth = (starting_ops || DEFAULT_STARTING_MAXIMUM_OPS_PER_SECOND).to_f
+          @phase_length = phase_length || DEFAULT_PHASE_LENGTH
+        end
+
+        ##
+        # Wait till the number of tokens is available
+        # Assumes that the bandwidth is distributed evenly across the entire second.
+        #
+        # Example - If the limit is 500 qps, then it has been further broken down to 2e+6 nsec
+        # per query
+        #
+        # @return [nil]
+        def wait_for_tokens size
+          available_time = @last_fetched + (size / @bandwidth)
+          waiting_time = [0, available_time - time].max
+          sleep waiting_time
+          @last_fetched = time
+          increase_bandwidth
+        end
+
+        private
+
+        ##
+        # Returns time elapsed since epoch.
+        #
+        # @return [Float] Float denoting time elapsed since epoch
+        def time
+          Time.now.to_f
+        end
+
+        ##
+        # Increase the bandwidth as per 555 rule
+        #
+        # @return [nil]
+        def increase_bandwidth
+          intervals = (time - @start_time) / @phase_length
+          @bandwidth = (DEFAULT_STARTING_MAXIMUM_OPS_PER_SECOND * (1.5**intervals.floor)).to_f
+        end
+      end
+    end
+  end
+end

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

@@ -186,6 +186,18 @@ module Google
           )
         end
 
+        ##
+        # Makes the BatchWrite API call. Contains the list of write operations to be processed.
+        #
+        # @return [::Google::Cloud::Firestore::V1::BatchWriteResponse]
+        def batch_write writes
+          batch_write_req = {
+            database: database_path,
+            writes: writes
+          }
+          firestore.batch_write batch_write_req, call_options(parent: database_path)
+        end
+
         def database_path project_id: project, database_id: database
           # Originally used V1::FirestoreClient.database_root_path until it was removed in #5405.
           "projects/#{project_id}/databases/#{database_id}"

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 2.13.0
 platform: ruby
 authors:
 - Google Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-02-23 00:00:00.000000000 Z
+date: 2023-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -228,6 +228,11 @@ files:
 - lib/google/cloud/firestore/aggregate_query.rb
 - lib/google/cloud/firestore/aggregate_query_snapshot.rb
 - lib/google/cloud/firestore/batch.rb
+- lib/google/cloud/firestore/bulk_commit_batch.rb
+- lib/google/cloud/firestore/bulk_writer.rb
+- lib/google/cloud/firestore/bulk_writer_exception.rb
+- lib/google/cloud/firestore/bulk_writer_operation.rb
+- lib/google/cloud/firestore/bulk_writer_scheduler.rb
 - lib/google/cloud/firestore/client.rb
 - lib/google/cloud/firestore/collection_group.rb
 - lib/google/cloud/firestore/collection_reference.rb
@@ -240,13 +245,17 @@ files:
 - lib/google/cloud/firestore/document_reference.rb
 - lib/google/cloud/firestore/document_reference/list.rb
 - lib/google/cloud/firestore/document_snapshot.rb
+- lib/google/cloud/firestore/errors.rb
 - lib/google/cloud/firestore/field_path.rb
 - lib/google/cloud/firestore/field_value.rb
+- lib/google/cloud/firestore/filter.rb
 - lib/google/cloud/firestore/generate.rb
+- lib/google/cloud/firestore/promise/future.rb
 - lib/google/cloud/firestore/query.rb
 - lib/google/cloud/firestore/query_listener.rb
 - lib/google/cloud/firestore/query_partition.rb
 - lib/google/cloud/firestore/query_snapshot.rb
+- lib/google/cloud/firestore/rate_limiter.rb
 - lib/google/cloud/firestore/resource_path.rb
 - lib/google/cloud/firestore/service.rb
 - lib/google/cloud/firestore/transaction.rb