Make AppIntentsMetadataProcessor outputs deterministic #2761
Conversation
This file contains hidden or 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
thelvis4
requested review from
BalestraPatrick,
aaronsky,
brentleyjones,
keith,
luispadron,
mattrobmattrob and
thii
as code owners
thelvis4
changed the title
aaronsky
reviewed
Aug 6, 2025
| # Set write permission to allow rewrite extract.actionsdata | ||
| chmod -R +w {output_dir} | ||
| # Write extract.actionsdata with sorted keys | ||
| "$DEVELOPER_DIR/usr/bin/python3" -m json.tool --compact --sort-keys "$original_actionsdata_file" > "$temporary_actionsdata_file" |
There was a problem hiding this comment.
I'm not crazy about relying on the toolchain's Python here – normally I would prefer this live in a tool declared in a py_binary. That being said, I acknowledge that you're mainly working within the existing code here, and that json.tool hasn't meaningfully changed in several years now, so it's not the worst idea.
There was a problem hiding this comment.
Right, given the action depends on DEVELOPER_DIR and is invalidated when Xcode version changes, I figured I can call python3 shipped with Xcode. It reduces the amount of code needed to pass the python binary and makes it easier to remove the mitigation after Apple fixes the root issue.
**Context** bazelbuild#2760 Similar to https://github.sc-corp.net/Snapchat/rules_apple/pull/46, this sorts the keys of `version.json` file generated by the `AppIntentsMetadataProcessor` which also has non-deterministic key order. --- Automatic squash commit from https://github.sc-corp.net/Snapchat/rules_apple/pull/47 Cooled by araifura
thelvis4
force-pushed
the
make-AppIntentsMetadataProcessor-output-deterministic
branch
from
907e3ce to
27a9d2b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
We noticed that
xcrun appintentsmetadataprocessorproduces non-deterministicMetadata.appintents/extract.actionsdataandMetadata.appintents/version.jsonJSON outputs (unstable json key order) resulting in different hashes for them when building the same target on different machines.Changes
Sort the keys of
Metadata.appintents/extract.actionsdataandMetadata.appintents/extract.actionsdatadirectory tree output using/usr/bin/python3 -m json.toolto make it deterministic.Filed Apple Feedback:
FB19585633Fixes #2760