fix: Shallow copy group_entities and person_entity when cloning TBS #294
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Temporarily moving to draft; I think we can actually re-enable the two tests removed previously, but want to confirm |
nikhilwoodruff
approved these changes
Oct 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #293.
Previous fixes to
-coreensured that when a TaxBenefitSystem object was cloned via its internal.clone()method, entities themselves were shallow copied to prevent stale variable versions from being transferred between systems. However, this fix assumed thatGroupEntityandPopulationEntityobjects were included within theTaxBenefitySystem'sentitieskey, when they are not.This led structural reform runs to crash, as the
GroupEntityandPopulationEntitywould possess stale variable versions from the API's first instantiation of the default tax-benefit system, attempt to calculate using this, then crash when they couldn't find a variable that had been newly created as part of a structural reform.This PR ensures that
GroupEntityandPopulationEntityobjects are also shallow-copied to prevent this behavior. This PR does not add tests at the moment, but I have opened an issue in the-apipackage laying out a comprehensive series of tests around structural reforms at PolicyEngine/policyengine-api#1885. I have also opened a draft PR in the-uspackage to ensure these changes cause no test failures there (PolicyEngine/policyengine-us#5240).