spree_cm_commissioner 2.3.0.pre.pre18 → 2.3.0.pre.pre20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31d13343c99ba15786dc8ea2706e64fd79ada05ce505f06fea9dfdffd24f1313
-  data.tar.gz: 2638b1befd6df8abbc2ed8bcabfd447bb15bb2006336e2ff894662c58c07e933
+  metadata.gz: f73314825dc2db092e1255e49203ceb8e1071e0dac1c11803d8343b8dc37fafa
+  data.tar.gz: 32c25a52977a2f20591b8650ece48a69e517845b3431b79e3c57da63cf8ddb50
 SHA512:
-  metadata.gz: 487aa62c3894d83cd38036169a677ab79633f9792654e4d87e59c61fdbbe6a6bb60cd303f69727e093fc37fcf41c361ad43fbb2f60e79f84e5cd6e830aa05ed2
-  data.tar.gz: 608a5d18e523889840e11a31f2686d357636de604fb360abb0c5074c1f3eda129c33012e779f5dc5ce025aed2842eb605cb051014217fccf4fa36361b8315fb5
+  metadata.gz: 1bd90e765ad3bdd9f28b6199900a7ea4f587dd11732af3a03c8bd3b13d234eb83765740de6619223dd03cbe77cb4b865c82c12c8a1845bc05157977463bf17d6
+  data.tar.gz: ef7380007df4d1ee55da2fea5d2d9cb2b3b5d931c44d17a955b9925c338f8a6285df1df59459b643152cd03fda819bcdd264075bc87eaaff5961e93d08b84606

data/Gemfile.lock

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

data/app/jobs/spree_cm_commissioner/orders/bulk_archive_inactive_orders_job.rb

@@ -0,0 +1,13 @@
+module SpreeCmCommissioner
+  module Orders
+    class BulkArchiveInactiveOrdersJob < ApplicationJob
+      # Manual job that archives ALL incomplete orders inactive for 14+ days.
+      # Thin wrapper that calls BulkArchiveInactiveOrders service.
+      # ApplicationJob handles error logging via around_perform hook.
+      # Triggered manually via Sidekiq (not scheduled).
+      def perform
+        SpreeCmCommissioner::Orders::BulkArchiveInactiveOrders.new.call
+      end
+    end
+  end
+end

data/app/jobs/spree_cm_commissioner/orders/daily_archive_inactive_orders_job.rb

@@ -0,0 +1,12 @@
+module SpreeCmCommissioner
+  module Orders
+    class DailyArchiveInactiveOrdersJob < ApplicationJob
+      # Scheduled job that runs daily to archive incomplete orders inactive for 14+ days.
+      # Thin wrapper that calls DailyArchiveInactiveOrders service.
+      # ApplicationJob handles error logging via around_perform hook.
+      def perform
+        SpreeCmCommissioner::Orders::DailyArchiveInactiveOrders.new.call
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+module SpreeCmCommissioner
+  module OrderScopes
+    extend ActiveSupport::Concern
+
+    included do
+      # Archiving scopes
+      scope :archived, -> { where.not(archived_at: nil) }
+      scope :not_archived, -> { where(archived_at: nil) }
+
+      # Payment and state scopes
+      scope :subscription, -> { where.not(subscription_id: nil) }
+      scope :paid, -> { where(payment_state: :paid) }
+      scope :complete_or_canceled, -> { complete.or(where(state: 'canceled')) }
+      scope :payment, -> { incomplete.where(state: 'payment') }
+      scope :without_user, -> { where(user_id: nil) }
+
+      # Inactive orders scopes with parameterized dates
+      # Usage: Spree::Order.inactive_incomplete_all(threshold: 14.days.ago)
+      scope :inactive_incomplete_all, lambda { |threshold: 14.days.ago|
+        where(archived_at: nil, completed_at: nil)
+          .where('updated_at < ?', threshold)
+      }
+
+      # Usage: Spree::Order.inactive_incomplete(threshold: 14.days.ago, window: 7.days)
+      # Returns orders updated between (threshold - window) and threshold
+      scope :inactive_incomplete, lambda { |threshold: 14.days.ago, window: 7.days|
+        where(archived_at: nil, completed_at: nil)
+          .where('updated_at >= ?', threshold - window)
+          .where('updated_at < ?', threshold)
+      }
+
+      # Filter scopes
+      scope :filter_by_match_user_contact, lambda { |user|
+        complete.where(
+          '(email = :email OR intel_phone_number = :intel_phone_number) AND user_id IS NULL',
+          email: user.email,
+          intel_phone_number: user.intel_phone_number
+        )
+      }
+
+      scope :filter_by_vendor, lambda { |vendor|
+        joins(:line_items).where(spree_line_items: { vendor_id: vendor }).distinct
+      }
+    end
+  end
+end

data/app/models/spree_cm_commissioner/order_decorator.rb

@@ -1,31 +1,12 @@
 module SpreeCmCommissioner
   module OrderDecorator
-    def self.prepended(base) # rubocop:disable Metrics/MethodLength,Metrics/AbcSize
+    def self.prepended(base) # rubocop:disable Metrics/MethodLength
       base.include SpreeCmCommissioner::StoreMetadata
       base.include SpreeCmCommissioner::PhoneNumberSanitizer
       base.include SpreeCmCommissioner::OrderSeatable
       base.include SpreeCmCommissioner::OrderStateMachine
       base.include SpreeCmCommissioner::RouteOrderCountable
-
-      base.scope :subscription, -> { where.not(subscription_id: nil) }
-      base.scope :paid, -> { where(payment_state: :paid) }
-      base.scope :complete_or_canceled, -> { complete.or(where(state: 'canceled')) }
-      base.scope :payment, -> { incomplete.where(state: 'payment') }
-      base.scope :archived, -> { where.not(archived_at: nil) }
-      base.scope :not_archived, -> { where(archived_at: nil) }
-      base.scope :without_user, -> { where(user_id: nil) }
-
-      base.scope :filter_by_match_user_contact, lambda { |user|
-        complete.where(
-          '(email = :email OR intel_phone_number = :intel_phone_number) AND user_id IS NULL',
-          email: user.email,
-          intel_phone_number: user.intel_phone_number
-        )
-      }
-
-      base.scope :filter_by_vendor, lambda { |vendor|
-        joins(:line_items).where(spree_line_items: { vendor_id: vendor }).distinct
-      }
+      base.include SpreeCmCommissioner::OrderScopes
 
       base.before_create :link_by_phone_number
       base.before_create :associate_customer
@@ -88,6 +69,7 @@ module SpreeCmCommissioner
     def restart_checkout_flow
       ActiveRecord::Base.transaction do
         cancel_blocks! if should_manage_blocks?
+        log_state_changes(state_name: 'cart', old_state: state, new_state: 'cart')
         update_columns( # rubocop:disable Rails/SkipsModelValidations
           state: 'cart',
           updated_at: Time.current

data/app/services/spree_cm_commissioner/orders/bulk_archive_inactive_orders.rb

@@ -0,0 +1,52 @@
+module SpreeCmCommissioner
+  module Orders
+    class BulkArchiveInactiveOrders
+      prepend ::Spree::ServiceModule::Base
+
+      # Archives ALL incomplete orders inactive for 14+ days (no time range limit).
+      # This is a bulk operation for manual cleanup via Sidekiq.
+      # Archived orders are hidden from users (Orders::Find filters them out).
+      #
+      # Criteria for archiving:
+      # - archived_at IS NULL (not already archived)
+      # - completed_at IS NULL (incomplete/unfinished orders)
+      # - updated_at < 14 days ago (inactive for 2+ weeks)
+      #
+      # Difference from ArchiveInactiveOrders:
+      # - ArchiveInactiveOrders: Runs daily, archives only 1-week window (21-14 days)
+      # - BulkArchiveInactiveOrders: Manual job, archives ALL orders older than 14 days
+      #
+      # Use case: Bulk cleanup when needed, triggered manually via Sidekiq
+      def call
+        # Archives ALL orders inactive for 14+ days (no time range limit)
+        # Uses parameterized scope: threshold=14.days.ago
+        inactive_orders = Spree::Order.inactive_incomplete_all(threshold: 14.days.ago)
+
+        count = inactive_orders.count
+
+        # Archive all inactive orders with reason in internal_note.
+        # We use bulk update_all instead of find_each because:
+        # - We rarely use internal_note, so preserving history is not critical
+        # - Bulk update is significantly faster (1 query vs N queries)
+        # - For bulk operations, performance is critical
+        inactive_orders.update_all( # rubocop:disable Rails/SkipsModelValidations
+          archived_at: Time.current,
+          internal_note: 'Auto-archived: inactive for 14 days',
+          updated_at: Time.current
+        )
+
+        CmAppLogger.log(
+          label: 'SpreeCmCommissioner::Orders::BulkArchiveInactiveOrders#call completed',
+          data: {
+            archived_count: count,
+            threshold_days: 14
+          }
+        )
+
+        success(archived_count: count)
+      rescue StandardError => e
+        failure(nil, e.message)
+      end
+    end
+  end
+end

data/app/services/spree_cm_commissioner/orders/daily_archive_inactive_orders.rb

@@ -0,0 +1,58 @@
+module SpreeCmCommissioner
+  module Orders
+    class DailyArchiveInactiveOrders
+      prepend ::Spree::ServiceModule::Base
+
+      # Archives incomplete orders that haven't been updated for 14 days.
+      # Archived orders are hidden from users (Orders::Find filters them out).
+      # Users will see an empty cart and can start a new one.
+      #
+      # Criteria for archiving:
+      # - archived_at IS NULL (not already archived)
+      # - completed_at IS NULL (incomplete/unfinished orders)
+      # - updated_at < 14 days ago (inactive for 2+ weeks)
+      #
+      # Why 14 days?
+      # - Gives users time to notice discontinued products and clean up their cart
+      # - If product is discontinued during these 14 days, users can manually clear
+      #   their cart when they see the "unavailable" status in the UI
+      # - Gives the team time to investigate payment errors or stuck orders
+      #
+      # Why archive all payment states?
+      # - Data is preserved (archived_at is just a flag, not deletion)
+      # - Team can still review archived orders in the database if needed
+      # - Keeps user-facing order history clean (hidden from Orders::Find queries)
+      # - Reduces clutter in active carts/orders
+      def call
+        # Archives orders from the 1-week window (21-14 days ago)
+        # Uses parameterized scope: threshold=14.days.ago, window=7.days
+        inactive_orders = Spree::Order.inactive_incomplete(threshold: 14.days.ago, window: 7.days)
+
+        count = inactive_orders.count
+
+        # Archive all inactive orders with reason in internal_note.
+        # We use bulk update_all instead of find_each because:
+        # - We rarely use internal_note, so preserving history is not critical
+        # - Bulk update is significantly faster (1 query vs N queries)
+        # - For typical 100-500 orders/day, bulk update is worth the performance gain
+        inactive_orders.update_all( # rubocop:disable Rails/SkipsModelValidations
+          archived_at: Time.current,
+          internal_note: 'Auto-archived: inactive for 14 days',
+          updated_at: Time.current
+        )
+
+        CmAppLogger.log(
+          label: 'SpreeCmCommissioner::Orders::DailyArchiveInactiveOrders#call completed',
+          data: {
+            archived_count: count,
+            threshold_days: 14
+          }
+        )
+
+        success(archived_count: count)
+      rescue StandardError => e
+        failure(nil, e.message)
+      end
+    end
+  end
+end

data/db/migrate/20251113081853_add_index_to_spree_orders_updated_at.rb

@@ -0,0 +1,7 @@
+class AddIndexToSpreeOrdersUpdatedAt < ActiveRecord::Migration[7.0]
+  def change
+    unless index_exists?(:spree_orders, :updated_at)
+      add_index :spree_orders, :updated_at, name: 'index_spree_orders_on_updated_at'
+    end
+  end
+end

data/lib/spree_cm_commissioner/version.rb

@@ -1,5 +1,5 @@
 module SpreeCmCommissioner
-  VERSION = '2.3.0-pre18'.freeze
+  VERSION = '2.3.0-pre20'.freeze
 
   module_function
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_cm_commissioner
 version: !ruby/object:Gem::Version
-  version: 2.3.0.pre.pre18
+  version: 2.3.0.pre.pre20
 platform: ruby
 authors:
 - You
@@ -1310,6 +1310,8 @@ files:
 - app/jobs/spree_cm_commissioner/option_type_variants_public_metadata_updater_job.rb
 - app/jobs/spree_cm_commissioner/option_value_variants_public_metadata_updater_job.rb
 - app/jobs/spree_cm_commissioner/order_complete_telegram_sender_job.rb
+- app/jobs/spree_cm_commissioner/orders/bulk_archive_inactive_orders_job.rb
+- app/jobs/spree_cm_commissioner/orders/daily_archive_inactive_orders_job.rb
 - 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
@@ -1357,6 +1359,7 @@ files:
 - app/models/concerns/spree_cm_commissioner/metafield.rb
 - app/models/concerns/spree_cm_commissioner/option_type_attr_type.rb
 - app/models/concerns/spree_cm_commissioner/option_value_attr_type.rb
+- app/models/concerns/spree_cm_commissioner/order_scopes.rb
 - app/models/concerns/spree_cm_commissioner/order_seatable.rb
 - app/models/concerns/spree_cm_commissioner/order_state_machine.rb
 - app/models/concerns/spree_cm_commissioner/parameterize_name.rb
@@ -1952,6 +1955,8 @@ files:
 - app/services/spree_cm_commissioner/intercity_taxi_order/update.rb
 - app/services/spree_cm_commissioner/metafields/product_metadata_service.rb
 - app/services/spree_cm_commissioner/order_params_checker.rb
+- app/services/spree_cm_commissioner/orders/bulk_archive_inactive_orders.rb
+- app/services/spree_cm_commissioner/orders/daily_archive_inactive_orders.rb
 - app/services/spree_cm_commissioner/orders/generate_commissions_decorator.rb
 - app/services/spree_cm_commissioner/organizer/export_guest_csv_service.rb
 - app/services/spree_cm_commissioner/organizer/export_invite_guest_csv_service.rb
@@ -2842,6 +2847,7 @@ files:
 - db/migrate/20251009033331_add_registered_by_to_spree_users.rb
 - db/migrate/20251009073040_add_lock_version_to_cm_routes.rb
 - db/migrate/20251009073929_add_lock_version_to_cm_vendor_routes.rb
+- db/migrate/20251113081853_add_index_to_spree_orders_updated_at.rb
 - docker-compose.yml
 - docs/api/scoped-access-token-endpoints.md
 - docs/option_types/attr_types.md