Graceful migration for compartment-map.json tags to conditions #2388
Labels
enhancement
New feature or request
Comments
kriskowal
added a commit
that referenced
this issue
Jul 30, 2024
#2389) Refs: #2388 ## Description See #2388, we cannot at this time change the schema of `compartment-map.json` as I attempted in #2373 ### Security Considerations None. ### Scaling Considerations None. ### Documentation Considerations None. ### Testing Considerations None. ### Compatibility Considerations Restores backward compatibility for production systems. The file `app.agar` is a zip file generated by a previous version of the compartment mapper, used as a test fixture to verify that future versions can import ancient versions. To get tests passing in #2373, I regenerated `app.agar` and in this change, I revert it to the original schema. Having to regenerate `app.agar` is supposed to be a hint that something is broken, and I waltzed through the warnings. ### Upgrade Considerations None.
kriskowal
added a commit
that referenced
this issue
Jul 30, 2024
#2389) Refs: #2388 See #2388, we cannot at this time change the schema of `compartment-map.json` as I attempted in #2373 None. None. None. None. Restores backward compatibility for production systems. The file `app.agar` is a zip file generated by a previous version of the compartment mapper, used as a test fixture to verify that future versions can import ancient versions. To get tests passing in #2373, I regenerated `app.agar` and in this change, I revert it to the original schema. Having to regenerate `app.agar` is supposed to be a hint that something is broken, and I waltzed through the warnings. None.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What is the Problem Being Solved?
We discovered late that Node.js uses the term “conditions” where we currently use “tags” in
compartment-map.jsonand previously throughout the compartment mapper implementation.Description of the Design
This migration is tightly constrained. Production currently uses the compartment map validator to forbid any archive/bundle that has extraneous properties in
compartment-map.json.We may need to first ship into production a version that relaxes these constraints. We may need to do this in order to support any new fields in
compartment-map.json, as may be necessary to get source maps properly threaded.We may then need to adjust the bundler to produce both the old
tagsand newconditionsproperties on all new bundles.We may need a mechanism in
bundle-sourceto opt-in to generatingconditionsinstead oftags.Security Considerations
Scaling Considerations
Test Plan
Compatibility Considerations
This is a compatibility consideration top to bottom.
Upgrade Considerations
The text was updated successfully, but these errors were encountered: