Feature: Capture notes/comment at the time of Form publish

sadiqkhoja · sadiqkhoja · commit eab4a9c850f5 · 2026-05-08T13:32:23.000-04:00
diff --git a/apps/central/src/components/form-draft/publish.vue b/apps/central/src/components/form-draft/publish.vue
@@ -40,37 +40,27 @@ except according to the terms contained in the LICENSE file.
 
         <hr v-if="draftVersionStringIsDuplicate">
         <p v-if="draftVersionStringIsDuplicate">{{ $t('introduction[2]') }}</p>
-
-        <p v-if="!draftVersionStringIsDuplicate && !versionConflict">{{ $t('introduction[3]') }}</p>
       </div>
-      <form v-if="draftVersionStringIsDuplicate || versionConflict" @submit.prevent="publish">
-        <form-group ref="versionString" v-model.trim="versionString"
-          :placeholder="$t('common.version')" required autocomplete="off"/>
+      <hr>
+      <form @submit.prevent="publish">
+        <form-group v-if="draftVersionStringIsDuplicate || versionConflict" ref="versionString" v-model.trim="versionString" :placeholder="$t('common.version')"
+          required autocomplete="off"/>
+        <div class="form-group">
+          <textarea id="form-draft-publish-note" v-model="notes" class="form-control"
+            :placeholder="$t('placeholder.note')" rows="3"></textarea>
+          <label for="form-draft-publish-note" class="form-label">{{ $t('field.note') }}</label>
+        </div>
         <p>{{ $t('introduction[3]') }}</p>
-        <!-- We specify two nearly identical .modal-actions, because here we
-        want the Proceed button to be a submit button (which means that browsers
-        will do some basic form validation when it is clicked). -->
         <div class="modal-actions">
           <button type="button" class="btn btn-link"
             :aria-disabled="awaitingResponse" @click="$emit('hide')">
             {{ $t('action.cancel') }}
           </button>
-          <button type="submit" class="btn btn-primary"
-            :aria-disabled="awaitingResponse">
+          <button type="submit" class="btn btn-primary" :aria-disabled="awaitingResponse">
             {{ $t('action.proceed') }} <spinner :state="awaitingResponse"/>
           </button>
         </div>
       </form>
-      <div v-else class="modal-actions">
-        <button type="button" class="btn btn-link" :aria-disabled="awaitingResponse"
-          @click="$emit('hide')">
-          {{ $t('action.cancel') }}
-        </button>
-        <button type="button" class="btn btn-primary"
-          :aria-disabled="awaitingResponse" @click="publish">
-          {{ $t('action.proceed') }} <spinner :state="awaitingResponse"/>
-        </button>
-      </div>
     </template>
   </modal>
 </template>
@@ -111,6 +101,7 @@ export default {
   data() {
     return {
       versionString: '',
+      notes: '',
       // versionConflict is used in a scenario where a user tries to
       // publish a form that conflicts with a form/version combo probably
       // found in the trash. This component doesn't have access to trashed
@@ -139,14 +130,20 @@ export default {
   },
   watch: {
     state(state) {
-      if (state) this.versionString = this.formDraft.version;
+      if (state) {
+        this.versionString = this.formDraft.version;
+        this.notes = '';
+      }
     }
   },
   methods: {
     focusInput() {
       if (this.draftVersionStringIsDuplicate) this.$refs.versionString.focus();
     },
     publish() {
+      const headers = {};
+      if (this.notes !== '')
+        headers['X-Action-Notes'] = encodeURIComponent(this.notes);
       this.request({
         method: 'POST',
         url: apiPaths.publishFormDraft(
@@ -156,6 +153,7 @@ export default {
             ? { version: this.versionString }
             : null
         ),
+        headers,
         fulfillProblem: (problem) => problem.code === 409.6
       })
         .then(({ data }) => {
@@ -198,6 +196,12 @@ export default {
     "newProperties": "Publishing this draft will create {count} property. | Publishing this draft will create {count} properties.",
     "problem": {
       "409_6": "The version name of this Draft conflicts with a past version of this Form or a deleted Form. Please use the field below to change it to something new or upload a new Form definition."
+    },
+    "field": {
+      "note": "Notes (optional)"
+    },
+    "placeholder": {
+      "note": "Add optional publishing notes..."
     }
   }
 }
diff --git a/apps/central/test/components/form-attachment/list.spec.js b/apps/central/test/components/form-attachment/list.spec.js
@@ -1140,7 +1140,7 @@ describe('FormAttachmentList', () => {
           .complete()
           .request(async (app) => {
             await app.get('#form-edit-publish-button').trigger('click');
-            return app.get('#form-draft-publish .btn-primary').trigger('click');
+            return app.get('#form-draft-publish form').trigger('submit');
           })
           .respondWithData(() => {
             testData.extendedFormDrafts.publish(-1);
@@ -1184,7 +1184,7 @@ describe('FormAttachmentList', () => {
           .complete()
           .request(async (app) => {
             await app.get('#form-edit-publish-button').trigger('click');
-            return app.get('#form-draft-publish .btn-primary').trigger('click');
+            return app.get('#form-draft-publish form').trigger('submit');
           })
           .respondWithData(() => {
             testData.extendedFormDrafts.publish(-1);
diff --git a/apps/central/test/components/form-draft/publish.spec.js b/apps/central/test/components/form-draft/publish.spec.js
@@ -109,7 +109,7 @@ describe('FormDraftPublish', () => {
       modal.findAll('form p').length.should.equal(1);
     });
 
-    it('does not show input if version string of draft is different', async () => {
+    it('does not show version input if version string of draft is different', async () => {
       testData.extendedForms.createPast(1);
       testData.extendedFormVersions.createPast(1, {
         version: 'v2',
@@ -118,15 +118,15 @@ describe('FormDraftPublish', () => {
       const modal = mount(FormDraftPublish, mountOptions());
       await modal.setProps({ state: true });
       modal.find('input').exists().should.be.false;
-      modal.findAll('.modal-introduction p').length.should.equal(3);
+      modal.find('.modal-introduction').text().should.not.match(/your Draft Form has the same version name/);
     });
 
-    it('does not show the input for a form without a published version', async () => {
+    it('does not show the version input for a form without a published version', async () => {
       testData.extendedForms.createPast(1, { draft: true });
       const modal = mount(FormDraftPublish, mountOptions());
       await modal.setProps({ state: true });
       modal.find('input').exists().should.be.false;
-      modal.findAll('.modal-introduction p').length.should.equal(3);
+      modal.find('.modal-introduction').text().should.not.match(/your Draft Form has the same version name/);
     });
 
     it('focuses the input', async () => {
@@ -178,18 +178,6 @@ describe('FormDraftPublish', () => {
           modal: true
         });
     });
-
-    it('implements things if the version string input is not shown', () => {
-      testData.extendedForms.createPast(1, { draft: true });
-      return mockHttp()
-        .mount(FormDraftPublish, mountOptions())
-        .afterResponses(modal => modal.setProps({ state: true }))
-        .testStandardButton({
-          button: '.btn-primary',
-          disabled: ['.btn-link'],
-          modal: true
-        });
-    });
   });
 
   describe('request', () => {
@@ -199,7 +187,7 @@ describe('FormDraftPublish', () => {
         .mount(FormDraftPublish, mountOptions())
         .request(async (modal) => {
           await modal.setProps({ state: true });
-          return modal.get('.btn-primary').trigger('click');
+          return modal.get('form').trigger('submit');
         })
         .beforeEachResponse((_, { method, url }) => {
           method.should.equal('POST');
@@ -249,7 +237,7 @@ describe('FormDraftPublish', () => {
         .mount(FormDraftPublish, mountOptions())
         .request(async (modal) => {
           await modal.setProps({ state: true });
-          return modal.get('.btn-primary').trigger('click');
+          return modal.get('form').trigger('submit');
         })
         .beforeEachResponse((_, { url }) => {
           url.should.equal('/v1/projects/1/forms/f/draft/publish');
@@ -283,7 +271,7 @@ describe('FormDraftPublish', () => {
       .mount(FormDraftPublish, mountOptions())
       .request(async (modal) => {
         await modal.setProps({ state: true });
-        return modal.get('#form-draft-publish .btn-primary').trigger('click');
+        return modal.get('#form-draft-publish form').trigger('submit');
       })
       .respondWithProblem({
         code: 409.17,
@@ -309,7 +297,7 @@ describe('FormDraftPublish', () => {
       .mount(FormDraftPublish, mountOptions())
       .request(async (modal) => {
         await modal.setProps({ state: true });
-        return modal.get('#form-draft-publish .btn-primary').trigger('click');
+        return modal.get('form').trigger('submit');
       })
       .respondWithProblem(409.6)
       .afterResponse(modal => {
@@ -329,13 +317,13 @@ describe('FormDraftPublish', () => {
       .mount(FormDraftPublish, mountOptions())
       .request(async (modal) => {
         await modal.setProps({ state: true });
-        return modal.get('#form-draft-publish .btn-primary').trigger('click');
+        return modal.get('form').trigger('submit');
       })
       .respondWithProblem(500.1)
       .afterResponse(modal => {
         modal.should.alert('danger');
         modal.find('input').exists().should.be.false;
-        modal.findAll('.modal-introduction p').length.should.equal(3);
+        modal.find('.modal-introduction').text().should.not.match(/your Draft Form has the same version name/);
       });
   });
 
@@ -355,7 +343,7 @@ describe('FormDraftPublish', () => {
         .complete()
         .request(async (app) => {
           await app.get('#form-edit-publish-button').trigger('click');
-          return app.get('#form-draft-publish .btn-primary').trigger('click');
+          return app.get('#form-draft-publish form').trigger('submit');
         })
         .modify(respondToPublish);
     };
@@ -369,6 +357,23 @@ describe('FormDraftPublish', () => {
         { url: '/v1/projects/1/forms/f/dataset-diff' }
       ]));
 
+    it('sends X-Action-Notes header when notes are provided', () => {
+      testData.extendedForms.createPast(1, { draft: true });
+      return load('/projects/1/forms/f/draft')
+        .complete()
+        .request(async (app) => {
+          await app.get('#form-edit-publish-button').trigger('click');
+          await app.get('#form-draft-publish-note').setValue('Version 1 release notes');
+          return app.get('#form-draft-publish form').trigger('submit');
+        })
+        .beforeEachResponse((_, { url, headers }) => {
+          if (url === '/v1/projects/1/forms/f/draft/publish') {
+            headers['X-Action-Notes'].should.equal(encodeURIComponent('Version 1 release notes'));
+          }
+        })
+        .modify(respondToPublish);
+    });
+
     it('hides the modal', () =>
       publish()
         .afterResponses(app => {
@@ -422,7 +427,7 @@ describe('FormDraftPublish', () => {
         .complete()
         .request(async (app) => {
           await app.get('#form-edit-publish-button').trigger('click');
-          return app.get('#form-draft-publish .btn-primary').trigger('click');
+          return app.get('#form-draft-publish form').trigger('submit');
         })
         .modify(respondToPublish)
         .complete()
diff --git a/apps/central/test/components/form/edit.spec.js b/apps/central/test/components/form/edit.spec.js
@@ -55,7 +55,7 @@ describe('FormEdit', () => {
       })
       .request(async (app) => {
         await app.get('#form-edit-publish-button').trigger('click');
-        return app.get('#form-draft-publish .btn-primary').trigger('click');
+        return app.get('#form-draft-publish form').trigger('submit');
       })
       .respondWithData(() => {
         testData.extendedFormDrafts.publish(-1);
diff --git a/apps/central/transifex/strings_en.json b/apps/central/transifex/strings_en.json
@@ -3324,6 +3324,17 @@
         "409_6": {
           "string": "The version name of this Draft conflicts with a past version of this Form or a deleted Form. Please use the field below to change it to something new or upload a new Form definition."
         }
+      },
+      "field": {
+        "note": {
+          "string": "Notes (optional)",
+          "developer_comment": "This is the text of a form field."
+        }
+      },
+      "placeholder": {
+        "note": {
+          "string": "Add optional publishing notes..."
+        }
       }
     },
     "FormDraftQrPanel": {
