Merge pull request #664 from MasterKale/fix/browser-tolerate-old-call-structures

fix/browser-tolerate-old-call-structures

Author: MasterKale

packages/browser/src/methods/startAuthentication.test.ts

@@ -7,7 +7,7 @@ import {
   assertRejects,
   assertStringIncludes,
 } from '@std/assert';
-import { assertSpyCalls, type Spy, spy } from '@std/testing/mock';
+import { assertSpyCalls, type Spy, spy, stub } from '@std/testing/mock';
 import { afterEach, beforeEach, describe, it } from '@std/testing/bdd';
 import { JSDOM } from 'jsdom';
 import type {
@@ -442,6 +442,31 @@ describe('Method: startAuthentication()', () => {
 
     assertEquals(response.authenticatorAttachment, 'cross-platform');
   });
+
+  it('should continue despite use of old call structure', async () => {
+    const stubConsoleWarn = stub(console, 'warn');
+
+    // @ts-ignore: Intentionally call this method in a pre-v11 way
+    await startAuthentication(goodOpts1);
+
+    assertSpyCalls(stubConsoleWarn, 1);
+
+    // Assert there's some browser console output
+    const warning = stubConsoleWarn.calls.at(0)?.args[0] as string;
+    assertStringIncludes(warning, 'startAuthentication() was not called correctly');
+
+    // Check that the method was able to handle the bad call anyway
+    const args = getSpy.calls.at(0)?.args[0] as CredentialCreationOptions;
+    const argsPublicKey = args.publicKey!;
+
+    // Make sure challenge and user.id are converted to Buffers
+    assertEquals(
+      new Uint8Array(argsPublicKey.challenge as ArrayBuffer),
+      new Uint8Array([213, 62, 174, 30, 184, 184, 56, 4]),
+    );
+
+    stubConsoleWarn.restore();
+  });
 });
 
 describe('WebAuthnError', () => {

packages/browser/src/methods/startAuthentication.ts

@@ -28,6 +28,16 @@ export async function startAuthentication(
     verifyBrowserAutofillInput?: boolean;
   },
 ): Promise<AuthenticationResponseJSON> {
+  // @ts-ignore: Intentionally check for old call structure to warn about improper API call
+  if (!options.optionsJSON && options.challenge) {
+    console.warn(
+      'startAuthentication() was not called correctly. It will try to continue with the provided options, but this call should be refactored to use the expected call structure instead. See https://simplewebauthn.dev/docs/packages/browser#typeerror-cannot-read-properties-of-undefined-reading-challenge for more information.',
+    );
+
+    // @ts-ignore: Reassign the options, passed in as a positional argument, to the expected variable
+    options = { optionsJSON: options };
+  }
+
   const {
     optionsJSON,
     useBrowserAutofill = false,

packages/browser/src/methods/startRegistration.test.ts

@@ -374,6 +374,31 @@ describe('Method: startRegistration', () => {
     // The most important bit
     assertEquals(argsMediation, 'conditional');
   });
+
+  it('should continue despite use of old call structure', async () => {
+    const stubConsoleWarn = stub(console, 'warn');
+
+    // @ts-ignore: Intentionally call this method in a pre-v11 way
+    await startRegistration(goodOpts1);
+
+    assertSpyCalls(stubConsoleWarn, 1);
+
+    // Assert there's some browser console output
+    const warning = stubConsoleWarn.calls.at(0)?.args[0] as string;
+    assertStringIncludes(warning, 'startRegistration() was not called correctly');
+
+    // Check that the method was able to handle the bad call anyway
+    const args = createSpy.calls.at(0)?.args[0] as CredentialCreationOptions;
+    const argsPublicKey = args.publicKey!;
+
+    // Make sure challenge and user.id are converted to Buffers
+    assertEquals(
+      new Uint8Array(argsPublicKey.challenge as ArrayBuffer),
+      new Uint8Array([213, 62, 174, 30, 184, 184, 56, 4]),
+    );
+
+    stubConsoleWarn.restore();
+  });
 });
 
 describe('WebAuthnError', () => {

packages/browser/src/methods/startRegistration.ts

@@ -26,6 +26,16 @@ export async function startRegistration(
     useAutoRegister?: boolean;
   },
 ): Promise<RegistrationResponseJSON> {
+  // @ts-ignore: Intentionally check for old call structure to warn about improper API call
+  if (!options.optionsJSON && options.challenge) {
+    console.warn(
+      'startRegistration() was not called correctly. It will try to continue with the provided options, but this call should be refactored to use the expected call structure instead. See https://simplewebauthn.dev/docs/packages/browser#typeerror-cannot-read-properties-of-undefined-reading-challenge for more information.',
+    );
+
+    // @ts-ignore: Reassign the options, passed in as a positional argument, to the expected variable
+    options = { optionsJSON: options };
+  }
+
   const { optionsJSON, useAutoRegister = false } = options;
 
   if (!browserSupportsWebAuthn()) {