CUMULUS-4129: Be able to turn off estimateTableRowCount (#1246)

* CUMULUS-4129: Add env var to toggle row count
Added cypress test for estimated row count
Added env var to webpack
Add estimate row count var to readme

Author: rswanso5-nasa

CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
   - Added `USE_UTC_TIME_FORMAT` environment variable to allow control over the table's date/time timezone format
 - **CUMULUS-3811**
   - Refactor data management class components to functional components
+- **CUMULUS_4129**
+  - Added ESTIMATE_TABLE_ROW_COUNT env var to toggle estimated table row count for executions and granules
 - **CUMULUS_4182**
   - executions and granules list calls updated to search un-archived records
 - **CUMULUS-4223**

README.md

@@ -38,7 +38,7 @@ Setting the following environment variables can override the default values.
 | KIBANAROOT | \<optional\>  Points to a Kibana endpoint. | |
 | INITIAL_DATE_RANGE_IN_DAYS| \<optional\> Number of days to load up before at start | |
 | USE_UTC_TIME_FORMAT| The table's timestamp column's time display format. Expected value is UTC. | |
-
+| ESTIMATE_TABLE_ROW_COUNT | \<optional\> Toggles estimated row count for Granule and Execution tables | true |
 
 ## Quick start
 

app/src/js/actions/index.js

@@ -206,7 +206,12 @@ export const listGranules = (options) => (dispatch, getState) => {
       method: 'GET',
       id: null,
       url: new URL('granules', root).href,
-      params: parseArchivedInListParams({ limit: defaultPageLimit, ...options, ...timeFilters })
+      params: parseArchivedInListParams({
+        limit: defaultPageLimit,
+        estimateTableRowCount: _config.estimateTableRowCount,
+        ...options,
+        ...timeFilters
+      })
     }
   });
 };
@@ -684,7 +689,12 @@ export const listExecutions = (options) => (dispatch, getState) => {
       type: types.EXECUTIONS,
       method: 'GET',
       url: new URL('executions', root).href,
-      params: parseArchivedInListParams({ limit: defaultPageLimit, ...options, ...timeFilters })
+      params: parseArchivedInListParams({
+        limit: defaultPageLimit,
+        estimateTableRowCount: _config.estimateTableRowCount,
+        ...options,
+        ...timeFilters
+      })
     }
   });
 };

app/src/js/config/config.js

@@ -30,6 +30,7 @@ const config = {
   enableRecovery: computeBool(process.env.ENABLE_RECOVERY, false),
   servedByCumulusAPI: computeBool(process.env.SERVED_BY_CUMULUS_API, ''),
   useUTCTimeFormat: process.env.USE_UTC_TIME_FORMAT || '',
+  estimateTableRowCount: computeBool(process.env.ESTIMATE_TABLE_ROW_COUNT, true),
 };
 
 module.exports = config;

cypress.config.js

@@ -5,6 +5,7 @@ module.exports = defineConfig({
   env: {
     APIROOT: 'http://localhost:5001',
     authToken: null,
+    ESTIMATE_TABLE_ROW_COUNT: true,
   },
   retries: {
     runMode: 2,

cypress/e2e/executions.cy.js

@@ -467,4 +467,24 @@ describe('Dashboard Executions Page', () => {
       cy.get('.table .tbody .tr').should('have.length', 1);
     });
   });
+
+  describe('when ESTIMATE_TABLE_ROW_COUNT is false', () => {
+    before(() => {
+      Cypress.env('ESTIMATE_TABLE_ROW_COUNT', false);
+      cy.login();
+      cy.visit('/executions');
+    });
+
+    it('should not estimate table row count', () => {
+      cy.wait(500);
+      cy.get('.num-title').invoke('text').then((executionCount) => {
+        cy.get('.tbody .tr').should('have.length', Number(executionCount));
+      });
+      cy.get('.checkmark--wrapper').contains('Archived').click();
+      cy.wait(500);
+      cy.get('.num-title').invoke('text').then((executionCount) => {
+        cy.get('.tbody .tr').should('have.length', Number(executionCount));
+      });
+    });
+  });
 });

cypress/e2e/granules.cy.js

@@ -1005,4 +1005,24 @@ describe('Dashboard Granules Page', () => {
         .and('include', `search=${searchShort}`);
     });
   });
+
+  describe('when ESTIMATE_TABLE_ROW_COUNT is false', () => {
+    before(() => {
+      Cypress.env('ESTIMATE_TABLE_ROW_COUNT', false);
+      cy.login();
+      cy.visit('/granules');
+    });
+
+    it('should not estimate table row count', () => {
+      cy.wait(500);
+      cy.get('.num-title').invoke('text').then((granuleCount) => {
+        cy.get('.tbody .tr').should('have.length', Number(granuleCount));
+      });
+      cy.get('.checkmark--wrapper').contains('Archived').click();
+      cy.wait(500);
+      cy.get('.num-title').invoke('text').then((granuleCount) => {
+        cy.get('.tbody .tr').should('have.length', Number(granuleCount));
+      });
+    });
+  });
 });

webpack.common.js

@@ -167,7 +167,8 @@ const CommonConfig = {
       BUCKET: config.graphicsPath,
       ENABLE_RECOVERY: config.enableRecovery,
       SERVED_BY_CUMULUS_API: config.servedByCumulusAPI,
-      USE_UTC_TIME_FORMAT: config.useUTCTimeFormat
+      USE_UTC_TIME_FORMAT: config.useUTCTimeFormat,
+      ESTIMATE_TABLE_ROW_COUNT: config.estimateTableRowCount
     }),
   ],
 };