fix: error-states-should-clear

Author: ryanbas21

.changeset/cute-snails-burn.md

@@ -0,0 +1,5 @@
+---
+'@forgerock/davinci-client': patch
+---
+
+error states should be cleared from state when a successful next or success node was processed

packages/davinci-client/src/lib/collector.utils.test.ts

@@ -427,15 +427,15 @@ describe('Object value collectors', () => {
           title: 'Device 1',
           id: '123123',
           default: true,
-          value: 'device1-value',
+          description: 'device1-value',
         },
         {
           type: 'device2',
           iconSrc: 'icon2.png',
           title: 'Device 2',
           id: '345345',
           default: false,
-          value: 'device2-value',
+          description: 'device2-value',
         },
       ],
       required: true,
@@ -444,7 +444,7 @@ describe('Object value collectors', () => {
     const transformedDevices = mockField.options.map((device) => ({
       label: device.title,
       value: device.id,
-      content: device.value,
+      content: device.description,
       type: device.type,
       key: device.id,
       default: device.default,

packages/davinci-client/src/lib/collector.utils.ts

@@ -374,15 +374,15 @@ export function returnObjectCollector<
     const unmappedDefault = field.options.find((device) => device.default);
     defaultValue = {
       type: unmappedDefault ? unmappedDefault.type : '',
-      value: unmappedDefault ? unmappedDefault.value : '',
+      value: unmappedDefault ? unmappedDefault.description : '',
       id: unmappedDefault ? unmappedDefault.id : '',
     };
 
     // Map DaVinci spec to normalized SDK API
     options = field.options.map((device) => ({
       type: device.type,
       label: device.title,
-      content: device.value,
+      content: device.description,
       value: device.id,
       key: device.id,
       default: device.default,

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

@@ -126,7 +126,7 @@ export type DeviceAuthenticationField = {
     title: string;
     id: string;
     default: boolean;
-    value: string;
+    description: string;
   }[];
   required: boolean;
 };

packages/davinci-client/src/lib/node.slice.test.ts

@@ -41,6 +41,49 @@ describe('The node slice reducers', () => {
     expect(nodeSlice.reducer(undefined, action)).toEqual(nodeNext0);
   });
 
+  it('should clear error when we successfully process a node with a next', () => {
+    const actionError = {
+      type: 'node/error',
+      payload: {
+        data: error0a,
+        requestId: '1234',
+        httpStatus: 400,
+      },
+    };
+    const errorState = {
+      cache: {
+        key: '1234',
+      },
+      client: {
+        status: 'error' as const,
+      },
+      error: {
+        code: ' Invalid username and/or password',
+        collectors: [],
+        message: ' Invalid username and/or password',
+        internalHttpStatus: 400,
+        status: 'error',
+        type: 'davinci_error',
+      },
+      httpStatus: 400,
+      server: {
+        status: 'error',
+      },
+      status: 'error',
+    };
+    const errorStateReducer = nodeSlice.reducer(undefined, actionError);
+    expect(errorStateReducer).toEqual(errorState);
+
+    const action = {
+      type: 'node/next',
+      payload: {
+        data: next0,
+        requestId: '1234',
+        httpStatus: 200,
+      },
+    };
+    expect(nodeSlice.reducer(errorStateReducer, action)).toEqual(nodeNext0);
+  });
   it('should handle success node after DaVinci flow', () => {
     const action = {
       type: 'node/success',
@@ -67,6 +110,50 @@ describe('The node slice reducers', () => {
     expect(nodeSlice.reducer(undefined, action)).toEqual(nodeSuccess1);
   });
 
+  it('should clear error when we successfully process a node', () => {
+    const action = {
+      type: 'node/error',
+      payload: {
+        data: error0a,
+        requestId: '1234',
+        httpStatus: 400,
+      },
+    };
+    const errorState = {
+      cache: {
+        key: '1234',
+      },
+      client: {
+        status: 'error' as const,
+      },
+      error: {
+        code: ' Invalid username and/or password',
+        collectors: [],
+        message: ' Invalid username and/or password',
+        internalHttpStatus: 400,
+        status: 'error',
+        type: 'davinci_error',
+      },
+      httpStatus: 400,
+      server: {
+        status: 'error',
+      },
+      status: 'error',
+    };
+    const errorStateReducer = nodeSlice.reducer(undefined, action);
+    expect(errorStateReducer).toEqual(errorState);
+
+    const actionSuccess = {
+      type: 'node/success',
+      payload: {
+        data: success1,
+        requestId: '1234',
+        httpStatus: 200,
+      },
+    };
+    expect(nodeSlice.reducer(errorStateReducer, actionSuccess)).toEqual(nodeSuccess1);
+  });
+
   it('should handle error node', () => {
     const action = {
       type: 'node/error',

packages/davinci-client/src/lib/node.slice.ts

@@ -51,7 +51,7 @@ export const initialNodeState = {
     status: START_STATUS,
   },
   status: START_STATUS,
-};
+} satisfies StartNode;
 
 type NodeStates = ErrorNode | FailureNode | ContinueNode | SuccessNode | StartNode;
 
@@ -204,6 +204,8 @@ export const nodeSlice = createSlice({
         status: CONTINUE_STATUS,
       };
 
+      newState.error = null;
+
       newState.httpStatus = action.payload.httpStatus;
 
       newState.server = {
@@ -257,6 +259,7 @@ export const nodeSlice = createSlice({
         status: SUCCESS_STATUS,
       };
 
+      newState.error = null;
       newState.status = SUCCESS_STATUS;
 
       return newState;