improve message for allowExpressions=false (#270)

ofrobots · web-flow · commit 14fee8277e88 · 2017-06-05T22:35:17.000-07:00
diff --git a/src/agent/debuglet.js b/src/agent/debuglet.js
@@ -39,7 +39,8 @@ var pjson = require('../../package.json');
 var assert = require('assert');
 
 var ALLOW_EXPRESSIONS_MESSAGE = 'Expressions and conditions are not allowed' +
-  ' by default. Please set the allowExpressions configuration option to true';
+  ' by default. Please set the allowExpressions configuration option to true.' +
+  ' See the debug agent documentation at https://goo.gl/ShSm6r.';
 var NODE_VERSION_MESSAGE = 'Node.js version not supported. Node.js 5.2.0 and ' +
   ' versions older than 0.12 are not supported.';
 var BREAKPOINT_ACTION_MESSAGE = 'The only currently supported breakpoint actions' +
@@ -285,7 +286,7 @@ Debuglet.createDebuggee =
   if (!description && process.env.FUNCTION_NAME) {
     description = 'Function: ' + process.env.FUNCTION_NAME;
   }
-  
+
   if (description) {
     desc += ' description:' + description;
   }
diff --git a/test/test-debuglet.js b/test/test-debuglet.js
@@ -31,6 +31,8 @@ var DEBUGGEE_ID = 'bar';
 var API = 'https://clouddebugger.googleapis.com';
 var REGISTER_PATH = '/v2/controller/debuggees/register';
 var BPS_PATH = '/v2/controller/debuggees/' + DEBUGGEE_ID + '/breakpoints';
+var EXPRESSIONS_REGEX =
+    /Expressions and conditions are not allowed.*https:\/\/goo\.gl\/ShSm6r/;
 
 var fakeCredentials = require('./fixtures/gcloud-credentials.json');
 
@@ -53,6 +55,12 @@ var errorBp = {
   location: {path: 'fixtures/foo.js', line: 2}
 };
 
+function verifyBreakpointRejection(re, body) {
+  var status = body.breakpoint.status;
+  var hasCorrectDescription = status.description.format.match(re);
+  return status.isError && hasCorrectDescription;
+}
+
 describe('Debuglet', function() {
   describe('setup', function() {
     before(function() { oldGP = process.env.GCLOUD_PROJECT; });
@@ -529,23 +537,20 @@ describe('Debuglet', function() {
       debuglet.config_.allowExpressions = false;
 
       var scope = nock(API)
-                      .post(REGISTER_PATH)
-                      .reply(200, {debuggee: {id: DEBUGGEE_ID}})
-                      .get(BPS_PATH + '?success_on_timeout=true')
-                      .reply(200, {breakpoints: [{
-                        id: 'test',
-                        action: 'CAPTURE',
-                        condition: 'x === 5',
-                        location: {path: 'fixtures/foo.js', line: 2}
-                      }]})
-                      .put(BPS_PATH + '/test',
-                           function(body) {
-                             var status = body.breakpoint.status;
-                             var hasCorrectDescription = status.description.format.indexOf(
-                                'Expressions and conditions are not allowed by default.') === 0;
-                             return status.isError && hasCorrectDescription;
-                           })
-                      .reply(200);
+        .post(REGISTER_PATH)
+        .reply(200, { debuggee: { id: DEBUGGEE_ID } })
+        .get(BPS_PATH + '?success_on_timeout=true')
+        .reply(200, {
+          breakpoints: [{
+            id: 'test',
+            action: 'CAPTURE',
+            condition: 'x === 5',
+            location: { path: 'fixtures/foo.js', line: 2 }
+          }]
+        })
+        .put(BPS_PATH + '/test',
+             verifyBreakpointRejection.bind(null, EXPRESSIONS_REGEX))
+        .reply(200);
 
       debuglet.once('registered', function reg(id) {
         assert.equal(id, DEBUGGEE_ID);
@@ -570,23 +575,20 @@ describe('Debuglet', function() {
       debuglet.config_.allowExpressions = false;
 
       var scope = nock(API)
-                      .post(REGISTER_PATH)
-                      .reply(200, {debuggee: {id: DEBUGGEE_ID}})
-                      .get(BPS_PATH + '?success_on_timeout=true')
-                      .reply(200, {breakpoints: [{
-                        id: 'test',
-                        action: 'CAPTURE',
-                        expressions: ['x'],
-                        location: {path: 'fixtures/foo.js', line: 2}
-                      }]})
-                      .put(BPS_PATH + '/test',
-                           function(body) {
-                             var status = body.breakpoint.status;
-                             var hasCorrectDescription = status.description.format.indexOf(
-                                'Expressions and conditions are not allowed by default.') === 0;
-                             return status.isError && hasCorrectDescription;
-                           })
-                      .reply(200);
+        .post(REGISTER_PATH)
+        .reply(200, { debuggee: { id: DEBUGGEE_ID } })
+        .get(BPS_PATH + '?success_on_timeout=true')
+        .reply(200, {
+          breakpoints: [{
+            id: 'test',
+            action: 'CAPTURE',
+            expressions: ['x'],
+            location: { path: 'fixtures/foo.js', line: 2 }
+          }]
+        })
+        .put(BPS_PATH + '/test',
+             verifyBreakpointRejection.bind(null, EXPRESSIONS_REGEX))
+        .reply(200);
 
       debuglet.once('registered', function reg(id) {
         assert.equal(id, DEBUGGEE_ID);
