fix(journey-client): create JourneyLoginFailure step and handle LoginFailure case

Author: vatsalparikh

.changeset/journey-loginfailure-on-error-code.md

@@ -0,0 +1,5 @@
+---
+'@forgerock/journey-client': patch
+---
+
+Return `JourneyLoginFailure` by hitting the previously-unreached `LoginFailure` branch when `start()`/`next()` receives a failure payload with a `code`.

e2e/journey-app/main.ts

@@ -206,7 +206,6 @@ if (searchParams.get('middleware') === 'true') {
       renderComplete();
     } else if (step?.type === 'LoginFailure') {
       console.error('Journey failed');
-      renderForm();
       renderError();
     } else {
       console.error('Unknown node status', step);

packages/journey-client/src/lib/client.store.test.ts

@@ -1,3 +1,4 @@
+// @vitest-environment node
 /*
  * Copyright (c) 2025 Ping Identity Corporation. All rights reserved.
  *
@@ -75,7 +76,7 @@ function getUrlFromInput(input: RequestInfo | URL): string {
 /**
  * Helper to setup mock fetch for wellknown + journey responses
  */
-function setupMockFetch(journeyResponse: Step | null = null) {
+function setupMockFetch(journeyResponse: Step | null = null, authenticateStatus = 200) {
   mockFetch.mockImplementation((input: RequestInfo | URL) => {
     const url = getUrlFromInput(input);
 
@@ -85,8 +86,13 @@ function setupMockFetch(journeyResponse: Step | null = null) {
     }
 
     // Journey authenticate endpoint
-    if (journeyResponse && url.includes('/authenticate')) {
-      return Promise.resolve(new Response(JSON.stringify(journeyResponse)));
+    if (url.includes('/authenticate')) {
+      if (journeyResponse === null) {
+        return Promise.reject(new Error(`Unexpected fetch: ${url}`));
+      }
+      return Promise.resolve(
+        new Response(JSON.stringify(journeyResponse), { status: authenticateStatus }),
+      );
     }
 
     return Promise.reject(new Error(`Unexpected fetch: ${url}`));
@@ -152,6 +158,30 @@ describe('journey-client', () => {
     }
   });
 
+  test('start_401WithCodeInBody_ReturnsLoginFailure', async () => {
+    const failurePayload: Step = {
+      code: 401,
+      message: 'Access Denied',
+      reason: 'Unauthorized',
+      detail: { failureUrl: 'https://example.com/failure' },
+    };
+    setupMockFetch(failurePayload, 401);
+
+    const client = await journey({ config: mockConfig });
+    const result = await client.start();
+
+    expect(result).toBeDefined();
+    expect(isGenericError(result)).toBe(false);
+    expect(result).toHaveProperty('type', 'LoginFailure');
+
+    if (!isGenericError(result) && result.type === 'LoginFailure') {
+      expect(result.payload).toEqual(failurePayload);
+      expect(result.getCode()).toBe(401);
+      expect(result.getMessage()).toBe('Access Denied');
+      expect(result.getReason()).toBe('Unauthorized');
+    }
+  });
+
   test('next_WellknownConfig_SendsStepAndReturnsNext', async () => {
     const initialStep = createJourneyStep({
       authId: 'test-auth-id',
@@ -192,6 +222,34 @@ describe('journey-client', () => {
     }
   });
 
+  test('next_401WithCodeInBody_ReturnsLoginFailure', async () => {
+    const initialStep = createJourneyStep({
+      authId: 'test-auth-id',
+      callbacks: [],
+    });
+    const failurePayload: Step = {
+      code: 401,
+      message: 'Access Denied',
+      reason: 'Unauthorized',
+      detail: { failureUrl: 'https://example.com/failure' },
+    };
+    setupMockFetch(failurePayload, 401);
+
+    const client = await journey({ config: mockConfig });
+    const result = await client.next(initialStep, {});
+
+    expect(result).toBeDefined();
+    expect(isGenericError(result)).toBe(false);
+    expect(result).toHaveProperty('type', 'LoginFailure');
+
+    if (!isGenericError(result) && result.type === 'LoginFailure') {
+      expect(result.payload).toEqual(failurePayload);
+      expect(result.getCode()).toBe(401);
+      expect(result.getMessage()).toBe('Access Denied');
+      expect(result.getReason()).toBe('Unauthorized');
+    }
+  });
+
   test('redirect_WellknownConfig_StoresStepAndCallsLocationAssign', async () => {
     const mockStepPayload: Step = {
       callbacks: [
@@ -204,6 +262,15 @@ describe('journey-client', () => {
     };
     const step = createJourneyStep(mockStepPayload);
     const assignMock = vi.fn();
+    // Node test environment doesn't provide `window`, so create a minimal shim
+    // with a real `location` getter so we can keep using vi.spyOn(..., 'get').
+    (globalThis as unknown as { window?: unknown }).window = {};
+    Object.defineProperty(window, 'location', {
+      configurable: true,
+      get: () => ({
+        assign: vi.fn(),
+      }),
+    });
     const locationSpy = vi.spyOn(window, 'location', 'get').mockReturnValue({
       ...window.location,
       assign: assignMock,

packages/journey-client/src/lib/client.store.ts

@@ -16,6 +16,7 @@ import {
 import type { GenericError } from '@forgerock/sdk-types';
 import type { ActionTypes, RequestMiddleware } from '@forgerock/sdk-request-middleware';
 import type { Step } from '@forgerock/sdk-types';
+import type { FetchBaseQueryError } from '@reduxjs/toolkit/query';
 
 import { createJourneyStore } from './client.store.utils.js';
 import { configSlice } from './config.slice.js';
@@ -155,32 +156,48 @@ export async function journey<ActionType extends ActionTypes = ActionTypes>({
 
   const self: JourneyClient = {
     start: async (options?: StartParam) => {
-      const { data } = await store.dispatch(journeyApi.endpoints.start.initiate(options));
-      if (!data) {
-        const error: GenericError = {
-          error: 'no_response_data',
-          message: 'No data received from server when starting journey',
-          type: 'unknown_error',
-        };
-        return error;
+      const { data, error } = await store.dispatch(journeyApi.endpoints.start.initiate(options));
+      if (data) {
+        return createJourneyObject(data);
+      }
+
+      const errorData = (error as FetchBaseQueryError | undefined)?.data;
+      const errorStep = errorData as Step | undefined;
+      if (errorStep?.code !== undefined) {
+        return createJourneyObject(errorStep);
       }
-      return createJourneyObject(data);
+
+      const genericError: GenericError = {
+        error: 'no_response_data',
+        message: 'No data received from server when starting journey',
+        type: 'unknown_error',
+      };
+      return genericError;
     },
 
     /**
      * Submits the current Step payload to the authentication API and retrieves the next JourneyStep in the journey.
      */
     next: async (step: JourneyStep, options?: NextOptions) => {
-      const { data } = await store.dispatch(journeyApi.endpoints.next.initiate({ step, options }));
-      if (!data) {
-        const error: GenericError = {
-          error: 'no_response_data',
-          message: 'No data received from server when submitting step',
-          type: 'unknown_error',
-        };
-        return error;
+      const { data, error } = await store.dispatch(
+        journeyApi.endpoints.next.initiate({ step, options }),
+      );
+      if (data) {
+        return createJourneyObject(data);
+      }
+
+      const errorData = (error as FetchBaseQueryError | undefined)?.data;
+      const errorStep = errorData as Step | undefined;
+      if (errorStep?.code !== undefined) {
+        return createJourneyObject(errorStep);
       }
-      return createJourneyObject(data);
+
+      const genericError: GenericError = {
+        error: 'no_response_data',
+        message: 'No data received from server when submitting step',
+        type: 'unknown_error',
+      };
+      return genericError;
     },
 
     // TODO: Remove the actual redirect from this method and just return the URL to the caller