Class: ShipengineLtlTrackingWorker

Inherits:
Object
  • Object
show all
Includes:
Sidekiq::Job
Defined in:
app/workers/shipengine_ltl_tracking_worker.rb

Overview

Hourly poll of ShipEngine's LTL tracking endpoint for every invoiced
ShipEngine LTL freight delivery that has a PRO and hasn't delivered yet.

ShipEngine LTL has no tracking webhook (unlike ShipEngine parcel), so we
poll. Each poll projects the carrier's scans into ShipmentEvent rows keyed
by the delivery's PRO — the SAME table the parcel tracking webhook writes —
so the delivery-level status icon (DeliveriesHelper#shipengine_ltl_status_icon)
is rendered by the identical ShipmentEventStatusSummary logic as parcel.

Stop conditions (see Shipping::ShipengineLtlTracker#pollable?):

  • a delivered scan (DE/SP) is on file → stop;
  • Shipping::ShipengineLtlTracker::POLL_MAX_AGE past pickup → stop (the
    backstop for refused / undeliverable / stuck freight; exceptions still
    surface via the red icon while polling continues up to the backstop).

Scheduled hourly via sidekiq-scheduler — see
config/sidekiq_production_schedule.yml and config/sidekiq_staging_schedule.yml.

Instance Method Summary collapse

Instance Method Details

#perform ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'app/workers/shipengine_ltl_tracking_worker.rb', line 25

def perform
  polled = 0
  inserted = 0

  Shipping::ShipengineLtlTracker.candidates.find_each do |delivery|
    tracker = Shipping::ShipengineLtlTracker.new(delivery)
    next unless tracker.pollable?

    polled += 1
    inserted += tracker.poll!
  rescue StandardError => e
    # One bad delivery must not abort the sweep. The tracker already
    # swallows its own poll/persist errors, but guard the loop too.
    Rails.logger.error("[ShipengineLtlTrackingWorker] delivery=#{delivery.id} error: #{e.class}: #{e.message}")
    ErrorReporting.warning('ShipengineLtlTrackingWorker per-delivery failure',
                           error: e.message, delivery_id: delivery.id)
  end

  Rails.logger.info("[ShipengineLtlTrackingWorker] polled=#{polled} new_events=#{inserted}")
end