spree_cm_commissioner 2.5.0.pre.pre8 → 2.5.0.pre.pre10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 538969bdcdc4e74a70c795d9355b5c49357852b362d0534d208098434dcc8558
-  data.tar.gz: 14329cc3a2c2e8b0ae754057f65c6175c16e6f3251b9d16cd589efe64460ebde
+  metadata.gz: b5cbbf00c2631fe710fb1ea7860ddb1f932dcbdd77f266104f9a51ceffbebc70
+  data.tar.gz: cd934346b3bc288b68ff82410a19ebf40809f88d66562539fd6d08770b69b1b3
 SHA512:
-  metadata.gz: 8f989e81e1e4fc89004874ac6fe64535b450aeff5d709127e125339c0a71f5f4fd35eb344722354950fb72c28dbd751325b4b9c44ac3acb73c3ea6473626bdca
-  data.tar.gz: 624b7a73bf7ac18e24a60de96e284a6c1f336d3efbc3d818cbcdb0bda0e1839a9107e9264af5924c934d0e383bac7093db07b88e3ab0543bf0e6512a1f46d3d0
+  metadata.gz: 6550f4205c95a6f33b6619f8d3184307c9a0a99801db530124f97f973da7978d40f089f6444e984ff0d1c725492eb734cf0df59b774ed23992a7a17fbf2bf2d9
+  data.tar.gz: 49ec91822b20df7d0b939dee101125f7d344fe96972f57c9b93aeccdf96a22fb0edc688cbc052e171d9452684daeee9b54e72934d6206beb29f7ec972ba285d7

data/.bundle/config

@@ -1,3 +1,4 @@
 ---
-BUNDLE_RETRY: "3"
-BUNDLE_JOBS: "4"
+BUNDLE_PATH: "/home/runner/work/commissioner/commissioner/vendor/bundle"
+BUNDLE_DEPLOYMENT: "true"
+BUNDLE_JOBS: "2"

data/.github/workflows/test_and_build_gem.yml

@@ -5,12 +5,11 @@ on:
   pull_request:
     types:
       - opened
-      - edited
       - synchronize
       - reopened
     branches:
       - develop
-      - milestone-77-scalable-design
+      - "*-milestone" # matches any branch with suffix *-milestone, eg. external-integration-milestone
   push:
     tags:
       - "*"
@@ -20,7 +19,7 @@ jobs:
 
     steps:
       - name: Check PR title format
-        if: github.event_name == 'pull_request'
+        if: github.event_name == 'pull_request' && !contains(github.head_ref, '-milestone')
         uses: actions/github-script@v7
         with:
           script: |
@@ -38,8 +37,7 @@ jobs:
               console.log("PR title format is correct.");
             }
       - name: Check commit messages format
-        # skip validation if the PR is from the milestone-77-scalable-design branch for temporary
-        if: github.event_name == 'pull_request' && github.head_ref != 'milestone-77-scalable-design'
+        if: github.event_name == 'pull_request' && !contains(github.head_ref, '-milestone')
         uses: actions/github-script@v7
         with:
           script: |
@@ -71,7 +69,7 @@ jobs:
               console.log("All commit messages are correctly formatted.");
             }
       - name: Check for unresolved review threads
-        if: github.event_name == 'pull_request'
+        if: github.event_name == 'pull_request' && !contains(github.head_ref, '-milestone')
         uses: actions/github-script@v7
         with:
           script: |
@@ -117,9 +115,8 @@ jobs:
               console.log("✅ All review threads are resolved.");
             }
 
-  test_and_build_gem:
+  setup:
     needs: [validate-commits]
-    # if: github.head_ref != '2572-enforce-pr-workflow' || github.base_ref != 'develop'
     runs-on: ubuntu-latest
 
     services:
@@ -152,22 +149,10 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      # - uses: borales/actions-yarn@v2.0.0
-      #   with:
-      #     cmd: install
-
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: "3.2.0"
-
-          # bundle-cache might cause problem when upgrading ruby. Disable it when upgrading to solve the problem.
-          # bundler-cache: true
-
-      - name: Install dependencies
-        run: |
-          sudo apt-get -yqq install libpq-dev
-          gem install bundler
-          bundle install --jobs 4 --retry 3
+          bundler-cache: true
 
       - name: Quality
         env:
@@ -181,56 +166,137 @@ jobs:
         run: |
           bundle exec brakeman
 
-      - name: Run test
+  test:
+    needs: [setup]
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+
+    strategy:
+      fail-fast: false
+      matrix:
+        spec_group: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]
+
+    services:
+      db:
+        image: postgres:12
+        env:
+          POSTGRES_HOST_AUTH_METHOD: trust
+          POSTGRES_USER: myuser
+          POSTGRES_PASSWORD: mypassword
+          POSTGRES_DB: test_db
+        ports: ["5432:5432"]
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+      redis:
+        image: redis
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update -qq
+          sudo apt-get install -yqq libpq-dev
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.2.0"
+          bundler-cache: true
+
+      # Cache Strategy: Speed up test runs by ~40 seconds
+      # ================================================
+      # We split test app setup into 2 parts:
+      #   1. Generate files (slow ~40s, cacheable) - rake test_app:generate
+      #   2. Setup database (fast ~20s, always run) - rake test_app:db
+      #
+      # Cache Key: test-app-{OS}-{hash of Gemfile.lock + db/migrate files}
+      #   - If Gemfile.lock or migrations change → new cache key → regenerate files
+      #   - If unchanged → restore cached spec/dummy → skip generation
+      #
+      # Example:
+      #   First run:  Generate files (40s) + Setup DB (20s) = 60s total
+      #   Cache hit:  Restore cache (5s) + Setup DB (20s) = 25s total
+      #   Savings:    ~35-40 seconds per test job (10 parallel jobs = 350-400s saved!)
+      #
+      # What's cached: spec/dummy directory containing:
+      #   - Generated Rails app files
+      #   - Spree installation files
+      #   - Extension installation files
+      #   - Config files (database.yml, routes.rb, etc.)
+      #
+      # What's NOT cached (always regenerated):
+      #   - Database itself (PostgreSQL data)
+      #   - Test results
+      #   - Coverage reports
+      - name: Cache test app files
+        uses: actions/cache@v3
+        with:
+          path: spec/dummy
+          key: test-app-${{ runner.os }}-${{ hashFiles('Gemfile.lock', 'db/migrate/*.rb') }}
+          restore-keys: |
+            test-app-${{ runner.os }}-
+
+      # Generate dummy Rails app for testing (cacheable part)
+      # This step checks if spec/dummy exists and skips generation if found
+      # Defined in: gems/spree_cm_commissioner/Rakefile (test_app:generate task)
+      - name: Generate test app files
         env:
           DATABASE_URL: postgres://myuser:mypassword@localhost:5432/test_db
           REDIS_URL: redis://localhost:6379/0
+        run: |
+          bundle exec rake test_app:generate
 
-        if: github.event_name == 'pull_request'
+      # Setup database (always runs, fast ~20s)
+      # Drops/creates database and runs migrations
+      # Defined in: gems/spree_cm_commissioner/Rakefile (test_app:db task)
+      - name: Setup database
+        env:
+          DATABASE_URL: postgres://myuser:mypassword@localhost:5432/test_db
+          REDIS_URL: redis://localhost:6379/0
         run: |
-          bundle exec rake
-
-      # 2405-build-and-publish-gem
-      # - name: Rename long migration files
-      #   env:
-      #     DATABASE_URL: postgres://myuser:mypassword@localhost:5432/test_db
-      #   # if: startsWith(github.ref, 'refs/tags/') # Only on tag pushes
-      #   if: github.ref == 'refs/heads/2405-build-and-publish-gem'
-
-      #   run: |
-      #     cd db/migrate
-      #     for file in *.rb; do
-      #       if [ ${#file} -gt 60 ]; then  # Adjust threshold if needed
-      #         # Extract timestamp (first 14 chars) and shorten the rest
-      #         timestamp=${file:0:14}
-      #         suffix=$(echo "$file" | sed 's/^[0-9]\{14\}_//' | sed 's/\.rb$//')
-      #         short_suffix=$(echo "$suffix" | cut -c1-40) # Limit suffix to 40 chars
-      #         new_name="${timestamp}_${short_suffix}.rb"
-      #         mv "$file" "$new_name"
-      #         echo "Renamed $file to $new_name"
-      #       fi
-      #     done
+          bundle exec rake test_app:db
 
-      # Build the gem
-      - name: Build gem
+      # Run specs in parallel groups (1-12)
+      # Each group runs ~1/12th of total spec files
+      # Script: bin/run_spec_group shows which files are in each group
+      - name: Run test (Group ${{ matrix.spec_group }}/12)
         env:
           DATABASE_URL: postgres://myuser:mypassword@localhost:5432/test_db
+          REDIS_URL: redis://localhost:6379/0
+        run: |
+          bin/run_spec_group ${{ matrix.spec_group }} 12
+
+  build_and_publish:
+    needs: [setup]
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/')
+
+    steps:
+      - uses: actions/checkout@v3
 
-        # if: startsWith(github.ref, 'refs/tags/') # Only on tag pushes
-        if: |
-          startsWith(github.ref, 'refs/tags/')
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.2.0"
+          bundler-cache: true
+
+      # Build the gem
+      - name: Build gem
         run: |
           gem build *.gemspec
 
       # Publish the gem
       - name: Publish gem
-        env:
-          DATABASE_URL: postgres://myuser:mypassword@localhost:5432/test_db
-
-        # if: startsWith(github.ref, 'refs/tags/') # Only on tag pushes
-        # (github.event_name == 'push' && github.ref == 'refs/heads/2405-build-and-publish-gem')
-        if: |
-          startsWith(github.ref, 'refs/tags/')
         run: |
           mkdir -p ~/.gem
           echo ":rubygems_api_key: ${{ secrets.RUBYGEMS_API_KEY }}" > ~/.gem/credentials

data/.tool-versions

@@ -1 +1 @@
-ruby 3.3.5
+ruby 3.2.0

data/Gemfile.lock

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

data/Rakefile

@@ -17,34 +17,60 @@ end
 # Copied from:
 # spree_core:lib/spree/testing_support/common_rake.rb
 # But refactored to skip frontend & backend setup.
+
+namespace :test_app do
+  desc 'Generate dummy app files (cacheable)'
+  task :generate do
+    require 'spree_cm_commissioner'
+    require "generators/spree_cm_commissioner/install/install_generator"
+
+    Rails.env = ENV['RAILS_ENV'] = 'test'
+
+    # Skip if already generated
+    if Dir.exist?('spec/dummy') && File.exist?('spec/dummy/config/database.yml')
+      puts '✓ Test app files already exist, skipping generation...'
+    else
+      puts 'Generating test app files...'
+      Spree::DummyGeneratorHelper.inject_extension_requirements = true
+      Spree::DummyGenerator.start ["--lib_name=spree_cm_commissioner", '--quiet']
+      Spree::InstallGenerator.start [
+        "--lib_name=spree_cm_commissioner",
+        '--auto-accept',
+        '--migrate=false',
+        '--seed=false',
+        '--sample=false',
+        '--quiet',
+        '--copy_storefront=false',
+        "--install_storefront=false",
+        "--install_admin=false",
+        "--user_class=Spree::User"
+      ]
+
+      puts 'Generating dummy model...'
+      Spree::DummyModelGenerator.start
+
+      puts 'Running extension installation generator...'
+      SpreeCmCommissioner::Generators::InstallGenerator.start(['--auto-run-migrations'])
+
+      puts '✓ Test app files generated'
+    end
+  end
+
+  desc 'Setup database'
+  task :db do
+    Rails.env = ENV['RAILS_ENV'] = 'test'
+
+    puts 'Setting up dummy database...'
+    Dir.chdir('spec/dummy') do
+      system('RAILS_ENV=test bundle exec rake db:drop db:create')
+      system('RAILS_ENV=test bundle exec rake db:migrate')
+      puts '✓ Database setup complete'
+    end
+  end
+end
+
 desc 'Generates a dummy app for testing'
-task :test_app do |_t, args|
-  require 'spree_cm_commissioner'
-  require "generators/spree_cm_commissioner/install/install_generator"
-
-  Rails.env = ENV['RAILS_ENV'] = 'test'
-
-  Spree::DummyGeneratorHelper.inject_extension_requirements = true
-  Spree::DummyGenerator.start ["--lib_name=spree_cm_commissioner", '--quiet']
-  Spree::InstallGenerator.start [
-    "--lib_name=spree_cm_commissioner",
-    '--auto-accept',
-    '--migrate=false',
-    '--seed=false',
-    '--sample=false',
-    '--quiet',
-    '--copy_storefront=false',
-    "--install_storefront=false",
-    "--install_admin=false",
-    "--user_class=Spree::User"
-  ]
-
-  puts 'Setting up dummy database...'
-  system('bin/rails db:environment:set RAILS_ENV=test')
-  system('bundle exec rake db:drop db:create')
-  Spree::DummyModelGenerator.start
-  system('bundle exec rake db:migrate')
-
-  puts 'Running extension installation generator...'
-  SpreeCmCommissioner::Generators::InstallGenerator.start(['--auto-run-migrations'])
+task :test_app do
+  Rake::Task['test_app:generate'].invoke
+  Rake::Task['test_app:db'].invoke
 end

data/app/controllers/spree/admin/base_controller_decorator.rb

@@ -61,11 +61,11 @@ module Spree
           api_patterns = api_patterns_map[model]
 
           if api_patterns.is_a?(Array)
-            api_patterns.each { |pattern| SpreeCmCommissioner::InvalidateCacheRequestJob.perform_later(pattern) }
+            api_patterns.each { |pattern| SpreeCmCommissioner::InvalidateCacheRequestJob.perform_later(pattern: pattern) }
           elsif api_patterns.is_a?(String)
-            SpreeCmCommissioner::InvalidateCacheRequestJob.perform_later(api_patterns)
+            SpreeCmCommissioner::InvalidateCacheRequestJob.perform_later(pattern: api_patterns)
           elsif params[:api_pattern].present?
-            SpreeCmCommissioner::InvalidateCacheRequestJob.perform_later(params[:api_pattern])
+            SpreeCmCommissioner::InvalidateCacheRequestJob.perform_later(pattern: params[:api_pattern])
           end
         end
         redirect_back fallback_location: admin_root_path

data/app/controllers/spree/admin/base_import_orders_controller.rb

@@ -17,7 +17,12 @@ module Spree
         import_order = build_import_order(name, imported_file)
 
         if import_order.save
-          SpreeCmCommissioner::ImportOrderJob.perform_later(import_order.id, spree_current_user.id, import_order.import_type)
+          SpreeCmCommissioner::ImportOrderJob.perform_later(
+            import_order_id: import_order.id,
+            import_by_user_id: spree_current_user.id,
+
+            import_type: import_order.import_type
+          )
           flash[:success] = I18n.t('import_orders.success_message')
         else
           flash[:error] = I18n.t('import_orders.error_message')

data/app/controllers/spree/admin/classifications_controller.rb

@@ -5,7 +5,7 @@ module Spree
 
       def recalculate_conversions
         @taxon.products.each do |product|
-          SpreeCmCommissioner::ConversionPreCalculatorJob.perform_later(product.id)
+          SpreeCmCommissioner::ConversionPreCalculatorJob.perform_later(product_id: product.id)
         end
 
         flash[:success] = flash_message_for(@taxon, :successfully_updated)

data/app/controllers/spree/admin/integration_mappings_controller.rb

@@ -0,0 +1,21 @@
+module Spree
+  module Admin
+    class IntegrationMappingsController < Spree::Admin::BaseController
+      helper SpreeCmCommissioner::ExternalIntegrationsHelper
+      before_action :load_integration
+
+      def index
+        @mappings = @integration.integration_mappings
+                                .order(updated_at: :desc)
+                                .page(params[:page])
+                                .per(params[:per_page] || 25)
+      end
+
+      private
+
+      def load_integration
+        @integration ||= SpreeCmCommissioner::Integration.find(params[:integration_id])
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/integration_sessions_controller.rb

@@ -0,0 +1,21 @@
+module Spree
+  module Admin
+    class IntegrationSessionsController < Spree::Admin::BaseController
+      helper SpreeCmCommissioner::ExternalIntegrationsHelper
+      before_action :load_integration
+
+      def index
+        @sync_sessions = @integration.integration_sync_sessions
+                                     .order(created_at: :desc)
+                                     .page(params[:page])
+                                     .per(params[:per_page] || 25)
+      end
+
+      private
+
+      def load_integration
+        @integration ||= SpreeCmCommissioner::Integration.find(params[:integration_id])
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/integrations_controller.rb

@@ -0,0 +1,83 @@
+module Spree
+  module Admin
+    class IntegrationsController < Spree::Admin::ResourceController
+      helper SpreeCmCommissioner::ExternalIntegrationsHelper
+      before_action :load_form_collections, only: %i[new create edit update]
+      before_action :load_integration, only: %i[enqueue_polling]
+
+      def index
+        @integrations = model_class.all
+      end
+
+      def enqueue_polling
+        sync_type = params[:sync_type].presence || :full
+
+        if @integration.active?
+          SpreeCmCommissioner::Integrations::PollingJob.perform_later(
+            integration_id: @integration.id,
+            sync_type: sync_type
+          )
+          flash[:success] = Spree.t('admin.integration_sync_enqueued')
+        else
+          flash[:error] = Spree.t('admin.integration_inactive')
+        end
+
+        redirect_to admin_integration_sessions_path(@integration)
+      end
+
+      # override
+      def model_class
+        SpreeCmCommissioner::Integration
+      end
+
+      # override
+      def collection_url(options = {})
+        admin_integrations_url(options)
+      end
+
+      private
+
+      def permitted_resource_params
+        params.require(:spree_cm_commissioner_integration).permit(
+          :name,
+          :type,
+          :status,
+          :conflict_strategy,
+          :incremental_sync_interval_seconds,
+          :full_sync_interval_hours,
+          :tenant_id,
+          :vendor_id,
+          public_metadata: {},
+          private_metadata: {}
+        )
+      end
+
+      def load_integration
+        @integration ||= SpreeCmCommissioner::Integration.find(params[:id])
+      end
+
+      def load_form_collections
+        @integration_type_options ||= integration_type_options
+        @status_options ||= enum_to_options(SpreeCmCommissioner::Integration.statuses)
+        @conflict_strategy_options ||= enum_to_options(SpreeCmCommissioner::Integration.conflict_strategies)
+        @tenants ||= SpreeCmCommissioner::Tenant.select(:id, :name).order(:name)
+        @vendors ||= Spree::Vendor.select(:id, :name).order(:name)
+      end
+
+      def enum_to_options(enum_hash)
+        enum_hash.keys.map { |key| [key.humanize, key] }
+      end
+
+      def integration_type_options
+        files = Dir[SpreeCmCommissioner::Engine.root.join('app/models/spree_cm_commissioner/integrations/*.rb')]
+
+        return [[Spree.t(:type), 'SpreeCmCommissioner::Integration']] if files.blank?
+
+        files.map do |path|
+          class_name = "SpreeCmCommissioner::Integrations::#{File.basename(path, '.rb').camelize}"
+          [class_name, class_name]
+        end.sort_by(&:first)
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/notification_sender_controller.rb

@@ -5,7 +5,7 @@ module Spree
         customer_notification_id = params[:notification_id]
         user_ids = params[:send_all] == 'true' ? nil : params[:user_ids]
 
-        SpreeCmCommissioner::CustomerNotificationSenderJob.perform_later(customer_notification_id, user_ids)
+        SpreeCmCommissioner::CustomerNotificationSenderJob.perform_later(customer_notification_id: customer_notification_id, user_ids: user_ids)
 
         redirect_to admin_customer_notifications_path
       end

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

@@ -0,0 +1,15 @@
+module Spree
+  module Api
+    module V2
+      module Storefront
+        class EventMatchesController < TaxonsController
+          private
+
+          def collection_finder
+            SpreeCmCommissioner::Events::FindMatches
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/spree/api/v2/storefront/queue_cart/line_items_controller.rb

@@ -19,12 +19,12 @@ module Spree
               end
 
               job = SpreeCmCommissioner::EnqueueCart::AddItemJob.perform_later(
-                spree_current_order.id,
-                @variant.id,
-                add_item_params[:quantity],
-                add_item_params[:public_metadata],
-                add_item_params[:private_metadata],
-                add_item_params[:options]
+                order_id: spree_current_order.id,
+                variant_id: @variant.id,
+                quantity: add_item_params[:quantity],
+                public_metadata: add_item_params[:public_metadata],
+                private_metadata: add_item_params[:private_metadata],
+                options: add_item_params[:options]
               )
 
               return render_error_payload('Failed to enqueue the job') unless job

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

@@ -17,6 +17,17 @@ module Spree
           def resource_serializer
             SpreeCmCommissioner::V2::Storefront::TripSerializer
           end
+
+          # override
+          def serializer_params
+            super.merge(
+              include_details: include_details?
+            )
+          end
+
+          def include_details?
+            params.fetch(:include_details, 'true') == 'true'
+          end
         end
       end
     end

data/app/errors/spree_cm_commissioner/integrations/external_client_error.rb

@@ -0,0 +1,10 @@
+module SpreeCmCommissioner::Integrations
+  class ExternalClientError < StandardError
+    attr_reader :status_code
+
+    def initialize(message, status_code = nil)
+      super(message)
+      @status_code = status_code
+    end
+  end
+end

data/app/errors/spree_cm_commissioner/integrations/sync_error.rb

@@ -0,0 +1,4 @@
+module SpreeCmCommissioner::Integrations
+  class SyncError < StandardError
+  end
+end

data/app/finders/spree_cm_commissioner/events/find_matches.rb

@@ -0,0 +1,15 @@
+module SpreeCmCommissioner
+  module Events
+    class FindMatches < ::Spree::BaseFinder
+      # currently, there is no way to determine if an event is a match yet.
+      # this finder returns all events that have active integration mappings (synced from external systems like StadiumX)
+      # as a temporary workaround to filter out non-match events.
+      def execute
+        scope.joins(:integration_mappings).where(
+          kind: :event,
+          integration_mappings: { status: :active }
+        ).distinct
+      end
+    end
+  end
+end