fix(custom-resource-handlers): better fallback for require failures

packages/@aws-cdk/custom-resource-handlers/lib/custom-resources/aws-custom-resource-handler/aws-sdk-v3-handler.ts

@@ -40,34 +40,33 @@ interface AwsSdk {
 async function loadAwsSdk(
   packageName: string,
   installLatestAwsSdk?: 'true' | 'false',
-) {
-  let awsSdk: AwsSdk;
+): Promise<AwsSdk> {
   try {
     if (!installedSdk[packageName] && installLatestAwsSdk === 'true') {
+      // Try to install the latest version
       try {
         installLatestSdk(packageName);
-        // MUST use require here. Dynamic import() do not support importing from directories
-        // esbuild-disable unsupported-require-call -- not esbuildable but that's fine
-        awsSdk = require(`/tmp/node_modules/${packageName}`);
       } catch (e) {
         console.log(`Failed to install latest AWS SDK v3. Falling back to pre-installed version. Error: ${e}`);
-        // MUST use require as dynamic import() does not support importing from directories
-        // esbuild-disable unsupported-require-call -- not esbuildable but that's fine
-        return require(packageName); // Fallback to pre-installed version
       }
+    }
 
-    } else if (installedSdk[packageName]) {
-      // MUST use require here. Dynamic import() do not support importing from directories
-      // esbuild-disable unsupported-require-call -- not esbuildable but that's fine
-      awsSdk = require(`/tmp/node_modules/${packageName}`);
-    } else {
-      // esbuild-disable unsupported-require-call -- not esbuildable but that's fine
-      awsSdk = require(packageName);
+    if (installedSdk[packageName]) {
+      // Try to load the installed version
+      try {
+        // MUST use require here. Dynamic import() do not support importing from directories
+        // esbuild-disable unsupported-require-call -- not esbuildable but that's fine
+        return require(`/tmp/node_modules/${packageName}`);
+      } catch (e) {
+        console.log(`Failed to load latest AWS SDK v3. Falling back to pre-installed version. Error: ${e}`);
+      }
     }
+    // MUST use require as dynamic import() does not support importing from directories
+    // esbuild-disable unsupported-require-call -- not esbuildable but that's fine
+    return require(packageName); // Fallback to pre-installed version
   } catch (error) {
     throw Error(`Package ${packageName} does not exist.`);
   }
-  return awsSdk;
 }
 
 /* eslint-disable @typescript-eslint/no-require-imports, import/no-extraneous-dependencies */

packages/@aws-cdk/custom-resource-handlers/test/custom-resources/aws-custom-resource/aws-sdk-v3-handler.test.ts

@@ -1,6 +1,7 @@
 /* eslint-disable import/no-extraneous-dependencies */
 process.env.AWS_REGION = 'us-east-1';
 
+import { execSync } from 'child_process';
 import { CloudWatchClient, GetMetricDataCommand } from '@aws-sdk/client-cloudwatch';
 import { EncryptCommand, KMSClient } from '@aws-sdk/client-kms';
 import * as S3 from '@aws-sdk/client-s3';
@@ -16,14 +17,12 @@ import 'aws-sdk-client-mock-jest' ;
 // 5s timeout
 jest.setTimeout(60_000);
 
-const mockExecSync = jest.fn();
+const mockExecSync = jest.mocked(execSync);
 jest.mock('child_process', () => {
-  return jest.fn().mockImplementation(() => {
-    return {
-      ...(jest.requireActual('child_process')),
-      execSync: mockExecSync,
-    };
-  });
+  return {
+    ...(jest.requireActual('child_process')),
+    execSync: jest.fn(),
+  };
 });
 
 beforeEach(() => {
@@ -493,6 +492,9 @@ test('installs the latest SDK', async () => {
   // Now remove the symlink and let the handler install it
   await fs.unlink(tmpPath);
 
+  // unmock execSync for this test only
+  mockExecSync.mockImplementationOnce(jest.requireActual('child_process').execSync);
+
   localS3MockClient.on(localAwsSdk.GetObjectCommand).resolves({});
 
   const event: AWSLambda.CloudFormationCustomResourceCreateEvent = {
@@ -523,6 +525,9 @@ test('installs the latest SDK', async () => {
 
   expect(request.isDone()).toBeTruthy();
 
+  // require cache may succeed even if the path doesn't exist,
+  // so we check both
+  expect(await fs.pathExists(tmpPath)).toBeTruthy();
   expect(() => require.resolve(tmpPath)).not.toThrow();
 
   // clean up aws-sdk install
@@ -565,6 +570,68 @@ test('falls back to installed sdk if installation fails', async () => {
   expect(request.isDone()).toBeTruthy();
 });
 
+test('falls back to installed sdk if require fails', async () => {
+  s3MockClient.on(S3.GetObjectCommand).resolves({});
+
+  const firstEvent: AWSLambda.CloudFormationCustomResourceCreateEvent = {
+    ...eventCommon,
+    RequestType: 'Create',
+    ResourceProperties: {
+      ServiceToken: 'token',
+      Create: JSON.stringify({
+        service: '@aws-sdk/client-s3',
+        action: 'GetObjectCommand',
+        parameters: {
+          Bucket: 'my-bucket',
+          Key: 'key',
+        },
+        physicalResourceId: { id: 'id' },
+        logApiResponseData: true,
+      } satisfies AwsSdkCall),
+      InstallLatestAwsSdk: 'true',
+    },
+  };
+
+  // handler will invoke execSync mock to install @aws-sdk/client-s3
+  // the mock will not throw an error, so it will mark it as installed
+  // the require will fail, because the mock didn't *actually* install
+  // the package, and will fall back to the pre-installed version
+  createRequest(body =>
+    body.Status === 'SUCCESS',
+  );
+  await handler(firstEvent, {} as AWSLambda.Context);
+
+  const secondEvent: AWSLambda.CloudFormationCustomResourceCreateEvent = {
+    ...eventCommon,
+    RequestType: 'Create',
+    ResourceProperties: {
+      ServiceToken: 'token',
+      Create: JSON.stringify({
+        service: '@aws-sdk/client-s3',
+        action: 'GetObjectCommand',
+        parameters: {
+          Bucket: 'my-bucket',
+          Key: 'key',
+        },
+        physicalResourceId: { id: 'id' },
+        logApiResponseData: true,
+      } satisfies AwsSdkCall),
+      InstallLatestAwsSdk: 'true',
+    },
+  };
+
+  // second handler will see that install had been successful, but its
+  // require will fail and fall back to the pre-installed version
+  const request = createRequest(body =>
+    body.Status === 'SUCCESS',
+  );
+  await handler(secondEvent, {} as AWSLambda.Context);
+
+  // Reset to 'false' so that the next run will reinstall aws-sdk
+  forceSdkInstallation();
+  expect(request.isDone()).toBeTruthy();
+});
+
 test('SDK credentials are not persisted across subsequent invocations', async () => {
   // GIVEN
   s3MockClient.on(S3.GetObjectCommand).resolves({});