Fix simple encoder src/dst swapped #1083
Merged
+58
−3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
📝 Walkthrough""" WalkthroughThe changes reverse the argument order in the Changes
Sequence Diagram(s)sequenceDiagram
participant Test as TestEncodeTo
participant File as Test File
participant Zstd as zstd.EncodeTo/DecodeTo
Test->>File: Open and read file content
Test->>Zstd: EncodeTo(src, dst)
Zstd-->>Test: Compressed data
Test->>Zstd: DecodeTo(compressed, dst)
Zstd-->>Test: Decompressed data
Test->>Test: Compare decompressed to original
Assessment against linked issues
Possibly related PRs
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (16)
✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Fixes #1081 (unreleased)
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
zstd/simple_go124.go(1 hunks)zstd/simple_go124_test.go(1 hunks)zstd/zstd_test.go(1 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: klauspost
PR: klauspost/compress#1014
File: s2/encode_amd64.go:38-45
Timestamp: 2024-10-04T06:29:01.060Z
Learning: In `s2/encode_amd64.go`, when handling temporary buffers, arrays are required instead of slices.
Learnt from: klauspost
PR: klauspost/compress#1014
File: s2/encode_amd64.go:38-45
Timestamp: 2024-10-16T10:14:26.389Z
Learning: In `s2/encode_amd64.go`, when handling temporary buffers, arrays are required instead of slices.
zstd/zstd_test.go (2)
Learnt from: klauspost
PR: klauspost/compress#1014
File: s2/encode_amd64.go:38-45
Timestamp: 2024-10-04T06:29:01.060Z
Learning: In `s2/encode_amd64.go`, when handling temporary buffers, arrays are required instead of slices.
Learnt from: klauspost
PR: klauspost/compress#1014
File: s2/encode_amd64.go:38-45
Timestamp: 2024-10-16T10:14:26.389Z
Learning: In `s2/encode_amd64.go`, when handling temporary buffers, arrays are required instead of slices.
zstd/simple_go124.go (2)
Learnt from: klauspost
PR: klauspost/compress#1014
File: s2/encode_amd64.go:38-45
Timestamp: 2024-10-04T06:29:01.060Z
Learning: In `s2/encode_amd64.go`, when handling temporary buffers, arrays are required instead of slices.
Learnt from: klauspost
PR: klauspost/compress#1014
File: s2/encode_amd64.go:38-45
Timestamp: 2024-10-16T10:14:26.389Z
Learning: In `s2/encode_amd64.go`, when handling temporary buffers, arrays are required instead of slices.
zstd/simple_go124_test.go (2)
Learnt from: klauspost
PR: klauspost/compress#1014
File: s2/encode_amd64.go:38-45
Timestamp: 2024-10-04T06:29:01.060Z
Learning: In `s2/encode_amd64.go`, when handling temporary buffers, arrays are required instead of slices.
Learnt from: klauspost
PR: klauspost/compress#1014
File: s2/encode_amd64.go:38-45
Timestamp: 2024-10-16T10:14:26.389Z
Learning: In `s2/encode_amd64.go`, when handling temporary buffers, arrays are required instead of slices.
⏰ Context from checks skipped due to timeout of 90000ms (11)
- GitHub Check: build (1.24.x, ubuntu-latest)
- GitHub Check: build (1.24.x, windows-latest)
- GitHub Check: build (1.24.x, macos-latest)
- GitHub Check: build (1.22.x, ubuntu-latest)
- GitHub Check: build (1.22.x, macos-latest)
- GitHub Check: fuzz-zstd ("noasm,nounsafe")
- GitHub Check: fuzz-other ("noasm,nounsafe")
- GitHub Check: fuzz-zstd (nounsafe)
- GitHub Check: fuzz-other (nounsafe)
- GitHub Check: build-special
- GitHub Check: Analyze (go)
🔇 Additional comments (4)
zstd/simple_go124.go (1)
33-33: LGTM! Parameter order fix looks correct.The change from
enc.EncodeAll(dst, src)toenc.EncodeAll(src, dst)aligns with the consistent pattern used inDecodeTo(line 55) and follows typical compression API conventions where source comes before destination.zstd/zstd_test.go (1)
124-124: Good refactoring: improved code locality.Moving the
datavariable to local scope within the benchmark function improves code locality and reduces package-level scope pollution.zstd/simple_go124_test.go (2)
48-57: Excellent test coverage for the parameter fix.The round-trip test properly validates that the
EncodeTo/DecodeToparameter order fix works correctly by ensuring compressed data can be decompressed back to match the original input exactly.
18-60: Well-structured comprehensive test.The test design using real data from the ZIP archive provides robust validation of compression/decompression correctness, with proper error handling and short test mode support.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1081 (unreleased)
Summary by CodeRabbit
Bug Fixes
Tests