[marketplace] Availability improvements (#535)
## Problem
When Availabilities are created, the amount of bytes in the Availability are reserved in the repo, so those bytes on disk cannot be written to otherwise. When a request for storage is received by a node, if a previously created Availability is matched, an attempt will be made to fill a slot in the request (more accurately, the request's slots are added to the SlotQueue, and eventually those slots will be processed). During download, bytes that were reserved for the Availability were released (as they were written to disk). To prevent more bytes from being released than were reserved in the Availability, the Availability was marked as used during the download, so that no other requests would match the Availability, and therefore no new downloads (and byte releases) would begin. The unfortunate downside to this, is that the number of Availabilities a node has determines the download concurrency capacity. If, for example, a node creates a single Availability that covers all available disk space the operator is willing to use, that single Availability would mean that only one download could occur at a time, meaning the node could potentially miss out on storage opportunities.
## Solution
To alleviate the concurrency issue, each time a slot is processed, a Reservation is created, which takes size (aka reserved bytes) away from the Availability and stores them in the Reservation object. This can be done as many times as needed as long as there are enough bytes remaining in the Availability. Therefore, concurrent downloads are no longer limited by the number of Availabilities. Instead, they would more likely be limited to the SlotQueue's `maxWorkers`.
From a database design perspective, an Availability has zero or more Reservations.
Reservations are persisted in the RepoStore's metadata, along with Availabilities. The metadata store key path for Reservations is ` meta / sales / reservations / <availabilityId> / <reservationId>`, while Availabilities are stored one level up, eg `meta / sales / reservations / <availabilityId> `, allowing all Reservations for an Availability to be queried (this is not currently needed, but may be useful when work to restore Availability size is implemented, more on this later).
### Lifecycle
When a reservation is created, its size is deducted from the Availability, and when a reservation is deleted, any remaining size (bytes not written to disk) is returned to the Availability. If the request finishes, is cancelled (expired), or an error occurs, the Reservation is deleted (and any undownloaded bytes returned to the Availability). In addition, when the Sales module starts, any Reservations that are not actively being used in a filled slot, are deleted.
Having a Reservation persisted until after a storage request is completed, will allow for the originally set Availability size to be reclaimed once a request contract has been completed. This is a feature that is yet to be implemented, however the work in this PR is a step in the direction towards enabling this.
### Unknowns
Reservation size is determined by the `StorageAsk.slotSize`. If during download, more bytes than `slotSize` are attempted to be downloaded than this, then the Reservation update will fail, and the state machine will move to a `SaleErrored` state, deleting the Reservation. This will likely prevent the slot from being filled.
### Notes
Based on #514
2023-09-29 04:33:08 +00:00
|
|
|
import std/strformat
|
|
|
|
|
|
|
|
|
|
proc msgDetail*(e: ref CatchableError): string =
|
|
|
|
|
var msg = e.msg
|
|
|
|
|
if e.parent != nil:
|
|
|
|
|
msg = fmt"{msg} Inner exception: {e.parent.msg}"
|
2024-01-09 12:09:43 +00:00
|
|
|
return msg
|
|
|
|
|
|
|
|
|
|
template launderBare*(body: untyped): untyped =
|
|
|
|
|
## Launders bare Exceptions into CatchableError. This is typically used to
|
|
|
|
|
## "fix" code that throws bare exceptions and won't compile with Chronos V4,
|
|
|
|
|
## and which cannot be fixed otherise, e.g. in system APIs like json.parseJson
|
|
|
|
|
## in Nim 1.6.x. It should only be used as a last resort.
|
|
|
|
|
try:
|
|
|
|
|
body
|
|
|
|
|
except Defect as ex:
|
|
|
|
|
raise ex
|
|
|
|
|
except CatchableError as ex:
|
|
|
|
|
raise ex
|
|
|
|
|
except Exception as ex:
|
|
|
|
|
raise newException(Defect, ex.msg, ex)
|
