widgetOperation: fix previous status when path is changed

fixes #1116

When a previous status exists for a widget name, but it does not have
the same path as the one of the widget being prepared, do not return the
previous status. This extracts the previous status fetch to a function
which does this check.

Add a unit test the validates this change.

Author: tahini

packages/evolution-frontend/src/actions/utils/WidgetOperation.ts

@@ -17,7 +17,8 @@ import { checkConditional, checkChoicesConditional } from './Conditional';
 import { checkValidations } from './Validation';
 import {
     isInputTypeWithArrayValue,
-    UserRuntimeInterviewAttributes
+    UserRuntimeInterviewAttributes,
+    WidgetStatus
 } from 'evolution-common/lib/services/questionnaire/types';
 import { CliUser } from 'chaire-lib-common/lib/services/user/userType';
 import { GroupConfig } from 'evolution-common/lib/services/questionnaire/types';
@@ -72,6 +73,22 @@ const prepareGroupWidgets = (
     }
 };
 
+// Get the previous status for a widget
+const getPreviousWidgetStatus = (
+    interview: UserRuntimeInterviewAttributes,
+    widgetShortname: string,
+    path: string,
+    groupShortname?: string,
+    parentGroupedObjectId?: string
+): WidgetStatus | undefined => {
+    const previousStatusForWidget = groupShortname
+        ? parentGroupedObjectId
+            ? interview.previousGroups?.[groupShortname]?.[parentGroupedObjectId]?.[widgetShortname]
+            : undefined
+        : interview.previousWidgets?.[widgetShortname];
+    return previousStatusForWidget && previousStatusForWidget.path === path ? previousStatusForWidget : undefined;
+};
+
 const prepareSimpleWidget = (
     data: CurrentPreparationData,
     widgetData: WidgetPreparationData,
@@ -86,15 +103,13 @@ const prepareSimpleWidget = (
         : undefined;
     // get previous status:
     const parentGroupedObjectId = widgetData.parentGroupedObject ? widgetData.parentGroupedObject._uuid : undefined;
-    const previousStatus = widgetData.groupShortname
-        ? data.interview.previousGroups &&
-          data.interview.previousGroups[widgetData.groupShortname] &&
-          data.interview.previousGroups[widgetData.groupShortname][parentGroupedObjectId]
-            ? data.interview.previousGroups[widgetData.groupShortname][parentGroupedObjectId][widgetShortname]
-            : undefined
-        : data.interview.previousWidgets
-            ? data.interview.previousWidgets[widgetShortname]
-            : undefined;
+    const previousStatus = getPreviousWidgetStatus(
+        data.interview,
+        widgetShortname,
+        path,
+        widgetData.groupShortname,
+        parentGroupedObjectId
+    );
 
     // verify conditional visibility:
     const [isVisible, invisibleValue, customInvisibleValue] = checkConditional(

packages/evolution-frontend/src/actions/utils/__tests__/WidgetOperation.test.ts

@@ -382,6 +382,43 @@ describe('Test with previous status', () => {
 
     });
 
+    test('Should set widget status if previous path does not match current one', () => {
+        // Prepare test data: override previous status for widget1 with a different path
+        const testInterviewAttributes = _cloneDeep(runtimeInterviewAttributes);
+        const previousStatuses = _cloneDeep(previousWidgetStatuses);
+        previousStatuses.widget1.path = 'not.the.same.path';
+        previousStatuses.widget1.value = 'previous value of other path';
+        testInterviewAttributes.widgets = previousStatuses;
+
+        // Test, the 2 widgets should still be valid and visible
+        const { updatedInterview, updatedValuesByPath, needUpdate } = prepareSectionWidgets(mainSection, testInterviewAttributes, { 'response.section1.q2': true }, {});
+
+        // Interview data should correspond to expected
+        expect(updatedInterview).toEqual(expect.objectContaining(interviewAttributes));
+        expect(updatedValuesByPath).toEqual({});
+        expect(needUpdate).toEqual(false);
+
+        // Check calls of the validation function, should have been called for both widget: widget 2 because it is affected and widget 1 because it does not have a proper previous status.
+        expect(mockedCheckValidations).toHaveBeenCalledTimes(2);
+        expect(mockedCheckValidations).toHaveBeenCalledWith(undefined, interviewAttributes.response.section1.q1, undefined, testInterviewAttributes, 'section1.q1', undefined);
+        expect(mockedCheckValidations).toHaveBeenCalledWith(widgets.widget2.validations, interviewAttributes.response.section1.q2, undefined, testInterviewAttributes, 'section1.q2', undefined);
+
+        // Check calls to the conditional function, called twice, once for each widget
+        expect(mockedCheckConditional).toHaveBeenCalledTimes(2);
+        expect(mockedCheckConditional).toHaveBeenCalledWith(undefined, testInterviewAttributes, 'section1.q1', undefined);
+        expect(mockedCheckConditional).toHaveBeenCalledWith(undefined, testInterviewAttributes, 'section1.q2', undefined);
+
+        // Widget statuses should have been updated and match the one specified in the test, not the previous ones from the interview
+        expect(updatedInterview.widgets).toEqual({
+            widget1: previousWidgetStatuses.widget1,
+            widget2: previousWidgetStatuses.widget2
+        });
+
+        // Check the visible widgets and the allWidgetsValid flag
+        expect(updatedInterview.visibleWidgets).toEqual(['section1.q1', 'section1.q2']);
+        expect(updatedInterview.allWidgetsValid).toEqual(true);
+    });
+
 });
 
 describe('Test with conditional', () => {