[Xcodeproj] Sort targets and their groups in manifest definition order

[matthewseaman]

[SR-8204] Sort targets and their groups in the following order:

1. Root Aggregate Products
2. Root Targets
3. Root Test Targets
4. Dependency 1 Aggregate Products
5. Dependency 1 Targets
6. Dependency 1 Test Targets
7. (Repeated for dependencies in alphabetical order)
8. Root Package Description
9. Dependency Package Descriptions (in alphabetical order by package)

Within each category, targets are sorted in manifest definition order.

Resolved targets are received from the PackageGraph unordered due to the implementation of the package graph. Rather than mess with how packages are collected, a TargetSortDescriptor type is introduced that stores a number of mappings (to achieve O(n) sort) and follows the rules for the ordered list above.

This way, the implementation of this feature does not add complexity outside of the Xcodeproj module. Additionally, using a separate sort descriptor prevents us from needing to modify the order that targets are added when building the Project model, as the building logic relies on targets being added in a certain order.

Note: The old behavior is preserved with --sort-targets-alphabetically

[matthewseaman]

I need to fix a few tests, and possible add another.

[matthewseaman]

Hmm…this seems to have broken a few Xcodeproj FunctionalTests. In particular, Dependency targets in the "SystemModuleUser" and "SwiftCMixed" projects are not built in the Release directory.

[matthewseaman]

It seems that xcodebuild -alltargets doesn't build targets correctly if they come after the PackageDescription target in the PBXProject target list. Although this doesn't seem to matter when schemes are used, this is a problem when using xcodebuild on the command line. This PR always places PackageDescription targets last to avoid this issue, but more investigation may be warranted.

[matthewseaman]

@aciidb0mb3r Would it be correct to assume that this is no longer relevant since we're switching to Swift Packages in Xcode? If so, I can file a Radar on Xcode for this one and we can close this.