-
Notifications
You must be signed in to change notification settings - Fork 15
Description
cc ipfs/boxo#176, as would be good to have this before we merge that, or shortly after
TLDR
We don't want to be too strict here, but also we want to be able to write a test that limits the possibility space to the above paths.
If someone implements Ranges, we want to ensure the response is valid.
If they don't, we also want to ensure the response is valid.
Background
Coverage of range behaviors is bare minimum for UnixFS right now.
We should improve it and both relax requirements (allowing implementers to choose what to support) and make asserts more explicit (if you choose to implement something optional, you should behave A, if you don't, we expect fallback to be either B or C etc).
When it comes to range requests, HTTP specs (RFC9110) make them OPTIONAL. Supporting HTTP Ranges is useful for streaming chunks of deserialized videos, and that is what some IPFS Gateways support when a client asks for deserialized data (a single range).
Missing tests and tooling
- ability to enable/disable all range request tests as a profile/flag/unit
- make sure that if (multiple) ranges are implemented by gateway, they work correctly
- ok if range is not supported at all, confirm
Accept-Ranges noneis present (HEAD/GET) andRangerequest returns HTTP 200 with the whole file - test if a single range is supported, confirm
Rangereturned HTTP 206 with bytes for the slice - multiple ranges
- this is not used in practice, browsers streaming videos ask for a single range, Kubo >=0.23 does not support this for unixfs, but if someone implements this, we should confirm it works ok
- ok if returned HTTP 206 with content type
multipart/byterangesand ALL requested ranges - ok if returned HTTP 206 with with bytes for the first of the ranges
- ok if range is not supported at all, confirm
A file could be any type of deserialized response, but in practice, end users only care about UnixFS file, and the test should use a chunked(!) UnixFS file, ideally in a HAMT directory, making sure Ranges work there too.
What we need in DSL
It is most likely that we need to extend test DSL with something like AnyOf described in #153