Skip to content

Keep a leading U+FEFF when decoding binary strings - #1572

Merged
timostamm merged 5 commits into
bufbuild:mainfrom
devtechedge:fix/1567-string-bom
Nov 2, 2026
Merged

timostamm merged 5 commits into
bufbuild:mainfrom
devtechedge:fix/1567-string-bom

Conversation

@devtechedge

@devtechedge devtechedge commented Oct 18, 2026 •

Copy link
Copy Markdown
Contributor

Fixes #1567: A leading U+FEFF in a protobuf string is part of the value, not a byte-order mark. protobuf-es created its TextDecoder without ignoreBOM, so fromBinary silently removed one leading U+FEFF from every string it reads.

This PR passes ignoreBOM: true to both the lenient and the strict decoder in getTextEncoding(). As a result, strings decoded by protobuf-es now keep a leading U+FEFF.

If you depended on the old behavior, strip the character yourself after decoding, for example value.replace(/^\uFEFF/, "").

getTextEncoding() built its UTF-8 decoders without ignoreBOM. The WHATWG
decoder strips a leading U+FEFF, so fromBinary dropped that code point from
string fields. Both decoders now set ignoreBOM, and the strict decoder still
uses fatal.

Adds a decodeUtf8 case and a StringValue round trip.
@CLAassistant

CLAassistant commented Oct 18, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@timostamm
timostamm requested a review from ajeetdsouza October 20, 2026 09:43

@timostamm timostamm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR. I've pushed up corresponding docs changes and additional tests, and updated the PR description to call out the behavioral change. LGTM!

@timostamm
timostamm merged commit 9ef472d into bufbuild:main Nov 2, 2026
28 checks passed
@devtechedge

This comment was marked as low quality.

@timostamm timostamm mentioned this pull request Nov 4, 2026
markharding pushed a commit to futo-org/Harbor that referenced this pull request Nov 10, 2026
This PR contains the following updates:

| Package | Change | [Age](https://docs.renovatebot.com/merge-confidence/) | [Confidence](https://docs.renovatebot.com/merge-confidence/) |
|---|---|---|---|
| [@bufbuild/protobuf](https://protobufes.com/) ([source](https://github.com/bufbuild/protobuf-es/tree/HEAD/packages/protobuf)) | [`2.16.0` → `2.17.0`](https://renovatebot.com/diffs/npm/@bufbuild%2fprotobuf/2.16.0/2.17.0) | ![age](https://developer.mend.io/api/mc/badges/age/npm/@bufbuild%2fprotobuf/2.17.0?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@bufbuild%2fprotobuf/2.16.0/2.17.0?slim=true) |

---

> ⚠️ **Warning**
>
> Some dependencies could not be looked up. Check the [Dependency Dashboard](issues/2097) for more information.

---

### Release Notes

<details>
<summary>bufbuild/protobuf-es (@&#8203;bufbuild/protobuf)</summary>

### [`v2.17.0`](https://github.com/bufbuild/protobuf-es/releases/tag/v2.17.0)

[Compare Source](bufbuild/protobuf-es@v2.16.0...v2.17.0)

<!-- Release notes generated using configuration in .github/release.yaml at main -->

#### What's Changed

This release fixes several bugs, and some of the fixes change behavior in edge cases.

- Unknown fields in map entries should be skipped by [@&#8203;ajeetdsouza](https://github.com/ajeetdsouza) in [#&#8203;1544](bufbuild/protobuf-es#1544)
- Document plugin options for each bundler and runtime by [@&#8203;timostamm](https://github.com/timostamm) in [#&#8203;1555](bufbuild/protobuf-es#1555)
- Read ASCII strings without creating a subarray in BinaryReader by [@&#8203;intech](https://github.com/intech) in [#&#8203;1566](bufbuild/protobuf-es#1566)
- Add docs page on using Protobuf-ES with grpc-node by [@&#8203;sudorandom](https://github.com/sudorandom) in [#&#8203;1571](bufbuild/protobuf-es#1571)
- Fix nanos upper bound in timestampToJson error message by [@&#8203;ajeetdsouza](https://github.com/ajeetdsouza) in [#&#8203;1575](bufbuild/protobuf-es#1575)
- Emit the first name for aliased enum values in JSON by [@&#8203;vera-rubin](https://github.com/vera-rubin) in [#&#8203;1570](bufbuild/protobuf-es#1570)
- Keep a leading U+FEFF when decoding binary strings by [@&#8203;devtechedge](https://github.com/devtechedge) in [#&#8203;1572](bufbuild/protobuf-es#1572)

#### New Contributors

- [@&#8203;intech](https://github.com/intech) made their first contribution in [#&#8203;1566](bufbuild/protobuf-es#1566)
- [@&#8203;vera-rubin](https://github.com/vera-rubin) made their first contribution in [#&#8203;1570](bufbuild/protobuf-es#1570)
- [@&#8203;devtechedge](https://github.com/devtechedge) made their first contribution in [#&#8203;1572](bufbuild/protobuf-es#1572)

**Full Changelog**: <bufbuild/protobuf-es@v2.16.0...v2.17.0>

</details>

---

### Configuration

📅 **Schedule**: (UTC)

- Branch creation
  - "before 9am on tuesday"
- Automerge
  - At any time (no schedule defined)

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Mend Renovate CLI](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0NC4yMDYuMiIsInVwZGF0ZWRJblZlciI6IjQ0LjIwNi4yIiwidGFyZ2V0QnJhbmNoIjoiZGV2ZWxvcCIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiLCJyZW5vdmF0ZSJdfQ==-->

Reviewed-on: https://code.futo.org/harbor/harbor/pulls/2258
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.

fromBinary drops a leading U+FEFF from string fields

3 participants