Removing autosave functionality (not in use)

src/__mocks__/formDataStateMock.ts

@@ -13,7 +13,6 @@ export function getFormDataStateMock(customState?: Partial<IFormDataState>) {
       'referencedGroup[2].inputField': 'Value from input field [2]',
     },
     lastSavedFormData: {},
-    savingId: '',
     submittingId: '',
     unsavedChanges: false,
     saving: false,

src/__mocks__/uiConfigStateMock.ts

@@ -1,7 +1,6 @@
 import type { IUiConfig } from 'src/types';
 
 export const getUiConfigStateMock = (customStates?: Partial<IUiConfig>): IUiConfig => ({
-  autoSave: true,
   focus: null,
   tracks: {
     hidden: [],

src/features/formData/formDataSlice.ts

@@ -27,7 +27,6 @@ export const initialState: IFormDataState = {
   unsavedChanges: false,
   saving: false,
   submittingId: '',
-  savingId: '',
   error: null,
 };
 
@@ -68,25 +67,12 @@ export const formDataSlice = () => {
       submit: mkAction<ISubmitDataAction>({
         takeEvery: submitFormSaga,
         reducer: (state, action) => {
-          const { apiMode, componentId } = action.payload;
-          state.savingId = apiMode !== 'Complete' ? componentId : state.savingId;
-          state.submittingId = apiMode === 'Complete' ? componentId : state.submittingId;
-        },
-      }),
-      savingStarted: mkAction<void>({
-        reducer: (state) => {
-          state.saving = true;
-        },
-      }),
-      savingEnded: mkAction<{ model: IFormData }>({
-        reducer: (state, action) => {
-          state.saving = false;
-          state.lastSavedFormData = action.payload.model;
+          const { componentId } = action.payload;
+          state.submittingId = componentId;
         },
       }),
       submitFulfilled: mkAction<void>({
         reducer: (state) => {
-          state.savingId = '';
           state.unsavedChanges = false;
         },
       }),
@@ -95,7 +81,17 @@ export const formDataSlice = () => {
           const { error } = action.payload;
           state.error = error;
           state.submittingId = '';
-          state.savingId = '';
+        },
+      }),
+      savingStarted: mkAction<void>({
+        reducer: (state) => {
+          state.saving = true;
+        },
+      }),
+      savingEnded: mkAction<{ model: IFormData }>({
+        reducer: (state, action) => {
+          state.saving = false;
+          state.lastSavedFormData = action.payload.model;
         },
       }),
       update: mkAction<IUpdateFormData>({

src/features/formData/formDataTypes.ts

@@ -14,8 +14,6 @@ export interface IFormDataRejected {
 
 export interface ISubmitDataAction {
   url?: string;
-  apiMode?: string;
-  stopWithWarnings?: boolean;
   componentId: string;
 }
 

src/features/formData/index.d.ts

@@ -17,9 +17,8 @@ export interface IFormDataState {
   unsavedChanges: boolean;
   saving: boolean;
 
-  // The component IDs which triggered submitting/saving last time
+  // The component IDs which triggered a submit (saving the form data in order to move to the next step)
   submittingId: string;
-  savingId: string;
 
   error: Error | null;
 }

src/features/formData/submit/submitFormDataSagas.ts

@@ -25,44 +25,43 @@ import {
 } from 'src/utils/validation/validation';
 import type { IApplicationMetadata } from 'src/features/applicationMetadata';
 import type { IFormData } from 'src/features/formData';
-import type { ISubmitDataAction, IUpdateFormDataFulfilled } from 'src/features/formData/formDataTypes';
+import type { IUpdateFormDataFulfilled } from 'src/features/formData/formDataTypes';
 import type { ILayoutState } from 'src/features/layout/formLayoutSlice';
-import type { IRuntimeState, IRuntimeStore, IUiConfig, IValidationIssue } from 'src/types';
+import type { IRuntimeState, IRuntimeStore, IValidationIssue } from 'src/types';
 
 const LayoutSelector: (store: IRuntimeStore) => ILayoutState = (store: IRuntimeStore) => store.formLayout;
-const UIConfigSelector: (store: IRuntimeStore) => IUiConfig = (store: IRuntimeStore) => store.formLayout.uiConfig;
 const getApplicationMetaData = (store: IRuntimeState) => store.applicationMetadata?.applicationMetadata;
 
-export function* submitFormSaga({
-  payload: { apiMode, stopWithWarnings },
-}: PayloadAction<ISubmitDataAction>): SagaIterator {
+/**
+ * Saga that submits the form data to the backend, and moves the process forward.
+ * @see autoSaveSaga
+ */
+export function* submitFormSaga(): SagaIterator {
   try {
     const state: IRuntimeState = yield select();
     const { validationResult, componentSpecificValidations, emptyFieldsValidations } = runClientSideValidation(state);
 
     validationResult.validations = mergeValidationObjects(
       validationResult.validations,
       componentSpecificValidations,
-      apiMode === 'Complete' ? emptyFieldsValidations : null,
+      emptyFieldsValidations,
     );
     const { validations } = validationResult;
-    if (!canFormBeSaved(validationResult, apiMode)) {
+    if (!canFormBeSaved(validationResult)) {
       yield put(ValidationActions.updateValidations({ validations }));
       return yield put(FormDataActions.submitRejected({ error: null }));
     }
 
     yield call(putFormData, {});
-    if (apiMode === 'Complete') {
-      yield call(submitComplete, state, stopWithWarnings);
-    }
+    yield call(submitComplete, state);
     yield put(FormDataActions.submitFulfilled());
   } catch (error) {
     console.error(error);
     yield put(FormDataActions.submitRejected({ error }));
   }
 }
 
-function* submitComplete(state: IRuntimeState, stopWithWarnings: boolean | undefined) {
+function* submitComplete(state: IRuntimeState) {
   // run validations against the datamodel
   const instanceId = state.instanceData.instance?.id;
   const serverValidation: IValidationIssue[] | undefined = instanceId
@@ -78,8 +77,7 @@ function* submitComplete(state: IRuntimeState, stopWithWarnings: boolean | undef
   );
   yield put(ValidationActions.updateValidations({ validations: mappedValidations }));
   const hasErrors = hasValidationsOfSeverity(mappedValidations, Severity.Error);
-  const hasWarnings = hasValidationsOfSeverity(mappedValidations, Severity.Warning);
-  if (hasErrors || (stopWithWarnings && hasWarnings)) {
+  if (hasErrors) {
     // we have validation errors or warnings that should be shown, do not submit
     return yield put(FormDataActions.submitRejected({ error: null }));
   }
@@ -144,6 +142,17 @@ function* waitForSaving() {
   yield put(FormDataActions.savingStarted());
 }
 
+/**
+ * This is the saving logic that is used for both autosaving and when the form is
+ * submitted at the end (moving the process forward).
+ *
+ * Strangely, this only performs the autosave logic for regular apps, but stateless apps have their own logic for this.
+ * However, when the form is submitted at the end, this is used for both regular and stateless apps.
+ *
+ * @see submitFormSaga
+ * @see autoSaveSaga
+ * @see postStatelessData
+ */
 export function* putFormData({ field, componentId }: SaveDataParams) {
   const defaultDataElementGuid: string | undefined = yield select((state) =>
     getCurrentTaskDataElementId(
@@ -233,6 +242,13 @@ function getModelToSave(state: IRuntimeState) {
   );
 }
 
+/**
+ * Saves the form data to the backend, called from the auto-save saga. This calls the methods that actually perform
+ * the save operation, but this is NOT the saving logic that happens on _submit_ (when the form is submitted, and
+ * the process moves forward).
+ * @see autoSaveSaga
+ * @see submitFormSaga
+ */
 export function* saveFormDataSaga({
   payload: { field, componentId, singleFieldValidation },
 }: PayloadAction<IUpdateFormDataFulfilled>): SagaIterator {
@@ -242,7 +258,7 @@ export function* saveFormDataSaga({
     const application = state.applicationMetadata.applicationMetadata;
 
     if (isStatelessApp(application)) {
-      yield call(saveStatelessData, { field, componentId });
+      yield call(postStatelessData, { field, componentId });
     } else {
       // app with instance
       yield call(putFormData, { field, componentId });
@@ -270,7 +286,13 @@ interface SaveDataParams {
   componentId?: string;
 }
 
-export function* saveStatelessData({ field, componentId }: SaveDataParams) {
+/**
+ * Innermost POST request that is called for stateless apps. This is only called during auto-save, and not when the
+ * form is submitted.
+ * @see saveFormDataSaga
+ * @see autoSaveSaga
+ */
+export function* postStatelessData({ field, componentId }: SaveDataParams) {
   const state: IRuntimeState = yield select();
   const model = getModelToSave(state);
   const allowAnonymous = yield select(makeGetAllowAnonymousSelector());
@@ -319,24 +341,22 @@ export function* saveStatelessData({ field, componentId }: SaveDataParams) {
   yield put(FormDataActions.savingEnded({ model: state.formData.formData }));
 }
 
+/**
+ * Auto-saves the form data when the user has made changes to the form. This is done very often.
+ * @see submitFormSaga
+ */
 export function* autoSaveSaga({
   payload: { skipAutoSave, field, componentId, singleFieldValidation },
 }: PayloadAction<IUpdateFormDataFulfilled>): SagaIterator {
   if (skipAutoSave) {
     return;
   }
 
-  const uiConfig: IUiConfig = yield select(UIConfigSelector);
   const applicationMetadata: IApplicationMetadata = yield select(getApplicationMetaData);
 
-  // undefined should default to auto save
-  const shouldAutoSave = uiConfig.autoSave !== false;
-
-  if (shouldAutoSave) {
-    if (isStatelessApp(applicationMetadata)) {
-      yield put(FormDataActions.saveLatest({ field, componentId, singleFieldValidation }));
-    } else {
-      yield put(FormDataActions.saveEvery({ field, componentId, singleFieldValidation }));
-    }
+  if (isStatelessApp(applicationMetadata)) {
+    yield put(FormDataActions.saveLatest({ field, componentId, singleFieldValidation }));
+  } else {
+    yield put(FormDataActions.saveEvery({ field, componentId, singleFieldValidation }));
   }
 }

src/features/layout/fetch/fetchFormLayoutSagas.test.ts

@@ -94,7 +94,6 @@ describe('fetchFormLayoutSagas', () => {
             hiddenLayoutsExpressions: { ...hiddenExprPage1 },
           }),
         )
-        .put(FormLayoutActions.updateAutoSave({ autoSave: undefined }))
         .put(
           FormLayoutActions.updateCurrentView({
             newView: 'page1',
@@ -120,7 +119,6 @@ describe('fetchFormLayoutSagas', () => {
             hiddenLayoutsExpressions: { FormLayout: hiddenExprPage1['page1'] },
           }),
         )
-        .put(FormLayoutActions.updateAutoSave({ autoSave: undefined }))
         .put(
           FormLayoutActions.updateCurrentView({
             newView: 'FormLayout',
@@ -169,7 +167,6 @@ describe('fetchFormLayoutSagas', () => {
             },
           }),
         )
-        .put(FormLayoutActions.updateAutoSave({ autoSave: undefined }))
         .put(
           FormLayoutActions.updateCurrentView({
             newView: 'page2',
@@ -201,7 +198,6 @@ describe('fetchFormLayoutSagas', () => {
             },
           }),
         )
-        .put(FormLayoutActions.updateAutoSave({ autoSave: undefined }))
         .put(
           FormLayoutActions.updateCurrentView({
             newView: 'page1',
@@ -227,7 +223,6 @@ describe('fetchFormLayoutSagas', () => {
             hiddenLayoutsExpressions: { ...hiddenExprPage1 },
           }),
         )
-        .put(FormLayoutActions.updateAutoSave({ autoSave: undefined }))
         .put(
           FormLayoutActions.updateCurrentView({
             newView: 'page1',
@@ -253,7 +248,6 @@ describe('fetchFormLayoutSagas', () => {
             hiddenLayoutsExpressions: { ...hiddenExprPage1 },
           }),
         )
-        .put(FormLayoutActions.updateAutoSave({ autoSave: undefined }))
         .put(
           FormLayoutActions.updateCurrentView({
             newView: 'page1',

src/features/layout/fetch/fetchFormLayoutSagas.ts

@@ -54,13 +54,11 @@ export function* fetchLayoutSaga(): SagaIterator {
     const layouts: ILayouts = {};
     const navigationConfig: any = {};
     const hiddenLayoutsExpressions: ExprUnresolved<IHiddenLayoutsExpressions> = {};
-    let autoSave: boolean | undefined;
     let firstLayoutKey: string;
     if (layoutResponse.data?.layout) {
       layouts.FormLayout = layoutResponse.data.layout;
       hiddenLayoutsExpressions.FormLayout = layoutResponse.data.hidden;
       firstLayoutKey = 'FormLayout';
-      autoSave = layoutResponse.data.autoSave;
     } else {
       const orderedLayoutKeys = Object.keys(layoutResponse).sort();
 
@@ -79,7 +77,6 @@ export function* fetchLayoutSaga(): SagaIterator {
         layouts[key] = cleanLayout(layoutResponse[key].data.layout);
         hiddenLayoutsExpressions[key] = layoutResponse[key].data.hidden;
         navigationConfig[key] = layoutResponse[key].data.navigation;
-        autoSave = layoutResponse[key].data.autoSave;
       });
     }
 
@@ -102,7 +99,6 @@ export function* fetchLayoutSaga(): SagaIterator {
         hiddenLayoutsExpressions,
       }),
     );
-    yield put(FormLayoutActions.updateAutoSave({ autoSave }));
     yield put(
       FormLayoutActions.updateCurrentView({
         newView: firstLayoutKey,

src/features/layout/formLayoutSlice.ts

@@ -42,7 +42,6 @@ export const initialState: ILayoutState = {
   uiConfig: {
     focus: null,
     hiddenFields: [],
-    autoSave: null,
     repeatingGroups: null,
     fileUploadersWithTag: {},
     receiptLayoutName: undefined,
@@ -162,12 +161,6 @@ export const formLayoutSlice = () => {
             state.uiConfig.currentViewCacheKey = key;
           },
         }),
-        updateAutoSave: mkAction<LayoutTypes.IUpdateAutoSave>({
-          reducer: (state, action) => {
-            const { autoSave } = action.payload;
-            state.uiConfig.autoSave = autoSave;
-          },
-        }),
         updateCurrentView: mkAction<LayoutTypes.IUpdateCurrentView>({
           takeLatest: updateCurrentViewSaga,
         }),

src/features/layout/formLayoutTypes.ts

@@ -35,10 +35,6 @@ export interface ISetCurrentViewCacheKey {
   key: string | undefined;
 }
 
-export interface IUpdateAutoSave {
-  autoSave: boolean | undefined;
-}
-
 export interface IUpdateCurrentView {
   newView: string;
   returnToView?: string;

src/features/layout/repGroups/updateRepeatingGroupEditIndexSaga.ts

@@ -101,7 +101,7 @@ export function* updateRepeatingGroupEditIndexSaga({
       yield put(ValidationActions.updateValidations({ validations: newValidations }));
       const rowValidations = filterValidationsByRow(resolvedNodes, combinedValidations, group, rowIndex);
 
-      if (canFormBeSaved({ validations: rowValidations, invalidDataTypes: false }, 'Complete')) {
+      if (canFormBeSaved({ validations: rowValidations, invalidDataTypes: false })) {
         if (shouldAddRow) {
           yield put(FormLayoutActions.repGroupAddRow({ groupId: group }));
         }

src/features/layout/update/updateFormLayoutSagas.ts

@@ -136,13 +136,10 @@ export function* updateCurrentViewSaga({
           }),
         );
       } else if (
-        !canFormBeSaved(
-          {
-            validations: { [currentView]: validations[currentView] },
-            invalidDataTypes: false,
-          },
-          'Complete',
-        )
+        !canFormBeSaved({
+          validations: { [currentView]: validations[currentView] },
+          invalidDataTypes: false,
+        })
       ) {
         yield put(
           FormLayoutActions.updateCurrentViewRejected({

src/layout/Button/ButtonComponent.test.tsx

@@ -37,7 +37,6 @@ const render = (submittingId: string) => {
     },
     manipulateState: (state) => {
       state.formData.submittingId = submittingId;
-      state.formLayout.uiConfig.autoSave = true;
     },
   });
 };