fix(journey-client): error handling in journey.api file to keep infra separate from pure utils

Author: vatsalparikh

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

@@ -19,9 +19,9 @@ 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 { journeyApi, resolveRTKResponse } from './journey.api.js';
 import { createStorage } from '@forgerock/storage';
-import { createJourneyObject, resolveJourneyResult } from './journey.utils.js';
+import { createJourneyObject } from './journey.utils.js';
 import { wellknownApi } from './wellknown.api.js';
 
 import type { JourneyStep } from './step.utils.js';
@@ -156,7 +156,14 @@ export async function journey<ActionType extends ActionTypes = ActionTypes>({
   const self: JourneyClient = {
     start: async (options?: StartParam) => {
       const { data, error } = await store.dispatch(journeyApi.endpoints.start.initiate(options));
-      return resolveJourneyResult(data, error);
+
+      const result = resolveRTKResponse(data, error);
+
+      if ('error' in result) {
+        return result;
+      }
+
+      return createJourneyObject(result);
     },
 
     /**
@@ -166,7 +173,14 @@ export async function journey<ActionType extends ActionTypes = ActionTypes>({
       const { data, error } = await store.dispatch(
         journeyApi.endpoints.next.initiate({ step, options }),
       );
-      return resolveJourneyResult(data, error);
+
+      const result = resolveRTKResponse(data, error);
+
+      if ('error' in result) {
+        return result;
+      }
+
+      return createJourneyObject(result);
     },
 
     // TODO: Remove the actual redirect from this method and just return the URL to the caller

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

@@ -10,7 +10,9 @@ import { REQUESTED_WITH, getEndpointPath, stringify, resolve } from '@forgerock/
 import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query';
 
 import type { Step } from '@forgerock/sdk-types';
+import type { GenericError } from '@forgerock/sdk-types';
 import type { logger as loggerFn } from '@forgerock/sdk-logger';
+import type { SerializedError } from '@reduxjs/toolkit';
 import type {
   BaseQueryApi,
   BaseQueryFn,
@@ -197,3 +199,51 @@ export const journeyApi = createApi({
     }),
   }),
 });
+
+/**
+ * Resolves an RTK Query response to a Step or GenericError.
+ * Handles error evaluation and extraction of step data from error responses.
+ *
+ * @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 Step if valid data exists, or a GenericError otherwise
+ */
+export function resolveRTKResponse(
+  data: Step | undefined,
+  error: FetchBaseQueryError | SerializedError | undefined,
+): Step | GenericError {
+  // Check for FetchBaseQueryError with status
+  if (error && 'status' in error) {
+    const stepData = error.data;
+    // If error.data is an object, return it as step data for login failure
+    if (typeof stepData === 'object' && stepData !== null) {
+      return stepData as Step;
+    }
+    const errMsg = 'error' in error ? error.error : JSON.stringify(error.data);
+    return {
+      error: 'request_failed',
+      message: `Request failed: ${errMsg}`,
+      type: 'unknown_error',
+    };
+  }
+
+  // Check for SerializedError
+  if (error && 'message' in error) {
+    return {
+      error: 'request_failed',
+      message: `Request failed: ${error.message ?? 'Unknown error'}`,
+      type: 'unknown_error',
+    };
+  }
+
+  // Return data if available, otherwise no_response_data error
+  if (data) {
+    return data;
+  }
+
+  return {
+    error: 'no_response_data',
+    message: 'No data received from server',
+    type: 'unknown_error',
+  };
+}

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

@@ -10,7 +10,7 @@ import { describe, expect, it } from 'vitest';
 import { StepType } from '../types.js';
 import { type Step } from '../index.js';
 
-import { createJourneyObject, resolveJourneyResult } from './journey.utils.js';
+import { createJourneyObject } from './journey.utils.js';
 import type { JourneyLoginFailure } from './login-failure.utils.js';
 
 describe('createJourneyObject', () => {
@@ -41,47 +41,16 @@ describe('createJourneyObject', () => {
     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 LoginFailure when FetchBaseQueryError has an object payload', () => {
-    const result = resolveJourneyResult(undefined, { status: 500, data: { foo: 'bar' } });
-
-    expect(result).toHaveProperty('type', StepType.LoginFailure);
-    expect(result).toHaveProperty('payload', { foo: 'bar' });
-  });
-
-  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', () => {
+  it('returns LoginFailure when provided a step without authId or successUrl', () => {
     const failurePayload: Step = {
       code: 401,
       message: 'Access Denied',
       reason: 'Unauthorized',
       detail: { failureUrl: 'https://example.com/failure' },
     };
 
-    const result = resolveJourneyResult(undefined, { status: 401, data: failurePayload });
+    const result = createJourneyObject(failurePayload);
 
     expect(result).not.toHaveProperty('error');
     expect(result).toHaveProperty('type', StepType.LoginFailure);

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

@@ -6,8 +6,6 @@
  */
 
 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';
 
@@ -54,49 +52,3 @@ export function 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: FetchBaseQueryError | SerializedError | undefined,
-): JourneyResult {
-  if (error && 'status' in error) {
-    const stepData = error.data;
-    // If error.data is an object, we treat it as login failure
-    if (typeof stepData === 'object' && stepData !== null) {
-      return createJourneyObject(stepData as Step);
-    }
-
-    const errMsg = 'error' in error ? error.error : JSON.stringify(error.data);
-    return {
-      error: 'request_failed',
-      message: `Request failed: ${errMsg}`,
-      type: 'unknown_error',
-    };
-  }
-
-  if (error && 'message' in error) {
-    return {
-      error: 'request_failed',
-      message: `Request failed: ${error.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);
-}