wboayue / rust-ibapi / 25269136218

92%

push

github

feat(connection): require protobuf server version on connect (#492)

* feat(connection): require protobuf server version on connect

rust-ibapi 3.x is protobuf-only. Previously, connecting to a TWS or IB
Gateway older than server version 201 would complete the handshake and
then fail opaquely once we sent a protobuf StartApi request the gateway
could not parse.

Add `require_protobuf_support()` and call it in both sync and async
`establish_connection` between handshake and start_api. An old gateway
now fails fast with `Error::ServerVersion(201, actual, "protobuf
transport — rust-ibapi 3.x requires TWS or IB Gateway with server
version 201 or later; please upgrade")` and no further bytes hit the
wire.

* test(connection): extract common.rs tests to sibling file

Per CLAUDE.md, tests must live in their own *_tests.rs file wired in
via `#[path = "..."] mod tests;`, not in inline `#[cfg(test)] mod tests`
blocks. `connection/common.rs` was the lone holdout; sync.rs and
async.rs already follow the convention. Move every test (including the
new require_protobuf_support tests) into common_tests.rs, no logic
changes.

* refactor(connection): tighten require_protobuf_support per review

- Inject server_versions::PROTOBUF into the error message via format!
  instead of hard-coding "201", so the prose stays in sync with the
  variant tuple.
- Narrow visibility from `pub` to `pub(crate)` — only sync, async, and
  in-crate tests call it.
- Replace magic-number byte arithmetic in the new sync/async tests with
  a direct comparison against `connection_handler.format_handshake()`,
  which is what `handshake()` actually writes. Same guarantee, no
  hand-rolled frame parsing.
- Collapse the duplicate helper call in test_require_protobuf_support_
  rejects_older to a single call + match-by-reference, and derive the
  rendered-string check from PROTOBUF instead of a literal "201".

15 of 15 new or added lines in 3 files covered. (100.0%)

16911 of 19107 relevant lines covered (88.51%)

25.1 hits per line