spree_cm_commissioner 2.14.8 → 2.14.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ceb90915f56d7b2621b44c00abe7b65adbdf5093f566d3b801333496c3333402
-  data.tar.gz: 418a9332f9ddf34711f4c251c5c6040388e191efa8f2f8eefc11d12777a6f79a
+  metadata.gz: b5426f6a834611d1c303d1305de10998cea1cd5b6ca72c23f512ddff53614b2a
+  data.tar.gz: cb6688095f5daef9df50906c20d5adb5cba20dc4f2657a430b1d2ab00afaaaf6
 SHA512:
-  metadata.gz: 6ef4fcfc3e0feb5af8d54f06a7321e1369a35b87f625d8465a70edb5c2ac2502e180812ba60fb3d5d081bc746367bcb756e9124416719f73af0143cea86242b6
-  data.tar.gz: 46af2a2e96874f557e5921b671838148b148791a408c0c55b26d7647fb4fc1fc11ea775d25ee5998da402d0f7cac4b00374bb269ee21eaef5edc088bb1053bdd
+  metadata.gz: e609a94743b1283a225d077dad5ba3f775ed599985d687f8b6c4408de286bc6f8b6e91e4024e675ec03ae06a67a013fa43cc6242cc50070a334bc2ac4731e7d0
+  data.tar.gz: d007f4f9a802452c020d32f32f44c466e88469ea24386c87f8b45c834ced740d1faf55185d953901640fd1dd73f19af686667ef9f29e615b97642aadc8645020

data/Gemfile.lock

@@ -34,7 +34,7 @@ GIT
 PATH
   remote: .
   specs:
-    spree_cm_commissioner (2.14.8)
+    spree_cm_commissioner (2.14.9)
       activerecord-multi-tenant
       activerecord_json_validator (~> 2.1, >= 2.1.3)
       aws-sdk-cloudfront

data/app/jobs/concerns/spree_cm_commissioner/idempotent_job.rb

@@ -1,12 +1,13 @@
 module SpreeCmCommissioner
   module IdempotentJob
-    def with_idempotency(key = nil, &block)
-      SpreeCmCommissioner::IdempotencyKey.run_once(key.presence || default_idempotency_key, &block)
-    end
+    # The enqueuer mints one key per side effect being mirrored (e.g. one per Redis change) and
+    # passes it in the job args, so a retry or re-delivery of that job dedups while a genuinely new
+    # change always applies. No fallback: a key derived from the payload made legitimate repeats
+    # (unstock after restock, a re-acquired hold) look like duplicates and silently skipped them.
+    def with_idempotency(key, &block)
+      raise ArgumentError, "#{self.class.name} requires an idempotency_key" if key.blank?
 
-    # Namespaced so the key is self-describing in the DB (no `source` column needed).
-    def default_idempotency_key
-      "#{self.class.name}:#{job_id}"
+      SpreeCmCommissioner::IdempotencyKey.run_once(key, &block)
     end
   end
 end

data/app/jobs/spree_cm_commissioner/inventory_items/bulk_adjust_quantities_job.rb

@@ -6,26 +6,17 @@ module SpreeCmCommissioner
       queue_as :inventory_item
 
       def perform(options = {})
-        with_idempotency(idempotency_key_for(options)) do
+        with_idempotency(options[:idempotency_key]) do
           bulk_adjust_quantities!(options)
         end
       end
 
       private
 
-      # Dedup on the line items being synced, so a re-pushed payload for the same
-      # line items no-ops. An explicit key wins; with no line items we fall back to
-      # the per-enqueue job_id (returning nil lets with_idempotency apply that default).
-      def idempotency_key_for(options)
-        return options[:idempotency_key] if options[:idempotency_key].present?
-        return nil if options[:line_item_ids].blank?
-
-        "line_item:#{options[:line_item_ids].compact.uniq.sort.join(':')}"
-      end
-
-      # :line_item_ids, :inventory_id_and_quantities, :caller_source
+      # :line_item_ids, :inventory_id_and_quantities, :caller_source, :idempotency_key
       #
-      # :caller_source is a string like "ClassName#method" identifying who enqueued the job.
+      # :line_item_ids is for tracing only. :caller_source is a string like "ClassName#method"
+      # identifying who enqueued the job.
       def bulk_adjust_quantities!(options = {})
         SpreeCmCommissioner::InventoryItems::BulkAdjustQuantities.call!(
           inventory_id_and_quantities: options[:inventory_id_and_quantities],

data/app/jobs/spree_cm_commissioner/inventory_items/bulk_adjust_quantities_on_convert_job.rb

@@ -6,33 +6,14 @@ module SpreeCmCommissioner
       queue_as :inventory_item
 
       def perform(options = {})
-        with_idempotency(idempotency_key_for(options)) do
+        with_idempotency(options[:idempotency_key]) do
           bulk_adjust_quantities_on_convert(options)
         end
       end
 
       private
 
-      # Dedup on the order + the exact adjustment set, same shape as BulkAdjustQuantitiesOnHoldJob.
-      # An explicit key wins; with no order_id we fall back to the per-enqueue job_id (returning
-      # nil lets with_idempotency apply that default).
-      def idempotency_key_for(options)
-        return options[:idempotency_key] if options[:idempotency_key].present?
-        return nil if options[:order_id].blank?
-
-        "order:#{options[:order_id]}:convert:#{adjustments_fingerprint(options[:inventory_id_and_quantities])}"
-      end
-
-      # Readable, order-independent fingerprint of the adjustment payload, e.g. "1=2,2=-1:locked".
-      def adjustments_fingerprint(adjustments)
-        Array(adjustments)
-          .map { |adj| adj.with_indifferent_access.values_at(:inventory_id, :quantity, :locked) }
-          .sort_by { |inventory_id, quantity, locked| [inventory_id.to_s, quantity.to_s, locked.to_s] }
-          .map { |inventory_id, quantity, locked| locked ? "#{inventory_id}=#{quantity}:locked" : "#{inventory_id}=#{quantity}" }
-          .join(',')
-      end
-
-      # :order_id, :inventory_id_and_quantities, :caller_source
+      # :order_id, :inventory_id_and_quantities, :caller_source, :idempotency_key
       def bulk_adjust_quantities_on_convert(options = {})
         raise ArgumentError, 'order_id is required' if options[:order_id].blank?
         raise ArgumentError, 'inventory_id_and_quantities is required' if options[:inventory_id_and_quantities].blank?

data/app/jobs/spree_cm_commissioner/inventory_items/bulk_adjust_quantities_on_hold_job.rb

@@ -6,42 +6,16 @@ module SpreeCmCommissioner
       queue_as :inventory_item
 
       def perform(options = {})
-        with_idempotency(idempotency_key_for(options)) do
+        with_idempotency(options[:idempotency_key]) do
           bulk_adjust_quantities_on_hold(options)
         end
       end
 
       private
 
-      # Dedup on the order + the exact adjustment set, so a re-pushed identical
-      # on-hold payload no-ops while a genuinely different one re-applies. An explicit
-      # key wins; with no order_id we fall back to the per-enqueue job_id (returning
-      # nil lets with_idempotency apply that default).
-      def idempotency_key_for(options)
-        return options[:idempotency_key] if options[:idempotency_key].present?
-        return nil if options[:order_id].blank?
-
-        "order:#{options[:order_id]}:hold:#{adjustments_fingerprint(options[:inventory_id_and_quantities])}"
-      end
-
-      # Readable, order-independent fingerprint of the adjustment payload, e.g. "1=2,2=-1:locked".
-      # Delimiter hierarchy: ":" separates key fields, "," separates adjustments, "=" pairs id/qty.
-      #
-      # The pool is part of the identity: a mixed order can carry a public and a locked adjustment
-      # with the same inventory_id and quantity, and without this they fingerprint identically — so
-      # one of the two would be dropped as a duplicate and its counter never mirrored.
-      def adjustments_fingerprint(adjustments)
-        Array(adjustments)
-          .map { |adj| adj.with_indifferent_access.values_at(:inventory_id, :quantity, :locked) }
-          .sort_by { |inventory_id, quantity, locked| [inventory_id.to_s, quantity.to_s, locked.to_s] }
-          .map { |inventory_id, quantity, locked| locked ? "#{inventory_id}=#{quantity}:locked" : "#{inventory_id}=#{quantity}" }
-          .join(',')
-      end
-
-      # :order_id, :inventory_id_and_quantities, :caller_source
+      # :order_id, :inventory_id_and_quantities, :caller_source, :idempotency_key
       #
-      # :order_id is used for unique idempotency key generation to prevent duplicate
-      # processing, though it's not used in the adjustment itself.
+      # :order_id is required for tracing, though it's not used in the adjustment itself.
       # :caller_source is a string like "ClassName#method" identifying who enqueued the job.
       def bulk_adjust_quantities_on_hold(options = {})
         raise ArgumentError, 'order_id is required' if options[:order_id].blank?

data/app/models/concerns/spree_cm_commissioner/firestore_connection.rb

@@ -1,10 +1,11 @@
 require 'google/cloud/firestore'
 
 module SpreeCmCommissioner
-  # Shared Cloud Firestore client construction, used across the waiting-room services (see
-  # WaitingRoom::Admission::CallGuests, WaitingRoom::Positions::Stamp,
-  # WaitingRoom::Sessions::Issue) plus a #firestore_available? guard so environments without the
-  # credential (dev, test, CI) no-op instead of raising on connect.
+  # Cloud Firestore access for services (see WaitingRoom::Admission::CallGuests,
+  # WaitingRoom::Positions::Stamp, WaitingRoom::Sessions::Issue) plus a #firestore_available?
+  # guard so environments without the credential (dev, test, CI) no-op instead of raising on
+  # connect. The client comes from FirestoreClients, shared per process and per project; a service
+  # for another Firebase project overrides #service_account.
   module FirestoreConnection
     extend ActiveSupport::Concern
 
@@ -13,14 +14,11 @@ module SpreeCmCommissioner
     end
 
     def firestore
-      @firestore ||= Google::Cloud::Firestore.new(
-        project_id: service_account[:project_id],
-        credentials: service_account
-      )
+      @firestore ||= SpreeCmCommissioner::FirestoreClients.fetch(service_account)
     end
 
     def service_account
-      @service_account ||= Rails.application.credentials.cloud_firestore_service_account
+      @service_account ||= SpreeCmCommissioner::FirestoreClients.default_service_account
     end
   end
 end

data/app/models/spree_cm_commissioner/inventory_hold.rb

@@ -23,6 +23,11 @@ module SpreeCmCommissioner
 
     store_public_metadata :total_quantity_on_hold, :integer
 
+    # The DB sync for this acquisition (see InventoryHolds::Acquire), kept so a re-entry can re-send
+    # it under the same ledger key when the original enqueue never happened.
+    store_private_metadata :on_hold_sync_idempotency_key, :string
+    store_private_metadata :on_hold_sync_payload, :array
+
     def finalized?
       converted? || released?
     end

data/app/services/spree_cm_commissioner/inventory_holds/acquire.rb

@@ -33,7 +33,10 @@ module SpreeCmCommissioner
           hold = acquire_hold_for_order!(order, line_items, expires_at)
 
           enqueue_release_job(hold)
-          enqueue_sync_inventory_on_hold(order)
+          # Re-sent on every call, including re-entry with an existing hold: if this enqueue failed
+          # after the hold committed, the retry recovers it. The key stored with the acquisition makes
+          # a repeat a no-op in the ledger once the sync has applied.
+          enqueue_sync_inventory_on_hold(hold)
 
           CmAppLogger.log(
             label: "#{self.class.name}#call success",
@@ -88,7 +91,11 @@ module SpreeCmCommissioner
               payment_locked_at: nil,
               release_reason: nil,
               total_quantity_on_hold: line_items.sum(&:quantity),
-              ip_address: order.last_ip_address
+              ip_address: order.last_ip_address,
+              # Saved in the same transaction as the Redis reservation, so the DB sync for exactly
+              # this acquisition can be re-sent later without inventing a new key or payload.
+              on_hold_sync_idempotency_key: SecureRandom.uuid,
+              on_hold_sync_payload: on_hold_sync_payload(line_items)
             )
 
             hold.save!
@@ -107,6 +114,15 @@ module SpreeCmCommissioner
         end
       end
 
+      # Same line items and active inventory items that acquire_redis_stock! reserves.
+      def on_hold_sync_payload(line_items)
+        line_items.flat_map do |line_item|
+          line_item.inventory_items.active.map do |inventory_item|
+            { inventory_id: inventory_item.id, quantity: line_item.quantity, locked: line_item.locked_stock? }
+          end
+        end
+      end
+
       def acquire_redis_stock!(line_items)
         stock_keys = []
         hold_keys = []
@@ -146,25 +162,20 @@ module SpreeCmCommissioner
         SpreeCmCommissioner::InventoryHolds::ReleaseJob.set(wait_until: hold.expires_at).perform_later(hold_id: hold.id)
       end
 
-      def enqueue_sync_inventory_on_hold(order)
-        inventory_id_and_quantities = order.line_items.flat_map do |line_item|
-          next [] unless line_item.should_hold_inventory?
-
-          line_item.inventory_items.active.map do |inventory_item|
-            {
-              inventory_id: inventory_item.id,
-              quantity: line_item.quantity,
-              locked: line_item.locked_stock?
-            }
-          end
-        end
+      def enqueue_sync_inventory_on_hold(hold)
+        key = hold.on_hold_sync_idempotency_key
+        payload = hold.on_hold_sync_payload
 
-        return if inventory_id_and_quantities.blank?
+        # Holds acquired before the sync event was stored carry neither; their sync was sent when they
+        # were acquired.
+        return if key.blank? || payload.blank?
 
         SpreeCmCommissioner::InventoryItems::BulkAdjustQuantitiesOnHoldJob.perform_later(
-          order_id: order.id,
+          order_id: hold.order_id,
+          idempotency_key: key,
           caller_source: "#{self.class.name}#enqueue_sync_inventory_on_hold",
-          inventory_id_and_quantities: inventory_id_and_quantities
+          # Read back from jsonb with string keys; BulkAdjustQuantitiesOnHold reads symbol keys.
+          inventory_id_and_quantities: payload.map(&:symbolize_keys)
         )
       end
 

data/app/services/spree_cm_commissioner/inventory_holds/convert.rb

@@ -123,6 +123,7 @@ module SpreeCmCommissioner
 
         SpreeCmCommissioner::InventoryItems::BulkAdjustQuantitiesOnConvertJob.perform_later(
           order_id: order.id,
+          idempotency_key: SecureRandom.uuid,
           caller_source: "#{self.class.name}#enqueue_sync_inventory",
           inventory_id_and_quantities: adjustments
         )

data/app/services/spree_cm_commissioner/inventory_holds/release.rb

@@ -128,6 +128,7 @@ module SpreeCmCommissioner
 
         SpreeCmCommissioner::InventoryItems::BulkAdjustQuantitiesOnHoldJob.perform_later(
           order_id: order.id,
+          idempotency_key: SecureRandom.uuid,
           caller_source: "#{self.class.name}#enqueue_sync_inventory_on_hold",
           inventory_id_and_quantities: inventory_id_and_quantities
         )

data/app/services/spree_cm_commissioner/queue_draft_orders/publish_status.rb

@@ -1,7 +1,8 @@
 module SpreeCmCommissioner
   module QueueDraftOrders
     # Writes a queue-draft-order status document's current state and appends a `histories` entry
-    # in the same call, so no call site can update one without the other.
+    # in one batch commit, so no call site can update one without the other — and the request
+    # path (QueueDraftOrders::Enqueue) pays a single Firestore round trip, not two.
     #
     # Firestore layout:
     #   statuses/draft_orders/{date}/{document_id}                     — current status + terminal fields
@@ -21,13 +22,12 @@ module SpreeCmCommissioner
 
         now = Time.zone.now
         document = firestore.doc(document_path)
-        document.set(fields.merge(status: status, updated_at: now), merge: true)
-        document.col('histories').add(
-          previous_status: previous_status,
-          next_status: status,
-          message: message,
-          created_at: now
-        )
+        history = document.col('histories').doc
+
+        firestore.batch do |batch|
+          batch.set(document, fields.merge(status: status, updated_at: now), merge: true)
+          batch.create(history, { previous_status: previous_status, next_status: status, message: message, created_at: now })
+        end
 
         success(document_path)
       rescue StandardError => e

data/app/services/spree_cm_commissioner/redis_stock/base.rb

@@ -28,11 +28,17 @@ module SpreeCmCommissioner
         SpreeCmCommissioner::RedisStock::CachedInventoryItemsBuilder.new(inventory_items).call
       end
 
+      # One key per Redis mutation, minted here rather than derived from line_item_ids: the same line
+      # items are legitimately synced several times (unstock on complete, restock on cancel, unstock
+      # again on resume), and a shared key made every sync after the first a silent no-op, leaving
+      # the DB behind Redis until a later sale tripped the quantity_available >= 0 validation.
+      # Carried in the job args, so a retry or re-delivery of this same job still dedups.
       def schedule_sync_inventory(inventory_id_and_quantities)
         SpreeCmCommissioner::InventoryItems::BulkAdjustQuantitiesJob.perform_later(
           inventory_id_and_quantities: inventory_id_and_quantities,
           line_item_ids: @line_item_ids,
-          caller_source: "#{self.class.name}#schedule_sync_inventory"
+          caller_source: "#{self.class.name}#schedule_sync_inventory",
+          idempotency_key: SecureRandom.uuid
         )
       end
     end

data/app/services/spree_cm_commissioner/waiting_room/publish_lobby_path.rb

@@ -15,6 +15,7 @@ module SpreeCmCommissioner
     class PublishLobbyPath
       prepend ::Spree::ServiceModule::Base
       extend SpreeCmCommissioner::ServiceModuleThrowable
+      include SpreeCmCommissioner::FirestoreConnection
 
       def call
         # merge: true so we never clobber the lobby's `full` / `available_slots` fields.
@@ -40,14 +41,6 @@ module SpreeCmCommissioner
       def logs_document
         @logs_document ||= lobby_document.col('logs').doc('publish_lobby_path_job')
       end
-
-      def firestore
-        @firestore ||= Google::Cloud::Firestore.new(project_id: service_account[:project_id], credentials: service_account)
-      end
-
-      def service_account
-        @service_account ||= Rails.application.credentials.cloud_firestore_service_account
-      end
     end
   end
 end

data/app/services/spree_cm_commissioner/waiting_room_system_metadata_fetcher.rb

@@ -2,6 +2,8 @@ require 'google/cloud/firestore'
 
 module SpreeCmCommissioner
   class WaitingRoomSystemMetadataFetcher
+    include SpreeCmCommissioner::FirestoreConnection
+
     attr_reader :document_data
 
     def initialize(firestore: nil)
@@ -56,13 +58,5 @@ module SpreeCmCommissioner
     def document
       @document ||= firestore.col('metadata').doc('system')
     end
-
-    def firestore
-      @firestore ||= Google::Cloud::Firestore.new(project_id: service_account[:project_id], credentials: service_account)
-    end
-
-    def service_account
-      @service_account ||= Rails.application.credentials.cloud_firestore_service_account
-    end
   end
 end

data/config/initializers/firestore.rb

@@ -0,0 +1,19 @@
+require 'google/cloud/firestore'
+
+# The generated defaults give point reads/writes a 60s–300s deadline and keep retrying
+# RESOURCE_EXHAUSTED/UNAVAILABLE until it expires, so on a slow Firestore a request-path write
+# (QueueDraftOrders::PublishStatus) outlives Rack::Timeout's 30s and ends as a
+# RequestTimeoutException (an Exception, so no `rescue StandardError` sees it) instead of a clean
+# failure. The deadline covers retries too, so this is the most one call can block.
+#
+# Set on the class-level config because it is every client instance's parent config, so it also
+# reaches services that build their own client. `Google::Cloud::Firestore.new(timeout:)` would not
+# work: the per-RPC defaults take precedence over the client-wide timeout.
+#
+# Queries and streams (run_query, listen, write, ...) keep their defaults — they legitimately page
+# through large result sets and only run from jobs/dashboard reads.
+Google::Cloud::Firestore::V1::Firestore::Client.configure do |config|
+  %i[get_document batch_get_documents create_document update_document delete_document commit batch_write].each do |rpc|
+    config.rpcs.public_send(rpc).timeout = 10.0
+  end
+end

data/lib/spree_cm_commissioner/firestore_clients.rb

@@ -0,0 +1,49 @@
+require 'google/cloud/firestore'
+
+module SpreeCmCommissioner
+  # Process-wide registry of Cloud Firestore clients, one per Firebase project (`project_id`), so
+  # a service that talks to a second project just passes that project's service account and still
+  # gets a shared client.
+  #
+  # Shared rather than built per service instance: each new client opens its own gRPC channel, TLS
+  # handshake and OAuth token fetch, which on request paths like QueueDraftOrders::Enqueue was paid
+  # on every request. Clients are dropped when the PID changes so a forked worker (Puma runs with
+  # preload_app!) never reuses its parent's client; checking here instead of in a puma
+  # on_worker_boot hook also covers Sidekiq, rake and any other fork. That only works while the
+  # parent has made no Firestore RPC before forking — gRPC itself refuses to run in a child after
+  # the parent used it (unless GRPC_ENABLE_FORK_SUPPORT, Linux only) — so never call Firestore
+  # during app boot. RPC deadlines are set in config/initializers/firestore.rb.
+  module FirestoreClients
+    MUTEX = Mutex.new
+
+    class << self
+      # service_account: [Hash] a Firebase service-account credential; defaults to
+      # `cloud_firestore_service_account`.
+      def fetch(service_account = default_service_account)
+        project_id = service_account[:project_id]
+
+        MUTEX.synchronize do
+          reset_unlocked! if @pid != Process.pid
+          @clients[project_id] ||= Google::Cloud::Firestore.new(project_id: project_id, credentials: service_account)
+        end
+      end
+
+      def default_service_account
+        Rails.application.credentials.cloud_firestore_service_account
+      end
+
+      # Specs stub Google::Cloud::Firestore.new per example; without this the first example's
+      # double would be served to every later one.
+      def reset!
+        MUTEX.synchronize { reset_unlocked! }
+      end
+
+      private
+
+      def reset_unlocked!
+        @clients = {}
+        @pid = Process.pid
+      end
+    end
+  end
+end

data/lib/spree_cm_commissioner/version.rb

@@ -1,5 +1,5 @@
 module SpreeCmCommissioner
-  VERSION = '2.14.8'.freeze
+  VERSION = '2.14.9'.freeze
 
   module_function
 

data/lib/spree_cm_commissioner.rb

@@ -21,6 +21,7 @@ require 'spree_cm_commissioner/rate'
 require 'spree_cm_commissioner/rate_closings'
 require 'spree_cm_commissioner/rates_availability_grid'
 require 'spree_cm_commissioner/s3_url_generator'
+require 'spree_cm_commissioner/firestore_clients'
 require 'spree_cm_commissioner/service_module_throwable'
 require 'spree_cm_commissioner/serializable_transaction'
 require 'spree_cm_commissioner/jwt_token'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_cm_commissioner
 version: !ruby/object:Gem::Version
-  version: 2.14.8
+  version: 2.14.9
 platform: ruby
 authors:
 - You
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-11-03 00:00:00.000000000 Z
+date: 2026-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree
@@ -3176,6 +3176,7 @@ files:
 - config/initializers/assets.rb
 - config/initializers/doorkeeper.rb
 - config/initializers/exception_notification.rb
+- config/initializers/firestore.rb
 - config/initializers/google_map.rb
 - config/initializers/paper_trail.rb
 - config/initializers/phonelib.rb
@@ -3808,6 +3809,7 @@ files:
 - lib/spree_cm_commissioner/distance.rb
 - lib/spree_cm_commissioner/engine.rb
 - lib/spree_cm_commissioner/factories.rb
+- lib/spree_cm_commissioner/firestore_clients.rb
 - lib/spree_cm_commissioner/intercity_taxi/map_place.rb
 - lib/spree_cm_commissioner/jwt_token.rb
 - lib/spree_cm_commissioner/line_item_jwt_token.rb