spree_cm_commissioner 2.3.0.pre.pre4 → 2.3.0.pre.pre6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e7546de16834ee46678d06170bf2c9cd1f20bb41df2df1e6861b8228d5c493f
-  data.tar.gz: c455d1a19ea25846649e857e2f426e914a8e5f326782ed9fbc70f727778f516b
+  metadata.gz: d30ecd3195208c3763b429a17013f18a5582fd162581838135ae0736e8e7be60
+  data.tar.gz: d11dea0d955b0f7d6d2b62ed907d1b3996d34a89789b705192068b5941e8b9ac
 SHA512:
-  metadata.gz: 014ac4197bd506955cf8aff2546b459beb51aa01dadf086e162071652ecbdcdc064de97b881ed744ad6da0b0a7e90d22a19ed0e58aca903a9b8c40dc44b92be6
-  data.tar.gz: 83e89ee73435330e30591565e446494efc7c90202f5bf1b4680b6bc9ae8783cf80617cd3bcf9e0503258ed82058b72c7bb4302742ae89791bf6b1a5480aa109b
+  metadata.gz: c1a81f26c31ca303b364d34f8976ecb53d5b924d1515ba633085975c4297772f63ef780ccd93e300cd01f310bb59708cf7386993bd081897a69c8baee84d7828
+  data.tar.gz: 3a5fcd628e1698a57a7a3e43da83ff2dfe43831feccd5b41a385ec1405b22c3da4867a89eaed3fdc4ceefd57f7c893ae42e28dc6075746dad78512159d09eb5f

data/Gemfile.lock

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

data/app/controllers/spree/api/v2/storefront/seat_layouts_controller.rb

@@ -8,6 +8,32 @@ module Spree
     module V2
       module Storefront
         class SeatLayoutsController < Spree::Api::V2::ResourceController
+          # GET /api/v2/storefront/seat_layouts/:id
+          # - include_details=true|false (optional, default: true)
+          def show
+            render_serialized_payload { serialize_resource(resource) }
+          end
+
+          # This method is used by index:
+          # GET /api/v2/storefront/seat_layouts?
+          # - variant_ids[]=[1,2]
+          # - include_details=true|false (optional, default: true)
+          #
+          # override
+          def collection
+            return @collection if defined?(@collection)
+
+            scope = if include_details?
+                      SpreeCmCommissioner::SeatLayout.active.includes(:top_level_blocks, seat_sections: :blocks)
+                    else
+                      SpreeCmCommissioner::SeatLayout.active
+                    end
+
+            @collection = scope.joins(:blocks)
+                               .where(blocks: { variant_id: params[:variant_ids] })
+                               .distinct
+          end
+
           # override
           def resource
             SpreeCmCommissioner::SeatLayout.includes(
@@ -25,10 +51,32 @@ module Spree
             ]
           end
 
+          # override
+          def required_schema
+            return nil unless action_name == 'index'
+
+            SpreeCmCommissioner::SeatLayoutSchema
+          end
+
           # override
           def resource_serializer
             SpreeCmCommissioner::V2::Storefront::SeatLayoutSerializer
           end
+
+          # override
+          def collection_serializer
+            SpreeCmCommissioner::V2::Storefront::SeatLayoutSerializer
+          end
+
+          # override
+          def serializer_params
+            super.merge(include_details: include_details?)
+          end
+
+          # default return true
+          def include_details?
+            params.fetch(:include_details, 'true') == 'true'
+          end
         end
       end
     end

data/app/interactors/spree_cm_commissioner/inventory_item_syncer.rb

@@ -25,6 +25,10 @@ module SpreeCmCommissioner
       # Why? Clamping masks bugs in Redis deduction. If Redis deducted 5 but this
       # job tries to deduct 10, clamping silently loses the 5-unit discrepancy.
       # Validation errors are better than silent data loss.
+      #
+      # ❌ DO NOT use increment! because it skips model validations.
+      # We need validations to run so negative quantities are caught and surfaced
+      # as errors, not silently allowed by the database.
       inventory_item.update!(quantity_available: inventory_item.quantity_available + quantity)
     end
 

data/app/jobs/spree_cm_commissioner/seats/bulk_release_on_hold_blocks_job.rb

@@ -0,0 +1,26 @@
+module SpreeCmCommissioner
+  module Seats
+    class BulkReleaseOnHoldBlocksJob < ApplicationJob
+      queue_as :default
+
+      # Thin wrapper that calls BulkReleaseOnHoldBlocks service.
+      # Handles error logging and re-raising for Sidekiq retries.
+      #
+      # Args:
+      #   cutoff_days: Number of days before considering a block "stale" (default: 7)
+      def perform(cutoff_days = 7)
+        SpreeCmCommissioner::Seats::BulkReleaseOnHoldBlocks.new(cutoff_days: cutoff_days).call
+      rescue StandardError => e
+        CmAppLogger.error(
+          label: 'SpreeCmCommissioner::Seats::BulkReleaseOnHoldBlocksJob#perform',
+          data: {
+            error_class: e.class.name,
+            error_message: e.message,
+            backtrace: e.backtrace&.first(10)&.join("\n")
+          }
+        )
+        raise
+      end
+    end
+  end
+end

data/app/jobs/spree_cm_commissioner/seats/release_expired_blocks_job.rb

@@ -0,0 +1,23 @@
+module SpreeCmCommissioner
+  module Seats
+    class ReleaseExpiredBlocksJob < ApplicationJob
+      queue_as :default
+
+      # Thin wrapper that calls ReleaseExpiredBlocks service.
+      # Handles error logging and re-raising for Sidekiq retries.
+      def perform
+        SpreeCmCommissioner::Seats::ReleaseExpiredBlocks.new.call
+      rescue StandardError => e
+        CmAppLogger.error(
+          label: 'SpreeCmCommissioner::Seats::ReleaseExpiredBlocksJob#perform',
+          data: {
+            error_class: e.class.name,
+            error_message: e.message,
+            backtrace: e.backtrace&.first(10)&.join("\n")
+          }
+        )
+        raise
+      end
+    end
+  end
+end

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

@@ -13,10 +13,18 @@ module SpreeCmCommissioner
       # For certain large events, admin can disable this manually.
       store_public_metadata :allow_manual_search_for_operator, :boolean, default: true
 
-      # This model has no seat_layout column (polymorphic association), so we store the preload_seat_layout_id ID in public_metadata.
-      # This lets us check if a seat layout exists without triggering a database query.
-      # The ID is automatically updated whenever the seat_layout is saved.
-      store_public_metadata :preload_seat_layout_id, :integer
+      # ⚠️  CRITICAL: Cached seat layout IDs kept in sync by SeatLayout callback.
+      # If callback is removed/modified without updating this, availability checks will fail.
+      #
+      # Sync callback (see seat_layout.rb:L26-35):
+      #   after_commit :sync_seat_layout_id_to_layoutable!, if: -> { layoutable.present? }
+      #   def sync_seat_layout_id_to_layoutable!
+      #     layoutable.update!(preload_seat_layout_ids: layoutable.seat_layouts.pluck(:id))
+      #   end
+      #
+      # TODO: Not scalable for many seat layouts. Consider storing boolean flag
+      # (has_active_seat_layout) instead when seat layouts become frequent.
+      store_public_metadata :preload_seat_layout_ids, :array, default: []
 
       before_validation :validate_at_least_one_check_in_flow_presence
     end

data/app/models/spree_cm_commissioner/block.rb

@@ -6,6 +6,7 @@ module SpreeCmCommissioner
       driver: 3,
       bathroom: 4,
       text: 5,
+      standing: 6,
       other: 0
     }
 
@@ -27,17 +28,25 @@ module SpreeCmCommissioner
     before_validation :assign_layout_from_section, if: -> { seat_layout.nil? && seat_section.present? }
 
     def label_required?
-      seatable? || %w[other text].include?(block_type.to_s)
+      sellable? || %w[other text].include?(block_type.to_s)
     end
 
     def self.seatable?(block_type)
       block_type.to_s.in?(%w[sleeping_seat seat])
     end
 
+    def self.sellable?(block_type)
+      seatable?(block_type) || block_type.to_s == 'standing'
+    end
+
     def seatable?
       self.class.seatable?(block_type)
     end
 
+    def sellable?
+      self.class.sellable?(block_type)
+    end
+
     def assign_layout_from_section
       self.seat_layout = seat_section.seat_layout
     end

data/app/models/spree_cm_commissioner/guest.rb

@@ -80,6 +80,20 @@ module SpreeCmCommissioner
       ]
     end
 
+    # Only allow holding a block if it represents a seat.
+    # Other block types, like standing, don’t need a hold.
+    # Use the variant's inventory item to track availability instead.
+    def can_hold_block?
+      block.present? && block.seatable?
+    end
+
+    # Only allow holding a block if it represents a seat.
+    # Other block types, like standing, don’t need a hold.
+    # Use the variant's inventory item to track availability instead.
+    def can_reserve_block?
+      block.present? && block.seatable?
+    end
+
     # no validation for each field as we allow user to save data to model partially.
     def allowed_checkout?
       kyc_fields.all? { |field| allowed_checkout_for?(field) }

data/app/models/spree_cm_commissioner/seat_layout.rb

@@ -23,17 +23,21 @@ module SpreeCmCommissioner
 
     accepts_nested_attributes_for :seat_sections, :top_level_blocks, allow_destroy: true
 
+    # ⚠️  CRITICAL: Syncs preload_seat_layout_ids metadata to layoutable.
+    # DO NOT REMOVE without implementing alternative sync (see event_metadata.rb:L16-24).
     after_commit :sync_seat_layout_id_to_layoutable!, if: -> { layoutable.present? }
 
     private
 
-    # layoutable (taxon, vehicle) must have preload_seat_layout_id attribute,
-    # either as a column or as a key in a JSONB column (e.g., metadata)
     def sync_seat_layout_id_to_layoutable!
-      if destroyed?
-        layoutable.update!(preload_seat_layout_id: nil)
-      else
-        layoutable.update!(preload_seat_layout_id: id)
+      # Update layoutable's seat layout metadata after any change (create/update/destroy).
+      # This keeps the cache in sync with the actual seat_layouts association.
+      if layoutable.respond_to?(:seat_layouts)
+        # Event has many seat layouts: cache all IDs for quick availability checks.
+        layoutable.update!(preload_seat_layout_ids: layoutable.seat_layouts.pluck(:id))
+      elsif layoutable.respond_to?(:seat_layout)
+        # Taxon/Vehicle has single seat layout: cache the ID (or nil if destroyed).
+        layoutable.update!(preload_seat_layout_id: destroyed? ? nil : id)
       end
     end
   end

data/app/models/spree_cm_commissioner/seats/blocks_holder.rb

@@ -24,6 +24,8 @@ module SpreeCmCommissioner
 
         ActiveRecord::Base.transaction do
           guests_with_blocks.each do |guest|
+            next unless guest.can_hold_block?
+
             inventory_items.each do |inventory_item|
               reserved_blocks << hold_specific_block!(inventory_item, guest)
             end

data/app/models/spree_cm_commissioner/seats/blocks_reserver.rb

@@ -19,6 +19,8 @@ module SpreeCmCommissioner
 
         ActiveRecord::Base.transaction do
           guests_with_blocks.each do |guest|
+            next unless guest.can_reserve_block?
+
             inventory_items.each do |inventory_item|
               reserve_specific_block!(inventory_item, guest)
             end

data/app/models/spree_cm_commissioner/taxon_decorator.rb

@@ -21,7 +21,7 @@ module SpreeCmCommissioner
       base.has_many :check_ins, as: :checkinable, class_name: 'SpreeCmCommissioner::CheckIn', dependent: :nullify
       base.has_many :customer_taxons, class_name: 'SpreeCmCommissioner::CustomerTaxon'
 
-      base.has_one :seat_layout, as: :layoutable, class_name: 'SpreeCmCommissioner::SeatLayout', dependent: :destroy
+      base.has_many :seat_layouts, as: :layoutable, class_name: 'SpreeCmCommissioner::SeatLayout', dependent: :destroy
       base.has_one :category_icon, as: :viewable, dependent: :destroy, class_name: 'SpreeCmCommissioner::TaxonCategoryIcon'
 
       base.has_one :web_banner, as: :viewable, dependent: :destroy, class_name: 'SpreeCmCommissioner::TaxonWebBanner'

data/app/request_schemas/spree_cm_commissioner/seat_layout_schema.rb

@@ -0,0 +1,7 @@
+module SpreeCmCommissioner
+  class SeatLayoutSchema < ApplicationRequestSchema
+    params do
+      required(:variant_ids).value(:array).each(:integer)
+    end
+  end
+end

data/app/serializers/spree/v2/storefront/taxon_serializer_decorator.rb

@@ -18,7 +18,7 @@ module Spree
                           :purchasable_on, :vendor_id, :available_on, :hide_video_banner
 
           # To get full seat layout details, call the seat_layouts API with this ID.
-          base.attribute :seat_layout_id, &:preload_seat_layout_id
+          base.attribute :seat_layout_ids, &:preload_seat_layout_ids
 
           base.attribute :purchasable_on_app do |taxon|
             taxon.purchasable_on == 'app' || taxon.purchasable_on == 'both'

data/app/serializers/spree_cm_commissioner/v2/storefront/block_serializer.rb

@@ -5,6 +5,7 @@ module SpreeCmCommissioner
         attributes :label, :width, :height, :x, :y, :rotation, :block_type, :variant_id
 
         attribute :seatable, &:seatable?
+        attribute :sellable, &:sellable?
       end
     end
   end

data/app/serializers/spree_cm_commissioner/v2/storefront/seat_layout_serializer.rb

@@ -4,8 +4,11 @@ module SpreeCmCommissioner
       class SeatLayoutSerializer < BaseSerializer
         attributes :name, :status, :width, :height
 
-        has_many :seat_sections, serializer: SpreeCmCommissioner::V2::Storefront::SeatSectionSerializer
-        has_many :top_level_blocks, serializer: SpreeCmCommissioner::V2::Storefront::BlockSerializer
+        has_many :seat_sections, serializer: SpreeCmCommissioner::V2::Storefront::SeatSectionSerializer,
+                                 if: proc { |_, params| params && params[:include_details] == true }
+
+        has_many :top_level_blocks, serializer: SpreeCmCommissioner::V2::Storefront::BlockSerializer,
+                                    if: proc { |_, params| params && params[:include_details] == true }
       end
     end
   end

data/app/services/spree_cm_commissioner/seats/bulk_release_on_hold_blocks.rb

@@ -0,0 +1,42 @@
+module SpreeCmCommissioner
+  module Seats
+    class BulkReleaseOnHoldBlocks
+      def initialize(cutoff_days: 7)
+        @cutoff_days = cutoff_days
+      end
+
+      # Bulk releases stale on_hold blocks as a housekeeping job.
+      # Runs weekly to catch any blocks that didn't expire properly.
+      #
+      # This is a FULL release - releases ALL on_hold blocks older than cutoff_days.
+      # Complements ReleaseExpiredBlocks which runs every 5 minutes.
+      def call
+        cutoff_time = @cutoff_days.days.ago
+
+        stale_blocks = SpreeCmCommissioner::ReservedBlock
+                       .on_hold
+                       .where('created_at < ?', cutoff_time)
+
+        count = stale_blocks.count
+
+        # Transition all stale blocks to canceled status
+        stale_blocks.update_all( # rubocop:disable Rails/SkipsModelValidations
+          status: :canceled,
+          expired_at: nil,
+          updated_by_id: nil,
+          updated_at: Time.current
+        )
+
+        CmAppLogger.log(
+          label: 'SpreeCmCommissioner::Seats::BulkReleaseOnHoldBlocks#call',
+          data: {
+            released_count: count,
+            cutoff_days: @cutoff_days,
+            cutoff_time: cutoff_time,
+            job_type: 'bulk_release'
+          }
+        )
+      end
+    end
+  end
+end

data/app/services/spree_cm_commissioner/seats/release_expired_blocks.rb

@@ -0,0 +1,34 @@
+module SpreeCmCommissioner
+  module Seats
+    class ReleaseExpiredBlocks
+      # Releases blocks that have expired (hold time exceeded).
+      # Runs every 5 minutes to keep expired holds from accumulating.
+      #
+      # This is a PARTIAL release - only releases blocks where expired_at has passed.
+      # Complements BulkReleaseOnHoldBlocks which does weekly housekeeping.
+      def call
+        expired_blocks = SpreeCmCommissioner::ReservedBlock
+                         .on_hold
+                         .where('expired_at <= ?', Time.current)
+
+        count = expired_blocks.count
+
+        # Transition all expired blocks to canceled status
+        expired_blocks.update_all( # rubocop:disable Rails/SkipsModelValidations
+          status: :canceled,
+          expired_at: nil,
+          updated_by: nil,
+          updated_at: Time.current
+        )
+
+        CmAppLogger.log(
+          label: 'SpreeCmCommissioner::Seats::ReleaseExpiredBlocks#call',
+          data: {
+            released_count: count,
+            job_type: 'partial_release'
+          }
+        )
+      end
+    end
+  end
+end

data/config/routes.rb

@@ -674,7 +674,7 @@ Spree::Core::Engine.add_routes do
         post :user_order_transfer, to: 'user_order_transfer#create'
         resources :anonymous_orders, path: 'o', only: %i[show]
 
-        resources :seat_layouts, only: %i[show]
+        resources :seat_layouts, only: %i[show index]
         resources :inventory_items, only: %i[index]
         namespace :transit do
           resources :draft_orders, only: %i[create]

data/lib/spree_cm_commissioner/version.rb

@@ -1,5 +1,5 @@
 module SpreeCmCommissioner
-  VERSION = '2.3.0-pre4'.freeze
+  VERSION = '2.3.0-pre6'.freeze
 
   module_function
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spree_cm_commissioner
 version: !ruby/object:Gem::Version
-  version: 2.3.0.pre.pre4
+  version: 2.3.0.pre.pre6
 platform: ruby
 authors:
 - You
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-29 00:00:00.000000000 Z
+date: 2025-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: spree
@@ -1309,6 +1309,8 @@ files:
 - app/jobs/spree_cm_commissioner/product_event_id_to_children_syncer_job.rb
 - app/jobs/spree_cm_commissioner/queue_order_webhooks_requests_job.rb
 - app/jobs/spree_cm_commissioner/reports_assigner_job.rb
+- app/jobs/spree_cm_commissioner/seats/bulk_release_on_hold_blocks_job.rb
+- app/jobs/spree_cm_commissioner/seats/release_expired_blocks_job.rb
 - app/jobs/spree_cm_commissioner/sms_job.rb
 - app/jobs/spree_cm_commissioner/sms_pin_code_job.rb
 - app/jobs/spree_cm_commissioner/state_job.rb
@@ -1738,6 +1740,7 @@ files:
 - app/request_schemas/spree_cm_commissioner/application_request_schema.rb
 - app/request_schemas/spree_cm_commissioner/inventory_item_schema.rb
 - app/request_schemas/spree_cm_commissioner/profile_image_request_schema.rb
+- app/request_schemas/spree_cm_commissioner/seat_layout_schema.rb
 - app/request_schemas/spree_cm_commissioner/trip_search_request_schema.rb
 - app/request_schemas/spree_cm_commissioner/user_account_linkage_request_schema.rb
 - app/request_schemas/spree_cm_commissioner/user_profile_request_schema.rb
@@ -1946,6 +1949,8 @@ files:
 - app/services/spree_cm_commissioner/role_permissions_constructor.rb
 - app/services/spree_cm_commissioner/role_permissions_loader.rb
 - app/services/spree_cm_commissioner/rsa_service.rb
+- app/services/spree_cm_commissioner/seats/bulk_release_on_hold_blocks.rb
+- app/services/spree_cm_commissioner/seats/release_expired_blocks.rb
 - app/services/spree_cm_commissioner/seeds/roles_decorator.rb
 - app/services/spree_cm_commissioner/transit/base_route_order_metrics_updater.rb
 - app/services/spree_cm_commissioner/transit/legs_builder_service.rb