Elaborate on async stack trace warning (#340)

gaofanmichael · web-flow · commit 964cc31a0f26 · 2017-10-20T11:33:43.000-07:00
Since async_stack_traces is disabled on 32 bit platform, a warning message was emitted from node runtime. This PR elaborates the reason for the warning and lets user to ignore the warning.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/agent/debuglet.ts b/src/agent/debuglet.ts
@@ -30,6 +30,7 @@ import * as _ from 'lodash';
 import * as path from 'path';
 import * as semver from 'semver';
 import * as util from 'util';
+import * as utils from './util/utils';
 import * as http from 'http';
 
 import {Controller} from './controller';
@@ -206,6 +207,13 @@ export class Debuglet extends EventEmitter {
    */
   async start(): Promise<void> {
     const that = this;
+    process.on('warning', (warning) => {
+      if ((warning as any).code ===
+          'INSPECTOR_ASYNC_STACK_TRACES_NOT_AVAILABLE') {
+        that.logger_.info(utils.messages.ASYNC_TRACES_WARNING);
+      }
+    });
+
     const stat = promisify(fs.stat);
 
     try {
diff --git a/src/agent/util/utils.ts b/src/agent/util/utils.ts
@@ -24,7 +24,11 @@ export const messages = {
   CAPTURE_BREAKPOINT_DATA: 'Error trying to capture snapshot data: ',
   INVALID_LINE_NUMBER: 'Invalid snapshot position: ',
   COULD_NOT_FIND_OUTPUT_FILE:
-      'Could not determine the output file associated with the transpiled input file'
+      'Could not determine the output file associated with the transpiled input file',
+  ASYNC_TRACES_WARNING:
+      'The Stackdriver Debugger for Node.js does not require V8 Inspector ' +
+      'async stack traces. The INSPECTOR_ASYNC_STACK_TRACES_NOT_AVAILABLE ' +
+      'can be ignored.'
 };
 
 export interface Listener {
diff --git a/test/test-debuglet.ts b/test/test-debuglet.ts
@@ -17,6 +17,7 @@
 import * as stackdriver from '../src/types/stackdriver';
 import {DebugAgentConfig} from '../src/agent/config';
 import {Debuggee} from '../src/debuggee';
+import * as semver from 'semver';
 
 import * as _ from 'lodash';
 import * as path from 'path';
@@ -29,6 +30,7 @@ import * as dns from 'dns';
 import * as extend from 'extend';
 const metadata: {project: any, instance: any} = require('gcp-metadata');
 import {Debug} from '../src/client/stackdriver/debug';
+import * as utils from '../src/agent/util/utils'
 
 const DEBUGGEE_ID = 'bar';
 const API = 'https://clouddebugger.googleapis.com';
@@ -289,16 +291,19 @@ describe('Debuglet', function() {
   });
 
   describe('setup', function() {
-    before(function() { oldGP = process.env.GCLOUD_PROJECT; });
+    before(function() {
+      oldGP = process.env.GCLOUD_PROJECT;
+    });
 
     after(function() { process.env.GCLOUD_PROJECT = oldGP; });
-
     beforeEach(function() {
       delete process.env.GCLOUD_PROJECT;
       nocks.oauth2();
     });
 
-    afterEach(function() { nock.cleanAll(); });
+    afterEach(function() {
+      nock.cleanAll();
+    });
 
     it('should merge config correctly', function() {
       const testValue = 2 * defaultConfig.capture.maxExpandFrames;
@@ -315,6 +320,40 @@ describe('Debuglet', function() {
       assert.deepEqual(mergedConfig, compareConfig);
     });
 
+    it('should elaborate on inspector warning on 32 bit but not on 64 bit',
+        function(done) {
+      const projectId = '11020304f2934-a';
+      const debug = new Debug(
+          {projectId: projectId, credentials: fakeCredentials});
+      const debuglet = new Debuglet(debug, defaultConfig);
+      let logText = '';
+      debuglet.logger_.info = function(s: string) {
+        logText += s;
+      };
+      nocks.projectId('project-via-metadata');
+      const scope = nock(API)
+                      .post(REGISTER_PATH)
+                      .reply(200, {debuggee: {id: DEBUGGEE_ID}});
+
+      debuglet.once('registered', function(id: string) {
+        assert.equal(id, DEBUGGEE_ID);
+        // TODO: Handle the case where debuglet.debuggee is undefined
+        assert.equal((debuglet.debuggee_ as Debuggee).project, projectId);
+        const arch = process.arch;
+        if (semver.satisfies(process.version, '>=8.5') &&
+            (arch === 'ia32' || arch === 'x86')) {
+          assert(logText.includes(utils.messages.ASYNC_TRACES_WARNING));
+        } else {
+          assert(!logText.includes(utils.messages.ASYNC_TRACES_WARNING));
+        }
+        debuglet.stop();
+        scope.done();
+        done();
+      });
+
+      debuglet.start();
+    });
+
     it('should not start when projectId is not available', function(done) {
       const savedGetProjectId = Debuglet.getProjectId;
       Debuglet.getProjectId = () => {
