feat: allow draft edition of records

* feat/AB#65023-grid-apply-record-rules

* add comment

* refactor some code

---------

Co-authored-by: Antoine Hurard <[email protected]>

Author: LenaelleL

src/schema/mutation/editRecord.mutation.ts

@@ -3,6 +3,7 @@ import {
   GraphQLID,
   GraphQLError,
   GraphQLString,
+  GraphQLBoolean,
 } from 'graphql';
 import GraphQLJSON from 'graphql-type-json';
 import { Form, Record, Resource, Version } from '@models';
@@ -11,6 +12,7 @@ import {
   transformRecord,
   getOwnership,
   checkRecordValidation,
+  checkRecordTriggers,
 } from '@utils/form';
 import { RecordType } from '../types';
 import mongoose from 'mongoose';
@@ -63,6 +65,7 @@ export default {
     version: { type: GraphQLID },
     template: { type: GraphQLID },
     lang: { type: GraphQLString },
+    draft: { type: GraphQLBoolean },
   },
   async resolve(parent, args, context) {
     try {
@@ -101,6 +104,17 @@ export default {
         );
       }
 
+      // If draft option, return record after running triggers
+      if (args.draft) {
+        const triggeredRecord = checkRecordTriggers(
+          oldRecord,
+          args.data,
+          parentForm,
+          context
+        );
+        return triggeredRecord;
+      }
+
       // Update record
       // Put a try catch for record validation + check the structure of this form
       let validationErrors;

src/utils/form/checkRecordTriggers.ts

@@ -0,0 +1,34 @@
+import { Form, Record } from 'models';
+import * as Survey from 'survey-knockout';
+
+/**
+ * Check record triggered values, so inline edition ( draft edition ) can indicate changes on the data
+ *
+ * @param record edited record
+ * @param newData record updated data
+ * @param form template to use
+ * @param context graphQLContext
+ * @returns New record data
+ */
+export const checkRecordTriggers = (
+  record: Record,
+  newData: any,
+  form: Form,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  context
+): Record => {
+  // Necessary to fix 401 errors if we have choicesByUrl targeting self API.
+  // passTokenForChoicesByUrl(context);
+  // Avoid the choices by url to be called, as it could freeze system depending on the choices
+  (Survey.ChoicesRestful as any).getCachedItemsResult = () => true;
+  const survey = new Survey.Model(form.structure);
+  Survey.settings.commentPrefix = '_comment';
+  survey.data = { ...record.data, ...newData };
+  const triggers = survey.toJSON().triggers;
+  if (triggers) {
+    survey.runTriggers();
+  }
+  const updatedRecord = new Record(record);
+  updatedRecord.data = survey.data;
+  return updatedRecord;
+};

src/utils/form/checkRecordValidation.ts

@@ -1,31 +1,31 @@
 import { Form, Record } from 'models';
 import * as Survey from 'survey-knockout';
-import config from 'config';
+// import config from 'config';
 
 /**
  * Pass token before the request to fetch choices by URL if it's targeting SAFE API
  *
  * @param context GraphQL context.
  */
-export const passTokenForChoicesByUrl = (context: any) => {
-  Survey.ChoicesRestfull.onBeforeSendRequest = (
-    sender: Survey.ChoicesRestful,
-    options: { request: XMLHttpRequest }
-  ) => {
-    if (sender.url.includes(config.get('server.url'))) {
-      const token = context.token;
-      options.request.setRequestHeader('Authorization', token);
-    }
-  };
-};
+// export const passTokenForChoicesByUrl = (context: any) => {
+//   Survey.ChoicesRestfull.onBeforeSendRequest = (
+//     sender: Survey.ChoicesRestful,
+//     options: { request: XMLHttpRequest }
+//   ) => {
+//     if (sender.url.includes(config.get('server.url'))) {
+//       const token = context.token;
+//       options.request.setRequestHeader('Authorization', token);
+//     }
+//   };
+// };
 
 /**
  * Check if the record is correct according to the defined surveyjs validators
  *
  * @param record The record to check
  * @param newData The proposed update
  * @param form The formulaire object linked to the record
- * @param context GraphQL context
+ * @param context graphQL context
  * @param lang The current language of the form
  * @returns The list of errors (empty if no errors)
  */

src/utils/form/index.ts

@@ -13,3 +13,4 @@ export * from './getNextId';
 export * from './getDisplayText';
 export * from './checkRecordValidation';
 export * from './getAccessibleFields';
+export * from './checkRecordTriggers';