From f66b1fda628fd7d694ad646d173fab3d51de0832 Mon Sep 17 00:00:00 2001 From: Vatsal Parikh Date: Mon, 20 Apr 2026 15:24:27 -0700 Subject: [PATCH 1/3] fix(journey-client): create JourneyLoginFailure step and handle LoginFailure case --- .../journey-loginfailure-on-error-code.md | 5 ++ e2e/journey-app/main.ts | 1 - .../src/lib/client.store.test.ts | 73 ++++++++++++++++++- .../journey-client/src/lib/client.store.ts | 53 +++++++++----- 4 files changed, 110 insertions(+), 22 deletions(-) create mode 100644 .changeset/journey-loginfailure-on-error-code.md diff --git a/.changeset/journey-loginfailure-on-error-code.md b/.changeset/journey-loginfailure-on-error-code.md new file mode 100644 index 0000000000..c9260d6de9 --- /dev/null +++ b/.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`. diff --git a/e2e/journey-app/main.ts b/e2e/journey-app/main.ts index 3b61558b4d..2d28bab76b 100644 --- a/e2e/journey-app/main.ts +++ b/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); diff --git a/packages/journey-client/src/lib/client.store.test.ts b/packages/journey-client/src/lib/client.store.test.ts index 69b12553fb..02325591b0 100644 --- a/packages/journey-client/src/lib/client.store.test.ts +++ b/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, diff --git a/packages/journey-client/src/lib/client.store.ts b/packages/journey-client/src/lib/client.store.ts index 129386a864..ecb95bb802 100644 --- a/packages/journey-client/src/lib/client.store.ts +++ b/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({ 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 From 13326e0b4bad1913575129ef3d58c1b92ff463c9 Mon Sep 17 00:00:00 2001 From: Vatsal Parikh Date: Mon, 20 Apr 2026 15:24:27 -0700 Subject: [PATCH 2/3] fix(journey-client): create JourneyLoginFailure step and handle LoginFailure case --- ...-on-error-code.md => whole-mangos-find.md} | 2 +- .../src/lib/client.store.test.ts | 2 +- .../journey-client/src/lib/client.store.ts | 21 ++-------- .../journey-client/src/lib/journey.api.ts | 39 +++++++++++++++++++ 4 files changed, 44 insertions(+), 20 deletions(-) rename .changeset/{journey-loginfailure-on-error-code.md => whole-mangos-find.md} (81%) diff --git a/.changeset/journey-loginfailure-on-error-code.md b/.changeset/whole-mangos-find.md similarity index 81% rename from .changeset/journey-loginfailure-on-error-code.md rename to .changeset/whole-mangos-find.md index c9260d6de9..6b36eacfb2 100644 --- a/.changeset/journey-loginfailure-on-error-code.md +++ b/.changeset/whole-mangos-find.md @@ -2,4 +2,4 @@ '@forgerock/journey-client': patch --- -Return `JourneyLoginFailure` by hitting the previously-unreached `LoginFailure` branch when `start()`/`next()` receives a failure payload with a `code`. +Return `JourneyLoginFailure` by hitting the previously-unreached `LoginFailure` branch when `start()`/`next()` receives a failure payload with a login failure `code` diff --git a/packages/journey-client/src/lib/client.store.test.ts b/packages/journey-client/src/lib/client.store.test.ts index 02325591b0..2304458eaf 100644 --- a/packages/journey-client/src/lib/client.store.test.ts +++ b/packages/journey-client/src/lib/client.store.test.ts @@ -1,6 +1,6 @@ // @vitest-environment node /* - * Copyright (c) 2025 Ping Identity Corporation. All rights reserved. + * Copyright (c) 2025-2026 Ping Identity Corporation. All rights reserved. * * This software may be modified and distributed under the terms * of the MIT license. See the LICENSE file for details. diff --git a/packages/journey-client/src/lib/client.store.ts b/packages/journey-client/src/lib/client.store.ts index ecb95bb802..e50412f8f2 100644 --- a/packages/journey-client/src/lib/client.store.ts +++ b/packages/journey-client/src/lib/client.store.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2025 Ping Identity Corporation. All rights reserved. + * Copyright (c) 2025-2026 Ping Identity Corporation. All rights reserved. * * This software may be modified and distributed under the terms * of the MIT license. See the LICENSE file for details. @@ -16,7 +16,6 @@ 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'; @@ -156,17 +155,11 @@ export async function journey({ const self: JourneyClient = { start: async (options?: StartParam) => { - const { data, error } = await store.dispatch(journeyApi.endpoints.start.initiate(options)); + const { data } = 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); - } - const genericError: GenericError = { error: 'no_response_data', message: 'No data received from server when starting journey', @@ -179,19 +172,11 @@ export async function journey({ * 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, error } = await store.dispatch( - journeyApi.endpoints.next.initiate({ step, options }), - ); + const { data } = 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); - } - const genericError: GenericError = { error: 'no_response_data', message: 'No data received from server when submitting step', diff --git a/packages/journey-client/src/lib/journey.api.ts b/packages/journey-client/src/lib/journey.api.ts index 66c4da9a29..70e4692f2d 100644 --- a/packages/journey-client/src/lib/journey.api.ts +++ b/packages/journey-client/src/lib/journey.api.ts @@ -89,6 +89,9 @@ interface Extras { logger: ReturnType; } +// Only treat these numeric codes as login failures coming back in the Step payload. +const LOGIN_FAILURE_CODES = [400, 401, 403, 412, 423, 429]; + export const journeyApi = createApi({ reducerPath: 'journeyReducer', baseQuery: fetchBaseQuery({ @@ -133,6 +136,24 @@ export const journeyApi = createApi({ return result as QueryReturnValue; }); + /** + * If the endpoint returned an HTTP error whose body is an AM Step with a + * login-failure code, treat it as successful data so callers receive the + * Step via the `data` path (keeps downstream logic simpler). + */ + if ('error' in response) { + const errorData = (response.error as FetchBaseQueryError | undefined)?.data as + | Step + | undefined; + if (errorData && errorData.code && LOGIN_FAILURE_CODES.includes(errorData.code)) { + return { data: errorData } as QueryReturnValue< + Step, + FetchBaseQueryError, + FetchBaseQueryMeta + >; + } + } + return response as QueryReturnValue; }, }), @@ -162,6 +183,24 @@ export const journeyApi = createApi({ return result as QueryReturnValue; }); + /** + * If the endpoint returned an HTTP error whose body is an AM Step with a + * login-failure code, treat it as successful data so callers receive the + * Step via the `data` path (keeps downstream logic simpler). + */ + if ('error' in response) { + const errorData = (response.error as FetchBaseQueryError | undefined)?.data as + | Step + | undefined; + if (errorData && errorData.code && LOGIN_FAILURE_CODES.includes(errorData.code)) { + return { data: errorData } as QueryReturnValue< + Step, + FetchBaseQueryError, + FetchBaseQueryMeta + >; + } + } + return response as QueryReturnValue; }, }), From de777ffa7611d75f713997345b355b9be58f50fc Mon Sep 17 00:00:00 2001 From: Vatsal Parikh Date: Wed, 22 Apr 2026 16:56:33 -0700 Subject: [PATCH 3/3] fix(journey-client): handle errors in journey utils with RTK narrowing --- e2e/journey-app/main.ts | 4 +- .../src/lib/client.store.test.ts | 12 +-- .../journey-client/src/lib/client.store.ts | 43 +++----- .../journey-client/src/lib/journey.api.ts | 45 +-------- .../src/lib/journey.utils.test.ts | 97 +++++++++++++++++++ .../journey-client/src/lib/journey.utils.ts | 74 ++++++++++++-- packages/journey-client/src/types.ts | 2 + 7 files changed, 192 insertions(+), 85 deletions(-) create mode 100644 packages/journey-client/src/lib/journey.utils.test.ts diff --git a/e2e/journey-app/main.ts b/e2e/journey-app/main.ts index 2d28bab76b..015e5f6efd 100644 --- a/e2e/journey-app/main.ts +++ b/e2e/journey-app/main.ts @@ -8,8 +8,6 @@ import './style.css'; import { journey } from '@forgerock/journey-client'; -import type { JourneyClient, RequestMiddleware } from '@forgerock/journey-client/types'; - import { renderCallbacks } from './callback-map.js'; import { renderDeleteDevicesSection } from './components/delete-device.js'; import { renderQRCodeStep } from './components/qr-code.js'; @@ -18,6 +16,8 @@ import { deleteWebAuthnDevice } from './services/delete-webauthn-device.js'; import { handleWebAuthnStep } from './components/webauthn-step.js'; import { serverConfigs } from './server-configs.js'; +import type { JourneyClient, RequestMiddleware } from '@forgerock/journey-client/types'; + const qs = window.location.search; const searchParams = new URLSearchParams(qs); diff --git a/packages/journey-client/src/lib/client.store.test.ts b/packages/journey-client/src/lib/client.store.test.ts index 2304458eaf..0f8ef1a5fc 100644 --- a/packages/journey-client/src/lib/client.store.test.ts +++ b/packages/journey-client/src/lib/client.store.test.ts @@ -6,13 +6,13 @@ * of the MIT license. See the LICENSE file for details. */ -import { callbackType } from '@forgerock/sdk-types'; import { afterEach, describe, expect, test, vi } from 'vitest'; -import type { GenericError, Step, WellknownResponse } from '@forgerock/sdk-types'; - import { journey } from './client.store.js'; import { createJourneyStep } from './step.utils.js'; + +import { callbackType, type GenericError, type Step, type WellknownResponse } from '../types.js'; + import { JourneyClientConfig } from './config.types.js'; /** @@ -158,7 +158,7 @@ describe('journey-client', () => { } }); - test('start_401WithCodeInBody_ReturnsLoginFailure', async () => { + test('start_401WithStepPayload_ReturnsLoginFailure', async () => { const failurePayload: Step = { code: 401, message: 'Access Denied', @@ -222,7 +222,7 @@ describe('journey-client', () => { } }); - test('next_401WithCodeInBody_ReturnsLoginFailure', async () => { + test('next_401WithStepPayload_ReturnsLoginFailure', async () => { const initialStep = createJourneyStep({ authId: 'test-auth-id', callbacks: [], @@ -434,7 +434,7 @@ describe('journey-client', () => { expect(isGenericError(result)).toBe(true); if (isGenericError(result)) { - expect(result.error).toBe('no_response_data'); + expect(result.error).toBe('request_failed'); expect(result.type).toBe('unknown_error'); } }); diff --git a/packages/journey-client/src/lib/client.store.ts b/packages/journey-client/src/lib/client.store.ts index e50412f8f2..5c3114b21c 100644 --- a/packages/journey-client/src/lib/client.store.ts +++ b/packages/journey-client/src/lib/client.store.ts @@ -6,24 +6,27 @@ */ import { logger as loggerFn, LogLevel, CustomLogger } from '@forgerock/sdk-logger'; -import { callbackType } from '@forgerock/sdk-types'; import { isGenericError, isValidWellknownUrl, createWellknownError, } from '@forgerock/sdk-utilities'; -import type { GenericError } from '@forgerock/sdk-types'; -import type { ActionTypes, RequestMiddleware } from '@forgerock/sdk-request-middleware'; -import type { Step } from '@forgerock/sdk-types'; - import { createJourneyStore } from './client.store.utils.js'; import { configSlice } from './config.slice.js'; import { journeyApi } from './journey.api.js'; import { createStorage } from '@forgerock/storage'; -import { createJourneyObject } from './journey.utils.js'; +import { createJourneyObject, resolveJourneyResult } from './journey.utils.js'; import { wellknownApi } from './wellknown.api.js'; +import { + callbackType, + type ActionTypes, + type GenericError, + type RequestMiddleware, + type Step, +} from '../types.js'; + import type { JourneyStep } from './step.utils.js'; import type { JourneyClientConfig } from './config.types.js'; import type { RedirectCallback } from './callbacks/redirect-callback.js'; @@ -155,34 +158,18 @@ export async function journey({ const self: JourneyClient = { start: async (options?: StartParam) => { - const { data } = await store.dispatch(journeyApi.endpoints.start.initiate(options)); - if (data) { - return createJourneyObject(data); - } - - const genericError: GenericError = { - error: 'no_response_data', - message: 'No data received from server when starting journey', - type: 'unknown_error', - }; - return genericError; + const { data, error } = await store.dispatch(journeyApi.endpoints.start.initiate(options)); + return resolveJourneyResult(data, error); }, /** * 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) { - return createJourneyObject(data); - } - - const genericError: GenericError = { - error: 'no_response_data', - message: 'No data received from server when submitting step', - type: 'unknown_error', - }; - return genericError; + const { data, error } = await store.dispatch( + journeyApi.endpoints.next.initiate({ step, options }), + ); + return resolveJourneyResult(data, error); }, // TODO: Remove the actual redirect from this method and just return the URL to the caller diff --git a/packages/journey-client/src/lib/journey.api.ts b/packages/journey-client/src/lib/journey.api.ts index 70e4692f2d..a7cbbb5014 100644 --- a/packages/journey-client/src/lib/journey.api.ts +++ b/packages/journey-client/src/lib/journey.api.ts @@ -1,5 +1,5 @@ /* - * Copyright (c) 2020 - 2025 Ping Identity Corporation. All rights reserved. + * Copyright (c) 2020 - 2026 Ping Identity Corporation. All rights reserved. * * This software may be modified and distributed under the terms * of the MIT license. See the LICENSE file for details. @@ -9,6 +9,8 @@ import { initQuery, RequestMiddleware } from '@forgerock/sdk-request-middleware' import { REQUESTED_WITH, getEndpointPath, stringify, resolve } from '@forgerock/sdk-utilities'; import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query'; +import { NextOptions, StartParam } from './interfaces.js'; + import type { Step } from '@forgerock/sdk-types'; import type { logger as loggerFn } from '@forgerock/sdk-logger'; import type { @@ -21,9 +23,7 @@ import type { } from '@reduxjs/toolkit/query'; import { JourneyStep } from './step.types.js'; - import type { InternalJourneyClientConfig } from './config.types.js'; -import { NextOptions, StartParam } from './interfaces.js'; /** * Minimal state type for accessing journey config from RTK Query endpoints. @@ -89,9 +89,6 @@ interface Extras { logger: ReturnType; } -// Only treat these numeric codes as login failures coming back in the Step payload. -const LOGIN_FAILURE_CODES = [400, 401, 403, 412, 423, 429]; - export const journeyApi = createApi({ reducerPath: 'journeyReducer', baseQuery: fetchBaseQuery({ @@ -136,24 +133,6 @@ export const journeyApi = createApi({ return result as QueryReturnValue; }); - /** - * If the endpoint returned an HTTP error whose body is an AM Step with a - * login-failure code, treat it as successful data so callers receive the - * Step via the `data` path (keeps downstream logic simpler). - */ - if ('error' in response) { - const errorData = (response.error as FetchBaseQueryError | undefined)?.data as - | Step - | undefined; - if (errorData && errorData.code && LOGIN_FAILURE_CODES.includes(errorData.code)) { - return { data: errorData } as QueryReturnValue< - Step, - FetchBaseQueryError, - FetchBaseQueryMeta - >; - } - } - return response as QueryReturnValue; }, }), @@ -183,24 +162,6 @@ export const journeyApi = createApi({ return result as QueryReturnValue; }); - /** - * If the endpoint returned an HTTP error whose body is an AM Step with a - * login-failure code, treat it as successful data so callers receive the - * Step via the `data` path (keeps downstream logic simpler). - */ - if ('error' in response) { - const errorData = (response.error as FetchBaseQueryError | undefined)?.data as - | Step - | undefined; - if (errorData && errorData.code && LOGIN_FAILURE_CODES.includes(errorData.code)) { - return { data: errorData } as QueryReturnValue< - Step, - FetchBaseQueryError, - FetchBaseQueryMeta - >; - } - } - return response as QueryReturnValue; }, }), diff --git a/packages/journey-client/src/lib/journey.utils.test.ts b/packages/journey-client/src/lib/journey.utils.test.ts new file mode 100644 index 0000000000..a2361fbbd8 --- /dev/null +++ b/packages/journey-client/src/lib/journey.utils.test.ts @@ -0,0 +1,97 @@ +/* + * Copyright (c) 2026 Ping Identity Corporation. All rights reserved. + * + * This software may be modified and distributed under the terms + * of the MIT license. See the LICENSE file for details. + */ + +import { describe, expect, it } from 'vitest'; + +import { StepType, type Step } from '@forgerock/sdk-types'; + +import { createJourneyObject, resolveJourneyResult } from './journey.utils.js'; +import type { JourneyLoginFailure } from './login-failure.utils.js'; + +describe('createJourneyObject', () => { + it('returns Step when provided a step with authId', () => { + const stepPayload: Step = { + authId: 'test-auth-id', + callbacks: [], + }; + + const result = createJourneyObject(stepPayload); + + expect(result).not.toHaveProperty('error'); + expect(result).toHaveProperty('type', StepType.Step); + expect(result).toHaveProperty('payload'); + expect((result as { payload: Step }).payload).toEqual(stepPayload); + }); + + it('returns LoginSuccess when provided a step with successUrl', () => { + const successPayload: Step = { + successUrl: 'https://example.com/success', + realm: 'root', + tokenId: 'token-123', + }; + + const result = createJourneyObject(successPayload); + + expect(result).not.toHaveProperty('error'); + expect(result).toHaveProperty('type', StepType.LoginSuccess); + expect(result).toHaveProperty('payload', successPayload); + }); +}); + +describe('resolveJourneyResult - no_response_data', () => { + it('returns no_response_data GenericError when no data and no error', () => { + const result = resolveJourneyResult(undefined, undefined); + + expect(result).toMatchObject({ + error: 'no_response_data', + message: 'No data received from server', + type: 'unknown_error', + }); + }); +}); + +describe('toJourneyResult', () => { + it('returns request_failed GenericError for FetchBaseQueryError without Step payload', () => { + const result = resolveJourneyResult(undefined, { status: 500, data: { foo: 'bar' } }); + + expect(result).toMatchObject({ + error: 'request_failed', + message: 'Request failed: {"foo":"bar"}', + type: 'unknown_error', + }); + }); + + it('returns request_failed GenericError for SerializedError', () => { + const result = resolveJourneyResult(undefined, { message: 'Network failure' }); + + expect(result).toMatchObject({ + error: 'request_failed', + message: 'Request failed: Network failure', + type: 'unknown_error', + }); + }); + + it('returns LoginFailure when FetchBaseQueryError contains a failure Step payload', () => { + const failurePayload: Step = { + code: 401, + message: 'Access Denied', + reason: 'Unauthorized', + detail: { failureUrl: 'https://example.com/failure' }, + }; + + const result = resolveJourneyResult(undefined, { status: 401, data: failurePayload }); + + expect(result).not.toHaveProperty('error'); + expect(result).toHaveProperty('type', StepType.LoginFailure); + expect(result).toHaveProperty('payload', failurePayload); + + const failure = result as JourneyLoginFailure; + expect(failure.getCode()).toBe(401); + expect(failure.getMessage()).toBe('Access Denied'); + expect(failure.getReason()).toBe('Unauthorized'); + }); +}); diff --git a/packages/journey-client/src/lib/journey.utils.ts b/packages/journey-client/src/lib/journey.utils.ts index 4a42cae87e..23bbfd25e6 100644 --- a/packages/journey-client/src/lib/journey.utils.ts +++ b/packages/journey-client/src/lib/journey.utils.ts @@ -1,11 +1,13 @@ /* - * Copyright (c) 2025 Ping Identity Corporation. All rights reserved. + * Copyright (c) 2025-2026 Ping Identity Corporation. All rights reserved. * * This software may be modified and distributed under the terms * of the MIT license. See the LICENSE file for details. */ import { StepType } from '@forgerock/sdk-types'; +import type { FetchBaseQueryError } from '@reduxjs/toolkit/query'; +import type { SerializedError } from '@reduxjs/toolkit'; import type { GenericError, Step } from '@forgerock/sdk-types'; @@ -17,15 +19,31 @@ import type { JourneyStep } from './step.utils.js'; import type { JourneyLoginFailure } from './login-failure.utils.js'; import type { JourneyLoginSuccess } from './login-success.utils.js'; +export type JourneyResult = JourneyStep | JourneyLoginSuccess | JourneyLoginFailure | GenericError; + +const STEP_LIKE_KEYS = [ + 'authId', + 'callbacks', + 'code', + 'description', + 'detail', + 'header', + 'ok', + 'realm', + 'reason', + 'stage', + 'status', + 'successUrl', + 'tokenId', +] as const; + /** - * Creates a journey object from a raw Step response. - * Determines the step type based on the presence of authId or successUrl properties - * and returns the appropriate journey object type. + * Creates a typed journey object from a raw Step response. * * @param step - The raw Step response from the authentication API - * @returns A JourneyStep, JourneyLoginSuccess, JourneyLoginFailure, or GenericError if the step type cannot be determined + * @returns A JourneyStep, JourneyLoginSuccess, or JourneyLoginFailure, or a GenericError if the step type cannot be determined */ -function createJourneyObject( +export function createJourneyObject( step: Step, ): JourneyStep | JourneyLoginSuccess | JourneyLoginFailure | GenericError { let type; @@ -53,4 +71,46 @@ function createJourneyObject( } } -export { createJourneyObject }; +/** + * Maps an RTK Query dispatch result to a JourneyResult. + * Narrows RTK errors first; only calls createJourneyObject when data is confirmed present. + * + * @param data - The Step data returned by the RTK Query endpoint, if any + * @param error - The error returned by the RTK Query endpoint, if any + * @returns A JourneyResult representing the outcome of the journey step + */ +export function resolveJourneyResult(data: Step | undefined, error: unknown): JourneyResult { + if (error && typeof error === 'object' && 'status' in error) { + const fetchError = error as FetchBaseQueryError; + const stepData = fetchError.data; + if (stepData && typeof stepData === 'object' && STEP_LIKE_KEYS.some((key) => key in stepData)) { + return createJourneyObject(stepData as Step); + } + + const errMsg = 'error' in fetchError ? fetchError.error : JSON.stringify(fetchError.data); + return { + error: 'request_failed', + message: `Request failed: ${errMsg}`, + type: 'unknown_error', + }; + } + + if (error && typeof error === 'object' && 'message' in error) { + const serializedError = error as SerializedError; + return { + error: 'request_failed', + message: `Request failed: ${serializedError.message ?? 'Unknown error'}`, + type: 'unknown_error', + }; + } + + if (!data) { + return { + error: 'no_response_data', + message: 'No data received from server', + type: 'unknown_error', + }; + } + + return createJourneyObject(data); +} diff --git a/packages/journey-client/src/types.ts b/packages/journey-client/src/types.ts index 4b547efb23..dca7d1c287 100644 --- a/packages/journey-client/src/types.ts +++ b/packages/journey-client/src/types.ts @@ -14,6 +14,7 @@ export type { CallbackType, StepType, GenericError, + WellknownResponse, PolicyRequirement, FailedPolicyRequirement, NameValue, @@ -23,6 +24,7 @@ export type { } from '@forgerock/sdk-types'; export { PolicyKey } from '@forgerock/sdk-types'; +export { callbackType } from '@forgerock/sdk-types'; // Re-export local types export * from './lib/client.types.js';