Log error based on expected number of entities if one fails (#1701)

Error message includes total number of entities as well as how many of them had problems, which specific entities in the submission had problems, and what those problems were. 

Message tries to capture the idea that even the successful entities got skipped when some failed.

Co-authored-by: Matthew White <[email protected]>

Author: ktuite

lib/model/query/entities.js

@@ -533,9 +533,27 @@ const _processSubmissionEvent = (event, parentEvent) => async ({ Datasets, Entit
   };
   const sourceId = await Entities.createOrUpdateSource(sourceDetails, submissionDefId, event.id, forceOutOfOrderProcessing);
 
-  for (const entityData of entities) {
-    // eslint-disable-next-line no-await-in-loop
-    await Entities._processEntityData(sourceId, entityData, event, form, submissionDef, forceOutOfOrderProcessing);
+  const errors = [];
+  const totalEntities = entities.length;
+
+  for (const [i, entityData] of entities.entries()) {
+    try {
+      // eslint-disable-next-line no-await-in-loop
+      await Entities._processEntityData(sourceId, entityData, event, form, submissionDef, forceOutOfOrderProcessing);
+    } catch (err) {
+      if (totalEntities === 1)
+        throw (err);
+      else
+        errors.push({
+          errorMessage: err.message,
+          problem: err.isProblem === true ? err : null,
+          index: i
+        });
+    }
+  }
+
+  if (errors.length > 0) {
+    throw Problem.user.multiEntityError({ count: errors.length, total: totalEntities, errors });
   }
 
   return null;

lib/util/problem.js

@@ -148,6 +148,13 @@ const problems = {
 
     invalidRange: problem(400.42, () => `There is a problem with a range specification. Perhaps start and end have been swapped?`),
 
+    multiEntityError: problem(400.43, ({ count, total, errors }) => {
+      const joined = errors
+        .map(error => `(Entity ${error.index + 1}) ${error.errorMessage}`)
+        .join(' ');
+      return `Failed to process ${total} entities in submission due to ${count} errors: ${joined}`;
+    }),
+
     // no detail information for security reasons.
     authenticationFailed: problem(401.2, () => 'Could not authenticate with the provided credentials.'),
 

test/integration/api/entities-from-repeats.js

@@ -431,7 +431,7 @@ describe('Entities from Repeats', () => {
     }));
   });
 
-  describe('entity sources and backlog', () => {
+  describe('errors, entity sources and backlog', () => {
     it('should assign the same entity source to multiple entities created by the same submission', testService(async (service, container) => {
       const asAlice = await service.login('alice');
 
@@ -486,6 +486,72 @@ describe('Entities from Repeats', () => {
         .then(({ body }) => { body.length.should.equal(0); });
     }));
 
+    it('should log an error when one of multiple entities fails', testService(async (service, container) => {
+      const asAlice = await service.login('alice');
+
+      const subXml = `<data xmlns:jr="http://openrosa.org/javarosa" xmlns:orx="http://openrosa.org/xforms" id="repeatEntityTrees" version="1">
+      <plot_id>1</plot_id>
+      <tree>
+        <species>pine</species>
+        <circumference>12</circumference>
+        <meta>
+          <entity dataset="trees" create="1" id="f73ea0a0-f51f-4d13-a7cb-c2123ba06f34">
+            <label>Pine</label>
+          </entity>
+        </meta>
+      </tree>
+      <tree>
+        <species>oak</species>
+        <circumference>13</circumference>
+        <meta>
+          <entity dataset="trees" create="1" id="090c56ff-25f4-4503-b760-f6bef8528152">
+          </entity>
+        </meta>
+      </tree>
+      <tree>
+        <species>maple</species>
+        <circumference>14</circumference>
+        <meta>
+          <entity dataset="trees" create="1" id="invalid-uuid">
+            <label>Maple</label>
+          </entity>
+        </meta>
+      </tree>
+      <meta>
+        <instanceID>one</instanceID>
+      </meta>
+    </data>`;
+
+      await asAlice.post('/v1/projects/1/forms?publish=true')
+        .send(testData.forms.repeatEntityTrees)
+        .set('Content-Type', 'application/xml')
+        .expect(200);
+
+      await asAlice.post('/v1/projects/1/forms/repeatEntityTrees/submissions')
+        .send(subXml)
+        .set('Content-Type', 'application/xml')
+        .expect(200);
+
+      await exhaust(container);
+
+      await asAlice.get('/v1/projects/1/forms/repeatEntityTrees/submissions/one/audits')
+        .then(({ body }) => {
+          body[0].action.should.equal('entity.error');
+          body[0].details.problem.problemCode.should.equal(400.43);
+
+          body[0].details.errorMessage.includes('Failed to process 3 entities in submission due to 2 errors').should.be.true();
+          body[0].details.errorMessage.includes('(Entity 2) Required parameter label missing').should.be.true();
+          body[0].details.errorMessage.includes('(Entity 3) Invalid input data type: expected (uuid)').should.be.true();
+
+          const { problemDetails } = body[0].details.problem;
+          problemDetails.should.containEql({ count: 2, total: 3 });
+          const detailErrors = problemDetails.errors;
+          detailErrors.length.should.equal(2);
+          detailErrors[0].problem.problemCode.should.equal(400.2);
+          detailErrors[1].problem.problemCode.should.equal(400.11);
+        });
+    }));
+
     it('should note what happens when two entities hold submission into backlog', testService(async (service, container) => {
       const asAlice = await service.login('alice');