Resolving comments

Author: rishigupta1599

lib/core/CustomRequestHandler.js

@@ -2,13 +2,17 @@
 
 const logger = require('../util/loggerFactory');
 
-/*
-This class handles the custom requests made to existing playwright connection.
-This is kept as Singleton class because we want to maintain a map of commands for which
-we can resolve the response once we receive from Playwright server.
-Please don't change the singleton behaviour of this class.
-*/
+/**
+ * Handles the custom requests made to existing playwright connection.
+ * This class is implemented as a Singleton to maintain a map of commands for which
+ * responses can be resolved once received from the Playwright server.
+ * @class
+ */
 class CustomRequestHandler {
+  /**
+   * Creates an instance of CustomRequestHandler.
+   * @constructor
+   */
   constructor() {
     if (!CustomRequestHandler.instance) {
       // Initialize the instance if it doesn't exist
@@ -19,7 +23,11 @@ class CustomRequestHandler {
     // Return the existing instance if it already exists
     return CustomRequestHandler.instance;
   }
-  // Static method to get the single instance of the class
+
+  /**
+   * Static method to get the single instance of the class.
+   * @returns {CustomRequestHandler} The single instance of the CustomRequestHandler class.
+   */
   static getInstance() {
     if (!CustomRequestHandler.instance) {
       // Create a new instance if it doesn't exist
@@ -29,6 +37,10 @@ class CustomRequestHandler {
     return CustomRequestHandler.instance;
   }
 
+  /**
+   * Checks if the custom request list is empty.
+   * @returns {boolean} Returns true if the custom request list is empty, otherwise false.
+   */
   isCustomRequestListEmpty() {
     for (const prop in this.customRequestList) {
       if (this.customRequestList.hasOwnProperty(prop)) {
@@ -39,11 +51,10 @@ class CustomRequestHandler {
     return true;
   }
 
-  // only for specs purpose, don't use it in code.
-  static resetInstance() {
-    CustomRequestHandler.instance = null;
-  }
-  // Method to add an item to the list
+  /**
+   * Adds an item to the custom request list.
+   * @param {string} request_id - The ID of the request to be added.
+   */
   addCustomRequest(request_id) {
     let resolveFunc;
     let rejectFunc;
@@ -58,9 +69,23 @@ class CustomRequestHandler {
     };
     logger.info(`Added request '${request_id}' to the customRequestList.`);
   }
-  // Method to get the list items
+
+  /**
+   * Gets the items in the custom request list.
+   * @returns {Object} The custom request list.
+   */
   getList() {
     return this.customRequestList;
   }
+
+  /**
+   * Resets the instance of the CustomRequestHandler class.
+   * Only for testing purposes. Do not use it in production code.
+   * @static
+   */
+  static resetInstance() {
+    CustomRequestHandler.instance = null;
+  }
 }
+
 module.exports = CustomRequestHandler;

lib/core/Proxy.js

@@ -23,6 +23,11 @@ const AlertManager = require('../util/AlertManager');
 const Instrumentation = require('../util/Instrumentation');
 const ErrorHandler = require('../util/ErrorHandler');
 const CustomRequestHandler = require('./CustomRequestHandler');
+const responseHeaders = {
+  'content-type': 'application/json; charset=utf-8',
+  accept: 'application/json',
+  'WWW-Authenticate': 'Basic realm="WS Reconnect Proxy"',
+}
 
 /**
  * Proxy is the entrypoint and instantiates the context among the socket connection.
@@ -111,32 +116,20 @@ class Proxy {
           customReqInstance.customRequestList[commandId].promise
             .then((result) => {
               delete customReqInstance.customRequestList[commandId];
-              response.writeHead(200, {
-                'content-type': 'application/json; charset=utf-8',
-                accept: 'application/json',
-                'WWW-Authenticate': 'Basic realm="WS Reconnect Proxy"',
-              });
+              response.writeHead(200, responseHeaders);
               response.end(
                 JSON.stringify({ status: 'success', value: result })
               );
             })
             .catch((err) => {
               delete customReqInstance.customRequestList[commandId];
-              response.writeHead(500, {
-                'content-type': 'application/json; charset=utf-8',
-                accept: 'application/json',
-                'WWW-Authenticate': 'Basic realm="WS Reconnect Proxy"',
-              });
+              response.writeHead(500, responseHeaders);
               response.end(JSON.stringify({ status: 'failure', value: err }));
             });
         });
       } catch (err) {
         logger.error(`Error while handling custom request ${err}`);
-        response.writeHead(500, {
-          'content-type': 'application/json; charset=utf-8',
-          accept: 'application/json',
-          'WWW-Authenticate': 'Basic realm="WS Reconnect Proxy"',
-        });
+        response.writeHead(500, responseHeaders);
         response.end(JSON.stringify({ status: 'failure', value: err.message }));
       }
       return;

test/core/proxy.test.js

@@ -8,6 +8,11 @@ const http = require('http');
 const { assert } = require('console');
 const proxyquire = require('proxyquire');
 const CustomRequestHandler = require('../../lib/core/CustomRequestHandler');
+const responseHeaders = {
+  'content-type': 'application/json; charset=utf-8',
+  accept: 'application/json',
+  'WWW-Authenticate': 'Basic realm="WS Reconnect Proxy"',
+};
 
 describe('Proxy', () => {
   before(() => {
@@ -146,11 +151,7 @@ describe('Proxy', () => {
       );
       setTimeout(() => {
         assertChai.isTrue(
-          responseMock.writeHead.calledOnceWith(200, {
-            'content-type': 'application/json; charset=utf-8',
-            accept: 'application/json',
-            'WWW-Authenticate': 'Basic realm="WS Reconnect Proxy"',
-          })
+          responseMock.writeHead.calledOnceWith(200, responseHeaders)
         );
         assertChai.isTrue(
           responseMock.end.calledOnceWith(
@@ -218,11 +219,7 @@ describe('Proxy', () => {
       );
       setTimeout(() => {
         assertChai.isTrue(
-          responseMock.writeHead.calledOnceWith(500, {
-            'content-type': 'application/json; charset=utf-8',
-            accept: 'application/json',
-            'WWW-Authenticate': 'Basic realm="WS Reconnect Proxy"',
-          })
+          responseMock.writeHead.calledOnceWith(500, responseHeaders)
         );
         assertChai.isTrue(
           responseMock.end.calledOnceWith(
@@ -248,11 +245,7 @@ describe('Proxy', () => {
 
       // Assertions for the outer catch block
       assertChai.isTrue(
-        responseMock.writeHead.calledOnceWith(500, {
-          'content-type': 'application/json; charset=utf-8',
-          accept: 'application/json',
-          'WWW-Authenticate': 'Basic realm="WS Reconnect Proxy"',
-        })
+        responseMock.writeHead.calledOnceWith(500, responseHeaders)
       );
       assertChai.isTrue(
         responseMock.end.calledOnceWith(
@@ -273,11 +266,7 @@ describe('Proxy', () => {
     this.proxy.requestHandler(request, this.response);
     expect(this.response.writeHead.calledOnce).to.be.equal(true);
     assert(
-      this.response.writeHead.calledWith(200, {
-        'content-type': 'application/json; charset=utf-8',
-        accept: 'application/json',
-        'WWW-Authenticate': 'Basic realm="WS Reconnect Proxy"',
-      })
+      this.response.writeHead.calledWith(200, responseHeaders)
     );
     expect(this.response.end.calledOnce).to.be.equal(true);
     assert(