From ed5162b5b46e0e19602b062ec7dc2bf7af99e8a8 Mon Sep 17 00:00:00 2001
From: Kathleen Tuite <kathleen.tuite@gmail.com>
Date: Wed, 1 May 2024 13:58:34 -0700
Subject: [PATCH] Remove enketo polling in Form Show (#987)

---
 src/components/form/show.vue      |  71 +-----
 test/components/form/show.spec.js | 392 ------------------------------
 2 files changed, 2 insertions(+), 461 deletions(-)

diff --git a/src/components/form/show.vue b/src/components/form/show.vue
index 05afe2713..7a0d95d35 100644
--- a/src/components/form/show.vue
+++ b/src/components/form/show.vue
@@ -25,13 +25,10 @@ except according to the terms contained in the LICENSE file.
 </template>
 
 <script>
-import { DateTime } from 'luxon';
-
 import FormHead from './head.vue';
 import Loading from '../loading.vue';
 import PageBody from '../page/body.vue';
 
-import useCallWait from '../../composables/call-wait';
 import useForm from '../../request-data/form';
 import useDatasets from '../../request-data/datasets';
 import useRequest from '../../composables/request';
@@ -59,12 +56,11 @@ export default {
     useDatasets();
 
     const { request, awaitingResponse } = useRequest();
-    const { callWait, cancelCall } = useCallWait();
     const { formPath } = useRoutes();
     return {
       project, form, formDraft, attachments,
       ...resourceStates([project, form, formDraft, attachments]),
-      request, awaitingResponse, callWait, cancelCall, formPath
+      request, awaitingResponse, formPath
     };
   },
   created() {
@@ -78,82 +74,19 @@ export default {
         resend
       }).catch(noop);
     },
-    // Wait for up to a total of 10 minutes, not including request time.
-    waitToRequestEnketoId(tries) {
-      if (tries < 20) return 3000;
-      if (tries < 50) return 8000;
-      if (tries < 70) return 15000;
-      return null;
-    },
     fetchForm() {
-      this.cancelCall('fetchEnketoIdsForForm');
       const url = apiPaths.form(this.projectId, this.xmlFormId);
       this.form.request({ url, extended: true })
-        .then(() => {
-          if (this.form.publishedAt == null) return;
-          this.callWait(
-            'fetchEnketoIdsForForm',
-            async () => {
-              if (this.form.enketoId != null && this.form.enketoOnceId != null)
-                return true;
-              // If Enketo hasn't finished processing the form in 15 minutes,
-              // something else has probably gone wrong.
-              if (Date.now() -
-                DateTime.fromISO(this.form.publishedAt).toMillis() > 900000)
-                return true;
-              await this.form.request({
-                url,
-                patch: ({ data }) => {
-                  this.form.enketoId = data.enketoId;
-                  this.form.enketoOnceId = data.enketoOnceId;
-                },
-                alert: false
-              });
-              // The next call will check whether the form now has both Enketo
-              // IDs.
-              return false;
-            },
-            this.waitToRequestEnketoId
-          );
-        })
         .catch(noop);
     },
     fetchDraft() {
-      this.cancelCall('fetchEnketoIdForDraft');
       const draftUrl = apiPaths.formDraft(this.projectId, this.xmlFormId);
       Promise.allSettled([
         this.formDraft.request({
           url: draftUrl,
           extended: true,
           fulfillProblem: ({ code }) => code === 404.1
-        })
-          .then(() => {
-            this.callWait(
-              'fetchEnketoIdForDraft',
-              async () => {
-                if (this.formDraft.isEmpty() ||
-                  this.formDraft.get().enketoId != null)
-                  return true;
-                await this.formDraft.request({
-                  url: draftUrl,
-                  patch: ({ data }) => {
-                    // Do nothing if the form draft has been set to
-                    // Option.none() after a different, concurrent request, for
-                    // example, after the draft is published.
-                    if (this.formDraft.isDefined()) {
-                      // We do not check that the draft has not changed, for
-                      // example, by another user concurrently modifying the
-                      // draft.
-                      this.formDraft.get().enketoId = data.enketoId;
-                    }
-                  },
-                  alert: false
-                });
-                return false;
-              },
-              this.waitToRequestEnketoId
-            );
-          }),
+        }),
         this.attachments.request({
           url: apiPaths.formDraftAttachments(this.projectId, this.xmlFormId),
           fulfillProblem: ({ code }) => code === 404.1
diff --git a/test/components/form/show.spec.js b/test/components/form/show.spec.js
index d5f2e1000..d217410f3 100644
--- a/test/components/form/show.spec.js
+++ b/test/components/form/show.spec.js
@@ -1,14 +1,8 @@
-import sinon from 'sinon';
-
 import FormOverview from '../../../src/components/form/overview.vue';
-import FormShow from '../../../src/components/form/show.vue';
 import Loading from '../../../src/components/loading.vue';
 import NotFound from '../../../src/components/not-found.vue';
 
-import { ago } from '../../../src/util/date-time';
-
 import testData from '../../data';
-import { block } from '../../util/util';
 import { load } from '../../util/http';
 import { mockLogin } from '../../util/session';
 import { mockResponse } from '../../util/axios';
@@ -90,390 +84,4 @@ describe('FormShow', () => {
         loading[0].props().state.should.eql(false);
       });
   });
-
-  describe('draft enketoId', () => {
-    it('does not fetch the enketoId if the draft has an enketoId', () => {
-      const clock = sinon.useFakeTimers(Date.now());
-      testData.extendedForms.createPast(1, { draft: true, enketoId: 'xyz' });
-      return load('/projects/1/forms/f/draft')
-        .complete()
-        .testNoRequest(() => {
-          clock.tick(3000);
-        });
-    });
-
-    it('fetches the enketoId if the draft does not have one', () => {
-      const clock = sinon.useFakeTimers(Date.now());
-      testData.extendedForms.createPast(1, { draft: true, enketoId: null });
-      return load('/projects/1/forms/f/draft')
-        .complete()
-        .request(() => {
-          clock.tick(3000);
-        })
-        .beforeEachResponse((_, { method, url, headers }) => {
-          method.should.equal('GET');
-          url.should.equal('/v1/projects/1/forms/f/draft');
-          should.not.exist(headers['X-Extended-Metadata']);
-        })
-        .respondWithData(() => {
-          testData.extendedFormDrafts.update(-1, { enketoId: 'xyz' });
-          return testData.standardFormDrafts.last();
-        })
-        .afterResponse(app => {
-          const { formDraft } = app.vm.$container.requestData;
-          formDraft.get().enketoId.should.equal('xyz');
-        })
-        .testNoRequest(() => {
-          clock.tick(3000);
-        });
-    });
-
-    it('continues to fetch the enketoId if the draft does not have one', () => {
-      const clock = sinon.useFakeTimers(Date.now());
-      testData.extendedForms.createPast(1, { draft: true, enketoId: null });
-      return load('/projects/1/forms/f/draft')
-        .complete()
-        .request(() => {
-          clock.tick(3000);
-        })
-        .respondWithData(() => testData.standardFormDrafts.last())
-        .complete()
-        .request(() => {
-          clock.tick(3000);
-        })
-        .respondWithData(() => {
-          testData.extendedFormDrafts.update(-1, { enketoId: 'xyz' });
-          return testData.standardFormDrafts.last();
-        })
-        .afterResponse(app => {
-          const { formDraft } = app.vm.$container.requestData;
-          formDraft.get().enketoId.should.equal('xyz');
-        });
-    });
-
-    it('stops fetching the enketoId after an error response', () => {
-      const clock = sinon.useFakeTimers(Date.now());
-      testData.extendedForms.createPast(1, { draft: true, enketoId: null });
-      return load('/projects/1/forms/f/draft')
-        .complete()
-        .request(() => {
-          clock.tick(3000);
-        })
-        .respondWithProblem()
-        .complete()
-        .testNoRequest(() => {
-          clock.tick(3000);
-        });
-    });
-
-    it('stops fetching the enketoId if there is no longer a draft', () => {
-      const clock = sinon.useFakeTimers(Date.now());
-      testData.extendedForms.createPast(1);
-      testData.extendedFormVersions.createPast(1, {
-        draft: true,
-        enketoId: null
-      });
-      return load('/projects/1/forms/f/draft')
-        .complete()
-        .request(async (app) => {
-          await app.get('#form-draft-status-abandon-button').trigger('click');
-          return app.get('#form-draft-abandon .btn-danger').trigger('click');
-        })
-        .respondWithSuccess()
-        .respondWithData(() => testData.standardFormAttachments.sorted())
-        .complete()
-        .testNoRequest(() => {
-          clock.tick(3000);
-        });
-    });
-
-    it('stops fetching enketoId if draft was deleted by concurrent request', () => {
-      const clock = sinon.useFakeTimers(Date.now());
-      testData.extendedForms.createPast(1);
-      testData.extendedFormVersions.createPast(1, {
-        draft: true,
-        enketoId: null
-      });
-      const [lock, unlock] = block();
-      return load('/projects/1/forms/f/draft')
-        .complete()
-        .request(async (app) => {
-          await app.get('#form-draft-status-abandon-button').trigger('click');
-          // We will wait for the navigation to the form overview before
-          // returning the response for the form draft.
-          app.vm.$router.afterEach(unlock);
-          return app.get('#form-draft-abandon .btn-danger').trigger('click');
-        })
-        .beforeEachResponse(async (_, { method }) => {
-          if (method === 'DELETE')
-            clock.tick(3000);
-          else
-            await lock;
-        })
-        .respondWithSuccess()
-        .respondWithData(() => testData.standardFormDrafts.last())
-        .respondWithData(() => testData.standardFormAttachments.sorted())
-        .complete()
-        .testNoRequest(() => {
-          clock.tick(3000);
-        });
-    });
-
-    it('does not fetch enketoId during a new request for draft', () => {
-      const clock = sinon.useFakeTimers(Date.now());
-      testData.extendedForms.createPast(1, { draft: true, enketoId: null });
-      return load('/projects/1/forms/f/draft')
-        .complete()
-        .request(app => {
-          app.getComponent(FormShow).vm.fetchDraft();
-          clock.tick(3000);
-        })
-        // There should be only two responses, not three.
-        .respondWithProblem(() => testData.extendedFormDrafts.last())
-        .respondWithProblem(() => testData.standardFormAttachments.sorted());
-    });
-
-    describe('route change', () => {
-      it('continues to fetch enketoId as user navigates within form', () => {
-        const clock = sinon.useFakeTimers(Date.now());
-        testData.extendedForms.createPast(1, { draft: true, enketoId: null });
-        testData.standardFormAttachments.createPast(1);
-        return load('/projects/1/forms/f/draft')
-          .complete()
-          .route('/projects/1/forms/f/draft/attachments')
-          .complete()
-          .request(() => {
-            clock.tick(3000);
-          })
-          .respondWithData(() => testData.standardFormDrafts.last());
-      });
-
-      it('stops fetching enketoId if user navigates to a form draft with an enketoId', () => {
-        const clock = sinon.useFakeTimers(Date.now());
-        testData.extendedForms
-          .createPast(1, { xmlFormId: 'f', draft: true, enketoId: null })
-          .createPast(1, { xmlFormId: 'f2', draft: true, enketoId: 'xyz' });
-        return load('/projects/1/forms/f/draft', {}, {
-          form: () => testData.extendedForms.first(),
-          formDraft: () => testData.extendedFormDrafts.first()
-        })
-          .complete()
-          .load('/projects/1/forms/f2/draft', { project: false })
-          .complete()
-          .testNoRequest(() => {
-            clock.tick(3000);
-          });
-      });
-
-      it('stops fetching enketoId if user navigates somewhere other than a form route', () => {
-        const clock = sinon.useFakeTimers(Date.now());
-        testData.extendedForms.createPast(1, { draft: true, enketoId: null });
-        return load('/projects/1/forms/f/draft')
-          .complete()
-          .load('/account/edit')
-          .complete()
-          .testNoRequest(() => {
-            clock.tick(3000);
-          });
-      });
-    });
-  });
-
-  describe('form enketoId', () => {
-    it('does not fetch the enketoId if the form has an enketoId', () => {
-      const clock = sinon.useFakeTimers(Date.now());
-      testData.extendedForms.createPast(1, { enketoId: 'xyz' });
-      return load('/projects/1/forms/f')
-        .complete()
-        .testNoRequest(() => {
-          clock.tick(3000);
-        });
-    });
-
-    it('does not fetch enketoId for form published more than 15 minutes ago', () => {
-      const clock = sinon.useFakeTimers(Date.now());
-      testData.extendedForms.createPast(1, {
-        enketoId: null,
-        publishedAt: ago({ minutes: 16 }).toISO()
-      });
-      return load('/projects/1/forms/f')
-        .complete()
-        .testNoRequest(() => {
-          clock.tick(3000);
-        });
-    });
-
-    it('fetches the enketoId if a recently published form does not have one', () => {
-      const clock = sinon.useFakeTimers(Date.now());
-      testData.extendedForms.createPast(1, {
-        enketoId: null,
-        publishedAt: new Date().toISOString()
-      });
-      return load('/projects/1/forms/f')
-        .complete()
-        .request(() => {
-          clock.tick(3000);
-        })
-        .beforeEachResponse((_, { method, url, headers }) => {
-          method.should.equal('GET');
-          url.should.equal('/v1/projects/1/forms/f');
-          should.not.exist(headers['X-Extended-Metadata']);
-        })
-        .respondWithData(() => {
-          testData.extendedForms.update(-1, { enketoId: 'xyz' });
-          return testData.standardForms.last();
-        })
-        .afterResponse(app => {
-          const { form } = app.vm.$container.requestData;
-          form.enketoId.should.equal('xyz');
-        })
-        .testNoRequest(() => {
-          clock.tick(3000);
-        });
-    });
-
-    it('continues to fetch enketoId if form still does not have one', () => {
-      const clock = sinon.useFakeTimers(Date.now());
-      testData.extendedForms.createPast(1, {
-        enketoId: null,
-        publishedAt: new Date().toISOString()
-      });
-      return load('/projects/1/forms/f')
-        .complete()
-        .request(() => {
-          clock.tick(3000);
-        })
-        .respondWithData(() => testData.standardForms.last())
-        .complete()
-        .request(() => {
-          clock.tick(3000);
-        })
-        .respondWithData(() => {
-          testData.extendedForms.update(-1, { enketoId: 'xyz' });
-          return testData.standardForms.last();
-        })
-        .afterResponse(app => {
-          const { form } = app.vm.$container.requestData;
-          form.enketoId.should.equal('xyz');
-        });
-    });
-
-    it('stops fetching the enketoId after an error response', () => {
-      const clock = sinon.useFakeTimers(Date.now());
-      testData.extendedForms.createPast(1, {
-        enketoId: null,
-        publishedAt: new Date().toISOString()
-      });
-      return load('/projects/1/forms/f')
-        .complete()
-        .request(() => {
-          clock.tick(3000);
-        })
-        .respondWithProblem()
-        .complete()
-        .testNoRequest(() => {
-          clock.tick(3000);
-        });
-    });
-
-    it('does not fetch the enketoId during a new request for the form', () => {
-      const clock = sinon.useFakeTimers(Date.now());
-      testData.extendedForms.createPast(1, {
-        enketoId: null,
-        publishedAt: new Date().toISOString()
-      });
-      return load('/projects/1/forms/f')
-        .complete()
-        .request(app => {
-          app.getComponent(FormShow).vm.fetchForm();
-          clock.tick(3000);
-        })
-        // There should be only one response, not two.
-        .respondWithData(() => testData.extendedForms.last());
-    });
-
-    it('sends two requests if form and draft both do not have an enketoId', () => {
-      const clock = sinon.useFakeTimers(Date.now());
-      testData.extendedForms.createPast(1, {
-        enketoId: null,
-        publishedAt: new Date().toISOString()
-      });
-      testData.extendedFormDrafts.createPast(1, { draft: true, enketoId: null });
-      return load('/projects/1/forms/f')
-        .complete()
-        .request(() => {
-          clock.tick(3000);
-        })
-        .respondWithData(() => {
-          testData.extendedForms.update(0, { enketoId: 'xyz' });
-          return testData.standardForms.last();
-        })
-        .respondWithData(() => {
-          testData.extendedFormDrafts.update(1, { enketoId: 'abc' });
-          return testData.standardFormDrafts.last();
-        })
-        .afterResponses(app => {
-          const { form, formDraft } = app.vm.$container.requestData;
-          form.enketoId.should.equal('xyz');
-          formDraft.get().enketoId.should.equal('abc');
-        })
-        .testNoRequest(() => {
-          clock.tick(3000);
-        });
-    });
-
-    describe('enketoOnceId', () => {
-      it('fetches the enketoOnceId', () => {
-        const clock = sinon.useFakeTimers(Date.now());
-        testData.extendedForms.createPast(1, {
-          enketoId: 'xyz',
-          enketoOnceId: null,
-          publishedAt: new Date().toISOString()
-        });
-        return load('/projects/1/forms/f')
-          .complete()
-          .request(() => {
-            clock.tick(3000);
-          })
-          .respondWithData(() => {
-            testData.extendedForms.update(-1, { enketoOnceId: 'zyx' });
-            return testData.standardForms.last();
-          })
-          .afterResponse(app => {
-            const { form } = app.vm.$container.requestData;
-            form.enketoOnceId.should.equal('zyx');
-          })
-          .testNoRequest(() => {
-            clock.tick(3000);
-          });
-      });
-    });
-
-    it('continues to fetch the enketoOnceId', () => {
-      const clock = sinon.useFakeTimers(Date.now());
-      testData.extendedForms.createPast(1, {
-        enketoId: 'xyz',
-        enketoOnceId: null,
-        publishedAt: new Date().toISOString()
-      });
-      return load('/projects/1/forms/f')
-        .complete()
-        .request(() => {
-          clock.tick(3000);
-        })
-        .respondWithData(() => testData.standardForms.last())
-        .complete()
-        .request(() => {
-          clock.tick(3000);
-        })
-        .respondWithData(() => {
-          testData.extendedForms.update(-1, { enketoOnceId: 'zyx' });
-          return testData.standardForms.last();
-        })
-        .afterResponse(app => {
-          const { form } = app.vm.$container.requestData;
-          form.enketoOnceId.should.equal('zyx');
-        });
-    });
-  });
 });