Merge pull request #3099 from ONSdigital/EAR-2305-data-version-selection

EAR 2305 data version selection
ONSdigital · Mar 13, 2024 · 3f3b74d · 3f3b74d
2 parents 479092f + fef676b
commit 3f3b74d
Show file tree

Hide file tree

Showing 21 changed files with 449 additions and 17 deletions.
diff --git a/eq-author-api/constants/allDataVersions.js b/eq-author-api/constants/allDataVersions.js
@@ -0,0 +1 @@
+module.exports = ["1", "3"];
diff --git a/eq-author-api/migrations/addAllowableDataVersions.js b/eq-author-api/migrations/addAllowableDataVersions.js
@@ -0,0 +1,18 @@
+const { getOptions } = require("../schema/resolvers/utils");
+
+module.exports = (questionnaire) => {
+  const allQuestionnaireOptions = getOptions({ questionnaire });
+
+  if (
+    questionnaire.collectionLists?.lists?.length > 0 ||
+    questionnaire.supplementaryData ||
+    allQuestionnaireOptions?.some((option) => option.dynamicAnswer)
+  ) {
+    questionnaire.dataVersion = "3";
+    questionnaire.allowableDataVersions = ["3"];
+  } else {
+    questionnaire.allowableDataVersions = ["1", "3"];
+  }
+
+  return questionnaire;
+};
diff --git a/eq-author-api/migrations/addAllowableDataVersions.test.js b/eq-author-api/migrations/addAllowableDataVersions.test.js
@@ -0,0 +1,82 @@
+const addAllowableDataVersions = require("./addAllowableDataVersions");
+
+describe("addAllowableDataVersions", () => {
+  it("should set dataVersion to 3 and add allowableDataVersions with data version 3 when questionnaire has collection list", () => {
+    const questionnaire = {
+      id: "questionnaire-1",
+      title: "Questionnaire 1",
+      collectionLists: {
+        lists: [{ id: "list-1" }],
+      },
+    };
+
+    const updatedQuestionnaire = addAllowableDataVersions(questionnaire);
+
+    expect(updatedQuestionnaire.dataVersion).toEqual("3");
+    expect(updatedQuestionnaire.allowableDataVersions).toEqual(["3"]);
+  });
+
+  it("should set dataVersion to 3 and add allowableDataVersions with data version 3 when questionnaire has supplementary data", () => {
+    const questionnaire = {
+      id: "questionnaire-1",
+      title: "Questionnaire 1",
+      supplementaryData: { id: "supplementary-data-1" },
+    };
+
+    const updatedQuestionnaire = addAllowableDataVersions(questionnaire);
+
+    expect(updatedQuestionnaire.dataVersion).toEqual("3");
+    expect(updatedQuestionnaire.allowableDataVersions).toEqual(["3"]);
+  });
+
+  it("should set dataVersion to 3 and add allowableDataVersions with data version 3 when questionnaire has dynamic answer", () => {
+    const questionnaire = {
+      id: "questionnaire-1",
+      title: "Questionnaire 1",
+      sections: [
+        {
+          id: "section-1",
+          folders: [
+            {
+              id: "folder-1",
+              pages: [
+                {
+                  id: "page-1",
+                  answers: [
+                    {
+                      id: "answer-1",
+                      options: [
+                        {
+                          id: "option-1",
+                          dynamicAnswer: true,
+                        },
+                      ],
+                    },
+                  ],
+                },
+              ],
+            },
+          ],
+        },
+      ],
+    };
+
+    const updatedQuestionnaire = addAllowableDataVersions(questionnaire);
+
+    expect(updatedQuestionnaire.dataVersion).toEqual("3");
+    expect(updatedQuestionnaire.allowableDataVersions).toEqual(["3"]);
+  });
+
+  it("should add allowableDataVersions with data versions 1 and 3 without updating dataVersion when questionnaire has no collection lists, supplementary data or dynamic answers", () => {
+    const questionnaire = {
+      id: "questionnaire-1",
+      title: "Questionnaire 1",
+      dataVersion: "1",
+    };
+
+    const updatedQuestionnaire = addAllowableDataVersions(questionnaire);
+
+    expect(updatedQuestionnaire.dataVersion).toEqual("1");
+    expect(updatedQuestionnaire.allowableDataVersions).toEqual(["1", "3"]);
+  });
+});
diff --git a/eq-author-api/migrations/index.js b/eq-author-api/migrations/index.js
@@ -53,6 +53,7 @@ const migrations = [
   require("./addFieldsToListCollectorFolderContents"),
   require("./addAdditonalContentsToAddItemPage"),
   require("./updateHealthThemeToPandemicMonitoring"),
+  require("./addAllowableDataVersions"),
 ];
 
 const currentVersion = migrations.length;

diff --git a/eq-author-api/schema/resolvers/base.js b/eq-author-api/schema/resolvers/base.js
@@ -26,6 +26,7 @@ const {
   AWAITING_APPROVAL,
   UPDATES_REQUIRED,
 } = require("../../constants/publishStatus");
+const allDataVersions = require("../../constants/allDataVersions");
 
 const { DURATION_LOOKUP } = require("../../constants/durationTypes");
 const {
@@ -149,7 +150,8 @@ const createNewQuestionnaire = (input) => {
     qcodes: true,
     navigation: false,
     hub: false,
-    dataVersion: "1",
+    dataVersion: "3",
+    allowableDataVersions: allDataVersions,
     createdAt: new Date(),
     metadata: [],
     sections: [createSection()],
@@ -658,6 +660,7 @@ const Resolvers = {
       const pages = getPages(ctx);
 
       onSectionDeleted(ctx, removedSection, pages);
+      setDataVersion(ctx);
 
       if (!ctx.questionnaire.sections.length) {
         ctx.questionnaire.sections.push(createSection());
@@ -727,6 +730,7 @@ const Resolvers = {
       const pages = getPages(ctx);
 
       onFolderDeleted(ctx, removedFolder, pages);
+      setDataVersion(ctx);
 
       if (!section.folders.length) {
         section.folders.push(createFolder());
@@ -862,6 +866,7 @@ const Resolvers = {
       const deletedAnswer = first(remove(page.answers, { id: input.id }));
 
       onAnswerDeleted(ctx, page, deletedAnswer, pages);
+      setDataVersion(ctx);
 
       return page;
     }),

diff --git a/eq-author-api/schema/resolvers/importing.js b/eq-author-api/schema/resolvers/importing.js
@@ -16,6 +16,8 @@ const { UserInputError } = require("apollo-server-express");
 
 const { createMutation } = require("./createMutation");
 
+const { setDataVersion } = require("./utils");
+
 module.exports = {
   Mutation: {
     importQuestions: createMutation(
@@ -91,6 +93,7 @@ module.exports = {
             ...strippedPages.map((page) => createFolder({ pages: [page] }))
           );
         }
+        setDataVersion(ctx);
 
         return section;
       }
@@ -178,6 +181,8 @@ module.exports = {
 
         destinationSections.splice(insertionIndex, 0, ...strippedSections);
         ctx.questionnaire.hub = ctx.questionnaire.sections.length > 1;
+        setDataVersion(ctx);
+
         return destinationSections;
       }
     ),

diff --git a/eq-author-api/schema/resolvers/pages/index.js b/eq-author-api/schema/resolvers/pages/index.js
@@ -20,6 +20,7 @@ const { createQuestionPage } = require("./questionPage");
 const deleteFirstPageSkipConditions = require("../../../src/businessLogic/deleteFirstPageSkipConditions");
 const deleteLastPageRouting = require("../../../src/businessLogic/deleteLastPageRouting");
 const onFolderDeleted = require("../../../src/businessLogic/onFolderDeleted");
+const { setDataVersion } = require("../utils/setDataVersion");
 
 const Resolvers = {};
 
@@ -86,6 +87,7 @@ Resolvers.Mutation = {
 
     deleteFirstPageSkipConditions(ctx);
     deleteLastPageRouting(ctx);
+    setDataVersion(ctx);
 
     return section;
   }),

diff --git a/eq-author-api/schema/resolvers/utils/setDataVersion.js b/eq-author-api/schema/resolvers/utils/setDataVersion.js
@@ -1,15 +1,18 @@
 const { getAnswers } = require("./answerGetters");
+const allDataVersions = require("../../../constants/allDataVersions");
 
 const setDataVersion = ({ questionnaire }) => {
-  questionnaire.dataVersion = "1";
+  questionnaire.allowableDataVersions = allDataVersions;
 
   if (questionnaire.collectionLists?.lists?.length) {
     questionnaire.dataVersion = "3";
+    questionnaire.allowableDataVersions = ["3"];
     return;
   }
 
   if (questionnaire.supplementaryData) {
     questionnaire.dataVersion = "3";
+    questionnaire.allowableDataVersions = ["3"];
     return;
   }
 
@@ -18,6 +21,7 @@ const setDataVersion = ({ questionnaire }) => {
     return answer.options?.some((option) => {
       if (option.dynamicAnswer) {
         questionnaire.dataVersion = "3";
+        questionnaire.allowableDataVersions = ["3"];
         return true;
       }
       return false;

diff --git a/eq-author-api/schema/tests/questionnaire.test.js b/eq-author-api/schema/tests/questionnaire.test.js
@@ -1,4 +1,5 @@
 const { last, findIndex, find } = require("lodash");
+const { CHECKBOX, RADIO } = require("../../constants/answerTypes");
 
 jest.mock("node-fetch");
 const fetch = require("node-fetch");
@@ -35,6 +36,9 @@ const {
   setQuestionnaireLocked,
   updateSubmission,
 } = require("../../tests/utils/contextBuilder/questionnaire");
+const {
+  updateOption,
+} = require("../../tests/utils/contextBuilder/option/updateOption");
 
 const {
   createAnswer,
@@ -164,6 +168,66 @@ describe("questionnaire", () => {
       expect(queriedShortTitleQuestionnaire.displayName).toEqual("short title");
     });
 
+    it("should set data version to 3 and remove data version 1 from allowable data versions if questionnaire contains dynamic answers", async () => {
+      const ctx = await buildContext({
+        supplementaryData: null,
+        sections: [
+          {
+            folders: [
+              {
+                pages: [
+                  {
+                    answers: [
+                      {
+                        type: CHECKBOX,
+                        options: [
+                          {
+                            label: "checkbox-option-1",
+                          },
+                        ],
+                      },
+                    ],
+                  },
+                  {
+                    answers: [
+                      {
+                        type: RADIO,
+                        options: [
+                          {
+                            id: "radio-option-1",
+                          },
+                        ],
+                      },
+                    ],
+                  },
+                ],
+              },
+            ],
+          },
+        ],
+      });
+
+      expect(ctx.questionnaire.dataVersion).toEqual("3");
+      expect(ctx.questionnaire.allowableDataVersions).toEqual(["1", "3"]);
+
+      const option =
+        ctx.questionnaire.sections[0].folders[0].pages[1].answers[0].options[0];
+
+      const update = {
+        id: option.id,
+        label: "Dynamic option 1",
+        description: "Dynamic option description",
+        value: "dynamic-option-1",
+        qCode: "dynamic-option-1",
+        dynamicAnswer: true,
+      };
+
+      updateOption(ctx, update);
+
+      expect(ctx.questionnaire.dataVersion).toEqual("3");
+      expect(ctx.questionnaire.allowableDataVersions).toEqual(["3"]);
+    });
+
     describe("starring", () => {
       it("should throw user input error if questionnaire ID doesn't exist", () => {
         expect(

diff --git a/eq-author-api/schema/typeDefs.js b/eq-author-api/schema/typeDefs.js
@@ -62,6 +62,7 @@ type Questionnaire {
   navigation: Boolean
   hub: Boolean
   dataVersion: String
+  allowableDataVersions: [String]
   createdAt: DateTime
   updatedAt: DateTime
   createdBy: User!
@@ -1311,6 +1312,7 @@ input UpdateQuestionnaireInput {
   editors: [ID!] 
   isPublic: Boolean
   permission: String
+  dataVersion: String
 }
 
 

diff --git a/eq-author-api/tests/utils/contextBuilder/index.js b/eq-author-api/tests/utils/contextBuilder/index.js
@@ -73,7 +73,8 @@ const buildContext = async (questionnaireConfig, userConfig = {}) => {
   const { questionnaire } = ctx;
   ctx.questionnaire.sections = [];
   ctx.comments = comments || {};
-  ctx.questionnaire.supplementaryData = supplementaryData || {};
+  ctx.questionnaire.supplementaryData =
+    supplementaryData === null ? null : supplementaryData || {};
 
   if (Array.isArray(sections)) {
     for (let section of sections) {