feat[marketplace]: add slot queue pausing (#752)
* add seen flag
* Add MockSlotQueueItem and better prioritisation tests
* Update seen priority, and include in SlotQueueItem.init
* Re-add processed slots to queue
Re-add processed slots to queue if the sale was ignored or errored
* add pausing of queue
- when processing slots in queue, pause queue if item was marked seen
- if availability size is increased, trigger onAvailabilityAdded callback
- in sales, on availability added, clear 'seen' flags, then unpause the queue
- when items pushed to the queue, unpause the queue
* remove unused NoMatchingAvailabilityError from slotqueue
The slot queue should also have nothing to do with availabilities
* when all availabilities are empty, pause the queue
An empty availability is defined as size < DefaultBlockSize as this means even the smallest possible request could not be served. However, this is up for discussion.
* remove availability from onAvailabilitiesEmptied callback
* refactor onAvailabilityAdded and onAvailabilitiesEmptied
onAvailabilityAdded and onAvailabilitiesEmptied are now only called from reservations.update (and eventually reservations.delete once implemented).
- Add empty routine for Availability and Reservation
- Add allEmpty routine for Availability and Reservation, which returns true when all all Availability or Reservation objects in the datastore are empty.
* SlotQueue test support updates
* Sales module test support updates
* Reservations module tests for queue pausing
* Sales module tests for queue pausing
Includes tests for sales states cancelled, errored, ignored to ensure onCleanUp is called with correct parameters
* SlotQueue module tests for queue pausing
* fix existing sales test
* PR feedback
- indent `self.unpause`
- update comment for `clearSeenFlags`
* reprocessSlot in SaleErrored only when coming from downloading
* remove pausing of queue when availabilities are "emptied"
Queue pausing when all availiabilies are "emptied" is not necessary, given that the node would not be able to service slots once all its availabilities' freeSize are too small for the slots in the queue, and would then be paused anyway.
Add test that asserts the queue is paused once the freeSpace of availabilities drops too low to fill slots in the queue.
* Update clearing of seen flags
The asyncheapqueue update overload would need to check index bounds and ultimately a different solution was found using the mitems iterator.
* fix test
request.id was different before updating request.ask.slots, and that id was used to set the state in mockmarket.
* Change filled/cleanup future to nil, so no await is needed
* add wait to allow items to be added to queue
* do not unpause queue when seen items are pushed
* re-add seen item back to queue once paused
Previously, when a seen item was processed, it was first popped off the queue, then the queue was paused waiting to process that item once the queue was unpaused. Now, when a seen item is processed, it is popped off the queue, the queue is paused, then the item is re-added to the queue and the queue will wait until unpaused before it will continue popping items off the queue. If the item was not re-added to the queue, it would have been processed immediately once unpaused, however there may have been other items with higher priority pushed to the queue in the meantime. The queue would not be unpaused if those added items were already seen. In particular, this may happen when ignored items due to lack of availability are re-added to a paused queue. Those ignored items will likely have a higher priority than the item that was just seen (due to it having been processed first), causing the queue to the be paused.
* address PR comments
2024-05-26 00:38:38 +00:00
|
|
|
import pkg/codex/contracts/requests
|
|
|
|
|
import pkg/codex/sales/slotqueue
|
|
|
|
|
|
|
|
|
|
type MockSlotQueueItem* = object
|
|
|
|
|
requestId*: RequestId
|
|
|
|
|
slotIndex*: uint16
|
|
|
|
|
slotSize*: UInt256
|
|
|
|
|
duration*: UInt256
|
|
|
|
|
reward*: UInt256
|
|
|
|
|
collateral*: UInt256
|
|
|
|
|
expiry*: UInt256
|
|
|
|
|
seen*: bool
|
|
|
|
|
|
|
|
|
|
proc toSlotQueueItem*(item: MockSlotQueueItem): SlotQueueItem =
|
|
|
|
|
SlotQueueItem.init(
|
|
|
|
|
requestId = item.requestId,
|
|
|
|
|
slotIndex = item.slotIndex,
|
|
|
|
|
ask = StorageAsk(
|
|
|
|
|
slotSize: item.slotSize,
|
|
|
|
|
duration: item.duration,
|
|
|
|
|
reward: item.reward,
|
|
|
|
|
collateral: item.collateral
|
|
|
|
|
),
|
|
|
|
|
expiry = item.expiry,
|
|
|
|
|
seen = item.seen
|
|
|
|
|
)
|