Bp feature/template selector

openapi/openapi.json

@@ -132,6 +132,11 @@
                                                                 "pattern": "^urn:uuid:"
                                                             }
                                                         }
+                                                    },
+                                                    "templateVersion": {
+                                                        "title": "semver",
+                                                        "type": "string",
+                                                        "pattern": "^[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}$"
                                                     }
                                                 }
                                             }
@@ -153,7 +158,8 @@
                                         },
                                         "external": {
                                             "id": "urn:uuid:f81d4fae-7dec-11d0-a765-123456781234"
-                                        }
+                                        },
+                                        "templateVersion": "1.0.0"
                                     }
                                 }
                             }

openapi/src/json-schemas/api/_questionnaires/post/req/201.json

@@ -53,6 +53,9 @@
                                     "$ref": "../../../../models/definitions/external-id.json"
                                 }
                             }
+                        },
+                        "templateVersion": {
+                            "$ref": "../../../../models/definitions/semver.json"
                         }
                     }
                 }

openapi/src/openapi-src.json

@@ -76,7 +76,8 @@
                                         },
                                         "external": {
                                             "id": "urn:uuid:f81d4fae-7dec-11d0-a765-123456781234"
-                                        }
+                                        },
+                                        "templateVersion": "1.0.0"
                                     }
                                 }
                             }

package.json

@@ -39,7 +39,9 @@
         "pino-std-serializers": "^6.2.2",
         "q-expressions": "github:CriminalInjuriesCompensationAuthority/q-expressions",
         "q-router": "github:CriminalInjuriesCompensationAuthority/q-router#v3.1.1",
-        "q-templates-application": "github:CriminalInjuriesCompensationAuthority/q-templates-application#v12.3.6",
+        "q-templates-application": "github:CriminalInjuriesCompensationAuthority/q-templates-application",
+        "q-templates-application-v12": "github:CriminalInjuriesCompensationAuthority/q-templates-application#v12.0.0",
+        "q-templates-application-v11": "github:CriminalInjuriesCompensationAuthority/q-templates-application#v11.0.0",
         "semver": "^7.5.4",
         "swagger-ui-express": "^4.6.3",
         "uuid": "^3.3.2",

questionnaire/questionnaire-service.js

@@ -8,7 +8,7 @@ const VError = require('verror');
 const router = require('q-router');
 const uuidv4 = require('uuid/v4');
 const ajvFormatsMobileUk = require('ajv-formats-mobile-uk');
-const templates = require('./templates');
+const getTemplate = require('./templates');
 const questionnaireResource = require('./resources/questionnaire-resource');
 const createQuestionnaireHelper = require('./questionnaire/questionnaire');
 const isQuestionnaireCompatible = require('./utils/isQuestionnaireVersionCompatible');
@@ -62,18 +62,15 @@ function createQuestionnaireService({
         return false;
     }
 
-    async function createQuestionnaire(templateName, ownerData, originData, externalData) {
-        if (!(templateName in templates)) {
-            throw new VError(
-                {
-                    name: 'ResourceNotFound'
-                },
-                `Template "${templateName}" does not exist`
-            );
-        }
-
+    async function createQuestionnaire(
+        templateName,
+        ownerData,
+        originData,
+        externalData,
+        templateVersion
+    ) {
         const uuidV4 = uuidv4();
-        const questionnaire = templates[templateName](uuidV4);
+        const questionnaire = getTemplate(templateName, templateVersion)(uuidV4);
 
         if (!ownerData) {
             throw new VError(

questionnaire/routes.js

@@ -28,7 +28,7 @@ router.route('/').post(permissions('create:questionnaires'), async (req, res, ne
             throw err;
         }
 
-        const {templateName, owner, origin, external} = req.body.data.attributes;
+        const {templateName, owner, origin, external, templateVersion} = req.body.data.attributes;
 
         const questionnaireService = createQuestionnaireService({
             logger: req.log,
@@ -39,7 +39,8 @@ router.route('/').post(permissions('create:questionnaires'), async (req, res, ne
             templateName,
             owner,
             origin,
-            external
+            external,
+            templateVersion
         );
 
         res.status(201).json(response);

questionnaire/templates.js

@@ -1,16 +1,44 @@
+/* eslint-disable global-require */
+
 'use strict';
 
-const applicationTemplate = require('q-templates-application');
+const VError = require('verror');
+
+const registry = {
+    'sexual-assault': {
+        latest: require('q-templates-application'),
+        '12.0.0': require('q-templates-application-v12'),
+        '11.0.0': require('q-templates-application-v11')
+    }
+};
 
-const applicationTemplateAsJson = JSON.stringify(applicationTemplate);
+function getTemplate(templateName, version = 'latest') {
+    const versions = registry[templateName];
+    if (!versions) {
+        throw new VError(
+            {
+                name: 'ResourceNotFound'
+            },
+            `Template "${templateName}" does not exist`
+        );
+    }
 
-function getApplicationTemplateCopy() {
-    return JSON.parse(applicationTemplateAsJson);
-}
+    const template = versions[version];
+    if (!template) {
+        throw new VError(
+            {
+                name: 'ResourceNotFound'
+            },
+            `Version "${version}" not found for template "${templateName}"`
+        );
+    }
 
-module.exports = {
-    'sexual-assault': id => ({
+    const applicationTemplateAsJson = JSON.stringify(template);
+
+    return id => ({
         id,
-        ...getApplicationTemplateCopy()
-    })
-};
+        ...JSON.parse(applicationTemplateAsJson) // deep copy
+    });
+}
+
+module.exports = getTemplate;

questionnaire/templates.test.js

@@ -0,0 +1,73 @@
+/* eslint-disable global-require */
+
+'use strict';
+
+const fakeUuid = 'some-id';
+let getTemplates;
+
+beforeEach(() => {
+    jest.resetModules();
+
+    jest.doMock('q-templates-application', () => ({
+        version: '12.3.3'
+    }));
+
+    jest.doMock('q-templates-application-v12', () => ({
+        version: '12.0.0'
+    }));
+
+    getTemplates = require('./templates');
+});
+
+describe('Templates', () => {
+    it('Should select a template', () => {
+        const templateName = 'sexual-assault';
+        const templateVersion = 'latest';
+        const questionnaire = getTemplates(templateName, templateVersion)(fakeUuid);
+
+        expect(questionnaire).toMatchObject({
+            id: 'some-id',
+            version: '12.3.3'
+        });
+    });
+
+    it('Should select a template with the desired version', () => {
+        const templateName = 'sexual-assault';
+        const templateVersion = '12.0.0';
+        const questionnaire = getTemplates(templateName, templateVersion)(fakeUuid);
+
+        expect(questionnaire).toMatchObject({
+            id: 'some-id',
+            version: '12.0.0'
+        });
+    });
+
+    it('Should select the latest template if no version is specified', () => {
+        const templateName = 'sexual-assault';
+        const templateVersion = undefined;
+        const questionnaire = getTemplates(templateName, templateVersion)(fakeUuid);
+
+        expect(questionnaire).toMatchObject({
+            id: 'some-id',
+            version: '12.3.3'
+        });
+    });
+
+    it('Should error if the templateName is not available', () => {
+        const templateName = 'not-a-template';
+        const templateVersion = undefined;
+
+        expect(() => {
+            getTemplates(templateName, templateVersion)(fakeUuid);
+        }).toThrow('Template "not-a-template" does not exist');
+    });
+
+    it('Should error if the templateVersion is not supported', () => {
+        const templateName = 'sexual-assault';
+        const templateVersion = '20.0.0';
+
+        expect(() => {
+            getTemplates(templateName, templateVersion)(fakeUuid);
+        }).toThrow('Version "20.0.0" not found for template "sexual-assault"');
+    });
+});