refactor(toolkit-lib): remove duplicate SdkLogger and use copy of interface (#467)

We had two version of an `SdkLogger` that logs to an IoHost. This was
because historically they lived in different packages. Align both
versions to use the CLI one - because that is definitely safe and battle
tested.

Additionally we move away from using the `Logger` interface provided by
`@smithy/types`. This is in preparation of fully removing this
dependency.

---
By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache-2.0 license

Author: mrgrain

packages/@aws-cdk/toolkit-lib/lib/api/aws-auth/awscli-compatible.ts

@@ -3,10 +3,11 @@ import { createCredentialChain, fromEnv, fromIni, fromNodeProviderChain } from '
 import { MetadataService } from '@aws-sdk/ec2-metadata-service';
 import type { NodeHttpHandlerOptions } from '@smithy/node-http-handler';
 import { loadSharedConfigFiles } from '@smithy/shared-ini-file-loader';
-import type { AwsCredentialIdentityProvider, Logger } from '@smithy/types';
+import type { AwsCredentialIdentityProvider } from '@smithy/types';
 import * as promptly from 'promptly';
 import { makeCachingProvider } from './provider-caching';
 import { ProxyAgentProvider } from './proxy-agent';
+import type { ISdkLogger } from './sdk-logger';
 import type { SdkHttpOptions } from './types';
 import { AuthenticationError } from '../../toolkit/toolkit-error';
 import { IO, type IoHelper } from '../io/private';
@@ -25,9 +26,9 @@ const DEFAULT_TIMEOUT = 300000;
 export class AwsCliCompatible {
   private readonly ioHelper: IoHelper;
   private readonly requestHandler: NodeHttpHandlerOptions;
-  private readonly logger?: Logger;
+  private readonly logger?: ISdkLogger;
 
-  public constructor(ioHelper: IoHelper, requestHandler: NodeHttpHandlerOptions, logger?: Logger) {
+  public constructor(ioHelper: IoHelper, requestHandler: NodeHttpHandlerOptions, logger?: ISdkLogger) {
     this.ioHelper = ioHelper;
     this.requestHandler = requestHandler;
     this.logger = logger;
@@ -267,7 +268,7 @@ function shouldPrioritizeEnv() {
 
 export interface CredentialChainOptions {
   readonly profile?: string;
-  readonly logger?: Logger;
+  readonly logger?: ISdkLogger;
 }
 
 export async function makeRequestHandler(ioHelper: IoHelper, options: SdkHttpOptions = {}): Promise<NodeHttpHandlerOptions> {

packages/@aws-cdk/toolkit-lib/lib/api/aws-auth/sdk-logger.ts

@@ -1,10 +1,17 @@
 import { inspect, format } from 'util';
-import type { Logger } from '@smithy/types';
 import { replacerBufferWithInfo } from '../../util';
 import type { IoHelper } from '../io/private';
 import { IO } from '../io/private';
 
-export class SdkToCliLogger implements Logger {
+export interface ISdkLogger {
+  trace?: (...content: any[]) => void;
+  debug: (...content: any[]) => void;
+  info: (...content: any[]) => void;
+  warn: (...content: any[]) => void;
+  error: (...content: any[]) => void;
+}
+
+export class IoHostSdkLogger implements ISdkLogger {
   private readonly ioHelper: IoHelper;
 
   public constructor(ioHelper: IoHelper) {

packages/@aws-cdk/toolkit-lib/lib/api/aws-auth/sdk-provider.ts

@@ -5,7 +5,7 @@ import { EnvironmentUtils, UNKNOWN_ACCOUNT, UNKNOWN_REGION } from '@aws-cdk/cx-a
 import type { AssumeRoleCommandInput } from '@aws-sdk/client-sts';
 import { fromTemporaryCredentials } from '@aws-sdk/credential-providers';
 import type { NodeHttpHandlerOptions } from '@smithy/node-http-handler';
-import type { AwsCredentialIdentityProvider, Logger } from '@smithy/types';
+import type { AwsCredentialIdentityProvider } from '@smithy/types';
 import { AwsCliCompatible } from './awscli-compatible';
 import { cached } from './cached';
 import { CredentialPlugins } from './credential-plugins';
@@ -16,6 +16,7 @@ import { AuthenticationError } from '../../toolkit/toolkit-error';
 import { formatErrorMessage } from '../../util';
 import { IO, type IoHelper } from '../io/private';
 import { PluginHost, Mode } from '../plugin';
+import type { ISdkLogger } from './sdk-logger';
 
 export type AssumeRoleAdditionalOptions = Partial<Omit<AssumeRoleCommandInput, 'ExternalId' | 'RoleArn'>>;
 
@@ -102,7 +103,7 @@ export class SdkProvider {
   private readonly plugins;
   private readonly requestHandler: NodeHttpHandlerOptions;
   private readonly ioHelper: IoHelper;
-  private readonly logger?: Logger;
+  private readonly logger?: ISdkLogger;
 
   public constructor(
     defaultCredentialProvider: AwsCredentialIdentityProvider,
@@ -547,5 +548,5 @@ export interface SdkProviderServices {
   /**
    * An SDK logger
    */
-  readonly logger?: Logger;
+  readonly logger?: ISdkLogger;
 }

packages/@aws-cdk/toolkit-lib/lib/api/aws-auth/sdk.ts

@@ -340,11 +340,12 @@ import { GetCallerIdentityCommand, STSClient } from '@aws-sdk/client-sts';
 import { Upload } from '@aws-sdk/lib-storage';
 import { getEndpointFromInstructions } from '@smithy/middleware-endpoint';
 import type { NodeHttpHandlerOptions } from '@smithy/node-http-handler';
-import type { AwsCredentialIdentityProvider, Logger } from '@smithy/types';
+import type { AwsCredentialIdentityProvider } from '@smithy/types';
 import { ConfiguredRetryStrategy } from '@smithy/util-retry';
 import type { WaiterResult } from '@smithy/util-waiter';
 import { AccountAccessKeyCache } from './account-cache';
 import { cachedAsync } from './cached';
+import type { ISdkLogger } from './sdk-logger';
 import type { Account } from './sdk-provider';
 import { traceMemberMethods } from './tracing';
 import { defaultCliUserAgent } from './user-agent';
@@ -385,7 +386,7 @@ export interface ConfigurationOptions {
   requestHandler: NodeHttpHandlerOptions;
   retryStrategy: ConfiguredRetryStrategy;
   customUserAgent: string;
-  logger?: Logger;
+  logger?: ISdkLogger;
   s3DisableBodySigning?: boolean;
   computeChecksums?: boolean;
 }
@@ -562,7 +563,7 @@ export class SDK {
 
   public readonly config: ConfigurationOptions;
 
-  protected readonly logger?: Logger;
+  protected readonly logger?: ISdkLogger;
 
   private readonly accountCache;
 
@@ -590,7 +591,7 @@ export class SDK {
     region: string,
     requestHandler: NodeHttpHandlerOptions,
     ioHelper: IoHelper,
-    logger?: Logger,
+    logger?: ISdkLogger,
   ) {
     const debugFn = async (msg: string) => ioHelper.notify(IO.DEFAULT_SDK_DEBUG.msg(msg));
     this.accountCache = new AccountAccessKeyCache(AccountAccessKeyCache.DEFAULT_PATH, debugFn);

packages/@aws-cdk/toolkit-lib/lib/api/aws-auth/tracing.ts

@@ -1,4 +1,4 @@
-import type { Logger } from '@smithy/types';
+import type { ISdkLogger } from './sdk-logger';
 
 let ENABLED = false;
 let INDENT = 0;
@@ -10,7 +10,7 @@ export function setSdkTracing(enabled: boolean) {
 /**
  * Method decorator to trace a single static or member method, any time it's called
  */
-export function callTrace(fn: string, className?: string, logger?: Logger) {
+export function callTrace(fn: string, className?: string, logger?: ISdkLogger) {
   if (!ENABLED || !logger) {
     return;
   }

packages/@aws-cdk/toolkit-lib/lib/api/io/private/index.ts

@@ -1,5 +1,4 @@
 export * from './io-host-wrappers';
-export * from './sdk-logger';
 export * from './io-helper';
 export * from './level-priority';
 export * from './span';

packages/@aws-cdk/toolkit-lib/lib/api/io/private/sdk-logger.ts

@@ -36,7 +36,7 @@ import { patternsArrayForWatch } from '../actions/watch/private';
 import { BaseCredentials, type SdkConfig } from '../api/aws-auth';
 import { makeRequestHandler } from '../api/aws-auth/awscli-compatible';
 import type { SdkProviderServices } from '../api/aws-auth/private';
-import { SdkProvider } from '../api/aws-auth/private';
+import { SdkProvider, IoHostSdkLogger } from '../api/aws-auth/private';
 import { Bootstrapper } from '../api/bootstrap';
 import type { ICloudAssemblySource } from '../api/cloud-assembly';
 import { CachedCloudAssembly, StackSelectionStrategy } from '../api/cloud-assembly';
@@ -47,7 +47,7 @@ import { Deployments } from '../api/deployments';
 import { DiffFormatter } from '../api/diff';
 import type { IIoHost, IoMessageLevel, ToolkitAction } from '../api/io';
 import type { IoHelper } from '../api/io/private';
-import { asIoHelper, asSdkLogger, IO, SPAN, withoutColor, withoutEmojis, withTrimmedWhitespace } from '../api/io/private';
+import { asIoHelper, IO, SPAN, withoutColor, withoutEmojis, withTrimmedWhitespace } from '../api/io/private';
 import { CloudWatchLogEventMonitor, findCloudWatchLogGroups } from '../api/logs-monitor';
 import { PluginHost } from '../api/plugin';
 import { AmbiguityError, ambiguousMovements, findResourceMovements, formatAmbiguousMappings, formatTypedMappings, fromManifestAndExclusionList, resourceMappings } from '../api/refactoring';
@@ -182,7 +182,7 @@ export class Toolkit extends CloudAssemblySourceBuilder {
       const services: SdkProviderServices = {
         ioHelper,
         requestHandler: await makeRequestHandler(ioHelper, this.props.sdkConfig?.httpOptions),
-        logger: asSdkLogger(ioHelper),
+        logger: new IoHostSdkLogger(ioHelper),
         pluginHost: this.pluginHost,
       };
 

packages/@aws-cdk/toolkit-lib/lib/toolkit/toolkit.ts

@@ -1,22 +1,22 @@
-import { formatSdkLoggerContent, SdkToCliLogger } from '../../../lib/api/aws-auth/private';
+import { formatSdkLoggerContent, IoHostSdkLogger } from '../../../lib/api/aws-auth/private';
 
-describe(SdkToCliLogger, () => {
+describe(IoHostSdkLogger, () => {
   const ioHost = {
     notify: jest.fn(),
     requestResponse: jest.fn(),
   };
-  const logger = new SdkToCliLogger(ioHost as any);
+  const logger = new IoHostSdkLogger(ioHost as any);
 
   beforeEach(() => {
     ioHost.notify.mockReset();
   });
 
-  test.each(['trace', 'debug'] as Array<keyof SdkToCliLogger>)('%s method does not call notify', (method) => {
+  test.each(['trace', 'debug'] as Array<keyof IoHostSdkLogger>)('%s method does not call notify', (method) => {
     logger[method]('SDK Logger test message');
     expect(ioHost.notify).not.toHaveBeenCalled();
   });
 
-  test.each(['info', 'warn', 'error'] as Array<keyof SdkToCliLogger>)('%s method logs to notify', (method) => {
+  test.each(['info', 'warn', 'error'] as Array<keyof IoHostSdkLogger>)('%s method logs to notify', (method) => {
     logger[method]('SDK Logger test message');
     expect(ioHost.notify).toHaveBeenCalledWith(expect.objectContaining({
       level: 'trace',

packages/@aws-cdk/toolkit-lib/test/api/aws-auth/sdk-logger.test.ts

@@ -11,7 +11,7 @@ import { Configuration } from './user-configuration';
 import * as version from './version';
 import { ToolkitError } from '../../../@aws-cdk/toolkit-lib';
 import { asIoHelper, IO } from '../../../@aws-cdk/toolkit-lib/lib/api/io/private';
-import { SdkProvider, SdkToCliLogger, setSdkTracing } from '../api/aws-auth';
+import { SdkProvider, IoHostSdkLogger, setSdkTracing } from '../api/aws-auth';
 import type { BootstrapSource } from '../api/bootstrap';
 import { Bootstrapper } from '../api/bootstrap';
 import type { DeploymentMethod } from '../api/deployments';
@@ -123,7 +123,7 @@ export async function exec(args: string[], synthesizer?: Synthesizer): Promise<n
       proxyAddress: argv.proxy,
       caBundlePath: argv['ca-bundle-path'],
     }),
-    logger: new SdkToCliLogger(asIoHelper(ioHost, ioHost.currentAction as any)),
+    logger: new IoHostSdkLogger(asIoHelper(ioHost, ioHost.currentAction as any)),
     pluginHost: GLOBAL_PLUGIN_HOST,
   });