fix!: TXT decode preserves string-boundary info#125
Merged
Conversation
808d158 to
7c07f35
Compare
61a50c5 to
20d47e2
Compare
There was a problem hiding this comment.
Pull request overview
This PR fixes lossy decoding of TXT/SPF records by preserving RFC 1035 §3.3.14 <character-string> boundaries on decode (so multi-string TXT records like SPF/DKIM round-trip correctly), and updates the project’s public behavior to return TXT data as an array consistently.
Changes:
- Update
Packet.Resource.TXT.decode(and SPF alias) to returndataas an array of strings, preserving per-string boundaries. - Update server/packet tests to assert TXT
dataasstring[](including a new boundary-preservation test). - Mark the change as breaking via a major version bump to
3.0.0and a changelog entry.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
packet.js |
Changes TXT/SPF decode to preserve <character-string> boundaries by producing an array of strings. |
test/packet.js |
Updates TXT-related assertions and adds a test ensuring multi-string TXT boundaries are preserved. |
test/server.js |
Updates end-to-end expectations so TXT answers return data as string[]. |
package.json |
Bumps package version to 3.0.0 to reflect the breaking API change. |
CHANGELOG.md |
Documents the breaking TXT data shape change and the decode fix. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
20d47e2 to
7671c9d
Compare
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.
BREAKING
RFC 1035 §3.3.14
A TXT RDATA can contain multiple
<character-string>items, each length-prefixed.Packet.Resource.TXT.decode(packet.js:618–633) concatenates all strings into a singlethis.datavalue, discarding the boundaries. Applications that rely on multi-string TXT records (SPF, DKIM) will receive incorrect data.The encoder handles arrays correctly; the asymmetry means decode→encode is lossy.
PS: it was back around node.js 0.11 or so when c-ares had this exact same issue, and had to resolve it this same way. It affected us over in Haraka, a SMTP daemon, where we consume a lot of SPF and DKIM records.