Stop bundling in tests

.changeset/mighty-jokes-argue.md

@@ -0,0 +1,7 @@
+---
+'skuba': minor
+---
+
+lint: Add a **skuba** patch to automatically stop CDK snapshot tests from calling esbuild bundling.
+
+Calling esbuild bundling during unit tests can be slow. This change looks for `new App()` use in `infra` folder test files, and if found, replacing with `new App({ context: { 'aws:cdk:bundling-stacks': [] } })`. This context signals AWS CDK to skip bundling for the test stack.

.changeset/new-cars-fix.md

@@ -0,0 +1,5 @@
+---
+'skuba': patch
+---
+
+template/lambda-sqs-worker-cdk: Update test to skip esbuild bundling by using the AWS CDK context key `aws:cdk:bundling-stacks`

src/cli/__snapshots__/format.int.test.ts.snap

@@ -38,6 +38,8 @@ Patch applied: Upgrade Node.js to version 22 upgrade-skuba
 
 Patch skipped: Remove yarn --ignore-optional flags in Dockerfiles - no Dockerfiles found upgrade-skuba
 
+Patch skipped: Stop bundling inside CDK unit tests - no CDK test files found upgrade-skuba
+
 skuba update complete. upgrade-skuba
 
 Refreshed .gitignore. refresh-config-files
@@ -131,6 +133,8 @@ Patch applied: Upgrade Node.js to version 22 upgrade-skuba
 
 Patch skipped: Remove yarn --ignore-optional flags in Dockerfiles - no Dockerfiles found upgrade-skuba
 
+Patch skipped: Stop bundling inside CDK unit tests - no CDK test files found upgrade-skuba
+
 skuba update complete. upgrade-skuba
 
 Refreshed .gitignore. refresh-config-files
@@ -219,6 +223,8 @@ Patch applied: Upgrade Node.js to version 22 upgrade-skuba
 
 Patch skipped: Remove yarn --ignore-optional flags in Dockerfiles - no Dockerfiles found upgrade-skuba
 
+Patch skipped: Stop bundling inside CDK unit tests - no CDK test files found upgrade-skuba
+
 skuba update complete. upgrade-skuba
 
 Refreshed .gitignore. refresh-config-files
@@ -278,6 +284,8 @@ Patch applied: Upgrade Node.js to version 22 upgrade-skuba
 
 Patch skipped: Remove yarn --ignore-optional flags in Dockerfiles - no Dockerfiles found upgrade-skuba
 
+Patch skipped: Stop bundling inside CDK unit tests - no CDK test files found upgrade-skuba
+
 skuba update complete. upgrade-skuba
 
 Refreshed .gitignore. refresh-config-files

src/cli/lint/internalLints/upgrade/patches/10.1.0/index.ts

@@ -0,0 +1,10 @@
+import type { Patches } from '../..';
+
+import { tryStopBundlingInCDKTests } from './stopBundlingInCDKTests';
+
+export const patches: Patches = [
+  {
+    apply: tryStopBundlingInCDKTests,
+    description: 'Stop bundling inside CDK unit tests',
+  },
+];

src/cli/lint/internalLints/upgrade/patches/10.1.0/stopBundlingInCDKTests.test.ts

@@ -0,0 +1,124 @@
+import memfs, { vol } from 'memfs';
+
+import type { PatchConfig } from '../..';
+import { configForPackageManager } from '../../../../../../utils/packageManager';
+
+import {
+  hasAppImportRegex,
+  tryStopBundlingInCDKTests,
+} from './stopBundlingInCDKTests';
+
+const volToJson = () => vol.toJSON(process.cwd(), undefined, true);
+
+jest.mock('fs-extra', () => memfs);
+jest.mock('fast-glob', () => ({
+  glob: (pat: any, opts: any) =>
+    jest.requireActual('fast-glob').glob(pat, { ...opts, fs: memfs }),
+}));
+
+beforeEach(() => vol.reset());
+
+describe('stopBundlingInCDKTests', () => {
+  const baseArgs = {
+    manifest: {} as PatchConfig['manifest'],
+    packageManager: configForPackageManager('yarn'),
+  };
+
+  afterEach(() => jest.resetAllMocks());
+
+  describe.each(['lint', 'format'] as const)('%s', (mode) => {
+    it('should skip if no CDK test files are found', async () => {
+      await expect(
+        tryStopBundlingInCDKTests({
+          ...baseArgs,
+          mode,
+        }),
+      ).resolves.toEqual({
+        result: 'skip',
+        reason: 'no CDK test files found',
+      });
+
+      expect(volToJson()).toEqual({});
+    });
+
+    it('should skip if no App import is found from aws-cdk-lib', async () => {
+      const input = `const myApp = new App();`;
+
+      vol.fromJSON({
+        'apps/my-worker/infra/myWorkerStack.test.ts': input,
+      });
+
+      await expect(
+        tryStopBundlingInCDKTests({
+          ...baseArgs,
+          mode,
+        }),
+      ).resolves.toEqual({
+        result: 'skip',
+        reason: 'no CDK test files need patching',
+      });
+
+      expect(volToJson()).toEqual({
+        'apps/my-worker/infra/myWorkerStack.test.ts': input,
+      });
+    });
+
+    it('should patch a detected bare App() constructor', async () => {
+      const input = `import { App } from "aws-cdk-lib";\nconst app = new App();\n\nother stuff\n\nconst secondApp = new App();`;
+
+      const inputVolume = {
+        'infra/myWorkerStack.test.ts': input,
+      };
+
+      vol.fromJSON(inputVolume);
+
+      await expect(
+        tryStopBundlingInCDKTests({
+          ...baseArgs,
+          mode,
+        }),
+      ).resolves.toEqual({
+        result: 'apply',
+      });
+
+      expect(volToJson()).toEqual(
+        mode === 'lint'
+          ? inputVolume
+          : {
+              'infra/myWorkerStack.test.ts': `import { App } from "aws-cdk-lib";\nconst app = new App({ context: { 'aws:cdk:bundling-stacks': [] } });\n\nother stuff\n\nconst secondApp = new App({ context: { 'aws:cdk:bundling-stacks': [] } });`,
+            },
+      );
+    });
+  });
+});
+
+describe('hasAppImportRegex', () => {
+  it.each([
+    ['Bare', 'import { App } from "aws-cdk-lib";'],
+    ['Other after', 'import { App, aws_sns } from "aws-cdk-lib";'],
+    [
+      'Surrounded',
+      "import { aws_sns, App, aws_secretsmanager } from 'aws-cdk-lib';",
+    ],
+    ['Other before', 'import { aws_sns, App } from "aws-cdk-lib";'],
+    ['newline', 'import { App\n} from "aws-cdk-lib";'],
+    [
+      'newline surrounded',
+      'import {\n  aws_secretsmanager\n,  App\n, aws_sns\n} from "aws-cdk-lib";',
+    ],
+  ])('should match %s', (_, input: string) => {
+    expect(input).toMatch(hasAppImportRegex);
+  });
+
+  it.each([
+    ['No App', 'import { aws_sns } from "aws-cdk-lib";'],
+    ['Other import', 'import { aws_sns } from "aws-cdk-lib";'],
+    ['Other lib', 'import { App } from "aws-some-other-lib";'],
+    [
+      'App on one line and then aws-cdk-lib on another',
+      'import { App } from "some-lib";\nimport { aws_sns } from "aws-cdk-lib";',
+    ],
+  ])('should not match %s', (_, input: string) => {
+    expect(input).not.toMatch(hasAppImportRegex);
+  });
+});

src/cli/lint/internalLints/upgrade/patches/10.1.0/stopBundlingInCDKTests.ts

@@ -0,0 +1,85 @@
+import { inspect } from 'util';
+
+import { glob } from 'fast-glob';
+import { promises as fs } from 'fs-extra';
+
+import type { PatchFunction, PatchReturnType } from '../..';
+import { log } from '../../../../../../utils/logging';
+
+const fetchFiles = async (files: string[]) =>
+  Promise.all(
+    files.map(async (file) => {
+      const contents = await fs.readFile(file, 'utf8');
+
+      return {
+        file,
+        contents,
+      };
+    }),
+  );
+
+export const hasAppImportRegex =
+  /import\s*\{\s*(?:[^}]*,\s*)?App\s*(?:,\s*[^}]*)?\s*\}\s*from\s*['"]aws-cdk-lib['"]/gm;
+
+const addBundlingContext = (contents: string) => {
+  if (contents.includes('new App()') && hasAppImportRegex.test(contents)) {
+    return contents.replaceAll(
+      'new App()',
+      "new App({ context: { 'aws:cdk:bundling-stacks': [] } })",
+    );
+  }
+
+  return contents;
+};
+
+const stopBundlingInCDKTests: PatchFunction = async ({
+  mode,
+}): Promise<PatchReturnType> => {
+  const infraTestFileNames = await glob(['**/infra/**/*.test.ts']);
+
+  if (!infraTestFileNames.length) {
+    return {
+      result: 'skip',
+      reason: 'no CDK test files found',
+    };
+  }
+
+  const infraTestFiles = await fetchFiles(infraTestFileNames);
+
+  const mapped = infraTestFiles.map(({ file, contents }) => ({
+    file,
+    before: contents,
+    after: addBundlingContext(contents),
+  }));
+
+  if (!mapped.some(({ before, after }) => before !== after)) {
+    return {
+      result: 'skip',
+      reason: 'no CDK test files need patching',
+    };
+  }
+
+  if (mode === 'lint') {
+    return {
+      result: 'apply',
+    };
+  }
+
+  await Promise.all(
+    mapped.map(async ({ file, after }) => {
+      await fs.writeFile(file, after);
+    }),
+  );
+
+  return { result: 'apply' };
+};
+
+export const tryStopBundlingInCDKTests: PatchFunction = async (config) => {
+  try {
+    return await stopBundlingInCDKTests(config);
+  } catch (err) {
+    log.warn('Failed to remove bundling in CDK tests');
+    log.subtle(inspect(err));
+    return { result: 'skip', reason: 'due to an error' };
+  }
+};

template/lambda-sqs-worker-cdk/infra/appStack.test.ts

@@ -45,7 +45,7 @@ it.each(['dev', 'prod'])(
         (scope, id) => new aws_secretsmanager.Secret(scope, id),
       );
 
-    const app = new App();
+    const app = new App({ context: { 'aws:cdk:bundling-stacks': [] } });
 
     const stack = new AppStack(app, 'appStack');