wboayue / rust-ibapi / 25302170727

92%

push

github

refactor(transport): typed RoutedItem channel envelope (PR 2a) (#503)

* refactor(transport): typed RoutedItem channel envelope (PR 2a)

Replace the raw `Result<ResponseMessage, Error>` (sync) / `ResponseMessage`
(async) channel item with a typed `RoutedItem = Response | Notice | Error`.
Sets the foundation for the warning-routing feature without changing public
APIs or dispatcher classification yet.

- `RoutedItem` lives in `subscriptions::common`; `Notice` arm reachable from
  PR 3 onward (defined but unused here).
- Sync `TcpMessageBus` and async `AsyncTcpMessageBus` channels now carry
  `RoutedItem`. Cancellation/shutdown/reset paths emit typed `Error` variants
  instead of magic-string `ResponseMessage::from("Cancelled")` etc.
- `InternalSubscription::next` keeps the legacy `Option<Result<ResponseMessage,
  Error>>` shape via a `routed_to_legacy` shim (Notice -> loop and recv next).
  Domain consumers remain unchanged.
- `Error: Clone` (manual; Io preserves kind+message) so `RoutedItem` can be
  Clone (required by `tokio::sync::broadcast`). `HistoricalParseError` gains
  `Clone` derive.

Decoder `IncomingMessages::Error` arms left intact; dispatcher classification
deferred to PR 3.

Refs warning-message-routing roadmap (PR 2a).

* docs: mark PR 2a as open

* test(subscriptions): async RoutedItem coverage + Error::Clone caveat

- Add `test_routed_item_error_surfaces_through_async_subscription` and
  `test_routed_item_notice_skipped_then_response_delivered` mirroring the
  sync-side error test and locking the Notice → skip contract before PR 3
  starts emitting notices.
- Document Error::Clone lossiness for `ParseTime` (collapses to Simple,
  loses variant identity).

* refactor(routed-item): From impls + into_legacy method

- `From<ResponseMessage> for RoutedItem` and `From<Error> for RoutedItem`
  so send sites read `sender.send(msg.into())` / `sender.send(err.into())`
  instead of spelling out the variant.
- `RoutedItem::into_legacy()` replaces ... (continued)

58 of 103 new or added lines in 6 files covered. (56.31%)

16961 of 19352 relevant lines covered (87.64%)

26.28 hits per line