Support configurable timeout (#62)

Signed-off-by: Rupal Mahajan <[email protected]>

USER_GUIDE.md

@@ -41,6 +41,7 @@ Option | Default Value | Valid Options |  Environment Variable | Description
 --subject | This is an email containing your dashboard report | - | OPENSEARCH_SUBJECT | subject for the email
 --note | Hi,\nHere is the latest report! | string or path to text file | OPENSEARCH_EMAIL_NOTE | The email body
 --selfsignedcerts | false | true, false | - | enable or disable self-signed certicates for smtp transport
+--timeout | 300000 | - | OPENSEARCH_TIMEOUT | timeout for generating report in ms
 | - | - | - | CHROMIUM_PATH | path to chromium directory
 
 You can also find this information using help command.

src/arguments.js

@@ -8,7 +8,7 @@ const { program, Option } = require('commander');
 const { exit } = require('process');
 const fs = require('fs');
 const ora = require('ora');
-const { AUTH, CLI_COMMAND_NAME, DEFAULT_AUTH, DEFAULT_FILENAME, DEFAULT_FORMAT, DEFAULT_MIN_HEIGHT, DEFAULT_TENANT, DEFAULT_WIDTH, ENV_VAR, FORMAT, TRANSPORT_TYPE, DEFAULT_EMAIL_SUBJECT, DEFAULT_EMAIL_NOTE, DEFAULT_MULTI_TENANCY, DEFAULT_SELF_SIGNED_CERTIFICATES } = require('./constants.js');
+const { AUTH, CLI_COMMAND_NAME, DEFAULT_AUTH, DEFAULT_FILENAME, DEFAULT_FORMAT, DEFAULT_MIN_HEIGHT, DEFAULT_TENANT, DEFAULT_WIDTH, ENV_VAR, FORMAT, TRANSPORT_TYPE, DEFAULT_EMAIL_SUBJECT, DEFAULT_EMAIL_NOTE, DEFAULT_MULTI_TENANCY, DEFAULT_SELF_SIGNED_CERTIFICATES, DEFAULT_TIMEOUT } = require('./constants.js');
 const dotenv = require("dotenv");
 dotenv.config();
 const spinner = ora('');
@@ -67,7 +67,10 @@ async function getCommandArguments() {
             .env(ENV_VAR.EMAIL_NOTE))
         .addOption(new Option('--selfsignedcerts <flag>', 'enable or disable self-signed certicates for smtp transport')
             .default(DEFAULT_SELF_SIGNED_CERTIFICATES)
-            .choices(['true', 'false']));
+            .choices(['true', 'false']))
+        .addOption(new Option('--timeout <timeout>', 'timeout for generating report in ms')
+            .default(DEFAULT_TIMEOUT)
+            .env(ENV_VAR.TIMEOUT));
 
     program.addHelpText('after', `
 Note: The tenant in the url has the higher priority than tenant value provided as command option.`);
@@ -99,6 +102,8 @@ async function getEventArguments(event) {
         event['multitenancy'] = DEFAULT_MULTI_TENANCY;
     if (event.selfsignedcerts === undefined)
         event['selfsignedcerts'] = DEFAULT_SELF_SIGNED_CERTIFICATES;
+    if (event.timeout === undefined)
+        event['timeout'] = DEFAULT_TIMEOUT;
 
     return getOptions(event);
 }
@@ -127,7 +132,8 @@ function getOptions(options) {
         time: null,
         note: null,
         emailbody: null,
-        selfsignedcerts: null
+        selfsignedcerts: null,
+        timeout: null
     }
 
     // Set url.
@@ -222,6 +228,9 @@ function getOptions(options) {
     // Set self signed certificate flag.
     commandOptions.selfsignedcerts = options.selfsignedcerts;
 
+    // Set timeout.
+    commandOptions.timeout = options.timeout;
+
     spinner.succeed('Fetched argument values');
     return commandOptions;
 }

src/constants.js

@@ -14,6 +14,7 @@ const DEFAULT_EMAIL_SUBJECT = 'This is an email containing your opensearch dashb
 const DEFAULT_EMAIL_NOTE = 'Hi,\nHere is the latest report!';
 const DEFAULT_MULTI_TENANCY = true;
 const DEFAULT_SELF_SIGNED_CERTIFICATES = false;
+const DEFAULT_TIMEOUT = 300000;
 
 const REPORT_TYPE = {
   DASHBOARD: 'Dashboard',
@@ -65,6 +66,7 @@ const ENV_VAR = {
   SMTP_PASSWORD: 'OPENSEARCH_SMTP_PASSWORD',
   EMAIL_SUBJECT: 'OPENSEARCH_EMAIL_SUBJECT',
   EMAIL_NOTE: 'OPENSEARCH_EMAIL_NOTE',
+  TIMEOUT: 'OPENSEARCH_TIMEOUT'
 }
 
 const TRANSPORT_TYPE = {
@@ -74,5 +76,5 @@ const TRANSPORT_TYPE = {
 
 module.exports = {
   CLI_COMMAND_NAME, DEFAULT_AUTH, DEFAULT_TENANT, DEFAULT_FORMAT, DEFAULT_WIDTH, DEFAULT_MIN_HEIGHT, DEFAULT_FILENAME, DEFAULT_EMAIL_SUBJECT,
-  DEFAULT_EMAIL_NOTE, REPORT_TYPE, SELECTOR, FORMAT, AUTH, URL_SOURCE, ENV_VAR, TRANSPORT_TYPE, DEFAULT_MULTI_TENANCY, DEFAULT_SELF_SIGNED_CERTIFICATES
-};
+  DEFAULT_EMAIL_NOTE, REPORT_TYPE, SELECTOR, FORMAT, AUTH, URL_SOURCE, ENV_VAR, TRANSPORT_TYPE, DEFAULT_MULTI_TENANCY, DEFAULT_SELF_SIGNED_CERTIFICATES, DEFAULT_TIMEOUT
+};

src/download-helpers.js

@@ -10,7 +10,7 @@ const exit = require('process');
 const ora = require('ora');
 const spinner = ora('');
 
-module.exports = async function downloadReport(url, format, width, height, filename, authType, username, password, tenant, multitenancy, time, transport, emailbody) {
+module.exports = async function downloadReport(url, format, width, height, filename, authType, username, password, tenant, multitenancy, time, transport, emailbody, timeout) {
   spinner.start('Connecting to url ' + url);
   try {
     const browser = await puppeteer.launch({
@@ -32,13 +32,12 @@ module.exports = async function downloadReport(url, format, width, height, filen
         TZ: process.env.TZ || 'UTC',
       },
     });
-
     const page = await browser.newPage();
     const overridePage = await browser.newPage();
     page.setDefaultNavigationTimeout(0);
-    page.setDefaultTimeout(300000);
+    page.setDefaultTimeout(timeout);
     overridePage.setDefaultNavigationTimeout(0);
-    overridePage.setDefaultTimeout(300000);
+    overridePage.setDefaultTimeout(timeout);
 
     // auth 
     if (authType !== undefined && authType !== AUTH.NONE && username !== undefined && password !== undefined) {
@@ -95,7 +94,7 @@ module.exports = async function downloadReport(url, format, width, height, filen
 
     // force wait for any resize to load after the above DOM modification.
     await new Promise(resolve => setTimeout(resolve, 2000));
-    await waitForDynamicContent(page);
+    await waitForDynamicContent(page, timeout);
     let buffer;
     spinner.text = `Downloading Report...`;
 
@@ -155,7 +154,7 @@ module.exports = async function downloadReport(url, format, width, height, filen
 
 const waitForDynamicContent = async (
   page,
-  timeout = 30000,
+  timeout = timeout,
   interval = 1000,
   checks = 5
 ) => {
@@ -257,7 +256,7 @@ const samlAuthentication = async (page, url, username, password, tenant, multite
   await page.type('[name="identifier"]', username);
   await page.type('[name="credentials.passcode"]', password);
   await page.click('[value="Sign in"]')
-  await page.waitForTimeout(30000);
+  await page.waitForTimeout(timeout);
   try {
     if (multitenancy === true) {
       if (tenant === 'global' || tenant === 'private') {
@@ -291,7 +290,7 @@ const cognitoAuthentication = async (page, overridePage, url, username, password
   await page.type('[name="username"]', username);
   await page.type('[name="password"]', password);
   await page.click('[name="signInSubmitButton"]');
-  await page.waitForTimeout(30000);
+  await page.waitForTimeout(timeout);
   try {
     if (multitenancy === true) {
       if (tenant === 'global' || tenant === 'private') {

src/run.js

@@ -27,7 +27,8 @@ module.exports = async function run(args) {
         options.multitenancy,
         options.time,
         options.transport,
-        options.emailbody
+        options.emailbody,
+        options.timeout
     );
 
     await sendEmail(

test/help.test.js

@@ -34,6 +34,7 @@ Options:
   --subject <subject>                    email subject (default: "This is an email containing your opensearch dashboard report", env: OPENSEARCH_EMAIL_SUBJECT)
   --note <note>                          email body (string or path to text file) (default: "Hi,\\nHere is the latest report!", env: OPENSEARCH_EMAIL_NOTE)
   --selfsignedcerts <flag>               enable or disable self-signed certicates for smtp transport (choices: "true", "false", default: false)
+  --timeout <timeout>                    timeout for generating report in ms (default: 300000, env: OPENSEARCH_TIMEOUT)
   -h, --help                             display help for command
 
 Note: The tenant in the url has the higher priority than tenant value provided as command option.