Merge pull request #5564 from tomcat323/betterLoggingWithHeaders

refactor(logging): removed types input in getLogger()

Author: tomcat323

CONTRIBUTING.md

@@ -133,7 +133,7 @@ You can also use these NPM tasks (see `npm run` for the full list):
     1. Declare a global unhandledRejection handler.
         ```ts
         process.on('unhandledRejection', (e) => {
-            getLogger('channel').error(
+            getLogger().error(
                 localize(
                     'AWS.channel.aws.toolkit.activation.error',
                     'Error Activating {0} Toolkit: {1}',

packages/core/src/extensionNode.ts

@@ -237,7 +237,7 @@ export async function activate(context: vscode.ExtensionContext) {
         if (stacktrace !== undefined && stacktrace.length > 40) {
             stacktrace.length = 40
         }
-        getLogger('channel').error(
+        getLogger().error(
             localize(
                 'AWS.channel.aws.toolkit.activation.error',
                 'Error Activating {0} Toolkit: {1} \n{2}',

packages/core/src/lambda/commands/createNewSamApp.ts

@@ -100,7 +100,7 @@ export async function resumeCreateNewSamApp(
         reason = 'error'
 
         globals.outputChannel.show(true)
-        getLogger('channel').error(
+        getLogger().error(
             localize('AWS.samcli.initWizard.resume.error', 'Error resuming SAM Application creation. {0}', checklogs())
         )
 
@@ -235,7 +235,7 @@ export async function createNewSamApplication(
                 destinationDirectory: vscode.Uri.file(destinationDirectory),
             }
             schemaCodeDownloader = createSchemaCodeDownloaderObject(client!, globals.outputChannel)
-            getLogger('channel').info(
+            getLogger().info(
                 localize(
                     'AWS.message.info.schemas.downloadCodeBindings.start',
                     'Downloading code for schema {0}...',
@@ -333,7 +333,7 @@ export async function createNewSamApplication(
         reason = getTelemetryReason(err)
 
         globals.outputChannel.show(true)
-        getLogger('channel').error(
+        getLogger().error(
             localize('AWS.samcli.initWizard.general.error', 'Error creating new SAM Application. {0}', checklogs())
         )
 

packages/core/src/lambda/commands/deploySamApplication.ts

@@ -158,7 +158,7 @@ async function buildOperation(params: {
     invoker: SamCliProcessInvoker
 }): Promise<boolean> {
     try {
-        getLogger('channel').info(localize('AWS.samcli.deploy.workflow.init', 'Building SAM Application...'))
+        getLogger().info(localize('AWS.samcli.deploy.workflow.init', 'Building SAM Application...'))
 
         const buildDestination = getBuildRootFolder(params.deployParameters.deployRootFolder)
 
@@ -173,7 +173,7 @@ async function buildOperation(params: {
 
         return true
     } catch (err) {
-        getLogger('channel').warn(
+        getLogger().warn(
             localize(
                 'AWS.samcli.build.failedBuild',
                 '"sam build" failed: {0}',
@@ -200,7 +200,7 @@ async function packageOperation(
         )
     }
 
-    getLogger('channel').info(
+    getLogger().info(
         localize(
             'AWS.samcli.deploy.workflow.packaging',
             'Packaging SAM Application to S3 Bucket: {0}',
@@ -232,7 +232,7 @@ async function deployOperation(params: {
     invoker: SamCliProcessInvoker
 }): Promise<void> {
     try {
-        getLogger('channel').info(
+        getLogger().info(
             localize(
                 'AWS.samcli.deploy.workflow.stackName.initiated',
                 'Deploying SAM Application to CloudFormation Stack: {0}',
@@ -273,13 +273,13 @@ async function deploy(params: {
     window: WindowFunctions
 }): Promise<void> {
     globals.outputChannel.show(true)
-    getLogger('channel').info(localize('AWS.samcli.deploy.workflow.start', 'Starting SAM Application deployment...'))
+    getLogger().info(localize('AWS.samcli.deploy.workflow.start', 'Starting SAM Application deployment...'))
 
     const buildSuccessful = await buildOperation(params)
     await packageOperation(params, buildSuccessful)
     await deployOperation(params)
 
-    getLogger('channel').info(
+    getLogger().info(
         localize(
             'AWS.samcli.deploy.workflow.success',
             'Deployed SAM Application to CloudFormation Stack: {0}',
@@ -311,10 +311,10 @@ function enhanceAwsCloudFormationInstructions(
 }
 
 function outputDeployError(error: Error) {
-    getLogger('channel').error(error)
+    getLogger().error(error)
 
     globals.outputChannel.show(true)
-    getLogger('channel').error('AWS.samcli.deploy.general.error', 'Error deploying a SAM Application. {0}', checklogs())
+    getLogger().error('AWS.samcli.deploy.general.error', 'Error deploying a SAM Application. {0}', checklogs())
 }
 
 function getDefaultWindowFunctions(): WindowFunctions {

packages/core/src/lambda/local/debugConfiguration.ts

@@ -256,7 +256,7 @@ export function getArchitecture(
         const isArch = isArchitecture(arch)
 
         if (!isArch) {
-            getLogger('channel').warn('SAM Invoke: Invalid architecture. Defaulting to x86_64.')
+            getLogger().warn('SAM Invoke: Invalid architecture. Defaulting to x86_64.')
             void vscode.window.showWarningMessage(
                 localize(
                     'AWS.output.sam.invalidArchitecture',

packages/core/src/shared/logger/activation.ts

@@ -46,22 +46,12 @@ export async function activate(
 
     setLogger(mainLogger)
 
-    // Logs to "AWS Toolkit" output channel.
-    setLogger(
-        makeLogger({
-            logLevel: chanLogLevel,
-            logPaths: logUri ? [logUri] : undefined,
-            outputChannels: [outputChannel, logChannel],
-        }),
-        'channel'
-    )
-
     // Logs to vscode Debug Console.
     setLogger(
         makeLogger({
             logLevel: chanLogLevel,
             outputChannels: [outputChannel, logChannel],
-            useDebugConsole: true,
+            useConsoleLog: true,
         }),
         'debugConsole'
     )
@@ -81,27 +71,21 @@ export async function activate(
  * @param opts.logLevel Log messages at or above this level
  * @param opts.logPaths Array of paths to output log entries to
  * @param opts.outputChannels Array of output channels to log entries to
- * @param opts.useDebugConsole If true, outputs log entries to `vscode.debug.activeDebugConsole`
  * @param opts.useConsoleLog If true, outputs log entries to the nodejs or browser devtools console.
  */
 export function makeLogger(opts: {
     logLevel: LogLevel
     logPaths?: vscode.Uri[]
     outputChannels?: vscode.OutputChannel[]
-    useDebugConsole?: boolean
     useConsoleLog?: boolean
 }): Logger {
     const logger = new WinstonToolkitLogger(opts.logLevel)
     // debug console can show ANSI colors, output channels can not
-    const stripAnsi = opts.useDebugConsole ?? false
     for (const logPath of opts.logPaths ?? []) {
         logger.logToFile(logPath)
     }
     for (const outputChannel of opts.outputChannels ?? []) {
-        logger.logToOutputChannel(outputChannel, stripAnsi)
-    }
-    if (opts.useDebugConsole) {
-        logger.logToDebugConsole()
+        logger.logToOutputChannel(outputChannel)
     }
     if (opts.useConsoleLog) {
         logger.logToConsole()

packages/core/src/shared/logger/index.ts

@@ -12,4 +12,5 @@ export type Loggable = Error | string
 export type Logger = logger.Logger
 export type LogLevel = logger.LogLevel
 export const getLogger = logger.getLogger
+export const getDebugConsoleLogger = logger.getDebugConsoleLogger
 export const getNullLogger = logger.getNullLogger

packages/core/src/shared/logger/logger.ts

@@ -84,20 +84,21 @@ export function compareLogLevel(l1: LogLevel, l2: LogLevel): number {
 
 /**
  * Gets the logger if it has been initialized
- * @param type Gets the logger type:
- * * `'main'` or `undefined`: Main logger; default impl: logs to log file and log output channel
- * * `'channel'`: Channel Logger; default impl: logs to the `main` channels and the `AWS Toolkit` output channel
- * * `'debug'`: Debug Console Logger; default impl: logs to the `channel` channels and the currently-active VS Code Debug Console pane.
+ * the logger is of `'main'` or `undefined`: Main logger; default impl: logs to log file and log output channel
  */
-export function getLogger(type?: keyof typeof toolkitLoggers): Logger {
-    const logger = toolkitLoggers[type ?? 'main']
+export function getLogger(): Logger {
+    const logger = toolkitLoggers['main']
     if (!logger) {
         return new ConsoleLogger()
     }
 
     return logger
 }
 
+export function getDebugConsoleLogger(): Logger {
+    return toolkitLoggers['debugConsole'] ?? new ConsoleLogger()
+}
+
 export class NullLogger implements Logger {
     public setLogLevel(logLevel: LogLevel) {}
     public logLevelEnabled(logLevel: LogLevel): boolean {
@@ -187,14 +188,14 @@ export class ConsoleLogger implements Logger {
     public enableDebugConsole(): void {}
 }
 
-export function getNullLogger(type?: 'channel' | 'debugConsole' | 'main'): Logger {
+export function getNullLogger(type?: 'debugConsole' | 'main'): Logger {
     return new NullLogger()
 }
 /**
  * Sets (or clears) the logger that is accessible to code.
  * The Extension is expected to call this only once per log type.
  * Tests should call this to set up a logger prior to executing code that accesses a logger.
  */
-export function setLogger(logger: Logger | undefined, type?: 'channel' | 'debugConsole' | 'main') {
+export function setLogger(logger: Logger | undefined, type?: 'debugConsole' | 'main') {
     toolkitLoggers[type ?? 'main'] = logger
 }

packages/core/src/shared/logger/winstonToolkitLogger.ts

@@ -44,7 +44,7 @@ export class WinstonToolkitLogger implements Logger, vscode.Disposable {
     }
 
     public enableDebugConsole(): void {
-        this.logToDebugConsole()
+        this.logToConsole()
     }
 
     public setLogLevel(logLevel: LogLevel) {
@@ -74,7 +74,7 @@ export class WinstonToolkitLogger implements Logger, vscode.Disposable {
         this.logger.add(fileTransport)
     }
 
-    public logToOutputChannel(outputChannel: vscode.OutputChannel, stripAnsi: boolean): void {
+    public logToOutputChannel(outputChannel: vscode.OutputChannel, stripAnsi: boolean = false): void {
         const outputChannelTransport: winston.transport = new OutputChannelTransport({
             outputChannel,
             stripAnsi,
@@ -84,16 +84,6 @@ export class WinstonToolkitLogger implements Logger, vscode.Disposable {
         this.logger.add(outputChannelTransport)
     }
 
-    public logToDebugConsole(): void {
-        const debugConsoleTransport = new OutputChannelTransport({
-            name: 'DebugConsole',
-            outputChannel: vscode.debug.activeDebugConsole,
-        })
-        const debugConsoleUri: vscode.Uri = vscode.Uri.parse('console://debug')
-        debugConsoleTransport.on('logged', (obj: any) => this.parseLogObject(debugConsoleUri, obj))
-        this.logger.add(debugConsoleTransport)
-    }
-
     public logToConsole(): void {
         const consoleLogTransport: winston.transport = new ConsoleLogTransport({})
         const logConsoleUri: vscode.Uri = vscode.Uri.parse('console://log')

packages/core/src/shared/sam/cli/samCliInvoker.ts

@@ -36,6 +36,7 @@ export class DefaultSamCliProcessInvoker implements SamCliProcessInvoker {
         const invokeOptions = makeRequiredSamCliProcessInvokeOptions(options)
         const logging = options?.logging !== false
         const getLogger = logging ? logger.getLogger : logger.getNullLogger
+        const getDebugConsoleLogger = logging ? logger.getDebugConsoleLogger : logger.getNullLogger
         const log = getLogger()
 
         const sam = await this.context.getOrDetectSamCli()
@@ -51,16 +52,16 @@ export class DefaultSamCliProcessInvoker implements SamCliProcessInvoker {
             spawnOptions: await addTelemetryEnvVar(options?.spawnOptions),
         })
 
-        getLogger('channel').info(localize('AWS.running.command', 'Command: {0}', `${this.childProcess}`))
+        getLogger().info(localize('AWS.running.command', 'Command: {0}', `${this.childProcess}`))
         log.verbose(`running: ${this.childProcess}`)
         return await this.childProcess.run({
             onStdout: (text, context) => {
-                getLogger('debugConsole').info(text)
+                getDebugConsoleLogger().info(text)
                 log.verbose(`stdout: ${text}`)
                 options?.onStdout?.(text, context)
             },
             onStderr: (text, context) => {
-                getLogger('debugConsole').info(text)
+                getDebugConsoleLogger().info(text)
                 log.verbose(`stderr: ${text}`)
                 options?.onStderr?.(text, context)
             },