Ignore structural change warning on form publish (getodk#749)

* ignore structural change warning on form publish

* added test to verify publish event is logged for managed encryption

Author: sadiqkhoja

lib/model/query/forms.js

@@ -129,7 +129,14 @@ const _getDraftToken = (form) => {
   return generateToken();
 };
 
-const createVersion = (partial, form, publish = false) => async ({ run, one, Datasets, FormAttachments, Forms, Keys }) => {
+// Parameters:
+// ===========
+// partial:     Partial form definition of the new version
+// form:        Form frame of existing form
+// publish:     set true if you want new version to be published
+// duplicating: set true if copying form definition from previously uploaded definition, in that cases we don't check for structural change
+//              as user has already been warned otherwise set false
+const createVersion = (partial, form, publish = false, duplicating = false) => async ({ run, one, Datasets, FormAttachments, Forms, Keys }) => {
   // Check xmlFormId match
   if (form.xmlFormId !== partial.xmlFormId)
     return reject(Problem.user.unexpectedValue({ field: 'xmlFormId', value: partial.xmlFormId, reason: 'does not match the form you are updating' }));
@@ -163,8 +170,13 @@ const createVersion = (partial, form, publish = false) => async ({ run, one, Dat
       // Only need to check new fields against old fields if the structure does not match
       const allFields = await Forms.getMergedFields(form.id);
       await Forms.checkFieldDowncast(allFields, fields);
-      await Forms.checkStructuralChange(prevFields, fields)
-        .then(Forms.rejectIfWarnings);
+
+      // skip checking for structural change if duplicating because user has already
+      // been warning at the time of form definition upload
+      if (!duplicating) {
+        await Forms.checkStructuralChange(prevFields, fields)
+          .then(Forms.rejectIfWarnings);
+      }
       // If we haven't been rejected or warned yet, make a new schema id
       schemaId = await Forms._newSchema();
     }
@@ -207,7 +219,7 @@ const createVersion = (partial, form, publish = false) => async ({ run, one, Dat
   return savedDef;
 };
 
-createVersion.audit = (newDef, partial, form, _, publish) => (log) => ((publish === true)
+createVersion.audit = (newDef, partial, form, publish) => (log) => ((publish === true)
   ? log('form.update.publish', form, { oldDefId: form.currentDefId, newDefId: newDef.id })
   : log('form.update.draft.set', form, { oldDraftDefId: form.draftDefId, newDraftDefId: newDef.id }));
 createVersion.audit.withResult = true;

lib/resources/forms.js

@@ -125,7 +125,7 @@ module.exports = (service, endpoint) => {
           .then(Form.fromXml)
           // copy forward xlsx reference since no real change was made
           .then((partial) => partial.withAux('xls', { xlsBlobId: form.def.xlsBlobId }))
-          .then((partial) => Forms.createVersion(partial, form, false))
+          .then((partial) => Forms.createVersion(partial, form, false, true))
           .then(() => Forms.getByProjectAndXmlFormId(params.projectId, params.id, false, Form.DraftVersion))
           .then(getOrNotFound)
         : resolve(form)))

test/integration/api/forms/forms.js

@@ -405,6 +405,18 @@ describe('api: /projects/:id/forms (create, read, update)', () => {
         });
     }));
 
+    it('should reject with structure changed warning', testService(async (service) => {
+      const asAlice = await service.login('alice', identity);
+
+      await asAlice.post('/v1/projects/1/forms/simple/draft?ignoreWarnings=true')
+        .send(testData.forms.simple.replace(/age/g, 'address'))
+        .set('Content-Type', 'application/xml')
+        .expect(200);
+
+      await asAlice.post('/v1/projects/1/forms/simple/draft/publish?ignoreWarnings=true&version=v2')
+        .expect(200);
+    }));
+
     it('should reject with xls and structure changed warnings', testService(async (service) => {
       const asAlice = await service.login('alice', identity);
 

test/integration/other/encryption.js

@@ -678,6 +678,22 @@ two,h,/data/h,2000-01-01T00:06,2000-01-01T00:07,-5,-6,,ee,ff
                 csv[2].should.eql([ 'one','Alice','30','one','5','Alice','0','0','','','','0','' ]);
                 csv[3].should.eql([ '' ]);
               }))))));
+
+    it('should log publish events in the audits', testService(async (service) => {
+      const asAlice = await service.login('alice');
+
+      // There are the forms in the fixture that get re-published with managed encryption
+      await asAlice.post('/v1/projects/1/key')
+        .send({ passphrase: 'supersecret', hint: 'it is a secret' })
+        .expect(200);
+
+      await asAlice.get('/v1/audits?action=form')
+        .expect(200)
+        .then(({ body: logs }) => {
+          logs.forEach(l => l.action.should.be.eql('form.update.publish'));
+        });
+
+    }));
   });
 });