Switch deprecated @github/webauthn-json package to browser methods#119
Merged
Conversation
Member
|
Thank you so much, will review this today if possible 🙂 |
Member
|
v7.6.2 |
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.
The
@github/webauthn-jsonpackage was deprecated last year, with the developers recommending the use of built-in browser methods in its place, so I removed the package from the dependencies list and dropped in the equivalentnavigator.credentialsmethods. The package developers say that the browser methods can be used as drop-in replacements since the package's functions were wrappers around those methods, so switching to them should result in no changes for users, especially as the methods have been supported by all major browsers since around 2018-2019.I tested the plugin changes by attempting to authenticate using 2FA on my local instance, and the plugin worked as expected. I also ran the
npm testsuite from the head of the main NodeBB repo before and after making the plugin changes, which resulted in a few more tests passing for me locally but no major differences otherwise.Source for the drop-in nature of the browser methods:
https://github.com/github/webauthn-json#reasoning
Browser compatibility:
https://developer.mozilla.org/en-US/docs/Web/API/CredentialsContainer/create#browser_compatibility
https://developer.mozilla.org/en-US/docs/Web/API/CredentialsContainer/get#browser_compatibility
Package wrapper functions references:
https://github.com/github/webauthn-json/blob/v0.5.7/src/basic/api.ts#L35
https://github.com/github/webauthn-json/blob/v0.5.7/src/basic/api.ts#L62