You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@thrift.apache.org by "kpumuk (via GitHub)" <gi...@apache.org> on 2026/05/20 01:22:21 UTC

[PR] THRIFT-5310: Harden Ruby binary protocol integer bounds [thrift]

kpumuk opened a new pull request, #3502:
URL: https://github.com/apache/thrift/pull/3502

   <!-- Explain the changes in the pull request below: -->
   
   Fix Ruby binary protocol integer serialization so signed Thrift integer types are validated consistently before writing.
   
   Previously, Ruby `BinaryProtocol` could silently wrap or clip out-of-range values, for example:
   
   - `write_byte(255)` wrote `0xff`, which read back as `-1`
   - `write_i16(40000)` succeeded
   - `write_i64(2**63)` succeeded
   
   This now rejects out-of-range values for `byte`, `i16`, `i32`, and `i64` in both the pure Ruby and native accelerated binary protocol implementations. Container sizes and binary/string lengths are also checked before writing as non-negative signed `i32` lengths.
   
   ## Implementation Notes
   
   - Added explicit signed bounds checks to pure Ruby `BinaryProtocol`.
   - Added matching checks to `binary_protocol_accelerated.c`.
   - Kept nil behavior unchanged: nil still raises the existing `"nil argument not allowed!"` error.
   - Added shared regression specs so the same boundary checks cover both pure Ruby and native accelerated implementations.
   - Avoided `Integer#between?` in the write hot path. In the `thrift` container, a direct micro-benchmark showed:
   
   ```text
     between?     1.948s
     < || >       0.892s
   ```
   
   for 20M checks, so the final Ruby implementation uses direct comparisons.
   
   ## Benchmark Results
   
   Benchmarked serialization with `test/rb/benchmarks/protocol_benchmark.rb`.
   
   Command:
   
   ```
   ruby ../../test/rb/benchmarks/protocol_benchmark.rb \
     --json \
     --large-runs 120 \
     --small-runs 2500000 \
     --scenarios rb-bin-write-large,c-bin-write-large,rb-bin-write-small,c-bin-write-small
   ```
   
   Each measured scenario ran for at least 10 seconds.
   
   ```
   scenario             baseline median  patched median  delta
   rb-bin-write-large   21.480146s       20.685707s      -3.70%
   c-bin-write-large    11.176904s       10.834723s      -3.06%
   rb-bin-write-small   21.915494s       21.641400s      -1.25%
   c-bin-write-small    11.784214s       11.387855s      -3.36%
   ```
   
   No serialization regression was observed.
   
   <!-- We recommend you review the checklist/tips before submitting a pull request. -->
   
   - [x] Did you create an [Apache Jira](https://issues.apache.org/jira/projects/THRIFT/issues/) ticket? [THRIFT-5310](https://issues.apache.org/jira/browse/THRIFT-5310)
   - [x] If a ticket exists: Does your pull request title follow the pattern "THRIFT-NNNN: describe my issue"?
   - [x] Did you squash your changes to a single commit?  (not required, but preferred)
   - [x] Did you do your best to avoid breaking changes?  If one was needed, did you label the Jira ticket with "Breaking-Change"?
   - [ ] If your change does not involve any code, include `[skip ci]` anywhere in the commit message to free up build resources.
   
   <!--
     The Contributing Guide at:
     https://github.com/apache/thrift/blob/master/CONTRIBUTING.md
     has more details and tips for committing properly.
   -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@thrift.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] THRIFT-5310: Harden Ruby binary protocol integer bounds [thrift]

Posted by "kpumuk (via GitHub)" <gi...@apache.org>.
kpumuk merged PR #3502:
URL: https://github.com/apache/thrift/pull/3502


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscribe@thrift.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org