Skip to content

fix(s3-deployment): Source.jsonData() fails with null JSON values #36054

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

Merged
mergify merged 4 commits into from
Nov 14, 2025
Merged

fix(s3-deployment): Source.jsonData() fails with null JSON values #36054

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6abfbe7
fix(cdk-lib): S3 deployment fails on jsonData with null values
Lukanite Nov 14, 2025
d881d13
fix: missing semicolon and quote style
Lukanite Nov 14, 2025
aa2f475
chore: add integ test snapshot
Lukanite Nov 14, 2025
2bc2da3
Merge branch 'main' into Lukanite-escape-tokens-1
mergify[bot] Nov 14, 2025
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
1 change: 1 addition & 0 deletions ...c173740857dd772ca214c7ac8381483f7ee406d94fb9ff9e95ad407d876/my-json/config-with-null.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1,858 changes: 1,685 additions & 173 deletions ...0c8b1bb373e93297e26aec564.bundle/index.js → ...0d9464a947a386d38d8163515.bundle/index.js
View file
Open in desktop

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions ...data.js.snapshot/integtestbucketdeploymentdataDefaultTestDeployAssert6FF3075D.assets.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

56 changes: 53 additions & 3 deletions ...ta.js.snapshot/integtestbucketdeploymentdataDefaultTestDeployAssert6FF3075D.template.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

66 changes: 50 additions & 16 deletions ...-integ/test/aws-s3-deployment/test/integ.bucket-deployment-data.js.snapshot/manifest.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 17 additions & 3 deletions ...ent/test/integ.bucket-deployment-data.js.snapshot/test-bucket-deployment-data.assets.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 7 additions & 1 deletion ...t/test/integ.bucket-deployment-data.js.snapshot/test-bucket-deployment-data.template.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,9 @@
{
"Fn::Sub": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}"
},
{
"Fn::Sub": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}"
},
{
"Fn::Sub": "cdk-hnb659fds-assets-${AWS::AccountId}-${AWS::Region}"
}
Expand All @@ -230,7 +233,8 @@
"4ba8cfb53da242e91a423f3333c95db70ac0b5c2481a2d7e5c51142e5738403f.zip",
"4458891c23c9754723db261b607985ee4fce5a087343fca93e9608fb49e083ba.zip",
"c3f91ed893cc759513d80ebd56bcaae5061b08bff3dd8ad10daeb62558bac52e.zip",
"10cb9bf43614add407e699e4af8e1ba4a9789363f48fa816662b15885c354e1a.zip"
"10cb9bf43614add407e699e4af8e1ba4a9789363f48fa816662b15885c354e1a.zip",
"8de7dc173740857dd772ca214c7ac8381483f7ee406d94fb9ff9e95ad407d876.zip"
],
"SourceMarkers": [
{},
Expand Down Expand Up @@ -334,6 +338,7 @@
]
}
},
{},
{}
],
"SourceMarkersConfig": [
Expand All @@ -346,6 +351,7 @@
"jsonEscape": true
},
{},
{},
{}
],
"DestinationBucketName": {
Expand Down
2 changes: 1 addition & 1 deletion ...work-integ/test/aws-s3-deployment/test/integ.bucket-deployment-data.js.snapshot/tree.json
View file
Open in desktop

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions ...s-cdk-testing/framework-integ/test/aws-s3-deployment/test/integ.bucket-deployment-data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,9 @@ class TestBucketDeploymentData extends Stack {
// Test empty string handling
const file8 = Source.data('file8.txt', '');

// Test null JSON data value
const file9 = Source.jsonData('my-json/config-with-null.json', { hello: 'there', goodbye: null });

const deployment = new BucketDeployment(this, 'DeployWithDataSources', {
destinationBucket: this.bucket,
sources: [file1, file2],
Expand All @@ -77,6 +80,7 @@ class TestBucketDeploymentData extends Stack {
deployment.addSource(file6);
deployment.addSource(file7);
deployment.addSource(file8);
deployment.addSource(file9);

new CfnOutput(this, 'BucketName', { value: this.bucket.bucketName });
}
Expand Down Expand Up @@ -105,6 +109,17 @@ assertionProvider.expect(ExpectedResult.objectLike({
Body: '{"secret_value":"test\\"with\\"quotes"}',
}));

// Assert that JSON data with a null value is represented properly
const jsonNullAssertionProvider = integTest.assertions.awsApiCall('S3', 'getObject', {
Bucket: testCase.bucket.bucketName,
Key: path.join('deploy/here', 'my-json/config-with-null.json'),
});

// Verify the content is valid JSON and both null and non-null fields are present
jsonNullAssertionProvider.expect(ExpectedResult.objectLike({
Body: '{"hello":"there","goodbye":null}',
}));

// Add assertions to verify the YAML file
const yamlAssertionProvider = integTest.assertions.awsApiCall('S3', 'getObject', {
Bucket: testCase.bucket.bucketName,
Expand Down
2 changes: 1 addition & 1 deletion packages/aws-cdk-lib/aws-s3-deployment/lib/source.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ export class Source {
return obj.map(v => Source.escapeTokens(scope, v));
}

if (typeof obj === 'object') {
if (obj !== null && typeof obj === 'object') {
Copy link
Member

@Abogical Abogical Nov 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/typeof#typeof_null

Javascript, wth. 🤦

return Object.fromEntries(
Object.entries(obj).map(([key, value]) => {
// As JSON keys are always strings, keys are assumed to be either regular strings or string tokens.
Expand Down
Loading
Loading