Fix xcode-locator preferring some Xcode versions outside of /Applications
The current xcode-locator prefers Xcode versions in /Applications
over other versions, comments indicate this is to prefer
local versions over mounted versions. The check for whether Xcode
is in /Applications is only checking if the file path contains
"/Applications/".
This causes issues if Xcode installations can be found on disk that
contains "/Applications/" but are not rooted at /Applications,
e.g. when using TimeMachine these can be found at
/Volumes/MyPassportForMac/Backups.backupdb/.../Macintosh HD/Applications/Xcode.app
The Xcode from the backup can replace the Xcode actually at
/Applications/Xcode.app. This leads to compile errors later when using
that version of Xcode, e.g. "the rule is missing dependency
declarations" for files in the wrong Xcode path.
Fix by checking if the path starts with "/Applications/" instead of
just contains "/Applications/".
This will change behavior and potentially break users if the
"contains" check was relied on, e.g. if anybody expects
"/Users/me/Applications/Xcode.app" to be preferred over
"<network mount>/somewhere/Xcode.app". It's not clear that this was ever
intended to work like this and need to preserve this behavior.
If we wanted to be extra cautious, we could change this to 3 preference
tiers: first choose version in /Applications, then choose versions
containing "/Applications/" anywhere in the path, and finally choose
any other path to Xcode.
Closes #11678.
RELNOTES[INC]: Bazel now correctly prefers Xcode versions in `/Applications` over any other paths, which resolves an issue with accidentally picking up an Xcode version from a Time Machine backup or network disk. In the improbable case that you relied on the old behavior and Bazel now picks up Xcode from the wrong location, you can fix it by moving that Xcode version to /Applications.
PiperOrigin-RevId: 325424375
diff --git a/tools/osx/xcode_locator.m b/tools/osx/xcode_locator.m
index 1c1ea26..d20e3c7 100644
--- a/tools/osx/xcode_locator.m
+++ b/tools/osx/xcode_locator.m
@@ -65,8 +65,7 @@
static void AddEntryToDictionary(
XcodeVersionEntry *entry,
NSMutableDictionary<NSString *, XcodeVersionEntry *> *dict) {
- BOOL inApplications =
- [entry.url.path rangeOfString:@"/Applications/"].location != NSNotFound;
+ BOOL inApplications = [entry.url.path hasPrefix:@"/Applications/"];
NSString *entryVersion = entry.version;
NSString *subversion = entryVersion;
if (dict[entryVersion] && !inApplications) {
