Fix o11y timeouts

bin/testObservability/helper/cleanupQueueSync.js

@@ -0,0 +1,13 @@
+/**
+ * Sending all the remaining queues for synchronous manner
+ */
+
+const RequestQueueHandler = require('./requestQueueHandler');
+
+const shutdown = async () => {
+  const requestHandler = new RequestQueueHandler();
+  requestHandler.queue = require(process.argv[2].trim());
+  await requestHandler.shutdown();
+}
+
+shutdown();

bin/testObservability/helper/constants.js

@@ -32,3 +32,5 @@ exports.OBSERVABILITY_ENV_VARS = [
 exports.TEST_OBSERVABILITY_REPORTER = 'browserstack-cypress-cli/bin/testObservability/reporter';
 
 exports.TEST_OBSERVABILITY_REPORTER_LOCAL = path.join(__dirname, '..', 'reporter');
+
+exports.PENDING_QUEUS_FILE = `pending_queues_${process.pid}.json`;

bin/testObservability/helper/helper.js

@@ -2,7 +2,7 @@ const fs = require('fs');
 const path = require('path');
 const http = require('http');
 const https = require('https');
-const request = require('request');
+const request = require('requestretry');
 const { v4: uuidv4 } = require('uuid');
 const os = require('os');
 const { promisify } = require('util');
@@ -17,6 +17,8 @@ const logger = require("../../helpers/logger").winstonLogger;
 const utils = require('../../helpers/utils');
 const helper = require('../../helpers/helper');
 
+const util = require('util');
+
 const CrashReporter = require('../crashReporter');
 
 // Getting global packages path
@@ -114,7 +116,8 @@ const nodeRequest = (type, url, data, config) => {
       url: `${API_URL}/${url}`,
       body: data,
       json: config.headers['Content-Type'] === 'application/json',
-      agent: this.httpsKeepAliveAgent
+      agent: this.httpsKeepAliveAgent,
+      maxAttempts: 2
     }};
 
     if(url === exports.requestQueueHandler.screenshotEventUrl) {
@@ -127,7 +130,7 @@ const nodeRequest = (type, url, data, config) => {
       } else if(response.statusCode != 200) {
         reject(response && response.body ? response.body : `Received response from BrowserStack Server with status : ${response.statusCode}`);
       } else {
-        try {
+        try {          
           if(typeof(body) !== 'object') body = JSON.parse(body);
         } catch(e) {
           if(!url.includes('/stop')) {
@@ -142,6 +145,8 @@ const nodeRequest = (type, url, data, config) => {
   });
 }
 
+exports.nodeRequest = nodeRequest;
+
 exports.failureData = (errors,tag) => {
   if(!errors) return [];
   try {

bin/testObservability/helper/requestQueueHandler.js

@@ -1,5 +1,9 @@
-const { BATCH_SIZE, BATCH_INTERVAL, consoleHolder } = require('./constants');
-const { debug, batchAndPostEvents } = require('./helper');
+const fs = require('fs');
+const cp = require('child_process');
+const path = require('path');
+
+const { BATCH_SIZE, BATCH_INTERVAL, PENDING_QUEUES_FILE } = require('./constants');
+const { batchAndPostEvents } = require('./helper');
 
 class RequestQueueHandler {
   constructor() {
@@ -48,6 +52,15 @@ class RequestQueueHandler {
     }
   }
 
+  shutdownSync = () => {
+    this.removeEventBatchPolling('REMOVING');
+
+    fs.writeFileSync(path.join(__dirname, PENDING_QUEUES_FILE), JSON.stringify(this.queue));
+    this.queue = [];
+    cp.spawnSync('node', [path.join(__dirname, 'cleanupQueueSync.js'), path.join(__dirname, PENDING_QUEUS_FILE)], {stdio: 'inherit'});
+    fs.unlinkSync(path.join(__dirname, PENDING_QUEUES_FILE));
+  }
+
   shutdown = async () => {
     this.removeEventBatchPolling('REMOVING');
     while(this.queue.length > 0) {

bin/testObservability/plugin/ipcServer.js

@@ -1,5 +1,6 @@
 const ipc = require('node-ipc');
 const { consoleHolder } = require('../helper/constants');
+const { requestQueueHandler } = require('../helper/helper');
 
 exports.startIPCServer = (subscribeServerEvents, unsubscribeServerEvents) => {
   if (ipc.server) {
@@ -26,6 +27,9 @@ exports.startIPCServer = (subscribeServerEvents, unsubscribeServerEvents) => {
     process.on('exit', () => {
       unsubscribeServerEvents(ipc.server);
       ipc.server.stop();
+      // Cleaning up all remaining event in request queue handler. Any synchronous operations
+      // on exit handler will block the process
+      requestQueueHandler.shutdownSync();
     });
 
   });

bin/testObservability/reporter/index.js

@@ -15,6 +15,8 @@ const { v4: uuidv4 } = require('uuid');
 const { IPC_EVENTS } = require('../helper/constants');
 const { startIPCServer } = require('../plugin/ipcServer');
 
+const ipc = require('node-ipc');
+
 const HOOK_TYPES_MAP = {
   "before all": "BEFORE_ALL",
   "after all": "AFTER_ALL",
@@ -186,7 +188,6 @@ class MyReporter {
         }
 
         await this.uploadTestSteps();
-        await requestQueueHandler.shutdown();
       });
   }
 
@@ -199,6 +200,7 @@ class MyReporter {
         server.on(IPC_EVENTS.COMMAND, this.cypressCommandListener.bind(this));
         server.on(IPC_EVENTS.CUCUMBER, this.cypressCucumberStepListener.bind(this));
         server.on(IPC_EVENTS.PLATFORM_DETAILS, this.cypressPlatformDetailsListener.bind(this));
+        this.ipcServer = server;
       },
       (server) => {
         server.off(IPC_EVENTS.CONFIG, '*');
@@ -213,7 +215,7 @@ class MyReporter {
       const lastTest = this.current_test;
       this.current_test = test;
       test.retryOf = null;
-      test.testAnalyticsId = uuidv4();
+      test.testAnalyticsId = uuidv4()
       test.started_at = (new Date()).toISOString();
       test.test_started_at = test.started_at;
       if(test._currentRetry > 0 && lastTest && lastTest.title == test.title) {