spree_cm_commissioner 2.13.3.pre.pre1 → 2.13.3.pre.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6debbf57a54a0a2fcbc3ba4ee4c3e07045c520377afbd0ad13d6f6fde2120654
-  data.tar.gz: 3c66791879a8187925ac7ecba67437a4e049bce327f7d19ff9f435d0acddd54e
+  metadata.gz: 1c04efc07b0defa6eedb7b800bf8c5504401b7de9042751e32a6eb40c1ec6897
+  data.tar.gz: 414a5fb2a306e1a1e948c9e08cbb14e412752b112c2509332ba6c15132870369
 SHA512:
-  metadata.gz: f5a7c7f1e396e46ae559484c92900a1180ede361e562b192a0b13abc922779f521fbc093a86d695b760abcc8609e0563785e5fadd285fb919670c0c8816bf5d9
-  data.tar.gz: 124912777c8bacddd0a1f067ab1e6faaa245af600da5343150f4862fd5c9cabdea60e54efddf64e636903a99cb2e0a7143c91647ff34e05a5c0d9d705ff8a5da
+  metadata.gz: d658bc4bfad3c59f0fb602afefd148e1ba7edc05a95925e4f7da564780f434178b16a910f747a58a21d9fe3644089ebd77e38a9b5751ec77804a6e91fb427ad5
+  data.tar.gz: fc0f5fb8a6c7ceed9874f78d2428f700afb508f1589d9ac1477c3e5768ce19885819719b74f7151309a671ec5eb51a0020a981f27da5fc977818bf4a5b067bb6

data/Gemfile.lock

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

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

@@ -12,9 +12,7 @@ module Spree
       def enqueue_polling
         sync_type = params[:sync_type].presence || :full
 
-        if !@integration.supports_polling?
-          flash[:error] = Spree.t('admin.integration_polling_not_supported')
-        elsif @integration.active?
+        if @integration.active?
           SpreeCmCommissioner::Integrations::PollingJob.perform_later(
             integration_id: @integration.id,
             sync_type: sync_type

data/app/models/spree_cm_commissioner/integration.rb

@@ -22,22 +22,10 @@ module SpreeCmCommissioner
         .sort
     end
 
-    # Integrations the partner calls into (rather than us pulling from them) have no sync_manager
-    # and override this to false. Class-level so the pollable scope can filter on `type`.
-    def self.supports_polling?
-      true
-    end
-
-    scope :pollable, -> { where(type: types.select { |type| type.constantize.supports_polling? }) }
-
     def sync_manager
       raise NotImplementedError, 'Subclasses must implement the sync_manager method'
     end
 
-    def supports_polling?
-      self.class.supports_polling?
-    end
-
     # Whether the partner, not BookMe+, sets this variant's per-night stock, prices and closings.
     # When true, stock resets and dashboard edits leave its inventory items alone, and new nights
     # start closed until the partner opens them (InventoryItem). Off by default.

data/app/models/spree_cm_commissioner/integrations/switch_cm.rb

@@ -1,6 +1,7 @@
 # A hotel connected to switch.cm, which calls our Booking.com-compatible channel-manager API
 # (Spree::Api::SwitchCm) instead of us calling it: it pushes availability, prices and
-# restrictions, and pulls reservations. So there's nothing to poll, hold or unstock externally.
+# restrictions, and pulls reservations. So there's nothing to pull, hold or unstock externally;
+# polling only runs our own checks (SyncManager).
 #
 # Every switch.cm row shares one Doorkeeper app; the hotels switch.cm may manage are the rows
 # pointing at it. `paused` is the setup state: switch.cm can read the hotel (room list,
@@ -18,11 +19,16 @@ class SpreeCmCommissioner::Integrations::SwitchCm < SpreeCmCommissioner::Integra
   before_create :set_connected_at
   after_commit :sync_unpushed_nights, on: %i[create update]
 
+  # Polling runs the hotel's periodic checks (SyncManager), and the incremental one alerts on
+  # every run while reservations sit unpulled, so the column's 10-second default would flood
+  # Telegram. Full runs daily upkeep.
+  attribute :incremental_sync_interval_seconds, :integer, default: -> { SyncStrategies::IncrementalSyncStrategy::UNSEEN_AFTER.to_i }
+
   scope :readable, -> { where(status: READABLE_STATUSES) }
 
   # override
-  def self.supports_polling?
-    false
+  def sync_manager
+    SyncManager.new(integration: self)
   end
 
   # Only for rooms switch.cm can see (RoomCatalog): a hotel's other products, and rooms that need
@@ -75,6 +81,6 @@ class SpreeCmCommissioner::Integrations::SwitchCm < SpreeCmCommissioner::Integra
     owned_before = status_before_last_save.to_s == 'active' && conflict_strategy_before_last_save.to_s == 'external_wins'
     return if owned_before == owns_inventory?
 
-    owns_inventory? ? PushedNights.new(self).close_unpushed! : PushedNights.new(self).reopen_unpushed!
+    PushedNights.new(self).reconcile_unpushed!
   end
 end

data/app/services/spree_cm_commissioner/integrations/polling_scheduler.rb

@@ -4,7 +4,7 @@ module SpreeCmCommissioner
       BATCH_SIZE = 10 # Process integrations in batches to avoid overwhelming the server
 
       def call
-        SpreeCmCommissioner::Integration.active.pollable.find_each(batch_size: BATCH_SIZE) do |integration|
+        SpreeCmCommissioner::Integration.active.find_each(batch_size: BATCH_SIZE) do |integration|
           if should_run_full_sync?(integration)
             schedule_full_sync(integration)
           elsif should_run_incremental_sync?(integration)

data/app/services/spree_cm_commissioner/integrations/switch_cm/pushed_nights.rb

@@ -45,6 +45,16 @@ class SpreeCmCommissioner::Integrations::SwitchCm
       unpushed_nights.where(closed: true).update_all(closed_update(false)) # rubocop:disable Rails/SkipsModelValidations
     end
 
+    # Puts unpushed nights back in the state ownership calls for; returns how many changed.
+    def reconcile_unpushed!
+      @integration.owns_inventory? ? close_unpushed! : reopen_unpushed!
+    end
+
+    # Returns how many were deleted.
+    def prune_past!
+      mappings.where('date < ?', Time.zone.today).delete_all
+    end
+
     # Upcoming room-nights pushed, out of all we hold, for the admin integration page.
     def progress
       { pushed: mappings.where(internal_id: upcoming_nights.select(:id)).count, total: upcoming_nights.count }

data/app/services/spree_cm_commissioner/integrations/switch_cm/sync_manager.rb

@@ -0,0 +1,16 @@
+class SpreeCmCommissioner::Integrations::SwitchCm
+  # switch.cm calls us, so polling has nothing to pull. It runs our own periodic checks for the
+  # hotel instead, logged as sync sessions like any other integration's: incremental alerts ops
+  # about reservations switch.cm hasn't picked up, full keeps the pushed-night bookkeeping tidy.
+  class SyncManager < SpreeCmCommissioner::Integrations::Base::SyncManager
+    # override
+    def sync_full!
+      run_execution(:full) { SyncStrategies::FullSyncStrategy.new(integration: @integration).call }
+    end
+
+    # override
+    def sync_incremental!
+      run_execution(:incremental) { SyncStrategies::IncrementalSyncStrategy.new(integration: @integration).call }
+    end
+  end
+end

data/app/services/spree_cm_commissioner/integrations/switch_cm/sync_strategies/full_sync_strategy.rb

@@ -0,0 +1,39 @@
+class SpreeCmCommissioner::Integrations::SwitchCm
+  module SyncStrategies
+    # Daily upkeep of the pushed-night bookkeeping (PushedNights):
+    #
+    # - Reconciles unpushed nights with who owns the rooms: closed while switch.cm owns them, open
+    #   otherwise. The connection's own save does this when ownership changes; this catches nights
+    #   that slipped past it, e.g. written by a path that skips callbacks.
+    # - Deletes mappings for past nights, which nothing reads and would otherwise grow by rooms ×
+    #   365 rows a year per hotel.
+    #
+    # Reconciling takes the hotel's push lock, so it never races a push that is opening a night.
+    # A busy lock fails the session, and PollingScheduler retries a failed full sync on its next tick.
+    class FullSyncStrategy
+      LOCK_WAIT = 5.seconds
+
+      class LockBusyError < StandardError; end
+
+      def initialize(integration:)
+        @integration = integration
+        @sync_result = SpreeCmCommissioner::Integrations::Base::SyncResult.new
+      end
+
+      def call
+        pushed_nights = PushedNights.new(@integration)
+
+        @sync_result.increment_metric(:pushed_nights, :pruned, pushed_nights.prune_past!)
+
+        reconciled = AccommodationLock.with_lock(@integration, wait: LOCK_WAIT) { pushed_nights.reconcile_unpushed! }
+        raise LockBusyError, 'Another push for this hotel held the lock' if reconciled == AccommodationLock::BUSY
+
+        @sync_result.increment_metric(:unpushed_nights, @integration.owns_inventory? ? :closed : :reopened, reconciled)
+        @sync_result
+      rescue StandardError => e
+        @sync_result.record_error(e)
+        @sync_result
+      end
+    end
+  end
+end

data/app/services/spree_cm_commissioner/integrations/switch_cm/sync_strategies/incremental_sync_strategy.rb

@@ -0,0 +1,51 @@
+class SpreeCmCommissioner::Integrations::SwitchCm
+  module SyncStrategies
+    # switch.cm pulls reservations, so a connector that stops polling fails silently: the hotel
+    # never hears about new bookings or cancellations. This alerts ops about the hotel's
+    # reservations still unseen after UNSEEN_AFTER, the same point at which Booking.com falls back
+    # to other delivery. It alerts on every run until they're picked up, so the hotel's
+    # incremental interval (SwitchCm defaults it to UNSEEN_AFTER) is also the alert's repeat rate.
+    class IncrementalSyncStrategy
+      UNSEEN_AFTER = 30.minutes
+      LISTED = 10
+
+      def initialize(integration:)
+        @integration = integration
+        @sync_result = SpreeCmCommissioner::Integrations::Base::SyncResult.new
+      end
+
+      def call
+        stale = stale_reservations
+        stale.group_by(&:status).each { |status, reservations| @sync_result.increment_metric(:unseen_reservations, status, reservations.size) }
+        alert(stale) if stale.any?
+
+        @sync_result
+      rescue StandardError => e
+        @sync_result.record_error(e)
+        @sync_result
+      end
+
+      private
+
+      def stale_reservations
+        feed = ReservationFeed.new([@integration])
+        limit = ReservationFeed::LIMIT_RANGE.max
+        cutoff = UNSEEN_AFTER.ago
+
+        (feed.new_reservations(limit: limit) + feed.cancelled_reservations(limit: limit)).select { |reservation| reservation.changed_at <= cutoff }
+      end
+
+      def alert(reservations)
+        data = {
+          integration_id: @integration.id,
+          hotel: "#{@integration.vendor.name} (#{@integration.vendor_id})",
+          reservations: reservations.first(LISTED).map { |reservation| "#{reservation.number} #{reservation.status}" }.join(', ')
+        }
+        message = "switch.cm hasn't picked up #{reservations.size} reservation(s) for #{UNSEEN_AFTER.inspect} or more"
+
+        CmAppLogger.error(label: "#{self.class.name}#alert", data: data.merge(message: message))
+        SpreeCmCommissioner::TelegramAlerts::IntegrationSyncFailure.call(error_message: message, data: data)
+      end
+    end
+  end
+end

data/app/views/spree/admin/integration_sessions/index.html.erb

@@ -28,14 +28,12 @@
       <%= Spree.t(:integration_sync_sessions) %>
     </h5>
 
-    <% if @integration.supports_polling? %>
-      <div class="card-header-actions">
-        <%= button_to Spree.t(:enqueue_full_sync),
-            enqueue_polling_admin_integration_path(@integration, sync_type: :full),
-            method: :post,
-            class: 'btn btn-primary btn-sm' %>
-      </div>
-    <% end %>
+    <div class="card-header-actions">
+      <%= button_to Spree.t(:enqueue_full_sync),
+          enqueue_polling_admin_integration_path(@integration, sync_type: :full),
+          method: :post,
+          class: 'btn btn-primary btn-sm' %>
+    </div>
   </div>
 
   <div class="card-body">

data/config/locales/en.yml

@@ -672,7 +672,6 @@ en:
       import_already_exists: "Import Already Exists"
       integration_sync_enqueued: "Integration sync has been enqueued"
       integration_inactive: "Integration is inactive"
-      integration_polling_not_supported: "This integration calls BookMe+ itself, so there is nothing to sync"
       inventory_external_wins: "Managed by %{name}: its stock and prices are set by the channel manager"
       external_integrations:
         view_result: "View Result"

data/config/locales/km.yml

@@ -445,7 +445,6 @@ km:
       import_already_exists: "ឯកសារយោងមានរួចហើយ"
       integration_sync_enqueued: "ការធ្វើសមកាលកម្មបានដាក់ក្នុងជួរ"
       integration_inactive: "ការភ្ជាប់មិនដំណើរការ"
-      integration_polling_not_supported: "ការភ្ជាប់នេះហៅមក BookMe+ ដោយខ្លួនឯង ដូច្នេះមិនមានអ្វីត្រូវធ្វើសមកាលកម្មទេ"
       inventory_external_wins: "គ្រប់គ្រងដោយ %{name}៖ ស្តុក និងតម្លៃ ត្រូវបានកំណត់ដោយ channel manager"
       external_integrations:
         view_result: "មើលលទ្ធផល"

data/lib/spree_cm_commissioner/version.rb

@@ -1,5 +1,5 @@
 module SpreeCmCommissioner
-  VERSION = '2.13.3-pre1'.freeze
+  VERSION = '2.13.3-pre2'.freeze
 
   module_function
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_cm_commissioner
 version: !ruby/object:Gem::Version
-  version: 2.13.3.pre.pre1
+  version: 2.13.3.pre.pre2
 platform: ruby
 authors:
 - You
@@ -1426,7 +1426,6 @@ files:
 - app/jobs/spree_cm_commissioner/integrations/cleanup_sync_sessions_job.rb
 - app/jobs/spree_cm_commissioner/integrations/polling_job.rb
 - app/jobs/spree_cm_commissioner/integrations/polling_scheduler_job.rb
-- app/jobs/spree_cm_commissioner/integrations/switch_cm/unseen_reservations_alert_job.rb
 - app/jobs/spree_cm_commissioner/invalidate_cache_request_job.rb
 - app/jobs/spree_cm_commissioner/inventory_holds/bulk_release_stale_job.rb
 - app/jobs/spree_cm_commissioner/inventory_holds/bulk_release_stale_payment_locked_job.rb
@@ -2434,7 +2433,9 @@ files:
 - app/services/spree_cm_commissioner/integrations/switch_cm/reservation.rb
 - app/services/spree_cm_commissioner/integrations/switch_cm/reservation_feed.rb
 - app/services/spree_cm_commissioner/integrations/switch_cm/room_catalog.rb
-- app/services/spree_cm_commissioner/integrations/switch_cm/unseen_reservations_alert.rb
+- app/services/spree_cm_commissioner/integrations/switch_cm/sync_manager.rb
+- app/services/spree_cm_commissioner/integrations/switch_cm/sync_strategies/full_sync_strategy.rb
+- app/services/spree_cm_commissioner/integrations/switch_cm/sync_strategies/incremental_sync_strategy.rb
 - app/services/spree_cm_commissioner/integrations/switch_cm/unseen_room_nights.rb
 - app/services/spree_cm_commissioner/integrations/switch_cm/validate_ari_updates.rb
 - app/services/spree_cm_commissioner/integrations/switch_cm/xml/availability_parser.rb

data/app/jobs/spree_cm_commissioner/integrations/switch_cm/unseen_reservations_alert_job.rb

@@ -1,7 +0,0 @@
-class SpreeCmCommissioner::Integrations::SwitchCm
-  class UnseenReservationsAlertJob < SpreeCmCommissioner::ApplicationUniqueJob
-    def perform(_options = {})
-      SpreeCmCommissioner::Integrations::SwitchCm::UnseenReservationsAlert.call
-    end
-  end
-end

data/app/services/spree_cm_commissioner/integrations/switch_cm/unseen_reservations_alert.rb

@@ -1,45 +0,0 @@
-class SpreeCmCommissioner::Integrations::SwitchCm
-  # switch.cm pulls reservations, so a connector that stops polling fails silently: the hotel
-  # never hears about new bookings or cancellations. This alerts ops about reservations still
-  # unseen after UNSEEN_AFTER, the same point at which Booking.com falls back to other delivery.
-  class UnseenReservationsAlert
-    prepend ::Spree::ServiceModule::Base
-
-    UNSEEN_AFTER = 30.minutes
-    LISTED_PER_HOTEL = 10
-
-    def call
-      stale = SpreeCmCommissioner::Integrations::SwitchCm.active.includes(:vendor).filter_map do |integration|
-        reservations = stale_reservations(integration)
-        next if reservations.empty?
-
-        { integration: integration, reservations: reservations }
-      end
-
-      stale.each { |entry| alert(entry[:integration], entry[:reservations]) }
-      success(alerted_hotels: stale.size)
-    end
-
-    private
-
-    def stale_reservations(integration)
-      feed = ReservationFeed.new([integration])
-      cutoff = UNSEEN_AFTER.ago
-
-      (feed.new_reservations(limit: ReservationFeed::LIMIT_RANGE.max) + feed.cancelled_reservations(limit: ReservationFeed::LIMIT_RANGE.max))
-        .select { |reservation| reservation.changed_at <= cutoff }
-    end
-
-    def alert(integration, reservations)
-      data = {
-        integration_id: integration.id,
-        hotel: "#{integration.vendor.name} (#{integration.vendor_id})",
-        reservations: reservations.first(LISTED_PER_HOTEL).map { |reservation| "#{reservation.number} #{reservation.status}" }.join(', ')
-      }
-      message = "switch.cm hasn't picked up #{reservations.size} reservation(s) for #{UNSEEN_AFTER.inspect} or more"
-
-      CmAppLogger.error(label: "#{self.class.name}#alert", data: data.merge(message: message))
-      SpreeCmCommissioner::TelegramAlerts::IntegrationSyncFailure.call(error_message: message, data: data)
-    end
-  end
-end