fix: don't crash serializing an explicit null/undefined param value - #1424
Open
SurajPatelPro wants to merge 1 commit into
Open
fix: don't crash serializing an explicit null/undefined param value#1424SurajPatelPro wants to merge 1 commit into
SurajPatelPro wants to merge 1 commit into
Conversation
serializer() called each key's format function unconditionally once the
key existed on the params object, so { location: undefined } (a common
way to conditionally omit an optional field) reached latLngToString and
threw "Cannot use 'in' operator to search for 'lat' in undefined"
instead of being treated as "not supplied".
Deleting the key outright, rather than leaving the null/undefined value
in place for query-string to drop, also avoids a mismatch in how that
library serializes the two: undefined is omitted from the query string
by default, but null is kept as a bare, value-less key.
Fixes googlemaps#1052
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
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.
Thank you for opening a Pull Request!
Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #1052 🦕
What & why
serializer()called each key's format function unconditionally whenever the key existed on the params object, so{ location: undefined }— a common way to conditionally omit an optional field — reachedlatLngToStringand threwCannot use 'in' operator to search for 'lat' in undefined, instead of being treated as "not supplied". @usefulthink correctly identified the root cause in the issue thread.What changed
src/serialize.ts— inserializer(), a key whose value isnull/undefinedis now deleted fromserializedParamsbefore the format step, rather than being passed through to the format function.I initially tried leaving the nullish value in place and letting
query-string's ownstringifydrop it, but that turned out to be inconsistent:query-stringomitsundefinedfrom the output query string by default, but keepsnullas a bare, value-less key (e.g.locationwith no=). Deleting the key outright avoids that mismatch and treats both the same way — as if the key were never supplied.How it was verified
src/serialize.test.tscovering bothlocation: undefinedandlocation: nullagainst a formatted key, asserting the key is dropped entirely from the resulting query string.npx jest src/— 21/21 test suites, 70/70 tests passing.npx tsc --noEmit— clean.npx eslint src/serialize.ts src/serialize.test.ts— clean.e2e/*suite requires a live Google Maps API key and network access, unavailable in my environment — confirmed those failures are unrelated to this change (same failure mode before and after, purely network/API-key dependent).Note
I'll need to sign the Google Individual CLA before this can be merged, per CONTRIBUTING.md.