Feat/#472 normalize new lines (#151)

* normalize schemas

* fix test fixtures

* fix string replacement

* refactor to count for script being an array

Author: ciaranschutte

src/services/dictionaryService.ts

@@ -19,7 +19,7 @@
 
 import { Dictionary, DictionaryDocument } from '../models/Dictionary';
 import { ConflictError, BadRequestError, NotFoundError } from '../utils/errors';
-import { validate } from '../services/schemaService';
+import { normalizeSchema, validate } from '../services/schemaService';
 import { incrementMajor, incrementMinor, isValidVersion, isGreater } from '../utils/version';
 import logger from '../config/logger';
 
@@ -103,7 +103,9 @@ export const create = async (newDict: {
 
   if (!isGreater(newDict.version, latest)) {
     logger.warn(
-      `Rejected ${newDict.name} due to version ${newDict.version} being lower than latest: ${latest}`,
+      `Rejected ${newDict.name} due to version ${
+        newDict.version
+      } being lower than latest: ${latest}`,
     );
     throw new BadRequestError(
       `New version for ${newDict.name} is not greater than latest existing version`,
@@ -116,11 +118,13 @@ export const create = async (newDict: {
     if (!result.valid) throw new BadRequestError(JSON.stringify(result.errors));
   });
 
+  const normalizedSchemas = newDict.schemas.map(schema => normalizeSchema(schema));
+
   // Save new dictionary version
   const dict = new Dictionary({
     name: newDict.name,
     version: newDict.version,
-    schemas: newDict.schemas,
+    schemas: normalizedSchemas,
     references: newDict.references || {},
   });
   const saved = await dict.save();
@@ -149,8 +153,10 @@ export const addSchema = async (id: string, schema: any): Promise<DictionaryDocu
   const entities = doc.schemas.map(s => s['name']);
   if (entities.includes(schema['name'])) throw new ConflictError('This schema already exists.');
 
+  const normalizedSchema = normalizeSchema(schema);
+
   const schemas = doc.schemas;
-  schemas.push(schema);
+  schemas.push(normalizedSchema);
   // Save new dictionary version
   const dict = new Dictionary({
     name: doc.name,
@@ -193,7 +199,10 @@ export const updateSchema = async (
 
   // Filter out one to update
   const schemas = doc.schemas.filter(s => !(s['name'] === schema['name']));
-  schemas.push(schema);
+
+  const normalizedSchema = normalizeSchema(schema);
+
+  schemas.push(normalizedSchema);
 
   // Increment Version
   const nextVersion = major ? incrementMajor(doc.version) : incrementMinor(doc.version);

src/services/schemaService.ts

@@ -33,3 +33,32 @@ export function validate(schema: any, references: any) {
 
   return { valid: validate(schemaWithReplacements), errors: validate.errors };
 }
+
+function normalizeScript(script: string | string[]) {
+  if (typeof script === 'string') {
+    return script.replace(/\r\n/g, '\n');
+  } else if (Array.isArray(script)) {
+    return script.map((s: string) => s.replace(/\r\n/g, '\n'));
+  } else {
+    return script;
+  }
+}
+
+export function normalizeSchema(schema: any) {
+  if (!schema.fields) return schema;
+  return {
+    ...schema,
+    fields: schema.fields.map((field: any) => {
+      if (field.restrictions && field.restrictions.script) {
+        return {
+          ...field,
+          restrictions: {
+            ...field.restrictions,
+            script: normalizeScript(field.restrictions.script),
+          },
+        };
+      }
+      return field;
+    }),
+  };
+}

test/functional/fixtures/linebreak/input1.json

@@ -0,0 +1,20 @@
+{
+  "name": "ARGO Dictionary",
+  "version": "1.2",
+  "schemas": [
+    {
+      "name": "donor",
+      "description": "Donor Entity",
+      "fields": [
+        {
+          "name": "cause_of_death",
+          "valueType": "string",
+          "description": "Cause of Donor Death",
+          "restrictions": {
+            "script": "(function(){\nreturn true;\n\n\n\n}())"
+          }
+        }
+      ]
+    }
+  ]
+}

test/functional/fixtures/linebreak/input2.json

@@ -0,0 +1,20 @@
+{
+  "name": "ARGO Dictionary",
+  "version": "1.2",
+  "schemas": [
+    {
+      "name": "donor",
+      "description": "Donor Entity",
+      "fields": [
+        {
+          "name": "cause_of_death",
+          "valueType": "string",
+          "description": "Cause of Donor Death",
+          "restrictions": {
+            "script": "(function(){\r\nreturn true;\r\n\r\n\r\n\r\n}())"
+          }
+        }
+      ]
+    }
+  ]
+}

test/functional/fixtures/linebreak/output.json

@@ -0,0 +1,20 @@
+{
+  "name": "ARGO Dictionary",
+  "version": "1.2",
+  "schemas": [
+    {
+      "name": "donor",
+      "description": "Donor Entity",
+      "fields": [
+        {
+          "name": "cause_of_death",
+          "valueType": "string",
+          "description": "Cause of Donor Death",
+          "restrictions": {
+            "script": "(function(){\nreturn true;\n\n\n\n}())"
+          }
+        }
+      ]
+    }
+  ]
+}

test/functional/schemaTest.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2020 The Ontario Institute for Cancer Research. All rights reserved
+ *
+ * This program and the accompanying materials are made available under the terms of
+ * the GNU Affero General Public License v3.0. You should have received a copy of the
+ * GNU Affero General Public License along with this program.
+ *  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+ * SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+ * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+ * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+import App from '../../src/app';
+import { expect } from 'chai';
+import { AppConfig, getAppConfig } from '../../src/config/appConfig';
+import { DictionaryDocument } from '../../src/models/Dictionary';
+import { normalizeSchema } from '../../src/services/schemaService';
+
+const input1 = require('./fixtures/linebreak/input1.json') as DictionaryDocument;
+const input2 = require('./fixtures/linebreak/input2.json') as DictionaryDocument;
+const output = require('./fixtures/linebreak/output.json') as DictionaryDocument;
+
+describe('Verify different EOL are normalized', () => {
+  it('Should not alter already formatted files', () => {
+    const normalizedSchema = normalizeSchema(input1.schemas[0]);
+    expect(normalizedSchema).to.deep.eq(output.schemas[0]);
+  });
+  it('Should output consistent script property', () => {
+    const normalizedSchema = normalizeSchema(input2.schemas[0]);
+    expect(normalizedSchema).to.deep.eq(output.schemas[0]);
+  });
+});