spree_cm_commissioner 2.4.2 → 2.5.0.pre.pre1

data/app/views/spree/admin/tenants/_form.html.erb

@@ -1,5 +1,12 @@
-<div data-hook="admin_tenant_form_fields" class="row">
-  <!-- Name Field -->
+
+<!-- ======================== Tenant Basic Info ======================== -->
+<div class="card mb-4">
+  <div class="card-body">
+    <div data-hook="admin_tenant_form_fields" class="row">
+  <!-- Basic Info Section -->
+  <div class="col-12 mb-4">
+    <h4>Basic Information <span class="text-muted" style="font-size: 1rem; font-weight: normal;">(General details about the tenant)</span></h4>
+  </div>
   <div class="col-6">
     <%= f.field_container :name do %>
       <%= f.label :name, raw(Spree.t(:name) + required_span_tag) %>
@@ -9,8 +16,6 @@
       <% end %>
     <% end %>
   </div>
-
-  <!-- Slug Field -->
   <div class="col-6">
     <%= f.field_container :slug do %>
       <%= f.label :slug, raw(Spree.t(:slug)) %>
@@ -20,8 +25,6 @@
       <% end %>
     <% end %>
   </div>
-
-  <!-- Description Field -->
   <div class="col-12">
     <%= f.field_container :description do %>
       <%= f.label :description, raw(Spree.t(:description)) %>
@@ -31,8 +34,6 @@
       <% end %>
     <% end %>
   </div>
-
-  <!-- Host Field -->
   <div class="col-12">
     <%= f.field_container :host do %>
       <%= f.label :host, raw(Spree.t(:host) + required_span_tag) %>
@@ -42,8 +43,37 @@
       <% end %>
     <% end %>
   </div>
+  <div class="col-6">
+    <%= f.field_container :state do %>
+      <%= f.label :state, raw(Spree.t(:state)) %>
+      <%= f.select :state,
+            options_for_select([["Enabled", "enabled"], ["Disabled", "disabled"]], f.object&.state),
+            { required: true },
+            class: 'select2 form-control' %>
+      <% if f.object.errors[:state].any? %>
+        <div class="error text-danger"><%= f.object.errors[:state].join(', ') %></div>
+      <% end %>
+    <% end %>
+  </div>
+    </div>
+  </div>
+</div>
 
-  <!-- Assetlinks Field -->
+<!-- ======================== Branding & App Links ======================== -->
+<div class="card mb-4">
+  <div class="card-body">
+    <div data-hook="admin_tenant_form_fields" class="row mt-4">
+  <!-- Branding Section -->
+  <div class="col-12 mb-4">
+    <h4>Branding & App Links <span class="text-muted" style="font-size: 1rem; font-weight: normal;">(Brand colors and mobile app association settings)</span></h4>
+  </div>
+  <div class="col-md-6">
+    <%= f.label :preferred_brand_primary_color, Spree.t(:brand_primary_color), class: 'form-label' %>
+    <%= f.text_field :preferred_brand_primary_color, class: 'form-control color-picker', placeholder: '#FF5733', value: @object.preferred_brand_primary_color %>
+    <div class="color-preview" style="margin-top: 10px;">
+      <%= content_tag :div, nil, style: "background-color: #{@object.preferred_brand_primary_color}; width: 60px; height: 60px; border: 1px solid #ccc; box-sizing: border-box; display: block;" %>
+    </div>
+  </div>
   <div class="col-12">
     <%= f.field_container :preferred_assetlinks do %>
       <%= f.label :preferred_assetlinks, raw(Spree.t(:assetlinks)) %>
@@ -69,8 +99,6 @@
       <% end %>
     <% end %>
   </div>
-
-  <!-- Apple App Site Association Field -->
   <div class="col-12">
     <%= f.field_container :preferred_apple_app_site_association do %>
       <%= f.label :preferred_apple_app_site_association, raw(Spree.t(:apple_app_site_association)) %>
@@ -100,32 +128,18 @@
       <% end %>
     <% end %>
   </div>
-
-  <!-- Brand Primary Color Field -->
-  <div class="col-md-6">
-    <%= f.label :preferred_brand_primary_color, Spree.t(:brand_primary_color), class: 'form-label' %>
-    <%= f.text_field :preferred_brand_primary_color, class: 'form-control color-picker', placeholder: '#FF5733', value: @object.preferred_brand_primary_color %>
-    <div class="color-preview" style="margin-top: 10px;">
-      <%= content_tag :div, nil, style: "background-color: #{@object.preferred_brand_primary_color}; width: 60px; height: 60px; border: 1px solid #ccc; box-sizing: border-box; display: block;" %>
     </div>
   </div>
-
-  <!-- State Field -->
-  <div class="col-6">
-    <%= f.field_container :state do %>
-      <%= f.label :state, raw(Spree.t(:state)) %>
-      <%= f.select :state,
-            options_for_select([['Enabled', 'enabled'], ['Disabled', 'disabled']], f.object&.state),
-            { required: true },
-            class: 'select2 form-control' %>
-      <% if f.object.errors[:state].any? %>
-        <div class="error text-danger"><%= f.object.errors[:state].join(', ') %></div>
-      <% end %>
-    <% end %>
-  </div>
 </div>
 
-<div data-hook="admin_tenant_form_fields" class="row">
+<!-- ======================== Payment Icons ======================== -->
+<div class="card mb-4">
+  <div class="card-body">
+    <div data-hook="admin_tenant_form_fields" class="row mt-4">
+  <!-- Payment Icons Section -->
+  <div class="col-12 mb-4">
+    <h4>Payment Icons <span class="text-muted" style="font-size: 1rem; font-weight: normal;">(Customize payment status icons for tenant checkout experience)</span></h4>
+  </div>
   <div class="col-12">
     <div class="row gy-4">
       <% payment_icon_fields = [
@@ -134,7 +148,6 @@
           { field: :preferred_payment_success_image, label: Spree.t(:payment_success_image), target: 'success' },
           { field: :preferred_payment_loader, label: Spree.t(:payment_loader), target: 'loader' }
         ] %>
-
       <% payment_icon_fields.each do |icon| %>
         <div class="col-md-3">
           <%= f.field_container icon[:field] do %>
@@ -142,7 +155,6 @@
               <label class="form-label fw-bold mb-2" for="tenant_<%= icon[:field] %>">
                 <%= icon[:label] %>
               </label>
-
               <div class="icon-preview-container mb-2" id="icon-preview-container-<%= icon[:field] %>">
                 <span class="payment-icon-preview" id="icon-preview-<%= icon[:field] %>">
                   <% if f.object.send(icon[:field]).present? %>
@@ -154,7 +166,6 @@
                 <span class="remove-icon-btn <%= 'hidden' unless f.object.send(icon[:field]).present? %>" data-target="<%= icon[:field] %>">&times;</span>
               </div>
             </div>
-
             <%= f.collection_select icon[:field],
                   @vector_icons, :path, :path,
                   { include_blank: 'None' },
@@ -167,4 +178,36 @@
       <% end %>
     </div>
   </div>
+    </div>
+  </div>
+</div>
+
+<!-- ======================== Redirect Settings ======================== -->
+<div class="card mb-4">
+  <div class="card-body">
+    <div data-hook="admin_tenant_form_fields" class="row mt-4">
+  <!-- Redirect Settings Section -->
+  <div class="col-12 mb-4">
+    <h4>Redirect Settings <span class="text-muted" style="font-size: 1rem; font-weight: normal;">(Configure host redirection and excluded paths for this tenant)</span></h4>
+  </div>
+  <div class="col-6">
+    <%= f.field_container :preferred_redirect_target_host do %>
+      <%= f.label :preferred_redirect_target_host, raw(Spree.t(:redirect_target_host)) %>
+      <%= f.text_field :preferred_redirect_target_host, class: 'form-control', placeholder: 'target.example.com' %>
+      <% if f.object.errors[:preferred_redirect_target_host].any? %>
+        <div class="error text-danger"><%= f.object.errors[:preferred_redirect_target_host].join(', ') %></div>
+      <% end %>
+    <% end %>
+  </div>
+  <div class="col-12">
+    <%= f.field_container :preferred_redirect_excluded_paths do %>
+      <%= f.label :preferred_redirect_excluded_paths, raw(Spree.t(:redirect_excluded_paths)) %>
+      <%= f.text_area :preferred_redirect_excluded_paths, class: 'form-control', placeholder: 'eg. /vpago_payments,/.well-known' %>
+      <% if f.object.errors[:preferred_redirect_excluded_paths].any? %>
+        <div class="error text-danger"><%= f.object.errors[:preferred_redirect_excluded_paths].join(', ') %></div>
+      <% end %>
+    <% end %>
+  </div>
+    </div>
+  </div>
 </div>

data/config/locales/en.yml

@@ -454,6 +454,14 @@ en:
     admin:
       display_on:
         frontend_for_early_adopter: "Storefront for Early Adopter"
+      external_integrations_title: "External Integrations"
+      integration_sync_enqueued: "Integration sync has been enqueued"
+      integration_inactive: "Integration is inactive"
+      external_integrations:
+        view_result: "View Result"
+        sync_result: "Sync Result"
+        external_payload: "External Payload"
+        no_results: "No results found"
     event:
       check_in:
         success: "Guest check-in in successfully"

data/config/locales/km.yml

@@ -341,6 +341,14 @@ km:
     admin:
       display_on:
         frontend_for_early_adopter: "Storefront for Early Adopter"
+      external_integrations_title: "ការភ្ជាប់ខាងក្រៅ"
+      integration_sync_enqueued: "ការធ្វើសមកាលកម្មបានដាក់ក្នុងជួរ"
+      integration_inactive: "ការភ្ជាប់មិនដំណើរការ"
+      external_integrations:
+        view_result: "មើលលទ្ធផល"
+        sync_result: "លទ្ធផលធ្វើសមកាលកម្ម"
+        external_payload: "ទិន្នន័យខាងក្រៅ"
+        no_results: "មិនមានលទ្ធផលទេ"
     event:
       check_in:
         success: "Guest check-in in successfully"

data/config/routes.rb

@@ -283,6 +283,13 @@ Spree::Core::Engine.add_routes do
         post :set_webhook
       end
     end
+    resources :integrations do
+      member do
+        post :enqueue_polling
+      end
+      resources :sessions, only: [:index], controller: 'integration_sessions'
+      resources :mappings, only: [:index], controller: 'integration_mappings'
+    end
 
     resources :webhooks_subscribers do
       resources :rules, controller: :webhooks_subscriber_rules, except: %i[index show]
@@ -579,7 +586,7 @@ Spree::Core::Engine.add_routes do
         resource :cart, controller: :cart, only: %i[show create destroy] do
           patch :restart_checkout_flow
         end
-
+        resources :tenants, only: %i[show], constraints: { id: /.+/ }
         resources :trip_places
         resources :trip_search, only: [:index]
         resources :trips, only: %i[show]
@@ -695,6 +702,7 @@ Spree::Core::Engine.add_routes do
 
         resources :seat_layouts, only: %i[show index]
         resources :inventory_items, only: %i[index]
+        resources :event_matches, only: %i[index]
         namespace :transit do
           resources :draft_orders, only: %i[create]
         end

data/db/migrate/20251017094845_create_cm_integrations.rb

@@ -0,0 +1,22 @@
+class CreateCmIntegrations < ActiveRecord::Migration[7.0]
+  def change
+    create_table :cm_integrations, if_not_exists: true do |t|
+      t.string :type, null: false
+      t.string :name, null: false
+
+      t.integer :status, null: false, default: 0
+      t.integer :conflict_strategy, null: false, default: 0
+
+      t.integer :incremental_sync_interval_seconds, null: false, default: 10
+      t.integer :full_sync_interval_hours, null: false, default: 24
+
+      t.references :tenant, foreign_key: { to_table: :cm_tenants }, null: true
+      t.references :vendor, foreign_key: { to_table: :spree_vendors }, null: false
+
+      t.jsonb :public_metadata, default: {}
+      t.jsonb :private_metadata, default: {}
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20251017101555_create_cm_integration_sync_sessions.rb

@@ -0,0 +1,68 @@
+class CreateCmIntegrationSyncSessions < ActiveRecord::Migration[7.0]
+  def change
+    create_table :cm_integration_sync_sessions, if_not_exists: true do |t|
+      t.integer :status, null: false
+      t.integer :sync_type, null: false
+
+      t.datetime :started_at
+      t.datetime :ended_at
+
+      t.references :integration, foreign_key: { to_table: :cm_integrations }, null: false
+      t.references :tenant, foreign_key: { to_table: :cm_tenants }, null: true
+
+      # Stores the serialized sync result (SyncResult#to_h) for this session.
+      # This field is used to persist the outcome of the sync operation,
+      # allowing for detailed tracking of results, whether the sync was successful or not.
+      #
+      # Base class: app/services/spree_cm_commissioner/integrations/base/sync_result.rb
+      #
+      # Example implementations include:
+      # - Full sync results: integrations/stadium_x_v1/sync_results/full_sync_result.rb
+      # - Incremental sync results: integrations/stadium_x_v1/sync_results/incremental_sync_result.rb
+      #
+      # The result is saved upon completion of the session in the SyncManager#run_execution method:
+      # - app/services/spree_cm_commissioner/integrations/base/sync_manager.rb
+      t.jsonb :sync_result, default: {}
+
+      t.timestamps
+    end
+
+    # Indexes for PollingScheduler queries (optimized for performance)
+    # Initially used in polling_scheduler.rb
+    #
+    # Index 1: Find in_progress/pending syncs created within last hour
+    # Used by: should_run_full_sync? and should_run_incremental_sync?
+    # Query: .where(sync_type: [...], status: [...]).where('created_at > ?', 1.hour.ago).exists?
+    # Why: Composite index on all filter columns for fast lookup of active syncs
+    unless index_exists?(:cm_integration_sync_sessions, [:integration_id, :sync_type, :status, :created_at], name: 'idx_sync_sessions_integration_type_status_created_at')
+      add_index :cm_integration_sync_sessions, [:integration_id, :sync_type, :status, :created_at],
+                name: 'idx_sync_sessions_integration_type_status_created_at'
+    end
+
+    # Index 2: Find latest completed full sync (partial index - only completed rows)
+    # Used by: should_run_full_sync?
+    # Query: .where(sync_type: :full, status: :completed).order(created_at: :desc).first
+    # Why: Partial index reduces size by ~60% (excludes in_progress/pending/failed rows)
+    #      Descending order on created_at allows DB to return latest without sorting
+    #      Only 2 columns needed since sync_type and status are filtered by WHERE clause
+    unless index_exists?(:cm_integration_sync_sessions, [:integration_id, :created_at], name: 'idx_sync_sessions_full_completed')
+      add_index :cm_integration_sync_sessions, [:integration_id, :created_at],
+                name: 'idx_sync_sessions_full_completed',
+                where: "sync_type = 0 AND status = 2", # full=0, completed=2
+                order: { created_at: :desc }
+    end
+
+    # Index 3: Find latest completed incremental sync (partial index - only completed rows)
+    # Used by: should_run_incremental_sync?
+    # Query: .where(sync_type: :incremental, status: :completed).order(created_at: :desc).first
+    # Why: Partial index reduces size by ~60% (excludes in_progress/pending/failed rows)
+    #      Descending order on created_at allows DB to return latest without sorting
+    #      Only 2 columns needed since sync_type and status are filtered by WHERE clause
+    unless index_exists?(:cm_integration_sync_sessions, [:integration_id, :created_at], name: 'idx_sync_sessions_incremental_completed')
+      add_index :cm_integration_sync_sessions, [:integration_id, :created_at],
+                name: 'idx_sync_sessions_incremental_completed',
+                where: "sync_type = 1 AND status = 2", # incremental=1, completed=2
+                order: { created_at: :desc }
+    end
+  end
+end

data/db/migrate/20251017101605_create_cm_integration_mappings.rb

@@ -0,0 +1,52 @@
+class CreateCmIntegrationMappings < ActiveRecord::Migration[7.0]
+  def change
+    create_table :cm_integration_mappings, if_not_exists: true do |t|
+      t.string :external_id, null: false
+      t.string :internal_type, null: false
+      t.bigint :internal_id, null: false
+      t.jsonb :external_payload, default: nil
+
+      # optional for record that can have different mappings on different dates
+      t.date :date, null: true
+      t.integer :status, null: false, default: 0
+      t.references :integration, null: false, foreign_key: { to_table: :cm_integrations }
+
+      t.jsonb :public_metadata, default: {}
+      t.jsonb :private_metadata, default: {}
+
+      t.datetime :last_synced_at
+      t.timestamps
+    end
+
+    # Index 1: Unique constraint for external_id mappings
+    # Used by: IntegrationMapping#validates :external_id
+    # Query: validates :external_id, uniqueness: { scope: %i[integration_id internal_type internal_id date] }
+    # Why: Ensures a single external_id maps to only one internal record per integration/date combination
+    #      Prevents duplicate mappings that could cause sync conflicts
+    #      Unique index enforces this at database level for data integrity
+    unless index_exists?(:cm_integration_mappings, [:integration_id, :external_id, :internal_type, :internal_id, :date], name: 'idx_external_internal_mapping')
+      add_index :cm_integration_mappings, [:integration_id, :external_id, :internal_type, :internal_id, :date], unique: true, name: 'idx_external_internal_mapping'
+    end
+
+    # Index 2: Efficient lookup by integration_id and external_id
+    # Used by: IntegrationMappable#find_by_integration, IntegrationMappable#find_or_initialize_by_integration,
+    # IntegrationMappable#find_or_initialize_by_integration_with_mapping
+    #
+    # Query: .find_by(integration_id: integration_id, external_id: external_id)
+    # Why: Composite index allows efficient lookup by both integration_id and external_id
+    #      These methods are called frequently during sync operations
+    unless index_exists?(:cm_integration_mappings, [:integration_id, :internal_type, :external_id], name: 'idx_integration_external_id')
+      add_index :cm_integration_mappings, [:integration_id, :internal_type, :external_id], name: 'idx_integration_external_id'
+    end
+
+    # Index 3: Incremental sync query optimization
+    # Used by: IntegrationMappable#find_oldest_active_mapping (called by IncrementalSyncStrategy every 10 seconds)
+    # Query: .where(integration_id: integration_id, internal_type: model_name).active.order(:last_synced_at).first
+    # Why: Composite index filters by integration_id, internal_type, status efficiently
+    #      Includes last_synced_at for ORDER BY to avoid expensive sort operation
+    #      Runs every 10s so performance is critical - even small optimizations matter at this frequency
+    unless index_exists?(:cm_integration_mappings, [:integration_id, :internal_type, :status, :last_synced_at], name: 'idx_incremental_sync')
+      add_index :cm_integration_mappings, [:integration_id, :internal_type, :status, :last_synced_at], name: 'idx_incremental_sync'
+    end
+  end
+end

data/lib/cm_app_logger.rb

@@ -12,6 +12,7 @@ module CmAppLogger
 
     message[:start_time] = start_time
     message[:duration_ms] = (Time.current - start_time) * 1000
+    message[:result] = block_result
     Rails.logger.info(message.to_json)
     block_result
   end

data/lib/spree_cm_commissioner/test_helper/factories/integration_factory.rb

@@ -0,0 +1,25 @@
+FactoryBot.define do
+  factory :cm_integration, class: SpreeCmCommissioner::Integration do
+    type { 'SpreeCmCommissioner::Integrations::StadiumXV1' }
+    name { FFaker::Company.name }
+    status { :active }
+    conflict_strategy { :newest_wins }
+    incremental_sync_interval_seconds { 300 }
+    full_sync_interval_hours { 24 }
+    association :vendor, factory: :cm_vendor
+
+    trait :active do
+      status { :active }
+    end
+
+    trait :inactive do
+      status { :inactive }
+    end
+  end
+
+  factory :cm_stadium_x_v1_integration, parent: :cm_integration, class: SpreeCmCommissioner::Integrations::StadiumXV1 do
+    public_key { FFaker::Lorem.characters(20) }
+    private_key { FFaker::Lorem.characters(40) }
+    base_url { 'https://api.stadiumx.com' }
+  end
+end

data/lib/spree_cm_commissioner/test_helper/factories/integration_mapping_factory.rb

@@ -0,0 +1,14 @@
+FactoryBot.define do
+  factory :cm_integration_mapping, class: SpreeCmCommissioner::IntegrationMapping do
+    external_id { SecureRandom.alphanumeric(10) }
+    association :integration, factory: :cm_integration
+    status { :active }
+
+    transient do
+      internal { create(:cm_product) }
+    end
+
+    internal_id { internal.id }
+    internal_type { internal.class.name }
+  end
+end

data/lib/spree_cm_commissioner/test_helper/factories/integration_sync_session_factory.rb

@@ -0,0 +1,7 @@
+FactoryBot.define do
+  factory :cm_integration_sync_session, class: SpreeCmCommissioner::IntegrationSyncSession do
+    status { :pending }
+    sync_type { :full }
+    association :integration, factory: :cm_integration
+  end
+end

data/lib/spree_cm_commissioner/version.rb

@@ -1,5 +1,5 @@
 module SpreeCmCommissioner
-  VERSION = '2.4.2'.freeze
+  VERSION = '2.5.0-pre1'.freeze
 
   module_function
 

data/lib/spree_cm_commissioner.rb

@@ -55,16 +55,17 @@ require 'byebug' if Rails.env.development? || Rails.env.test?
 
 module SpreeCmCommissioner
   class << self
-    # Allows overriding the default Redis connection pool with a custom one
-    attr_writer :redis_pool
+    # Allows overriding the default Redis connection pools with custom ones
+    attr_writer :inventory_redis_pool
 
-    def redis_pool
-      @redis_pool ||= default_redis_pool
+    # Inventory Redis pool for inventory management
+    def inventory_redis_pool
+      @inventory_redis_pool ||= default_redis_pool
     end
 
-    # Resets the Redis pool, useful for testing or reinitialization
-    def reset_redis_pool
-      @redis_pool = nil
+    # Resets all Redis pools, useful for testing or reinitialization
+    def reset_redis_pools
+      @inventory_redis_pool = nil
     end
 
     private