db-migrations: prevent new uses of application code (#1371)

Mixing application code into database migrations removes assurances that the same migration will mutate the same postgresql data identically when upgrading from/to different versions of the application.

* add exceptions to existing use of application code in db migrations
* discourage future use of application code in db migrations by adding an eslint rule to error for local includes outside `lib/model/migrations`

lib/model/migrations/.eslintrc.json

@@ -0,0 +1,6 @@
+{
+  "extends": "../../../.eslintrc.json",
+  "rules": {
+    "no-restricted-modules": [ "error", { "patterns": [ "../*" ] } ]
+  }
+}

lib/model/migrations/20180727-02-add-md5-to-blobs.js

@@ -8,7 +8,7 @@
 // except according to the terms contained in the LICENSE file.
 //
 
-const { md5sum } = require('../../util/crypto');
+const { md5sum } = require('../../util/crypto'); // eslint-disable-line no-restricted-modules
 
 const up = (knex) =>
   knex.schema.table('blobs', (blobs) => { blobs.string('md5', 32); })

lib/model/migrations/20180727-03-add-form-attachments-table.js

@@ -23,7 +23,7 @@ const up = (knex) =>
 
     fa.index([ 'formId' ]);
   }).then(() => {
-    const { expectedFormAttachments } = require('../../data/schema');
+    const { expectedFormAttachments } = require('../../data/schema'); // eslint-disable-line no-restricted-modules
     const { uniq, pluck } = require('ramda');
 
     // now add all expected attachments on extant forms.

lib/model/migrations/20190520-01-add-form-versioning.js

@@ -7,7 +7,7 @@
 // including this file, may be copied, modified, propagated, or distributed
 // except according to the terms contained in the LICENSE file.
 
-const { shasum, sha256sum } = require('../../util/crypto');
+const { shasum, sha256sum } = require('../../util/crypto'); // eslint-disable-line no-restricted-modules
 const assert = require('assert').strict;
 
 const check = (message, query) =>

lib/model/migrations/20191007-01-backfill-client-audits.js

@@ -7,9 +7,9 @@
 // including this file, may be copied, modified, propagated, or distributed
 // except according to the terms contained in the LICENSE file.
 
-const { parseClientAudits } = require('../../data/client-audits');
-const { getFormFields } = require('../../data/schema');
-const { traverseXml, findOne, root, node, text } = require('../../util/xml');
+const { parseClientAudits } = require('../../data/client-audits'); // eslint-disable-line no-restricted-modules
+const { getFormFields } = require('../../data/schema'); // eslint-disable-line no-restricted-modules
+const { traverseXml, findOne, root, node, text } = require('../../util/xml'); // eslint-disable-line no-restricted-modules
 
 const up = (db) => new Promise((resolve, reject) => {
   const work = [];

lib/model/migrations/20191231-02-add-schema-storage.js

@@ -7,7 +7,7 @@
 // including this file, may be copied, modified, propagated, or distributed
 // except according to the terms contained in the LICENSE file.
 
-const { getFormFields } = require('../../data/schema');
+const { getFormFields } = require('../../data/schema'); // eslint-disable-line no-restricted-modules
 
 const up = async (db) => {
   await db.schema.createTable('form_fields', (fields) => {
@@ -51,7 +51,7 @@ const up = async (db) => {
               // this config hardcoding would be dangerous with tests except that
               // tests will never invoke this path.
               const config = require('config').get('default.database');
-              const db2 = require('../migrate').knexConnect(config);
+              const db2 = require('../migrate').knexConnect(config); // eslint-disable-line no-restricted-modules
               return db2.select('projectId', 'xmlFormId').from('forms').where({ currentDefId: formDefId })
                 .then(([{ projectId, xmlFormId }]) => {
                   process.stderr.write(`\n!!!!\nThe database upgrade to v0.8 has failed because the Form '${xmlFormId}' in Project ${projectId} has an invalid schema. It tries to bind multiple instance nodes at the path ${path}.\n!!!!\n\n`);

lib/model/migrations/20200220-01-repair-submission-parsing.js

@@ -7,7 +7,7 @@
 // including this file, may be copied, modified, propagated, or distributed
 // except according to the terms contained in the LICENSE file.
 
-const { Submission } = require('../frames');
+const { Submission } = require('../frames'); // eslint-disable-line no-restricted-modules
 
 const up = async (db) => {
   const work = [];

lib/model/migrations/20210120-01-instance-names.js

@@ -7,7 +7,7 @@
 // including this file, may be copied, modified, propagated, or distributed
 // except according to the terms contained in the LICENSE file.
 
-const { Submission } = require('../frames');
+const { Submission } = require('../frames'); // eslint-disable-line no-restricted-modules
 
 const up = async (db) => {
   await db.schema.table('submission_defs', (sds) => {

lib/model/migrations/20211008-01-track-select-many-options.js

@@ -8,10 +8,10 @@
 // except according to the terms contained in the LICENSE file.
 
 const { map } = require('ramda');
-const { getFormFields } = require('../../data/schema');
-const { getSelectMultipleResponses } = require('../../data/submission');
-const { Form } = require('../frames');
-const { construct } = require('../../util/util');
+const { getFormFields } = require('../../data/schema'); // eslint-disable-line no-restricted-modules
+const { getSelectMultipleResponses } = require('../../data/submission'); // eslint-disable-line no-restricted-modules
+const { Form } = require('../frames'); // eslint-disable-line no-restricted-modules
+const { construct } = require('../../util/util'); // eslint-disable-line no-restricted-modules
 
 const up = async (db) => {
   // add select many flag, options field to fields

lib/model/migrations/20230109-01-add-form-schema.js

@@ -7,7 +7,7 @@
 // including this file, may be copied, modified, propagated, or distributed
 // except according to the terms contained in the LICENSE file.
 
-const { getFormFields, compare } = require('../../data/schema');
+const { getFormFields, compare } = require('../../data/schema'); // eslint-disable-line no-restricted-modules
 
 /* Steps of this migration
   1. remove check field collision trigger