Return specific Problem when form version in submission not found (getodk#766)

* Return specific Problem when form version in submission not found

* Simplifying code

Author: ktuite

lib/resources/submissions.js

@@ -120,7 +120,9 @@ module.exports = (service, endpoint) => {
   openRosaSubmission('/projects/:projectId/submission', false, (auth, { projectId }, xmlFormId, Forms, version) =>
     Forms.getByProjectAndXmlFormId(projectId, xmlFormId, false, version)
       .then(getOrNotFound)
-      .then(ensureDef)
+      // This replaces ensureDef(form). If the form was found with the project ID and form ID
+      // constraints but the def was not found, that suggest the problem was with the version.
+      .then(rejectIf(((form) => (form.def.id == null)), () => Problem.user.formVersionNotFound({ formVersion: version })))
       .then(rejectIf(((form) => !form.acceptsSubmissions()), noargs(Problem.user.notAcceptingSubmissions)))
       .then((form) => auth.canOrReject('submission.create', form)));
 
@@ -206,7 +208,9 @@ module.exports = (service, endpoint) => {
   restSubmission('/projects/:projectId/forms/:formId', false, ({ projectId, formId }, Forms, version) =>
     Forms.getByProjectAndXmlFormId(projectId, formId, false, version) // TODO: okay so this is exactly the same as the func above..
       .then(getOrNotFound)
-      .then(ensureDef)
+      // This replaces ensureDef(form). If the form was found with the project ID and form ID
+      // constraints but the def was not found, that suggest the problem was with the version.
+      .then(rejectIf(((form) => (form.def.id == null)), () => Problem.user.formVersionNotFound({ formVersion: version })))
       .then(rejectIf(
         (form) => !form.acceptsSubmissions(),
         () => Problem.user.notAcceptingSubmissions()

lib/util/problem.js

@@ -136,6 +136,9 @@ const problems = {
     // deprecated id does not exist.
     deprecatedIdNotFound: problem(404.5, ({ deprecatedId }) => `You tried to update an existing submission, but we can't find that submission to update (${deprecatedId})`),
 
+    // form version in submission does not exist
+    formVersionNotFound: problem(404.6, ({ formVersion }) => `The form version specified in this submission '${formVersion}' does not exist.`),
+
     // { allowed: [ acceptable formats ], got }
     unacceptableFormat: problem(406.1, ({ allowed }) => `Requested format not acceptable; this resource allows: ${allowed.join()}.`),
 

test/integration/api/submissions.js

@@ -82,7 +82,10 @@ describe('api: /submission', () => {
         asAlice.post('/v1/projects/1/submission')
           .set('X-OpenRosa-Version', '1.0')
           .attach('xml_submission_file', Buffer.from('<data id="simple" version="-1"><orx:meta><orx:instanceID>one</orx:instanceID></orx:meta></data>'), { filename: 'data.xml' })
-          .expect(404))));
+          .expect(404)
+          .then(({ text }) => {
+            text.should.match(/The form version specified in this submission/);
+          }))));
 
     it('should save the submission to the appropriate form', testService((service) =>
       service.login('alice', (asAlice) =>
@@ -932,7 +935,11 @@ describe('api: /forms/:id/submissions', () => {
         asAlice.post('/v1/projects/1/forms/simple/submissions')
           .send(Buffer.from('<data id="simple" version="-1"><meta><instanceID>one</instanceID></meta></data>'))
           .set('Content-Type', 'text/xml')
-          .expect(404))));
+          .expect(404)
+          .then(({ body }) => {
+            body.code.should.equal(404.6);
+            body.message.should.match(/The form version specified in this submission/);
+          }))));
 
     it('should submit if all details are provided', testService((service) =>
       service.login('alice', (asAlice) =>
@@ -1089,6 +1096,15 @@ describe('api: /forms/:id/submissions', () => {
             asAlice.get('/v1/projects/1/forms/simple/submissions/one').expect(404),
             asAlice.get('/v1/projects/1/forms/simple/draft/submissions/one').expect(200)
           ])))));
+
+    it('should accept even if the version in the submission is wrong', testService((service) =>
+      service.login('alice', (asAlice) =>
+        asAlice.post('/v1/projects/1/forms/simple/draft')
+          .expect(200)
+          .then(() => asAlice.post('/v1/projects/1/forms/simple/draft/submissions')
+            .send(Buffer.from('<data id="simple" version="-1"><meta><instanceID>one</instanceID></meta></data>'))
+            .set('Content-Type', 'application/xml')
+            .expect(200)))));
   });
 
   describe('/:instanceId PUT', () => {