fix(mixins-preview): AutoDeleteObjects mixin fails with cannot find file error

[go-to-k]

Issue # (if applicable)

N/A

Reason for this change

Synth fails when using the AutoDeleteObjects mixin:

import * as cdk from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { CfnBucket } from 'aws-cdk-lib/aws-s3';
import { AutoDeleteObjects } from '@aws-cdk/mixins-preview/aws_s3/mixins';
import '@aws-cdk/mixins-preview/with';
import { Mixins } from '@aws-cdk/mixins-preview/core';

export class CdkSampleStack extends cdk.Stack {
  constructor(scope: Construct, id: string, props?: cdk.StackProps) {
    super(scope, id, props);

    const bucket = new CfnBucket(this, 'MyBucket');
    Mixins.of(bucket).apply(new AutoDeleteObjects());
  }
}

Error messages:

❯ npx cdk synth
/Users/goto/cdk-sample/node_modules/@aws-cdk/mixins-preview/lib/custom-resource-handlers/aws-s3/auto-delete-objects-provider.ts:15
    return existing ?? new AutoDeleteObjectsProvider(stack, id, props);
                       ^
ValidationError: cannot find /Users/goto/cdk-sample/node_modules/@aws-cdk/mixins-preview/lib/custom-resource-handlers/dist/aws-s3/auto-delete-objects-handler/index.js
    at path [CdkSampleStack/Custom::S3AutoDeleteObjectsCustomResourceProvider] in aws-cdk-lib.CustomResourceProviderBase

    at Function.getOrCreateProvider (/Users/goto/cdk-sample/node_modules/@aws-cdk/mixins-preview/lib/custom-resource-handlers/aws-s3/auto-delete-objects-provider.ts:15:24)
    at AutoDeleteObjects.applyTo (/Users/goto/cdk-sample/node_modules/@aws-cdk/mixins-preview/lib/services/aws-s3/bucket.ts:27:48)
    at MixinApplicator.apply (/Users/goto/cdk-sample/node_modules/@aws-cdk/mixins-preview/lib/core/applicator.ts:29:17)
    at new CdkSampleStack (/Users/goto/cdk-sample/lib/cdk-sample-stack.ts:14:53)
    at Object.<anonymous> (/Users/goto/cdk-sample/bin/cdk-sample.ts:9:1)
    at Module._compile (node:internal/modules/cjs/loader:1554:14)
    at Module.m._compile (/Users/goto/cdk-sample/node_modules/ts-node/src/index.ts:1618:23)
    at node:internal/modules/cjs/loader:1706:10
    at Object.require.extensions.<computed> [as .ts] (/Users/goto/cdk-sample/node_modules/ts-node/src/index.ts:1621:12)
    at Module.load (node:internal/modules/cjs/loader:1289:32)

AutoDeleteObjectsProvider specifies:

  private constructor(scope: Construct, id: string, props?: CustomResourceProviderOptions) {
    super(scope, id, {
      ...props,
      codeDirectory: path.join(__dirname, '..', 'dist', 'aws-s3', 'auto-delete-objects-handler'),

And the script copies the dist files.

But .npmignore ignores dist, so code for auto-delete-objects-provider cannot be provided to user's module.

# There should be a 'dist' folder, but it is not there...

❯ ls node_modules/@aws-cdk/mixins-preview/lib/custom-resource-handlers/
  aws-s3

Description of changes

Describe any new or updated permissions being added

Added !lib/custom-resource-handlers/dist to packages/@aws-cdk/mixins-preview/.npmignore.

Description of how you validated changes

Checklist

• My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

---

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

[aws-cdk-automation]

(This review is outdated)

[go-to-k]

Exemption Request: This PR changes the npmignore file only.

[mrgrain]

Ha, thanks for that 🙈

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

Pull request has been modified.

[mergify]

Merge Queue Status

✅ The pull request has been merged

This pull request spent 28 minutes 15 seconds in the queue, including 28 minutes 6 seconds waiting for CI.
The checks were run in-place.

Required conditions to merge

• #approved-reviews-by >= 1 [🛡 GitHub branch protection]
  • fix(mixins-preview): AutoDeleteObjects mixin fails with cannot find file error #36188
• #changes-requested-reviews-by = 0 [🛡 GitHub branch protection]
  • fix(mixins-preview): AutoDeleteObjects mixin fails with cannot find file error #36188
• any of [🛡 GitHub branch protection]:
  • check-success = validate-pr
  • check-neutral = validate-pr
  • check-skipped = validate-pr
• any of [🛡 GitHub branch protection]:
  • check-success = build
  • check-neutral = build
  • check-skipped = build

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[github-actions]

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.