Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Merged by Bors] - Check if all bytes have been consumed during scale decode #4300

Closed
wants to merge 5 commits into from

Conversation

fasmat
Copy link
Member

@fasmat fasmat commented Apr 14, 2023

Motivation

Closes #4133

Changes

  • codec.Decode was changed to check if all bytes that were provided for decoding were consumed in the process.
    • if not the function now returns a named error: ErrShortRead
  • In tests checking that layerID / epochID is first value in encoded bytes decoding was updated to not fail on ErrShortRead

Test Plan

  • All existing tests pass

TODO

  • Explain motivation or link existing issue(s)
  • Test changes and document test plan
  • Update documentation as needed

DevOps Notes

  • This PR does not require configuration changes (e.g., environment variables, GitHub secrets, VM resources)
  • This PR does not affect public APIs
  • This PR does not rely on a new version of external services (PoET, elasticsearch, etc.)
  • This PR does not make changes to log messages (which monitoring infrastructure may rely on)

@fasmat fasmat self-assigned this Apr 14, 2023
codec/codec.go Outdated Show resolved Hide resolved
go.mod Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Apr 14, 2023

Codecov Report

Merging #4300 (0e59e10) into develop (0dcb371) will decrease coverage by 0.1%.
The diff coverage is 78.1%.

@@            Coverage Diff            @@
##           develop   #4300     +/-   ##
=========================================
- Coverage     76.1%   76.1%   -0.1%     
=========================================
  Files          240     240             
  Lines        25100   25116     +16     
=========================================
+ Hits         19117   19128     +11     
- Misses        4761    4764      +3     
- Partials      1222    1224      +2     
Impacted Files Coverage Δ
codec/codec.go 68.9% <40.0%> (-3.3%) ⬇️
api/grpcserver/transaction_service.go 60.5% <82.6%> (+0.5%) ⬆️
api/grpcserver/mesh_service.go 78.5% <100.0%> (ø)

... and 2 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@fasmat fasmat force-pushed the 4133-decode-messages-fully branch from d734fdd to 2231384 Compare April 15, 2023 11:05
codec/codec.go Outdated Show resolved Hide resolved
@fasmat fasmat force-pushed the 4133-decode-messages-fully branch from 2231384 to c5ded8d Compare April 17, 2023 07:40
@fasmat
Copy link
Member Author

fasmat commented Apr 17, 2023

bors merge

bors bot pushed a commit that referenced this pull request Apr 17, 2023
## Motivation
Closes #4133

## Changes
- `codec.Decode` was changed to check if all bytes that were provided for decoding were consumed in the process.
  - if not the function now returns a named error: `ErrShortRead`
- In tests checking that layerID / epochID is first value in encoded bytes decoding was updated to not fail on `ErrShortRead`

## Test Plan
- All existing tests pass

## TODO
<!-- This section should be removed when all items are complete -->
- [x] Explain motivation or link existing issue(s)
- [x] Test changes and document test plan
- [x] Update documentation as needed

## DevOps Notes
<!-- Please uncheck these items as applicable to make DevOps aware of changes that may affect releases -->
- [x] This PR does not require configuration changes (e.g., environment variables, GitHub secrets, VM resources)
- [x] This PR does not affect public APIs
- [x] This PR does not rely on a new version of external services (PoET, elasticsearch, etc.)
- [x] This PR does not make changes to log messages (which monitoring infrastructure may rely on)
@bors
Copy link

bors bot commented Apr 17, 2023

Pull request successfully merged into develop.

Build succeeded:

@bors bors bot changed the title Check if all bytes have been consumed during scale decode [Merged by Bors] - Check if all bytes have been consumed during scale decode Apr 17, 2023
@bors bors bot closed this Apr 17, 2023
@bors bors bot deleted the 4133-decode-messages-fully branch April 17, 2023 08:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

codec: validate that messages are fully decoded
2 participants