Move serializeLogs option to context-level

Author: codenirvana

CHANGELOG.yaml

@@ -1,6 +1,8 @@
 unreleased:
   fixed bugs:
     - Fixed memory leak due to console listeners
+  chores:
+    - Moved `serializeLogs` option to context-level instead of per-execute
 
 4.2.3:
   date: 2023-02-22

README.md

@@ -62,7 +62,6 @@ The following section outlines the API available inside sandbox scripts
 - execution.abort.*
 - execution.response.*
 - execution.cookies.*
-- execution.console.*
 
 ## Contributing
 

lib/postman-sandbox.js

@@ -5,6 +5,7 @@ const _ = require('lodash'),
     teleportJS = require('teleport-javascript'),
 
     TO_WAIT_BUFFER = 500, // time to wait for sandbox to declare timeout
+    CONSOLE_EVENT_NAME = 'execution.console',
     EXECUTION_TIMEOUT_ERROR_MESSAGE = 'sandbox not responding',
     BRIDGE_DISCONNECTING_ERROR_MESSAGE = 'sandbox: execution interrupted, bridge disconnecting.';
 
@@ -31,6 +32,14 @@ class PostmanSandbox extends UniversalVM {
             if (err) { return callback(err); }
 
             this.once('initialize', (err) => {
+                this.on(CONSOLE_EVENT_NAME, (cursor, level, args) => {
+                    if (connectOptions.serializeLogs) {
+                        return this.emit('console', cursor, level, args);
+                    }
+
+                    this.emit('console', cursor, level, ...teleportJS.parse(args));
+                });
+
                 // eslint-disable-next-line callback-return
                 callback(err, context);
                 context = null;
@@ -81,7 +90,6 @@ class PostmanSandbox extends UniversalVM {
         }
 
         const id = _.isString(options.id) ? options.id : uuid(),
-            consoleEventName = 'execution.console',
             executionEventName = 'execution.result.' + id,
             executionTimeout = _.get(options, 'timeout', this.executionTimeout),
             cursor = _.clone(_.get(options, 'cursor', {})), // clone the cursor as it travels through IPC for mutation
@@ -109,19 +117,10 @@ class PostmanSandbox extends UniversalVM {
                 delete this._executing[id];
             }
 
-            this.removeAllListeners(consoleEventName);
             this.emit('execution', err, id, result);
             callback(err, result);
         });
 
-        this.on(consoleEventName, (cursor, level, args) => {
-            if (_.get(options, 'serializeLogs')) {
-                return this.emit('console', cursor, level, args);
-            }
-
-            this.emit('console', cursor, level, ...teleportJS.parse(args));
-        });
-
         // send the code to the sandbox to be intercepted and executed
         this.dispatch('execute', id, target, _.get(options, 'context', {}), {
             cursor: cursor,
@@ -143,6 +142,7 @@ class PostmanSandbox extends UniversalVM {
             this.emit('execution.result.' + id, new Error(BRIDGE_DISCONNECTING_ERROR_MESSAGE));
         });
 
+        this.removeAllListeners(CONSOLE_EVENT_NAME);
         this.disconnect();
     }
 }

test/unit/sandbox-console.test.js

@@ -238,7 +238,7 @@ describe('console inside sandbox', function () {
     });
 
     it('should allow sending serialized logs', function (done) {
-        Sandbox.createContext({}, function (err, ctx) {
+        Sandbox.createContext({ serializeLogs: true }, function (err, ctx) {
             var logsData = {
                     undef: undefined,
                     str: 'string'
@@ -255,9 +255,7 @@ describe('console inside sandbox', function () {
                 consoleEventArgs = arguments;
             });
 
-            ctx.execute('console.log({ undef: undefined, str: "string" });', {
-                serializeLogs: true
-            }, function (err) {
+            ctx.execute('console.log({ undef: undefined, str: "string" });', {}, function (err) {
                 if (err) {
                     return done(err);
                 }
@@ -300,7 +298,7 @@ describe('console inside sandbox', function () {
     });
 
     it('should allow calling console.log without arguments with serializeLogs options set', function (done) {
-        Sandbox.createContext({}, function (err, ctx) {
+        Sandbox.createContext({ serializeLogs: true }, function (err, ctx) {
             var consoleEventArgs;
 
             if (err) {
@@ -312,9 +310,7 @@ describe('console inside sandbox', function () {
                 consoleEventArgs = arguments;
             });
 
-            ctx.execute('console.log();', {
-                serializeLogs: true
-            }, function (err) {
+            ctx.execute('console.log();', {}, function (err) {
                 if (err) {
                     return done(err);
                 }