Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(aspects): "localAspects is not iterable" error #32647

Merged
merged 8 commits into from
Dec 23, 2024
Merged

fix(aspects): "localAspects is not iterable" error #32647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5149588
WIP: add unit test
sumupitchayan Dec 23, 2024
bbee572
WIP: add getAspectApplications function
sumupitchayan Dec 23, 2024
098db1f
Merge branch 'main' into sumughan/aspects-applied-undefined-fix
sumupitchayan Dec 23, 2024
8d5898f
WIP: simplify unit test
sumupitchayan Dec 23, 2024
de17b5b
Merge branch 'sumughan/aspects-applied-undefined-fix' of https://gith…
sumupitchayan Dec 23, 2024
d296c8e
revert commit
sumupitchayan Dec 23, 2024
49915a2
WIP: simplify unit test
sumupitchayan Dec 23, 2024
c98f770
Merge branch 'main' into sumughan/aspects-applied-undefined-fix
mergify[bot] Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions packages/aws-cdk-lib/core/lib/private/synthesis.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { CloudAssembly } from '../../../cx-api';
import * as cxapi from '../../../cx-api';
import { Annotations } from '../annotations';
import { App } from '../app';
import { AspectApplication, Aspects } from '../aspect';
import { AspectApplication, AspectPriority, Aspects } from '../aspect';
import { FileSystem } from '../fs';
import { Stack } from '../stack';
import { ISynthesisSession } from '../stack-synthesizers/types';
Expand Down Expand Up @@ -228,7 +228,7 @@ function invokeAspects(root: IConstruct) {
const node = construct.node;
const aspects = Aspects.of(construct);

let localAspects = aspects.applied;
let localAspects = getAspectApplications(construct);
const allAspectsHere = sortAspectsByPriority(inheritedAspects, localAspects);

const nodeAspectsCount = aspects.all.length;
Expand Down Expand Up @@ -290,11 +290,10 @@ function invokeAspectsV2(root: IConstruct) {

function recurse(construct: IConstruct, inheritedAspects: AspectApplication[]): boolean {
const node = construct.node;
const aspects = Aspects.of(construct);

let didSomething = false;

let localAspects = aspects.applied;
let localAspects = getAspectApplications(construct);
const allAspectsHere = sortAspectsByPriority(inheritedAspects, localAspects);

for (const aspectApplication of allAspectsHere) {
Expand Down Expand Up @@ -354,6 +353,21 @@ function sortAspectsByPriority(inheritedAspects: AspectApplication[], localAspec
return allAspects;
}

/**
* Helper function to get aspect applications.
* If `Aspects.applied` is available, it is used; otherwise, create AspectApplications from `Aspects.all`.
*/
function getAspectApplications(node: IConstruct): AspectApplication[] {
const aspects = Aspects.of(node);
if (aspects.applied !== undefined) {
return aspects.applied;
}

// Fallback: Create AspectApplications from `aspects.all`
const typedAspects = aspects as Aspects;
return typedAspects.all.map(aspect => new AspectApplication(node, aspect, AspectPriority.DEFAULT));
}

/**
* Find all stacks and add Metadata Resources to all of them
*
Expand Down
20 changes: 20 additions & 0 deletions packages/aws-cdk-lib/core/test/aspect.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,4 +309,24 @@ describe('aspect', () => {
}
}
}

test.each([
{ stabilization: true },
{ stabilization: false },
])('Error is not thrown if Aspects.applied does not exist (stabilization: $stabilization)', ({ stabilization }) => {
const app = new App({ context: { '@aws-cdk/core:aspectStabilization': stabilization } });
const root = new Stack(app, 'My-Stack');

Aspects.of(root).add(new Tag('AspectA', 'Visited'));

// "Monkey patching" - Override `applied` to simulate its absence
Object.defineProperty(Aspects.prototype, 'applied', {
value: undefined,
configurable: true,
});

expect(() => {
app.synth();
}).not.toThrow();
});
});
Loading