Correct the status shown if maxDataSize is reached (#173)

DominicKramer · web-flow · commit 2a131c228f40 · 2016-11-10T21:49:11.000-08:00
If a watched expression is collected that causes the `config.capture.maxDataSize` limit to be reached, local variables may not be collected, but the status message associated with the local variable would be incorrect. In particular, if the local was an array, the message would describe that only the first `config.capture.maxProperties` items were captured. This PR corrects this so that the status message is instead 'Max data size reached'.
diff --git a/lib/state.js b/lib/state.js
@@ -218,6 +218,7 @@ StateResolver.prototype.trimVariableTable_ = function(fromIndex, frames) {
       if (variable.varTableIndex && variable.varTableIndex >= fromIndex) {
         // make it point to the sentinel 'buffer full' value
         variable.varTableIndex = BUFFER_FULL_MESSAGE_INDEX;
+        variable.status = MESSAGE_TABLE[BUFFER_FULL_MESSAGE_INDEX].status;
       }
       if (variable.members) {
         processBufferFull(variable.members);
diff --git a/test/test-v8debugapi.js b/test/test-v8debugapi.js
@@ -870,6 +870,43 @@ describe('v8debugapi', function() {
         });
     });
 
+    it('should set the correct status messages if maxDataSize is reached',
+      function(done) {
+        var bp = {
+          id: 'fake-id-124',
+          location: { path: 'test-v8debugapi.js', line: 5 },
+          expressions: ['A']
+        };
+        var oldMaxProps = config.capture.maxProperties;
+        var oldMaxData = config.capture.maxDataSize;
+        config.capture.maxProperties = 1;
+        config.capture.maxDataSize = 1;
+        api.set(bp, function(err) {
+          assert.ifError(err);
+          api.wait(bp, function(err) {
+            assert.ifError(err);
+
+            var bResults = bp.stackFrames[0].locals.filter(function(value) {
+              return value.name === 'B';
+            });
+            assert(bResults);
+            assert.strictEqual(bResults.length, 1);
+
+            var bArray = bResults[0];
+            assert(bArray);
+            assert(bArray.status.description.format.indexOf(
+              'Max data size reached') !== -1);
+            assert(bArray.status.isError);
+
+            api.clear(bp);
+            config.capture.maxDataSize = oldMaxData;
+            config.capture.maxProperties = oldMaxProps;
+            done();
+          });
+          process.nextTick(function() {foo(2);});
+        });
+    });
+
     it('should capture without values for invalid watch expressions', function(done) {
       // clone a clean breakpointInFoo
       var bp  = {

Original file line number	Diff line number	Diff line change
`@@ -218,6 +218,7 @@ StateResolver.prototype.trimVariableTable_ = function(fromIndex, frames) {`
`218`	`218`	`if (variable.varTableIndex && variable.varTableIndex >= fromIndex) {`
`219`	`219`	`// make it point to the sentinel 'buffer full' value`
`220`	`220`	`variable.varTableIndex = BUFFER_FULL_MESSAGE_INDEX;`
	`221`	`+ variable.status = MESSAGE_TABLE[BUFFER_FULL_MESSAGE_INDEX].status;`
`221`	`222`	`}`
`222`	`223`	`if (variable.members) {`
`223`	`224`	`processBufferFull(variable.members);`