Class: SpreeCmCommissioner::WaitingGuestsCaller

Inherits:
BaseInteractor show all
Defined in:
app/interactors/spree_cm_commissioner/waiting_guests_caller.rb

Constant Summary collapse

MIN_WAIT_TO_ENTER_SECONDS =

10 min floor — Waiting Room step (full journey, most uncertainty)

(ENV['WAITING_ROOM_MIN_WAIT_TO_ENTER_SECONDS'] || 600).to_i
MIN_QUEUE_TO_ENTER_SECONDS =

5 min floor — Queue step (position assigned, sub-segment of the journey)

(ENV['WAITING_ROOM_MIN_QUEUE_TO_ENTER_SECONDS'] || 300).to_i
FIRESTORE_BATCH_SIZE =

Firestore bounds a batch update by payload size (10 MiB); 500 ops/commit leaves us far under that.

(ENV['WAITING_ROOM_FIRESTORE_BATCH_SIZE'] || 500).to_i

Instance Method Summary collapse

Instance Method Details

#call ⇒ Object 



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 15

def call
  available_slots = fetch_available_slots
  return unless available_slots.positive?

  long_waiting_guests = fetch_long_waiting_guests(available_slots)
  calling_all(long_waiting_guests)

  mark_as(
    full: long_waiting_guests.size >= available_slots,
    available_slots: available_slots - long_waiting_guests.size,
    avg_wait_to_enter_seconds: compute_avg_wait_to_enter_seconds(long_waiting_guests),
    avg_queue_to_enter_seconds: compute_avg_queue_to_enter_seconds(long_waiting_guests),
    slots_per_call: available_slots
  )
end

#calling_all(waiting_guests) ⇒ Object

For alert waiting guests to enter room, we just update :allow_to_enter_room_at. App will listen to firebase & start refresh session token to enter room.

Commit in Firestore batches (chunks of FIRESTORE_BATCH_SIZE) instead of one update per guest, so e.g. 1000 guests = 2 commits, not 1000 round-trips. update merges, so we only send the changed field and leave the rest of each doc intact.



84
85
86
87
88
89
90
91
92
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 84

def calling_all(waiting_guests)
  allow_at = Time.zone.now

  waiting_guests.each_slice(FIRESTORE_BATCH_SIZE) do |slice|
    firestore.batch do |b|
      slice.each { |document| b.update(document.ref, { allow_to_enter_room_at: allow_at }) }
    end
  end
end

#compute_avg_queue_to_enter_seconds(guests) ⇒ Object

Average queue wait (position_set_at → allow_to_enter_room_at) for just-called guests. Used for the Queue step ETA: how long after getting a position until I actually enter. Returns nil when none of the called guests had position_set_at (first run, or no prior stamp).



131
132
133
134
135
136
137
138
139
140
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 131

def compute_avg_queue_to_enter_seconds(guests)
  return nil if guests.empty?

  now = Time.zone.now
  positioned = guests.select { |doc| doc.data[:position_set_at] }
  return nil if positioned.empty?

  total = positioned.sum { |doc| (now - doc.data[:position_set_at].to_time).to_f }
  [(total / positioned.size).round, MIN_QUEUE_TO_ENTER_SECONDS].max
end

#compute_avg_wait_to_enter_seconds(guests) ⇒ Object

Average total wait (queued_at → allow_to_enter_room_at) for just-called guests. Used for the Waiting Room step ETA: how long until I get in from when I joined.



120
121
122
123
124
125
126
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 120

def compute_avg_wait_to_enter_seconds(guests)
  return nil if guests.empty?

  now = Time.zone.now
  total = guests.sum { |doc| (now - doc.data[:queued_at].to_time).to_f }
  [(total / guests.size).round, MIN_WAIT_TO_ENTER_SECONDS].max
end

#current_date ⇒ Object 



94
95
96
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 94

def current_date
  Time.zone.now.strftime('%Y-%m-%d')
end

#default_records_path(date) ⇒ Object 



74
75
76
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 74

def default_records_path(date)
  "waiting_guests/#{date}/records"
end

#eligible_guests_in(records_path, limit) ⇒ Object 



56
57
58
59
60
61
62
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 56

def eligible_guests_in(records_path, limit)
  firestore.col(records_path)
           .where('allow_to_enter_room_at', '==', nil)
           .order('queued_at')
           .limit(limit)
           .get.to_a
end

#fetch_available_slots ⇒ Object 



31
32
33
34
35
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 31

def fetch_available_slots
  max_sessions = fetch_max_sessions
  active_sessions = SpreeCmCommissioner::WaitingRoomSession.active.count
  max_sessions - active_sessions
end

#fetch_long_waiting_guests(available_slots) ⇒ Object

This query requires an index; create it in Firebase beforehand. Client must create waiting_guests documents with :queued_at and :allow_to_enter_room_at set to nil to allow filter + order queries.

Yesterday’s guests are always older than today’s, so fill from yesterday first, then use any leftover slots for today. This way no one queued before the midnight rollover gets skipped.

e.g. 5 slots, 2 waiting in yesterday -> take both, then take 3 from today.



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 43

def fetch_long_waiting_guests(available_slots)
  previous_guests = eligible_guests_in(previous_records_path, available_slots)

  # Pre-flip window: the lobby pointer still points at yesterday, so both paths resolve to the
  # same partition — return now to avoid querying (and double-counting) it twice.
  return previous_guests if records_path == previous_records_path

  remaining_slots = available_slots - previous_guests.size
  return previous_guests if remaining_slots <= 0

  previous_guests + eligible_guests_in(records_path, remaining_slots)
end

#fetch_max_sessions ⇒ Object 



150
151
152
153
154
155
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 150

def fetch_max_sessions
  fetcher = SpreeCmCommissioner::WaitingRoomSystemMetadataFetcher.new(firestore: firestore)
  fetcher.load_document_data

  fetcher.max_sessions_count_with_min
end

#firestore ⇒ Object 



157
158
159
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 157

def firestore
  @firestore ||= Google::Cloud::Firestore.new(project_id: [:project_id], credentials: )
end

#lobby_data ⇒ Object 



142
143
144
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 142

def lobby_data
  @lobby_data ||= lobby_document.get.data
end

#lobby_document ⇒ Object 



146
147
148
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 146

def lobby_document
  @lobby_document ||= firestore.col('waiting_rooms').doc('lobby')
end

#mark_as(full:, available_slots:, avg_wait_to_enter_seconds: nil, avg_queue_to_enter_seconds: nil, slots_per_call: nil) ⇒ Object

merge: true so we preserve the published ‘waiting_guests_records_path` on the lobby doc.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 103

def mark_as(
  full:,
  available_slots:,
  avg_wait_to_enter_seconds: nil,
  avg_queue_to_enter_seconds: nil,
  slots_per_call: nil
)
  data = { full: full, available_slots: available_slots }
  data[:avg_wait_to_enter_seconds] = avg_wait_to_enter_seconds if avg_wait_to_enter_seconds
  data[:avg_queue_to_enter_seconds] = avg_queue_to_enter_seconds if avg_queue_to_enter_seconds
  data[:slots_per_call] = slots_per_call if slots_per_call

  lobby_document.set(data, merge: true)
end

#previous_date ⇒ Object 



98
99
100
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 98

def previous_date
  1.day.ago.strftime('%Y-%m-%d')
end

#previous_records_path ⇒ Object

Drain target is derived from the server date, never the (possibly stale) lobby pointer.



70
71
72
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 70

def previous_records_path
  default_records_path(previous_date)
end

#records_path ⇒ Object

Published path is authoritative; fall back to the server’s own date if not yet published.



65
66
67
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 65

def records_path
  lobby_data&.dig(:waiting_guests_records_path).presence || default_records_path(current_date)
end

#service_account ⇒ Object 



161
162
163
 
# File 'app/interactors/spree_cm_commissioner/waiting_guests_caller.rb', line 161

def 
  @service_account ||= Rails.application.credentials.
end