fix: preserve metadata key casing in multipart form-data requests#729
Merged
fix: preserve metadata key casing in multipart form-data requests#729
Conversation
The form-data serialization path (used when payload >= 3MB) was converting metadata keys to snake_case, unlike the JSON body path which correctly excluded them. This caused metadata key casing to change silently when sending messages with large attachments.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #729 +/- ##
=======================================
Coverage 98.72% 98.72%
=======================================
Files 39 39
Lines 860 860
Branches 69 69
=======================================
Hits 849 849
Misses 11 11 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
benjaminwhtan
approved these changes
May 7, 2026
Merged
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.
When sending messages with a total payload >= 3MB, the SDK switches from JSON to multipart/form-data serialization. The form-data path in
_buildFormRequest()was callingobjKeysToSnakeCase()without excluding themetadatafield, causing metadata keys likemyCustomKeyto be silently converted tomy_custom_key. The JSON path inapiClient.tsalready correctly excluded metadata from case conversion.This fix adds the
['metadata']exclusion to both_buildFormRequest()andcalculateTotalPayloadSize(), making metadata handling consistent across all serialization paths (messages, drafts create/update).Includes a regression test that verifies camelCase metadata keys survive the multipart serialization path unchanged.
License
I confirm that this contribution is made under the terms of the MIT license and that I have the authority necessary to make this contribution on behalf of its copyright owner.