chore: comments

Author: 07souravkunda

bin/testObservability/helper/cleanupQueueSync.js

@@ -1,3 +1,7 @@
+/**
+ * Sending all the remaining queues for synchronous manner
+ */
+
 const RequestQueueHandler = require('./requestQueueHandler');
 
 const shutdown = async () => {

bin/testObservability/helper/constants.js

@@ -33,4 +33,4 @@ exports.TEST_OBSERVABILITY_REPORTER = 'browserstack-cypress-cli/bin/testObservab
 
 exports.TEST_OBSERVABILITY_REPORTER_LOCAL = path.join(__dirname, '..', 'reporter');
 
-exports.PENDING_QUEUS_FILE = 'pending_queus.json';
+exports.PENDING_QUEUS_FILE = `pending_queus_${process.pid}.json`;

bin/testObservability/helper/requestQueueHandler.js

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

bin/testObservability/plugin/ipcServer.js

@@ -27,6 +27,8 @@ 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();
     });