Repository navigation
Conversation
There was a problem hiding this comment.
Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.
An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.
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
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.
Summary
Follows flow-sync #102,
spec/crypto.md: a payload's body is exactly one gzip member, starting1f 8b 08 00, with a correct CRC-32 and length and nothing after it.GZIPInputStreamreads through further members and accepts optional header fields, sodecodePayloadno longer uses it. It now checks the first four bytes of the fixed 10-byte header, inflates withInflater(nowrap = true), computes theCRC32, checks the stream ended exactly where the 8-byte trailer starts, and checks the trailer. The 64 MiB stop stays.Hand-rolled framing, as AGENTS.md asks me to say: I checked
java.util.zipand the other libraries on the classpath, and none reads gzip this strictly. Only the fixed header and trailer are read by hand; inflating and the CRC stay in the library. flow-sync's spec and the approved design ask for this shape.Vectors:
payload.jsoncomes byte for byte from flow-sync #102 (345a836), with its README row. FLOW-SYNC/1'ssync/protocol/SyncCodec.ktisn't part of this and keepsGZIPInputStream.Related issue
None. Follows flow-sync #102, which should land first.
Change type
Validation
All Gradle commands ran with
--offline -Dorg.gradle.jvmargs="-Xmx4096m -XX:MaxMetaspaceSize=1024m -Dfile.encoding=UTF-8 -Djava.net.preferIPv6Addresses=true".:app:testGithubDebugUnitTest --tests 'io.github.aedev.flow.sync2.*': 307 tests, 0 failed, three runs on nearly this code. An earlier run had one failure,LanSyncTest.a_device_that_is_not_a_member_is_refused_at_the_hello, a one-minute wait that ran out while other builds ran on this machine. It passed in all the runs after it. I don't know the cause.ktlintCheck: exit 0.Before the change,
VectorsTest.payloadsfailed on the new vectors.New
PayloadTest(6): the encoder's output reads back, including empty and 1 MiB of random bytes; its header starts1f 8b 08 00, which provesFLG0 from this JVM'sGZIPOutputStream; 64 MiB reads and one byte more is refused; short bodies, a stream that isn't deflate and a stream cut off are refused.Each of these made a test fail when tried: header start, short body, stream end, CRC, length, the 64 MiB stop, a stalled inflate, and corrupt deflate not mapped to the payload error.
./gradlew :app:assembleGithubDebug: not run locally, CI builds it../gradlew :app:testGithubDebugUnitTest: full suite not run locally, CI runs it.I ran any additional flavor-specific build or test tasks affected by this change.
I manually tested the affected behavior on an Android device or emulator: not done.
Test device and Android version: none. The tests use the JVM's
java.util.zip, not Android's. Whether Android'sGZIPOutputStreamalso writesFLG0 hasn't been run; flow-sync's design says so from reading. If it didn't, this device's own objects would be refused, so a device run before a release is worth it.Risk and compatibility
Anything an honest app writes still reads. No nightly note: nothing an honest group sees changes. The vector README also changes in the other open PRs that follow flow-sync.