Merge pull request #848 from 07souravkunda/fix_o11y_timeouts

Fix o11y timeouts

Author: pranavj1001

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_QUEUES_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');
@@ -114,7 +114,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) {

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_QUEUES_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

@@ -186,7 +186,6 @@ class MyReporter {
         }
 
         await this.uploadTestSteps();
-        await requestQueueHandler.shutdown();
       });
   }