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.

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

(core): formatAnalytics is documented as supporting plaintext but doesn't #28254

Open
gricey432 opened this issue Dec 5, 2023 · 2 comments
Open
Labels
@aws-cdk/core Related to core CDK functionality bug This issue is a bug. effort/medium Medium work item – several days of effort p2

Comments

@gricey432
Copy link

Describe the bug

https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/core/lib/private/metadata-resource.ts#L65 suggests there's an option to have the analytics format be plaintext rather than compressed. I can't find any other references to v2:plaintext in the codebase.

Expected Behavior

Current Behavior

Docstring doesn't describe code

Reproduction Steps

Possible Solution

I'm unsure if the code is wrong or if the docstring is wrong, someone who knows the project better than me would have to make that call.

Additional Information/Context

I found this while trying to debug an issue with the metadata "flipping" back and forward on the same code from two different developers. Plaintext would be really helpful here since a deflate64 string is basically useless in cdk diff

CDK CLI Version

2.113.0 (build ccd534a)

Framework Version

No response

Node.js Version

v18.17.1

OS

Windows 11

Language

TypeScript

Language Version

No response

Other information

No response

@gricey432 gricey432 added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Dec 5, 2023
@github-actions github-actions bot added the @aws-cdk/core Related to core CDK functionality label Dec 5, 2023
@pahud
Copy link
Contributor

pahud commented Dec 5, 2023

Looks like it always returns v2:deflate64?

return `v2:deflate64:${compressedConstructs}`;

@pahud pahud added p2 response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. effort/medium Medium work item – several days of effort and removed needs-triage This issue or PR still needs to be triaged. labels Dec 5, 2023
@gricey432
Copy link
Author

response-requested

Sorry, what response do you need from me here? It definitely also looks to me that it returns only deflate as you said.

@github-actions github-actions bot removed the response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. label Dec 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/core Related to core CDK functionality bug This issue is a bug. effort/medium Medium work item – several days of effort p2
Projects
None yet
Development

No branches or pull requests

2 participants