Feature flags are being moved to cdk.context.json

[rix0rrr]

From #6929

Another thing I'd like to understand is the difference between cdk.json and cdk.context.json. I noticed if I put things like "@aws-cdk/core:enableStackNameDuplicates": "true", in cdk.json once I run diff they are moved to cdk.context.json, not sure why.

This should not happen. Overloading the flags as context makes it weird...

---

This is 🐛 Bug Report

[eladb]

I agree

[abelmokadem]

Thanks for opening this issue. This behaviour is quite annoying when you are doing some tests deployments on your local machine. Since we are not using cdk.context.json for our CI/CD, I have to keep reverting the git changes before committing.

[shivlaks]

@rix0rrr the issue is this method we have to migrate legacy context which has a heuristic that's fragile as it marks any context key with a : in it as eligible for moving. This logic was initially intended to move relevant context provider data into cdk.context.json

also @eladb called this one. It seems like we intended to remove the migration logic altogether a long time ago but did not. Is that still the desired outcome here?

If we need to keep the logic, we'd need to move to an explicit whitelist of keys that are eligible for moving. Otherwise, we're precluding usage (internal or user provided) of : character in context.

[eladb]

I don't like the migration logic. As a user, if I configure application context in cdk.json, I would expect it to stay there. I think cdk.context.json should be kept for context providers.

[shivlaks]

@eladb agreed.

Is the use case for moving legacy context provider keys still a valid one? this change was introduced in 0.25.1. If not we can remove altogether.

[eladb]

@eladb agreed.

Is the use case for moving legacy context provider keys still a valid one? this change was introduced in 0.25.1. If not we can remove altogether.

I think we can remove