fix: use debuglet's logger in the controller. (#1077)

This will provide a consistent log level throughout the codebase.
googleapis · May 11, 2022 · c236f35 · c236f35
1 parent dd61d35
commit c236f35
Show file tree

Hide file tree

Showing 4 changed files with 64 additions and 21 deletions.
diff --git a/src/agent/debuglet.ts b/src/agent/debuglet.ts
@@ -449,7 +449,11 @@ export class Debuglet extends EventEmitter {
         this.emit('initError', err);
         return;
       }
-      this.controller = new OnePlatformController(this.debug, this.config);
+      this.controller = new OnePlatformController(
+        this.debug,
+        this.config,
+        this.logger
+      );
     }
 
     if (

diff --git a/src/agent/oneplatform-controller.ts b/src/agent/oneplatform-controller.ts
@@ -18,7 +18,6 @@
 
 import {ServiceObject} from '@google-cloud/common';
 import * as assert from 'assert';
-import * as consoleLogLevel from 'console-log-level';
 import * as qs from 'querystring';
 import * as t from 'teeny-request';
 
@@ -48,7 +47,7 @@ export class OnePlatformController extends ServiceObject implements Controller {
   /**
    * @constructor
    */
-  constructor(debug: Debug, config: ResolvedDebugAgentConfig) {
+  constructor(debug: Debug, config: ResolvedDebugAgentConfig, logger: Logger) {
     super({parent: debug, baseUrl: '/controller'});
 
     /** @private {string} */
@@ -61,10 +60,7 @@ export class OnePlatformController extends ServiceObject implements Controller {
     this.running = true;
 
     /** @private */
-    this.logger = consoleLogLevel({
-      stderr: true,
-      level: 'info',
-    });
+    this.logger = logger;
 
     if (config && config.apiUrl) {
       this.apiUrl = config.apiUrl + new URL(this.apiUrl).pathname;

diff --git a/system-test/test-controller.ts b/system-test/test-controller.ts
@@ -30,6 +30,7 @@ import {OnePlatformController} from '../src/agent/oneplatform-controller';
 import {Debuggee} from '../src/debuggee';
 import {Debug, PackageInfo} from '../src/client/stackdriver/debug';
 import {defaultConfig as DEFAULT_CONFIG} from '../src/agent/config';
+import {MockLogger} from '../test/mock-logger';
 
 const packageInfo: PackageInfo = {
   name: 'SomeName',
@@ -41,9 +42,10 @@ const debug = new Debug({}, packageInfo);
 
 describe('Controller', function () {
   this.timeout(60 * 1000);
+  const logger = new MockLogger();
 
   it('should register successfully', done => {
-    const controller = new OnePlatformController(debug, DEFAULT_CONFIG);
+    const controller = new OnePlatformController(debug, DEFAULT_CONFIG, logger);
     const debuggee = new Debuggee({
       project: process.env.GCLOUD_PROJECT,
       uniquifier: 'test-uid-' + Date.now(),
@@ -62,7 +64,7 @@ describe('Controller', function () {
   });
 
   it('should list breakpoints', done => {
-    const controller = new OnePlatformController(debug, DEFAULT_CONFIG);
+    const controller = new OnePlatformController(debug, DEFAULT_CONFIG, logger);
     const debuggee = new Debuggee({
       project: process.env.GCLOUD_PROJECT,
       uniquifier: 'test-uid-' + Date.now(),
@@ -86,7 +88,7 @@ describe('Controller', function () {
 
   it('should pass success on timeout', done => {
     this.timeout(100000);
-    const controller = new OnePlatformController(debug, DEFAULT_CONFIG);
+    const controller = new OnePlatformController(debug, DEFAULT_CONFIG, logger);
     const debuggee = new Debuggee({
       project: process.env.GCLOUD_PROJECT,
       uniquifier: 'test-uid-' + Date.now(),

diff --git a/test/test-controller.ts b/test/test-controller.ts
@@ -22,6 +22,7 @@ import {defaultConfig as DEFAULT_CONFIG} from '../src/agent/config';
 import * as stackdriver from '../src/types/stackdriver';
 import * as t from 'teeny-request'; // types only
 import {teenyRequest} from 'teeny-request';
+import {MockLogger} from './mock-logger';
 
 // the tests in this file rely on the GCLOUD_PROJECT environment variable
 // not being set
@@ -45,6 +46,8 @@ const api = '/v2/controller';
 nock.disableNetConnect();
 
 describe('Controller API', () => {
+  const logger = new MockLogger();
+
   describe('register', () => {
     it('should get a debuggeeId', done => {
       const scope = nock(url)
@@ -59,7 +62,11 @@ describe('Controller API', () => {
         description: 'unit test',
         agentVersion,
       });
-      const controller = new OnePlatformController(fakeDebug, DEFAULT_CONFIG);
+      const controller = new OnePlatformController(
+        fakeDebug,
+        DEFAULT_CONFIG,
+        logger
+      );
       // TODO: Determine if this type signature is correct.
       controller.register(debuggee, (err, result) => {
         assert(!err, 'not expecting an error');
@@ -84,7 +91,11 @@ describe('Controller API', () => {
         description: 'unit test',
         agentVersion,
       });
-      const controller = new OnePlatformController(fakeDebug, DEFAULT_CONFIG);
+      const controller = new OnePlatformController(
+        fakeDebug,
+        DEFAULT_CONFIG,
+        logger
+      );
       // TODO: Determine if this type signature is correct.
       controller.register(debuggee, (err, result) => {
         assert(!err, 'not expecting an error');
@@ -108,7 +119,11 @@ describe('Controller API', () => {
         description: 'unit test',
         agentVersion,
       });
-      const controller = new OnePlatformController(fakeDebug, DEFAULT_CONFIG);
+      const controller = new OnePlatformController(
+        fakeDebug,
+        DEFAULT_CONFIG,
+        logger
+      );
       controller.register(debuggee, (err, result) => {
         // TODO: Fix this incorrect method signature.
         (assert as {ifError: Function}).ifError(err, 'not expecting an error');
@@ -136,7 +151,11 @@ describe('Controller API', () => {
         description: 'unit test',
         agentVersion,
       });
-      const controller = new OnePlatformController(fakeDebug, DEFAULT_CONFIG);
+      const controller = new OnePlatformController(
+        fakeDebug,
+        DEFAULT_CONFIG,
+        logger
+      );
       controller.register(debuggee, (err /*, result*/) => {
         assert.ifError(err);
         done();
@@ -149,7 +168,11 @@ describe('Controller API', () => {
         .reply(200, {kind: 'whatever'});
 
       const debuggee = {id: 'fake-debuggee'};
-      const controller = new OnePlatformController(fakeDebug, DEFAULT_CONFIG);
+      const controller = new OnePlatformController(
+        fakeDebug,
+        DEFAULT_CONFIG,
+        logger
+      );
       // TODO: Fix debuggee to actually implement Debuggee
       // TODO: Determine if the response parameter should be used.
       controller.listBreakpoints(
@@ -179,7 +202,8 @@ describe('Controller API', () => {
           const debuggee = {id: 'fake-debuggee'};
           const controller = new OnePlatformController(
             fakeDebug,
-            DEFAULT_CONFIG
+            DEFAULT_CONFIG,
+            logger
           );
           // TODO: Fix debuggee to actually implement Debuggee
           // TODO: Determine if the response parameter should be used.
@@ -206,7 +230,11 @@ describe('Controller API', () => {
         .reply(403);
       // TODO: Fix debuggee to actually implement Debuggee
       const debuggee: Debuggee = {id: 'fake-debuggee'} as Debuggee;
-      const controller = new OnePlatformController(fakeDebug, DEFAULT_CONFIG);
+      const controller = new OnePlatformController(
+        fakeDebug,
+        DEFAULT_CONFIG,
+        logger
+      );
       // TODO: Determine if the response parameter should be used.
       controller.listBreakpoints(debuggee, (err, response, result) => {
         assert(err instanceof Error, 'expecting an error');
@@ -222,7 +250,11 @@ describe('Controller API', () => {
         .reply(200, {waitExpired: true});
       // TODO: Fix debuggee to actually implement Debuggee
       const debuggee: Debuggee = {id: 'fake-debuggee'} as Debuggee;
-      const controller = new OnePlatformController(fakeDebug, DEFAULT_CONFIG);
+      const controller = new OnePlatformController(
+        fakeDebug,
+        DEFAULT_CONFIG,
+        logger
+      );
       // TODO: Determine if the result parameter should be used.
       controller.listBreakpoints(debuggee, (err, response) => {
         // TODO: Fix this incorrect method signature.
@@ -257,7 +289,11 @@ describe('Controller API', () => {
         description: 'unit test',
         agentVersion,
       });
-      const controller = new OnePlatformController(fakeDebug, DEFAULT_CONFIG);
+      const controller = new OnePlatformController(
+        fakeDebug,
+        DEFAULT_CONFIG,
+        logger
+      );
       controller.register(debuggee, (err1 /*, response1*/) => {
         assert.ifError(err1);
         const debuggeeWithId: Debuggee = {id: 'fake-debuggee'} as Debuggee;
@@ -288,7 +324,8 @@ describe('Controller API', () => {
           const debuggee: Debuggee = {id: 'fake-debuggee'} as Debuggee;
           const controller = new OnePlatformController(
             fakeDebug,
-            DEFAULT_CONFIG
+            DEFAULT_CONFIG,
+            logger
           );
           // TODO: Determine if the response parameter should be used.
           controller.listBreakpoints(debuggee, (err, response, result) => {
@@ -328,7 +365,11 @@ describe('Controller API', () => {
         });
       // TODO: Fix debuggee to actually implement Debuggee
       const debuggee: Debuggee = {id: 'fake-debuggee'} as Debuggee;
-      const controller = new OnePlatformController(fakeDebug, DEFAULT_CONFIG);
+      const controller = new OnePlatformController(
+        fakeDebug,
+        DEFAULT_CONFIG,
+        logger
+      );
       controller.updateBreakpoint(
         debuggee as Debuggee,
         breakpoint,