RQLY-448 feat: capture console logs created by programmatic modify response (#13)

feat: capture console logs created by programmatic modify response and modify request rule processor
- adds default consoleLogs  to ctx_rq_namespace
- console logs also execute in the background during interception

Author: nsrCodes

package-lock.json

@@ -19,6 +19,7 @@
     "@sentry/browser": "^6.19.2",
     "async": "^3.2.1",
     "axios": "^0.26.1",
+    "capture-console-logs": "^1.0.1",
     "charset": "^1.0.1",
     "debug": "^4.3.2",
     "httpsnippet": "^2.0.0",

package.json

@@ -33,6 +33,9 @@ class CtxRQNamespace {
       // headers,
       // body
     };
+
+    
+    this.consoleLogs = []
   }
 
   set_original_request = ({

src/components/proxy-middleware/helpers/ctx_rq_namespace.js

@@ -89,6 +89,7 @@ class LoggerMiddleware {
       ),
       requestShellCurl: this.generate_curl_from_har(ctx?.rq?.final_request?.requestHarObject), // TODO: Move this to client side
       actions: get_success_actions_from_action_results(action_result_objs),
+      consoleLogs : ctx?.rq?.consoleLogs,
       requestState
     }
     return rqLog;

src/components/proxy-middleware/middlewares/logger_middleware.js

@@ -7,6 +7,7 @@ import {
 import { get_request_url } from "../../helpers/proxy_ctx_helper";
 import { build_action_processor_response } from "../utils";
 import fs from "fs";
+import ConsoleCapture from "capture-console-logs";
 const { types } = require("util");
 
 const process_modify_request_action = (action, ctx) => {
@@ -74,12 +75,20 @@ const modify_request_using_code = async (action, ctx) => {
       /*Do nothing -- could not parse body as JSON */
     }
 
+    const consoleCapture = new ConsoleCapture()
+    consoleCapture.start(true)
+
     finalRequest = userFunction(args);
 
     if (types.isPromise(finalRequest)) {
       finalRequest = await finalRequest;
     }
 
+    consoleCapture.stop()
+    const consoleLogs = consoleCapture.getCaptures()
+
+    ctx.rq.consoleLogs.push(...consoleLogs)
+
     const isRequestJSON = !!args.requestJSON;
     if (typeof finalRequest === "object" && isRequestJSON) {
       finalRequest = JSON.stringify(finalRequest);

src/components/proxy-middleware/rule_action_processor/processors/modify_request_processor.js

@@ -8,6 +8,7 @@ import { get_request_url } from "../../helpers/proxy_ctx_helper";
 import { build_action_processor_response } from "../utils";
 import fs from "fs";
 import { parseJsonBody } from "../../helpers/http_helpers";
+import ConsoleCapture from "capture-console-logs";
 const { types } = require("util");
 
 const process_modify_response_action = async (action, ctx) => {
@@ -93,12 +94,20 @@ const modify_response_using_code = async (action, ctx) => {
       /*Do nothing -- could not parse body as JSON */
     }
 
+    const consoleCapture = new ConsoleCapture()
+    consoleCapture.start(true)
+
     finalResponse = userFunction(args);
 
     if (types.isPromise(finalResponse)) {
       finalResponse = await finalResponse;
     }
 
+    consoleCapture.stop()
+    const consoleLogs = consoleCapture.getCaptures()
+    
+    ctx.rq.consoleLogs.push(...consoleLogs)
+
     if (typeof finalResponse === "object") {
       finalResponse = JSON.stringify(finalResponse);
     }