Fix unstable reads for XCSchemeManagement
#758
Merged
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
Resolves: #756 - Reading the same `xcschememanagement.plist` file was resulting in different `XCSchemeManagement` objects - This was due to the internal conversion of the `schemeUserState` from a dictionary to an array without sorting the dictionary key - This lead to having differently ordered `XCSchemeManagement` arrays each time the plist was read - Wrties were stable (going from `XCSchemeManagement` > `plist`) is most likely why this wasn't previously noticed - To address this, they dictionary elements are sorted by key name - Read stability tests have also been added and fixture updated to include more entries to aid with testing Note: it's unclear why the `schemeUserState` is stored as an array, it's a candidate to be changed to dictionary in the next major release as it would be a breaking change to do so now without any compatibility accessors to maintain the same public API. Test Plan: - Verify unit tests pass - Verify writing an `xcschememanagement.plist` file remains unchanged by these changes
6 tasks
2 tasks
brentleyjones
approved these changes
Apr 22, 2023
danieleformichelli
approved these changes
Apr 23, 2023
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.
Resolves: #756
Short description 📝
xcschememanagement.plistfile was resulting in differentXCSchemeManagementobjectsschemeUserStatefrom a dictionary to an array without sorting the dictionary keyXCSchemeManagementarrays each time the plist was readXCSchemeManagement>plist) is most likely why this wasn't previously noticedSolution 📦
Test Plan 🛠️
xcschememanagement.plistfile remains unchanged by these changesNotes 📝
it's unclear why the
schemeUserStateis stored as an array, it's a candidate to be changed to dictionary in the next major release as it would be a breaking change to do so now without any compatibility accessors to maintain the same public API.