Merge aws#5087 lint: disallow console.log

Author: justinmk3

.eslintrc.js

@@ -159,6 +159,7 @@ module.exports = {
         'aws-toolkits/no-banned-usages': 'error',
         'aws-toolkits/no-incorrect-once-usage': 'error',
         'aws-toolkits/no-string-exec-for-child-process': 'error',
+        'aws-toolkits/no-console-log': 'error',
 
         'no-restricted-imports': [
             'error',

CONTRIBUTING.md

@@ -477,6 +477,8 @@ The package.json 'devDependencies' includes `eslint-plugin-aws-toolkits`. This i
 3. Register your rule in `plugins/eslint-plugin-aws-toolkits/index.ts`.
 4. Enable your rule in `.eslintrc`.
 
+Writing lint rules can be tricky if you are unfamiliar with the process. Use an AST viewer such as https://astexplorer.net/
+
 ### AWS SDK generator
 
 When the AWS SDK does not (yet) support a service but you have an API

packages/core/src/lambda/vue/configEditor/samInvokeFrontend.ts

@@ -3,6 +3,9 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+// Disable because it is a front-end file.
+/* eslint-disable aws-toolkits/no-console-log */
+
 import { defineComponent } from 'vue'
 import { AwsSamDebuggerConfiguration } from '../../../shared/sam/debugger/awsSamDebugConfiguration'
 import { AwsSamDebuggerConfigurationLoose, SamInvokeWebview } from './samInvokeBackend'

packages/core/src/login/webview/vue/backend.ts

@@ -33,6 +33,7 @@ import { AuthEnabledFeatures, AuthError, AuthFlowState, AuthUiClick, TelemetryMe
 import { AuthUtil } from '../../../codewhisperer/util/authUtil'
 import { DevSettings } from '../../../shared/settings'
 import { AuthSSOServer } from '../../../auth/sso/server'
+import { getLogger } from '../../../shared/logger/logger'
 
 export abstract class CommonAuthWebview extends VueWebview {
     private metricMetadata: TelemetryMetadata = {}
@@ -75,7 +76,8 @@ export abstract class CommonAuthWebview extends VueWebview {
                 await setupFunc()
                 return
             } catch (e) {
-                console.log(e)
+                getLogger().error('ssoSetup encountered an error: %s', e)
+
                 if (e instanceof ToolkitError && e.code === 'NotOnboarded') {
                     /**
                      * Connection is fine, they just skipped onboarding so not an actual error.

packages/core/src/shared/clients/codecatalystClient.ts

@@ -11,7 +11,7 @@ const localize = nls.loadMessageBundle()
 
 import * as AWS from 'aws-sdk'
 import * as logger from '../logger/logger'
-import { PerfLog } from '../logger/logger'
+import { PerfLog } from '../logger/perfLogger'
 import { ServiceConfigurationOptions } from 'aws-sdk/lib/service'
 import { CancellationError, Timeout, waitTimeout, waitUntil } from '../utilities/timeoutUtils'
 import { isUserCancelledError } from '../../shared/errors'

packages/core/src/shared/extensionGlobals.ts

@@ -18,6 +18,7 @@ import { TelemetryService } from './telemetry/telemetryService'
 import { UriHandler } from './vscode/uriHandler'
 import { GlobalState } from './globalState'
 import { setContext } from './vscode/setContext'
+import { getLogger } from './logger/logger'
 
 type Clock = Pick<
     typeof globalThis,
@@ -47,7 +48,7 @@ function copyClock(): Clock {
 
     const browserAlternatives = getBrowserAlternatives()
     if (Object.keys(browserAlternatives).length > 0) {
-        console.log('globals: Using browser alternatives for clock functions')
+        getLogger().info('globals: Using browser alternatives for clock functions')
         Object.assign(clock, browserAlternatives)
     } else {
         // In node.js context

packages/core/src/shared/fs/templateRegistry.ts

@@ -16,7 +16,7 @@ import { getLogger } from '../logger'
 import globals from '../extensionGlobals'
 import { Timeout } from '../utilities/timeoutUtils'
 import { localize } from '../utilities/vsCodeUtils'
-import { PerfLog } from '../logger/logger'
+import { PerfLog } from '../logger/perfLogger'
 import { showMessageWithCancel } from '../utilities/messages'
 
 export class CloudFormationTemplateRegistry extends WatchedFiles<CloudFormation.Template> {

packages/core/src/shared/languageServer/utils/runner.ts

@@ -8,6 +8,9 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
+// Disable because this is a language server.
+/* eslint-disable aws-toolkits/no-console-log */
+
 import { CancellationToken, ErrorCodes, ResponseError } from 'vscode-languageserver'
 
 export function formatError(message: string, err: any): string {

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

@@ -156,23 +156,28 @@ export class ConsoleLogger implements Logger {
         }
     }
     public debug(message: string | Error, ...meta: any[]): number {
+        // eslint-disable-next-line aws-toolkits/no-console-log
         console.debug(message, ...meta)
         return 0
     }
     public verbose(message: string | Error, ...meta: any[]): number {
+        // eslint-disable-next-line aws-toolkits/no-console-log
         console.debug(message, ...meta)
         return 0
     }
     public info(message: string | Error, ...meta: any[]): number {
+        // eslint-disable-next-line aws-toolkits/no-console-log
         console.info(message, ...meta)
         return 0
     }
     public warn(message: string | Error, ...meta: any[]): number {
+        // eslint-disable-next-line aws-toolkits/no-console-log
         console.warn(message, ...meta)
         return 0
     }
     /** Note: In nodejs this prints to `stderr` (see {@link Console.error}). */
     public error(message: string | Error, ...meta: any[]): number {
+        // eslint-disable-next-line aws-toolkits/no-console-log
         console.error(message, ...meta)
         return 0
     }
@@ -193,26 +198,3 @@ export function getNullLogger(type?: 'channel' | 'debugConsole' | 'main'): Logge
 export function setLogger(logger: Logger | undefined, type?: 'channel' | 'debugConsole' | 'main') {
     toolkitLoggers[type ?? 'main'] = logger
 }
-
-export class PerfLog {
-    private readonly log
-    public readonly start
-
-    public constructor(public readonly topic: string) {
-        const log = getLogger()
-        this.log = log
-        this.start = performance.now()
-    }
-
-    public elapsed(): number {
-        return performance.now() - this.start
-    }
-
-    public done(): void {
-        if (!this.log.logLevelEnabled('verbose')) {
-            return
-        }
-        const elapsed = this.elapsed()
-        this.log.verbose('%s took %dms', this.topic, elapsed.toFixed(1))
-    }
-}

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

@@ -0,0 +1,29 @@
+/*!
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { getLogger } from './logger'
+
+export class PerfLog {
+    private readonly log
+    public readonly start
+
+    public constructor(public readonly topic: string) {
+        const log = getLogger()
+        this.log = log
+        this.start = performance.now()
+    }
+
+    public elapsed(): number {
+        return performance.now() - this.start
+    }
+
+    public done(): void {
+        if (!this.log.logLevelEnabled('verbose')) {
+            return
+        }
+        const elapsed = this.elapsed()
+        this.log.verbose('%s took %dms', this.topic, elapsed.toFixed(1))
+    }
+}