fix(davinci-client): improve fido module error handling

Author: ancheetah

.changeset/full-bikes-boil.md

@@ -0,0 +1,5 @@
+---
+'@forgerock/davinci-client': patch
+---
+
+Improve FIDO module error handling when no options

e2e/davinci-app/components/fido.ts

@@ -4,20 +4,20 @@
  * This software may be modified and distributed under the terms
  * of the MIT license. See the LICENSE file for details.
  */
+import { fido } from '@forgerock/davinci-client';
 import type {
   FidoRegistrationCollector,
   FidoAuthenticationCollector,
   Updater,
-  FidoClient,
 } from '@forgerock/davinci-client/types';
 
 export default function fidoComponent(
   formEl: HTMLFormElement,
   collector: FidoRegistrationCollector | FidoAuthenticationCollector,
   updater: Updater<FidoRegistrationCollector | FidoAuthenticationCollector>,
-  fidoApi: FidoClient,
   submitForm: () => Promise<void>,
 ) {
+  const fidoApi = fido();
   if (collector.type === 'FidoRegistrationCollector') {
     const button = document.createElement('button');
     button.type = 'button';

e2e/davinci-app/main.ts

@@ -7,7 +7,7 @@
 import './style.css';
 
 import { Config, FRUser, TokenManager } from '@forgerock/javascript-sdk';
-import { davinci, fido } from '@forgerock/davinci-client';
+import { davinci } from '@forgerock/davinci-client';
 import type {
   CustomLogger,
   DaVinciConfig,
@@ -83,7 +83,6 @@ const urlParams = new URLSearchParams(window.location.search);
 (async () => {
   const davinciClient: DavinciClient = await davinci({ config, logger, requestMiddleware });
   const protectApi = protect({ envId: '02fb4743-189a-4bc7-9d6c-a919edfe6447' });
-  const fidoApi = fido();
   const continueToken = urlParams.get('continueToken');
   const formEl = document.getElementById('form') as HTMLFormElement;
   let resumed: InternalErrorResponse | NodeStates | undefined;
@@ -261,7 +260,6 @@ const urlParams = new URLSearchParams(window.location.search);
           formEl, // You can ignore this; it's just for rendering
           collector, // This is the plain object of the collector
           davinciClient.update(collector), // Returns an update function for this collector
-          fidoApi, // FIDO module for interacting with WebAuthn API
           submitForm,
         );
       } else if (collector.type === 'FlowCollector') {

e2e/davinci-suites/src/fido.test.ts

@@ -49,10 +49,10 @@ test.describe('FIDO/WebAuthn Tests', () => {
     await page.getByRole('button', { name: 'Sign On' }).click();
 
     // Register WebAuthn credential
-    const { credentials: intialCredentials } = await cdp.send('WebAuthn.getCredentials', {
+    const { credentials: initialCredentials } = await cdp.send('WebAuthn.getCredentials', {
       authenticatorId,
     });
-    await expect(intialCredentials).toHaveLength(0);
+    await expect(initialCredentials).toHaveLength(0);
 
     await page.getByRole('button', { name: 'DEVICE_REGISTRATION' }).click();
     await page.getByRole('button', { name: 'Biometrics/Security Key' }).click();
@@ -87,7 +87,9 @@ test.describe('FIDO/WebAuthn Tests', () => {
     await expect(page.getByText('FIDO2 Test Form')).toBeVisible();
   });
 
-  test('Register and authenticate with usernameless', async ({ page }) => {
+  // Note: This test is currently not working due to a DaVinci issue where the authentication options
+  // are not included in the response.
+  test.skip('Register and authenticate with usernameless', async ({ page }) => {
     const { navigate } = asyncEvents(page);
 
     await navigate(
@@ -104,10 +106,10 @@ test.describe('FIDO/WebAuthn Tests', () => {
     await page.getByRole('button', { name: 'Sign On' }).click();
 
     // Register WebAuthn credential
-    const { credentials: intialCredentials } = await cdp.send('WebAuthn.getCredentials', {
+    const { credentials: initialCredentials } = await cdp.send('WebAuthn.getCredentials', {
       authenticatorId,
     });
-    await expect(intialCredentials).toHaveLength(0);
+    await expect(initialCredentials).toHaveLength(0);
 
     await page.getByRole('button', { name: 'DEVICE_REGISTRATION' }).click();
     await page.getByRole('button', { name: 'Biometrics/Security Key' }).click();

packages/davinci-client/src/lib/fido/fido.ts

@@ -55,6 +55,14 @@ export function fido(): FidoClient {
     register: async function register(
       options: FidoRegistrationOptions,
     ): Promise<FidoRegistrationInputValue | GenericError> {
+      if (!options) {
+        return {
+          error: 'registration_error',
+          message: 'FIDO registration failed: No options available',
+          type: 'fido_error',
+        } as GenericError;
+      }
+
       const createCredentialµ = Micro.sync(() => transformRegistrationOptions(options)).pipe(
         Micro.flatMap((publicKeyCredentialCreationOptions) =>
           Micro.tryPromise({
@@ -108,6 +116,14 @@ export function fido(): FidoClient {
     authenticate: async function authenticate(
       options: FidoAuthenticationOptions,
     ): Promise<FidoAuthenticationInputValue | GenericError> {
+      if (!options) {
+        return {
+          error: 'authentication_error',
+          message: 'FIDO authentication failed: No options available',
+          type: 'fido_error',
+        } as GenericError;
+      }
+
       const getAssertionµ = Micro.sync(() => transformAuthenticationOptions(options)).pipe(
         Micro.flatMap((publicKeyCredentialRequestOptions) =>
           Micro.tryPromise({