spec: clean up timer in GradebookExportManager

closes CNVS-34890

The timer in GradebookExportManager was getting cleaned up only
when the export succeeded or failed and was continuing on in the
test environment.  This timer is now automatically cleaned up
when the ActionMenu is unmounted

test plan
* Ensure the JS specs are no longer polluted with calls to the
  monitoring URL and other artifacts of this timer running
* Ensure the Action menu's import/export functionality works
  as always.

Change-Id: I89ee9ec48eb0c293c32857a673a9823b4da204af
Reviewed-on: https://gerrit.instructure.com/101691
Tested-by: Jenkins
Reviewed-by: Jeremy Neander <jneander@instructure.com>
Reviewed-by: Spencer Olson <solson@instructure.com>
QA-Review: Anju Reddy <areddy@instructure.com>
Product-Review: Keith T. Garner <kgarner@instructure.com>

Author: sjaveed

app/jsx/gradezilla/default_gradebook/components/ActionMenu.jsx

@@ -69,6 +69,10 @@ define([
       this.exportManager = new GradebookExportManager(this.props.gradebookExportUrl, this.props.currentUserId, existingExport);
     }
 
+    componentWillUnmount () {
+      if (this.exportManager) this.exportManager.clearMonitor();
+    }
+
     getExistingExport () {
       if (!(this.props.lastExport && this.props.attachment)) return undefined;
       if (!(this.props.lastExport.progressId && this.props.attachment.id)) return undefined;

app/jsx/gradezilla/shared/GradebookExportManager.jsx

@@ -9,6 +9,17 @@ define([
     static DEFAULT_MONITORING_BASE_URL = '/api/v1/progress';
     static DEFAULT_ATTACHMENT_BASE_URL = '/api/v1/users';
 
+    static exportCompleted (workflowState) {
+      return workflowState === 'completed';
+    }
+
+    // Returns false if the workflowState is 'failed' or an unknown state
+    static exportFailed (workflowState) {
+      if (workflowState === 'failed') return true;
+
+      return !['completed', 'queued', 'running'].includes(workflowState);
+    }
+
     constructor (exportingUrl, currentUserId, existingExport, pollingInterval = GradebookExportManager.DEFAULT_POLLING_INTERVAL) {
       this.pollingInterval = pollingInterval;
 
@@ -38,19 +49,26 @@ define([
       return `${this.attachmentBaseUrl}/${this.export.attachmentId}`;
     }
 
+    clearMonitor () {
+      if (this.exportStatusPoll) {
+        window.clearInterval(this.exportStatusPoll);
+        this.exportStatusPoll = null;
+      }
+    }
+
     monitorExport (resolve, reject) {
       if (!this.monitoringUrl()) {
         this.export = undefined;
 
         reject(I18n.t('No way to monitor gradebook exports provided!'));
       }
 
-      const exportStatusPoll = window.setInterval(() => {
+      this.exportStatusPoll = window.setInterval(() => {
         axios.get(this.monitoringUrl()).then((response) => {
           const workflowState = response.data.workflow_state;
 
-          if (workflowState === 'completed') {
-            window.clearInterval(exportStatusPoll);
+          if (GradebookExportManager.exportCompleted(workflowState)) {
+            this.clearMonitor();
 
             // Export is complete => let's get the attachment url
             axios.get(this.attachmentUrl()).then((attachmentResponse) => {
@@ -65,8 +83,8 @@ define([
             }).catch((error) => {
               reject(error);
             });
-          } else if (workflowState === 'failed') {
-            window.clearInterval(exportStatusPoll);
+          } else if (GradebookExportManager.exportFailed(workflowState)) {
+            this.clearMonitor();
 
             reject(I18n.t('Error exporting gradebook: %{msg}', { msg: response.data.message }));
           }

spec/javascripts/jsx/gradezilla/shared/GradebookExportManagerSpec.jsx

@@ -136,12 +136,13 @@ define([
     teardown () {
       moxios.uninstall();
 
+      this.subject.clearMonitor();
       this.subject = undefined;
     }
   });
 
   test('returns a rejected promise if the manager has no exportingUrl set', function () {
-    this.subject = new GradebookExportManager(exportingUrl, currentUserId, undefined);
+    this.subject = new GradebookExportManager(exportingUrl, currentUserId);
     this.subject.exportingUrl = undefined;
 
     return this.subject.startExport().catch((reason) => {
@@ -163,7 +164,7 @@ define([
       attachmentId: 'newAttachmentId'
     };
 
-    this.subject = new GradebookExportManager(exportingUrl, currentUserId, undefined);
+    this.subject = new GradebookExportManager(exportingUrl, currentUserId);
     this.subject.monitorExport = (resolve, _reject) => {
       resolve('success');
     };
@@ -175,7 +176,7 @@ define([
 
   test('clears any new export and returns a rejected promise if no monitoring is possible', function () {
     this.stub(GradebookExportManager.prototype, 'monitoringUrl').returns(undefined);
-    this.subject = new GradebookExportManager(exportingUrl, currentUserId, undefined);
+    this.subject = new GradebookExportManager(exportingUrl, currentUserId);
 
     return this.subject.startExport().catch((reason) => {
       equal(reason, 'No way to monitor gradebook exports provided!');
@@ -186,7 +187,7 @@ define([
   test('starts polling for progress and returns a rejected promise on progress failure', function () {
     const expectedMonitoringUrl = `${monitoringBase}/newProgressId`;
 
-    this.subject = new GradebookExportManager(exportingUrl, currentUserId, undefined);
+    this.subject = new GradebookExportManager(exportingUrl, currentUserId);
 
     moxios.stubRequest(expectedMonitoringUrl, {
       status: 200,
@@ -201,11 +202,29 @@ define([
     });
   });
 
+  test('starts polling for progress and returns a rejected promise on unknown progress status', function () {
+    const expectedMonitoringUrl = `${monitoringBase}/newProgressId`;
+
+    this.subject = new GradebookExportManager(exportingUrl, currentUserId);
+
+    moxios.stubRequest(expectedMonitoringUrl, {
+      status: 200,
+      responseText: {
+        workflow_state: 'discombobulated',
+        message: 'Pattern buffer degradation'
+      }
+    });
+
+    return this.subject.startExport().catch((reason) => {
+      equal(reason, 'Error exporting gradebook: Pattern buffer degradation');
+    });
+  });
+
   test('starts polling for progress and returns a fulfilled promise on progress completion', function () {
     const expectedMonitoringUrl = `${monitoringBase}/newProgressId`;
     const expectedAttachmentUrl = `${attachmentBase}/newAttachmentId`;
 
-    this.subject = new GradebookExportManager(exportingUrl, currentUserId, undefined);
+    this.subject = new GradebookExportManager(exportingUrl, currentUserId);
 
     moxios.stubRequest(expectedMonitoringUrl, {
       status: 200,