[Traits] Change TraitConfiguration to be an enum instead of struct
#8370
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
To phase in the modification to TraitConfiguration, start with the new enum and match the inits configured for the legacy TraitConfiguration struct
…method * enabledTraits will now instead default to using the new trait config * comment out enabledTraits legacy method in favour of enabledTraits2; begin using this method instead. To rename to enabledTraits. * remove optional TraitConfiguration parameters, since enum encapsulates a "no configuration" case. TODO: * Must still clean up commented out code * Ensure behaviour still operates as expected * Add tests for calculateAllEnabledTraits, as this is now public * Ensure checks on TraitConfiguration aren't redundant i.e. make appropriate use of the new structure * Pre-calculate enabled traits across the root with the TraitConfiguration and store where appropriate so we don't have to recalculate this constantly
- Since we will calculate all enabled traits for root manifests in the PackageGraphRoot init (which can throw depending on whether there is a non-allowable trait configuration passed), allow the init to throw this error as well. - Clean up some commented code - Replace redundant calculations of enabled traits since we now store the calculated traits in the PackageGraphRoot TODO: - Address disallow disabling traits test not catching error - More cleanup of commented out code
bkhouri
reviewed
Mar 19, 2025
- Updated the test that asserts for an error thrown when disabling
default traits for a package with no traits; prior, there was a
chance to encounter a false positive if there was no error
being thrown due to the do/catch block. Now, we assert for an
error being thrown and check that it's the expected error message.
- Changed the case names for TraitConfiguration:
- noConfiguration -> none
- noEnabledTraits -> disableAllTraits
- Added optional parameter to calculateAllEnabledTraits entitled
'parentPackage' that keeps a reference to the parent package
(if any) when computing the enabled traits of a package; this
way, we can meaningfully report an error if a parent package
sets an unallowable set of traits to be enabled/disabled for
a dependency.
- Move the trait helper and validation methods to a separate file (Manifest/Manifest+Traits.swift) and move the TraitConfiguration into the PackageModel instead of PackageGraph; updated the appropriate CMakeLists.txt - Update TraitConfiguration computed variable for enabled traits; '.none' case should return '["default"]', as that is what its behaviour defaults to. Removed other computed variables in favor of checking the enum cases themselves where appropriate.
- To support further testing on traits and their possible configurations, set traits where appropriate in the MockDependency + make PackageDependency.Trait public to allow its use in the mocks. - Fixed up the error messages displayed for traits - Added more tests to cover various possible configurations of traits
|
@swift-ci please test |
|
@swift-ci please test |
|
Definitely cleans things up. Let me know when it's ready and I'll do a final run through. |
|
@swift-ci please test windows |
|
@swift-ci please test self hosted windows |
|
@swift-ci please test self hosted windows |
- Cleaned up commented code - Assure that enabledTraits on the PackageGraphRoot also considers the root's dependencies enabled traits, specified by the root itself
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 #8355.
Since the way a
TraitConfigurationis set up can affect how traits are calculated and whether default traits are overridden or not, it's more ergonomic to change this to anenumthat lists the various possible cases of configuration:This way we can avoid doing multiple checks on the properties of the
structand instead rely on the exact case that describes how to continue calculating enabled traits.The refactoring done as a part of this change also fixes #8356.