fix(logs): improve error logging (#2999)

## Problem
* Inconsistent pattern for error logging
* Stack traces aren't emitted even when source maps are available
* `aws.viewLogsAtMessage` would show an extra error in certain situations

## Solution
* Use `%s` for error substitution so the entire object isn't printed
* Add logic to map errors in the logs depending on context
    * Source maps available and we log at error level -> output stack trace
    * Otherwise format the error in a nicer way
* Handle more edge cases in `aws.viewLogsAtMessage`

Author: JadenSimon

.changes/next-release/Bug Fix-2aac5758-8208-4124-83a8-3e347446e66c.json

@@ -0,0 +1,4 @@
+{
+	"type": "Bug Fix",
+	"description": "logging: `aws.viewLogsAtMessage` no longer fails when the log message cannot be found"
+}

src/apigateway/commands/copyUrl.ts

@@ -47,7 +47,7 @@ export async function copyUrlCommand(
             }
         )
     } catch (e) {
-        getLogger().error(`Failed to load stages: %O`, e)
+        getLogger().error(`Failed to load stages: %s`, e)
         telemetry.apigateway_copyUrl.emit({ result: 'Failed' })
         return
     }

src/apprunner/activation.ts

@@ -85,7 +85,7 @@ export async function activate(context: ExtContext): Promise<void> {
                 try {
                     await command(...args)
                 } catch (err) {
-                    getLogger().error(`${tuple[1]}: %O`, err)
+                    getLogger().error(`${tuple[1]}: %s`, err)
                     showViewLogsMessage(tuple[1])
                 }
             })

src/apprunner/explorer/apprunnerServiceNode.ts

@@ -127,7 +127,7 @@ export class AppRunnerServiceNode extends CloudWatchLogsBase implements AWSResou
                 getLogger().warn(
                     `Failed to list operations for service "${this._info.ServiceName}", service may be in an unstable state.`
                 )
-                getLogger().debug(`Failed to list operations for service "${this.arn}": %O`, err)
+                getLogger().debug(`Failed to list operations for service "${this.arn}": %s`, err)
             })
     }
 

src/apprunner/wizards/imageRepositoryWizard.ts

@@ -81,7 +81,7 @@ function createImagePrompter(
                 return repos
             })
             .catch(err => {
-                getLogger().error(`Unabled to list repositories: %O`, err)
+                getLogger().error(`Unabled to list repositories: %s`, err)
                 return [
                     {
                         label: localize(
@@ -187,7 +187,7 @@ function createTagPrompter(
                 return tagT
             })
             .catch(err => {
-                getLogger().error(`Unabled to list tags for repository "${imageRepo.repositoryName}": %O`, err)
+                getLogger().error(`Unabled to list tags for repository "${imageRepo.repositoryName}": %s`, err)
                 return [
                     {
                         label: localize(

src/awsexplorer/awsExplorer.ts

@@ -74,7 +74,7 @@ export class AwsExplorer implements vscode.TreeDataProvider<AWSTreeNodeBase>, Re
             }
         } catch (err) {
             const error = err as Error
-            this.logger.error(`Error getting children for node ${element?.label ?? 'Root Node'}: %O`, error)
+            this.logger.error(`Error getting children for node ${element?.label ?? 'Root Node'}: %s`, error)
 
             childNodes.splice(
                 0,

src/codewhisperer/activation.ts

@@ -53,7 +53,7 @@ const performance = globalThis.performance ?? require('perf_hooks').performance
 export async function activate(context: ExtContext): Promise<void> {
     // No need to await. This can be removed once the 'hover.enabled' hack is no longer needed.
     HoverConfigUtil.instance.restoreHoverConfig().catch(err => {
-        getLogger().warn('codewhisperer: failed to restore "editor.hover.enabled" setting: %O', err)
+        getLogger().warn('codewhisperer: failed to restore "editor.hover.enabled" setting: %s', err)
     })
 
     const codewhispererSettings = CodeWhispererSettings.instance

src/credentials/auth.ts

@@ -297,7 +297,7 @@ export class Auth implements AuthService, ConnectionManager {
         try {
             return await this.useConnection({ id })
         } catch (err) {
-            getLogger().warn(`auth: failed to restore previous session: ${UnknownError.cast(err).message}`)
+            getLogger().warn(`auth: failed to restore previous session: %s`, err)
         }
     }
 
@@ -433,7 +433,7 @@ export class Auth implements AuthService, ConnectionManager {
             // TODO: this seems to fail on the backend for scoped tokens
             await client.logout().catch(err => {
                 const name = profile.metadata.label ?? id
-                getLogger().warn(`auth: failed to logout of connection "${name}": ${UnknownError.cast(err)}`)
+                getLogger().warn(`auth: failed to logout of connection "${name}": %s`, err)
             })
 
             return provider.invalidate()
@@ -628,7 +628,7 @@ export class Auth implements AuthService, ConnectionManager {
                 await this.useConnection({ id })
                 return true
             } catch (err) {
-                getLogger().warn(`auth: failed to auto-connect using "${id}": ${UnknownError.cast(err).message}`)
+                getLogger().warn(`auth: failed to auto-connect using "${id}": %s`, err)
                 return false
             }
         }

src/credentials/loginManager.ts

@@ -147,7 +147,7 @@ export class LoginManager {
             const loginManager = new LoginManager(awsContext, new CredentialsStore())
             await loginWithMostRecentCredentials(new CredentialsSettings(), loginManager)
         } catch (err) {
-            getLogger().error('credentials: failed to auto-connect: %O', err)
+            getLogger().error('credentials: failed to auto-connect: %s', err)
             showViewLogsMessage(localize('AWS.credentials.autoconnect.fatal', 'Exception occurred while connecting'))
         }
         return !!(await awsContext.getCredentials())

src/credentials/secondaryAuth.ts

@@ -11,7 +11,6 @@ import { showQuickPick } from '../shared/ui/pickerPrompter'
 import { cast, Optional } from '../shared/utilities/typeConstructors'
 import { Auth, Connection } from './auth'
 import { once } from '../shared/utilities/functionUtils'
-import { UnknownError } from '../shared/errors'
 
 async function promptUseNewConnection(newConn: Connection, oldConn: Connection, tools: string[]) {
     // Multi-select picker would be better ?
@@ -154,7 +153,7 @@ export class SecondaryAuth<T extends Connection = Connection> {
 
             return this.#savedConnection
         } catch (err) {
-            getLogger().warn(`auth (${this.toolId}): failed to restore connection: ${UnknownError.cast(err).message}`)
+            getLogger().warn(`auth (${this.toolId}): failed to restore connection: %s`, err)
         }
     })