forked from AzureAD/microsoft-authentication-library-for-js
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request AzureAD#1155 from AzureAD/authorization-code-flow-…
…logger Authorization Code Flow for Single Page Applications: Adding Logger class
- Loading branch information
Showing
7 changed files
with
201 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,166 @@ | ||
| /* | ||
| * Copyright (c) Microsoft Corporation. All rights reserved. | ||
| * Licensed under the MIT License. | ||
| */ | ||
|
|
||
| import { StringUtils } from "../utils/StringUtils"; | ||
| import pkg from "../../package.json"; | ||
|
|
||
| export type LoggerMessageOptions = { | ||
| logLevel: LogLevel, | ||
| correlationId?: string, | ||
| containsPii?: boolean | ||
| }; | ||
|
|
||
| export enum LogLevel { | ||
| Error, | ||
| Warning, | ||
| Info, | ||
| Verbose | ||
| }; | ||
|
|
||
| export interface ILoggerCallback { | ||
| (level: LogLevel, message: string, containsPii: boolean): void; | ||
| } | ||
|
|
||
| export class Logger { | ||
|
|
||
| /** | ||
| * @hidden | ||
| */ | ||
| private correlationId: string; | ||
|
|
||
| /** | ||
| * @hidden | ||
| */ | ||
| private level: LogLevel = LogLevel.Info; | ||
|
|
||
| /** | ||
| * @hidden | ||
| */ | ||
| private piiLoggingEnabled: boolean; | ||
|
|
||
| /** | ||
| * @hidden | ||
| */ | ||
| private localCallback: ILoggerCallback; | ||
|
|
||
| constructor(localCallback: ILoggerCallback, piiLoggingEnabled: boolean) { | ||
| this.localCallback = localCallback; | ||
| this.piiLoggingEnabled = piiLoggingEnabled; | ||
| } | ||
|
|
||
| /** | ||
| * @hidden | ||
| */ | ||
| private logMessage(logMessage: string, options: LoggerMessageOptions): void { | ||
| if ((options.logLevel > this.level) || (!this.piiLoggingEnabled && options.containsPii)) { | ||
| return; | ||
| } | ||
| const timestamp = new Date().toUTCString(); | ||
| let logHeader: string = StringUtils.isEmpty(this.correlationId) ? `[${timestamp}] : ` : `[${timestamp}] : [${this.correlationId}]`; | ||
| const log = `${logHeader} : ${pkg.version} : ${LogLevel[options.logLevel]} - ${logMessage}`; | ||
| this.executeCallback(options.logLevel, log, options.containsPii); | ||
| } | ||
|
|
||
| /** | ||
| * @hidden | ||
| */ | ||
| executeCallback(level: LogLevel, message: string, containsPii: boolean) { | ||
| if (this.localCallback) { | ||
| this.localCallback(level, message, containsPii); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @hidden | ||
| */ | ||
| error(message: string, correlationId?: string): void { | ||
| this.logMessage(message, { | ||
| logLevel: LogLevel.Error, | ||
| containsPii: false, | ||
| correlationId: correlationId || "" | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * @hidden | ||
| */ | ||
| errorPii(message: string, correlationId?: string): void { | ||
| this.logMessage(message, { | ||
| logLevel: LogLevel.Error, | ||
| containsPii: true, | ||
| correlationId: correlationId || "" | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * @hidden | ||
| */ | ||
| warning(message: string, correlationId?: string): void { | ||
| this.logMessage(message, { | ||
| logLevel: LogLevel.Warning, | ||
| containsPii: false, | ||
| correlationId: correlationId || "" | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * @hidden | ||
| */ | ||
| warningPii(message: string, correlationId?: string): void { | ||
| this.logMessage(message, { | ||
| logLevel: LogLevel.Warning, | ||
| containsPii: true, | ||
| correlationId: correlationId || "" | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * @hidden | ||
| */ | ||
| info(message: string, correlationId?: string): void { | ||
| this.logMessage(message, { | ||
| logLevel: LogLevel.Info, | ||
| containsPii: false, | ||
| correlationId: correlationId || "" | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * @hidden | ||
| */ | ||
| infoPii(message: string, correlationId?: string): void { | ||
| this.logMessage(message, { | ||
| logLevel: LogLevel.Info, | ||
| containsPii: true, | ||
| correlationId: correlationId || "" | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * @hidden | ||
| */ | ||
| verbose(message: string, correlationId?: string): void { | ||
| this.logMessage(message, { | ||
| logLevel: LogLevel.Verbose, | ||
| containsPii: false, | ||
| correlationId: correlationId || "" | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * @hidden | ||
| */ | ||
| verbosePii(message: string, correlationId?: string): void { | ||
| this.logMessage(message, { | ||
| logLevel: LogLevel.Verbose, | ||
| containsPii: true, | ||
| correlationId: correlationId || "" | ||
| }); | ||
| } | ||
|
|
||
| isPiiLoggingEnabled(): boolean { | ||
| return this.piiLoggingEnabled; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters