fix/browser-tolerate-old-call-structures#664
Merged
MasterKale merged 2 commits intomasterfrom Jan 13, 2025
Merged
Conversation
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
1 participant
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.
I've prepared a PR that updates @simplewebauthn/browser's
startRegistration()andstartAuthentication()to detect and tolerate the old, pre-v11 method call (where options are passed in as a positional argument as instead of as theoptionsJSONproperty in the options blob.) There's a lot of existing developer guidance on using SimpleWebAuthn that reflects the pre-v11 method call structure, and rather than hope it all gets updated I figured for sake of developer DX a PR like this would engender some developer goodwill.With this PR these methods would
console.warnin the browser console about needing to update the method call, but ultimately try to proceed by internally remapping the provided options tooptionsJSON. The warning would also direct devs to here for more info:https://simplewebauthn.dev/docs/packages/browser#typeerror-cannot-read-properties-of-undefined-reading-challenge
Screenshots