iotaledger / iota / 25240479648

63%

Build Type

push

github

Committed by web-flow

Commit Message

feat(iota-rest-kv): add object before version support (#11311)

# Description of change

Adds an optional `?before_version=<bool>` query parameter to the object
retrieval routes of `iota-rest-kv`. When `true`, the server returns the
highest stored object version **strictly less than** the version encoded
in the request key, instead of the exact-version match.

This unblocks callers that know the `ObjectID` but not the exact version
(e.g. resolving a past object state) from using the REST KV store.
Previously only exact-version lookups were possible.

### Implementation details

- **Query parameter over dedicated route.** The existing routes are
generic over `item_type` (`/{item_type}` and `/{item_type}/{key}`).
Adding a dedicated route for this one retrieval mode would introduce an
object-only special case in an otherwise uniform route table. Expressing
the mode as an optional query parameter keeps the routes generic and
makes the feature backward-compatible by default. This also aligns with
common REST guidance: the resource is the same (`/ob/{key}` or `/ob`),
only the retrieval mode changes, which is the canonical use case for a
query parameter rather than a new path.
- **Validation in a custom extractor.** A `BeforeVersionQuery` extractor
reads the flag and, when `true`, enforces that the item type is `ob`.
Everything else is rejected with `400 Bad Request` before the handler
runs. This keeps route handlers focused on business logic.
- **Supported routes.** Both `GET /{item_type}/{key}` and `POST
/{item_type}` accept the parameter. When absent it defaults to `false`,
so existing callers are unaffected.
- **Batch semantics.** The response is a BCS-serialized
`Vec<Option<Bytes>>` that preserves the order of the input `keys`.
`Some(bytes)` is the highest version strictly below the requested one;
`None` means not found.
- **Edge case.** `before_version=true` with a key at version 0 returns
`None`.
- **BigTable scan.** Implemented as a single reverse `r... (continued)

Coverage Stats

0 of 102 new or added lines in 3 files covered. (0.0%)

850 existing lines in 38 files now uncovered.

156107 of 247061 relevant lines covered (63.19%)

454495.93 hits per line