activemodel-datastore 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3126172160a1df49727e648493401c8448f62a1442cba738dcf139d6406dfdce
-  data.tar.gz: 24bc7d6985f16739f16561611255d23ac6862cd72502f50827462a3c0674e6aa
+  metadata.gz: 62ccc081e2437c2c1ca324b12a78f888cb14bf5fb0d6cabe8ebee0c1089f3807
+  data.tar.gz: 5def43f01da73999c34f0f2a6bc66ead4249eda5df08281dd552da42856b0fea
 SHA512:
-  metadata.gz: bc4e6401b2932e11c37b509dc1f98561423b6908d0d11f0465363090239a67ae6f7dc02cc5aecedc6fb72e4e8168f44a6ddc9fe38d49665fc6fc95838e0144a8
-  data.tar.gz: 7acf7b5d14306afb3412c7ac667806e05708de0b9a8e8348b172bafa337316f4b11160f68eee3bb1152e27d7fa6ae066d4d28e17f430365b6caf003a3dfdbd1c
+  metadata.gz: 03f469254125d0dc7184395103cdea93648f0551e5a1289721ec5fe2dc382d0ccdf906087734875cfc8e79c815f51be766ab917d76cb2fdd9cde69e5858e1308
+  data.tar.gz: 71473fab63f1e02a4472db2a3c828492d1a23fddde05ca45aa275e9037a63cf252dc53140e93ac9bf5bc354a5fa38d549fec5d2c64565cb9f7fc0e7bfd05c896

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.10.0 / 2026-09-22
+* stop retrying invalid argument errors
+* make read retry counts configurable independently of writes
+* log a warning when a retry chain gives up, including its attempt count
+
 ### 0.9.0 / 2026-08-24
 * identify the Datastore operation, entity kind, and failed-attempt elapsed time in retry logs
 * use a configurable retry logger that defaults to Rails.logger and falls back to standard output

data/README.md

@@ -89,6 +89,15 @@ configure it during application initialization:
 ActiveModel::Datastore.logger = MyApplication.logger
 ```
 
+To change the gem's read retry count (default: `5`), configure it during initialization:
+
+```ruby
+ActiveModel::Datastore.read_retry_count = 2
+```
+
+Set it to `0` to disable read retries. Write retry counts are unchanged. Invalid argument errors
+are never retried.
+
 There is an example Puma config file [here](https://github.com/Agrimatics/activemodel-datastore/blob/main/test/support/datastore_example_rails_app/config/puma.rb).
  
 ## <a name="model"></a>Model Example

data/lib/active_model/datastore/version.rb

@@ -1,5 +1,5 @@
 module ActiveModel
   module Datastore
-    VERSION = '0.9.0'
+    VERSION = '0.10.0'
   end
 end

data/lib/active_model/datastore.rb

@@ -127,8 +127,17 @@ module ActiveModel::Datastore
     @logger = logger
   end
 
+  def self.read_retry_count
+    @read_retry_count || 5
+  end
+
+  def self.read_retry_count=(count)
+    @read_retry_count = count
+  end
+
   included do
-    private_class_method :query_options, :query_sort, :query_property_filter, :find_all_entities
+    private_class_method :query_options, :query_sort, :query_property_filter, :find_all_entities,
+                         :retry_read, :log_retry_failure
     define_model_callbacks :save, :update, :destroy
     attr_accessor :id, :parent_key_id, :entity_property_values
   end
@@ -239,7 +248,7 @@ module ActiveModel::Datastore
     def find_entity(id_or_name, parent = nil)
       key = CloudDatastore.dataset.key name, id_or_name
       key.parent = parent if parent.present?
-      retry_on_exception(operation: 'find') { CloudDatastore.dataset.find key }
+      retry_read('find') { CloudDatastore.dataset.find key }
     end
 
     ##
@@ -300,9 +309,7 @@ module ActiveModel::Datastore
     def all(options = {})
       next_cursor = nil
       query = build_query(options)
-      query_results = retry_on_exception(operation: 'run query') do
-        CloudDatastore.dataset.run query
-      end
+      query_results = retry_read('run query') { CloudDatastore.dataset.run query }
       if options[:limit]
         next_cursor = query_results.cursor if query_results.size == options[:limit]
         return from_entities(query_results.all), next_cursor
@@ -354,9 +361,7 @@ module ActiveModel::Datastore
       query.ancestor(args[:ancestor]) if args[:ancestor]
       query.limit(1)
       query.where(args.keys[0].to_s, '=', args.values[0])
-      query_results = retry_on_exception(operation: 'run query') do
-        CloudDatastore.dataset.run query
-      end
+      query_results = retry_read('run query') { CloudDatastore.dataset.run query }
       from_entity(query_results.first)
     end
 
@@ -421,16 +426,12 @@ module ActiveModel::Datastore
         started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC) if operation
         yield
       rescue Google::Cloud::Error => e
-        return false if retries >= max_retry_count
+        giving_up = e.is_a?(Google::Cloud::InvalidArgumentError) || retries >= max_retry_count
+        ending = "retrying in #{sleep_time}#{' s' if operation}"
+        ending = "giving up after #{retries + 1} attempts" if giving_up
+        log_retry_failure(e, ending, operation: operation, kind: kind, started_at: started_at)
+        return false if giving_up
 
-        if operation
-          elapsed_ms = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at) * 1000).round
-          message = "\e[33mDatastore #{operation} failed for #{kind} after #{elapsed_ms} ms: " \
-                    "#{e.message.inspect}; retrying in #{sleep_time} s\e[0m"
-        else
-          message = "\e[33mRescued exception #{e.message.inspect}, retrying in #{sleep_time}\e[0m"
-        end
-        ActiveModel::Datastore.logger ? ActiveModel::Datastore.logger.warn(message) : puts(message)
         # 0.25, 0.5, 1, 2, and 4 second between retries.
         sleep sleep_time
         retries += 1
@@ -446,16 +447,12 @@ module ActiveModel::Datastore
         started_at = Process.clock_gettime(Process::CLOCK_MONOTONIC) if operation
         yield
       rescue Google::Cloud::Error => e
-        raise e if retries >= max_retry_count
+        giving_up = e.is_a?(Google::Cloud::InvalidArgumentError) || retries >= max_retry_count
+        ending = "retrying in #{sleep_time}#{' s' if operation}"
+        ending = "giving up after #{retries + 1} attempts" if giving_up
+        log_retry_failure(e, ending, operation: operation, kind: kind, started_at: started_at)
+        raise if giving_up
 
-        if operation
-          elapsed_ms = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at) * 1000).round
-          message = "\e[33mDatastore #{operation} failed for #{kind} after #{elapsed_ms} ms: " \
-                    "#{e.message.inspect}; retrying in #{sleep_time} s\e[0m"
-        else
-          message = "\e[33mRescued exception #{e.message.inspect}, retrying in #{sleep_time}\e[0m"
-        end
-        ActiveModel::Datastore.logger ? ActiveModel::Datastore.logger.warn(message) : puts(message)
         # 0.25, 0.5, 1, 2, and 4 second between retries.
         sleep sleep_time
         retries += 1
@@ -473,6 +470,21 @@ module ActiveModel::Datastore
 
     # **************** private ****************
 
+    def log_retry_failure(error, ending, operation:, kind:, started_at:)
+      if operation
+        elapsed_ms = ((Process.clock_gettime(Process::CLOCK_MONOTONIC) - started_at) * 1000).round
+        message = "\e[33mDatastore #{operation} failed for #{kind} after #{elapsed_ms} ms: " \
+                  "#{error.message.inspect}; #{ending}\e[0m"
+      else
+        message = "\e[33mRescued exception #{error.message.inspect}, #{ending}\e[0m"
+      end
+      ActiveModel::Datastore.logger ? ActiveModel::Datastore.logger.warn(message) : puts(message)
+    end
+
+    def retry_read(operation, &block)
+      retry_on_exception(ActiveModel::Datastore.read_retry_count, operation: operation, &block)
+    end
+
     def query_options(query, options)
       query.ancestor(options[:ancestor]) if options[:ancestor]
       query.cursor(options[:cursor]) if options[:cursor]
@@ -521,7 +533,7 @@ module ActiveModel::Datastore
     def find_all_entities(ids_or_names, parent)
       keys = ids_or_names.map { |id| CloudDatastore.dataset.key name, id }
       keys.map { |key| key.parent = parent } if parent.present?
-      retry_on_exception(operation: 'find all') { CloudDatastore.dataset.find_all keys }
+      retry_read('find all') { CloudDatastore.dataset.find_all keys }
     end
 
     def build_model(entity)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activemodel-datastore
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Bryce McLean