Merge pull request #1423 from AzureAD/msal-node-logging

[msal-node] add DEBUG logging

Author: sameerag

lib/msal-common/package-lock.json

@@ -63,6 +63,7 @@
         "@rollup/plugin-json": "^4.0.0",
         "@types/chai": "^4.2.5",
         "@types/chai-as-promised": "^7.1.2",
+        "@types/debug": "^4.1.5",
         "@types/mocha": "^5.2.7",
         "@types/sinon": "^7.5.0",
         "@typescript-eslint/eslint-plugin": "^2.4.0",
@@ -85,5 +86,7 @@
         "tslint": "^5.20.0",
         "typescript": "^3.7.5"
     },
-    "dependencies": {}
+    "dependencies": {
+        "debug": "^4.1.1"
+    }
 }

lib/msal-common/package.json

@@ -47,6 +47,7 @@ export class AuthorizationCodeClient extends BaseClient {
      */
     async acquireToken(request: AuthorizationCodeRequest): Promise<string> {
 
+        this.logger.info("in acquireToken call");
         const authority: Authority = await this.createAuthority(request && request.authority);
         const response = await this.executeTokenRequest(authority, request);
         return JSON.stringify(response.body);

lib/msal-common/src/client/AuthorizationCodeClient.ts

@@ -86,8 +86,7 @@ const DEFAULT_SYSTEM_OPTIONS: SystemOptions = {
 // Default logger implementation
 const DEFAULT_LOGGER_IMPLEMENTATION: LoggerOptions = {
     loggerCallback: () => {
-        const notImplErr = "Logger - loggerCallbackInterface() has not been implemented.";
-        throw AuthError.createUnexpectedError(notImplErr);
+        // allow users to not set loggerCallback
     },
     piiLoggingEnabled: false,
     logLevel: LogLevel.Info

lib/msal-common/src/config/Configuration.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 import pkg from "../../package.json";
+import debug from "debug";
 import { StringUtils } from "../utils/StringUtils";
 import { LoggerOptions } from "../config/Configuration";
 
@@ -12,7 +13,8 @@ import { LoggerOptions } from "../config/Configuration";
 export type LoggerMessageOptions = {
     logLevel: LogLevel,
     correlationId?: string,
-    containsPii?: boolean
+    containsPii?: boolean,
+    context?: string
 };
 
 /**
@@ -67,6 +69,7 @@ export class Logger {
         const timestamp = new Date().toUTCString();
         const logHeader: string = StringUtils.isEmpty(this.correlationId) ? `[${timestamp}] : ` : `[${timestamp}] : [${this.correlationId}]`;
         const log = `${logHeader} : ${pkg.version} : ${LogLevel[options.logLevel]} - ${logMessage}`;
+        debug(`msal:${LogLevel[options.logLevel]}${options.containsPii ? "-Pii": ""}${options.context ? `:${options.context}` : ""}`)(logMessage);
         this.executeCallback(options.logLevel, log, options.containsPii);
     }
 

lib/msal-common/src/logger/Logger.ts

@@ -54,9 +54,8 @@ describe("Configuration.ts Class Unit Tests", () => {
         await expect(emptyConfig.networkInterface.sendPostRequestAsync("", null)).to.be.rejectedWith(AuthError);
         // Logger options checks
         expect(emptyConfig.loggerOptions).to.be.not.null;
-        expect(() => emptyConfig.loggerOptions.loggerCallback(null, "", false)).to.throw("Unexpected error in authentication.: Logger - loggerCallbackInterface() has not been implemented.");
-        expect(() => emptyConfig.loggerOptions.loggerCallback(null, "", false)).to.throw(AuthError);
         expect(emptyConfig.loggerOptions.piiLoggingEnabled).to.be.false;
+        expect(emptyConfig.loggerOptions.logLevel).to.be.equal(LogLevel.Info);
     });
 
     const clearFunc = (): void => {

lib/msal-common/test/config/Configuration.spec.ts

@@ -57,9 +57,8 @@ describe("SPAConfiguration.ts Class Unit Tests", () => {
         await expect(emptyConfig.networkInterface.sendPostRequestAsync("", null)).to.be.rejectedWith(AuthError);
         // Logger options checks
         expect(emptyConfig.loggerOptions).to.be.not.null;
-        expect(() => emptyConfig.loggerOptions.loggerCallback(null, "", false)).to.throw("Unexpected error in authentication.: Logger - loggerCallbackInterface() has not been implemented.");
-        expect(() => emptyConfig.loggerOptions.loggerCallback(null, "", false)).to.throw(AuthError);
         expect(emptyConfig.loggerOptions.piiLoggingEnabled).to.be.false;
+        expect(emptyConfig.loggerOptions.logLevel).to.be.equal(LogLevel.Info);
     });
 
     const clearFunc = (): void => {

lib/msal-common/test/config/PublicClientSPAConfiguration.spec.ts

@@ -9,12 +9,14 @@ import {
     AuthorizationCodeRequest,
     Configuration,
 } from '@azure/msal-common';
-import { ClientConfiguration, buildConfiguration } from '../config/ClientConfiguration';
+import {
+    ClientConfiguration,
+    buildConfiguration,
+} from '../config/ClientConfiguration';
 import { CryptoProvider } from '../crypto/CryptoProvider';
 import { Storage } from '../cache/Storage';
 
 export abstract class ClientApplication {
-
     // Input configuration by developer/user
     protected config: ClientConfiguration;
 
@@ -40,7 +42,6 @@ export abstract class ClientApplication {
      * @param {@link (Configuration:type)} configuration object for the MSAL PublicClientApplication instance
      */
     protected constructor(configuration: ClientConfiguration) {
-
         this.config = buildConfiguration(configuration);
     }
 
@@ -54,9 +55,12 @@ export abstract class ClientApplication {
      * acquireToken(AuthorizationCodeRequest)
      * @param request
      */
-    async getAuthCodeUrl(request: AuthorizationCodeUrlRequest): Promise<string> {
-
-        const authorizationCodeClient = new AuthorizationCodeClient(this.buildOauthClientConfiguration());
+    async getAuthCodeUrl(
+        request: AuthorizationCodeUrlRequest
+    ): Promise<string> {
+        const authorizationCodeClient = new AuthorizationCodeClient(
+            this.buildOauthClientConfiguration()
+        );
         return authorizationCodeClient.getAuthCodeUrl(request);
     }
 
@@ -70,9 +74,12 @@ export abstract class ClientApplication {
      *
      * @param request
      */
-    async acquireTokenByCode(request: AuthorizationCodeRequest): Promise<string> {
-
-        const authorizationCodeClient = new AuthorizationCodeClient(this.buildOauthClientConfiguration());
+    async acquireTokenByCode(
+        request: AuthorizationCodeRequest
+    ): Promise<string> {
+        const authorizationCodeClient = new AuthorizationCodeClient(
+            this.buildOauthClientConfiguration()
+        );
         return authorizationCodeClient.acquireToken(request);
     }
 
@@ -81,8 +88,10 @@ export abstract class ClientApplication {
         return {
             authOptions: this.config.auth,
             loggerOptions: {
-                loggerCallback: this.config.system!.loggerOptions!.loggerCallback,
-                piiLoggingEnabled: this.config.system!.loggerOptions!.piiLoggingEnabled,
+                loggerCallback: this.config.system!.loggerOptions!
+                    .loggerCallback,
+                piiLoggingEnabled: this.config.system!.loggerOptions!
+                    .piiLoggingEnabled,
             },
             cryptoInterface: new CryptoProvider(),
             networkInterface: this.config.system!.networkClient,

lib/msal-node/package-lock.json

@@ -3,16 +3,15 @@
  * Licensed under the MIT License.
  */
 
-import { DeviceCodeClient, DeviceCodeRequest } from "@azure/msal-common";
-import { ClientConfiguration} from '../config/ClientConfiguration';
+import { DeviceCodeClient, DeviceCodeRequest } from '@azure/msal-common';
+import { ClientConfiguration } from '../config/ClientConfiguration';
 import { ClientApplication } from './ClientApplication';
 
 /**
  * Class to be used to acquire tokens for public client applications (desktop, mobile). Public client applications
  * are not trusted to safely store application secrets, and therefore can only request tokens in the name of an user.
  */
 export class PublicClientApplication extends ClientApplication {
-
     /**
      * @constructor
      * Constructor for the PublicClientApplication
@@ -46,9 +45,12 @@ export class PublicClientApplication extends ClientApplication {
      * until the end-user completes input of credentials.
      * @param request
      */
-    public async acquireTokenByDeviceCode(request: DeviceCodeRequest): Promise<string>{
-
-        let deviceCodeClient: DeviceCodeClient = new DeviceCodeClient(this.buildOauthClientConfiguration());
+    public async acquireTokenByDeviceCode(
+        request: DeviceCodeRequest
+    ): Promise<string> {
+        let deviceCodeClient: DeviceCodeClient = new DeviceCodeClient(
+            this.buildOauthClientConfiguration()
+        );
         return deviceCodeClient.acquireToken(request);
     }
 }

lib/msal-node/src/client/ClientApplication.ts

@@ -51,8 +51,8 @@ export type ClientConfiguration = {
 };
 
 const DEFAULT_AUTH_OPTIONS: NodeAuthOptions = {
-    clientId: "",
-    authority: "",
+    clientId: '',
+    authority: '',
 };
 
 const DEFAULT_CACHE_OPTIONS: CacheOptions = {
@@ -61,30 +61,9 @@ const DEFAULT_CACHE_OPTIONS: CacheOptions = {
 };
 
 const DEFAULT_LOGGER_OPTIONS: LoggerOptions = {
-    loggerCallback: (
-        level: LogLevel,
-        message: string,
-        containsPii: boolean
-    ): void => {
-        if (containsPii) {
-            return;
-        }
-        switch (level) {
-            case LogLevel.Error:
-                console.error(message);
-                return;
-            case LogLevel.Info:
-                console.info(message);
-                return;
-            case LogLevel.Verbose:
-                console.debug(message);
-                return;
-            case LogLevel.Warning:
-                console.warn(message);
-                return;
-        }
-    },
+    loggerCallback: () => {},
     piiLoggingEnabled: false,
+    logLevel: LogLevel.Info,
 };
 
 const DEFAULT_SYSTEM_OPTIONS: NodeSystemOptions = {

lib/msal-node/src/client/PublicClientApplication.ts

@@ -1,6 +1,9 @@
 export { PublicClientApplication } from './client/PublicClientApplication';
 export { ConfidentialClientApplication } from './client/ConfidentialClientApplication';
-export { ClientConfiguration, buildConfiguration } from './config/ClientConfiguration';
+export {
+    ClientConfiguration,
+    buildConfiguration,
+} from './config/ClientConfiguration';
 export { Storage } from './cache/Storage';
 
 // crypto

lib/msal-node/src/config/ClientConfiguration.ts

@@ -3,15 +3,18 @@
  * Licensed under the MIT License.
  */
 
-import { INetworkModule, NetworkRequestOptions, NetworkResponse } from '@azure/msal-common';
+import {
+    INetworkModule,
+    NetworkRequestOptions,
+    NetworkResponse,
+} from '@azure/msal-common';
 import { HttpMethod } from './../utils/Constants';
-import axios, {AxiosRequestConfig} from 'axios';
+import axios, { AxiosRequestConfig } from 'axios';
 
 /**
  * This class implements the API for network requests.
  */
 export class HttpClient implements INetworkModule {
-
     constructor() {
         axios.defaults.validateStatus = () => true;
     }
@@ -25,17 +28,17 @@ export class HttpClient implements INetworkModule {
         url: string,
         options?: NetworkRequestOptions
     ): Promise<NetworkResponse<T>> {
-     const request: AxiosRequestConfig = {
-         method: HttpMethod.GET,
-         url: url,
-         headers: options && options.headers,
+        const request: AxiosRequestConfig = {
+            method: HttpMethod.GET,
+            url: url,
+            headers: options && options.headers,
         };
 
         const response = await axios(request);
         return {
             headers: response.headers,
             body: response.data as T,
-            status: response.status
+            status: response.status,
         };
     }
 
@@ -59,7 +62,7 @@ export class HttpClient implements INetworkModule {
         return {
             headers: response.headers,
             body: response.data as T,
-            status: response.status
+            status: response.status,
         };
     }
 }

lib/msal-node/src/index.ts

@@ -43,10 +43,10 @@ export const CACHE = {
  * Constants for headers
  */
 export const Header = {
-    MSAL_SKU_KEY: "x-client-SKU",
-    MSAL_SKU_VALUE: "MSAL.node",
-    MSAL_VERSION: "x-client-VER",
-    CPU: "x-client-CPU",
-    OS: "x-client-OS"
+    MSAL_SKU_KEY: 'x-client-SKU',
+    MSAL_SKU_VALUE: 'MSAL.node',
+    MSAL_VERSION: 'x-client-VER',
+    CPU: 'x-client-CPU',
+    OS: 'x-client-OS',
     // TODO will also add appName and appVersion here
-}
+};