Merge pull request #2 from brycepauken/product-build-version

Switch to using ProductBuildVersion for 15.3+ Compatibility Checks

Author: brycebostwick

README.md

@@ -31,21 +31,21 @@ Just like Xcode's original plugin system, this loader checks plugin bundles for
 
 For Xcode 14.0 - 15.2, plugins can add [`DVTPlugInCompatibilityUUIDs`](https://gist.github.com/minsko/9124ee24b9422fb8ea6b8d00815783ba) to their `Info.plist` files to specify which versions of Xcode they're compatible with.
 
-For Xcode 15.3+, plugins should instead specify `DTXcodeBuildCompatibleVersions` in their `Info.plist` file, based on Xcode's build number (like `15E5194e`). The lowercase letter suffix is optional and should generally be dropped, unless compatibility with specific builds is needed.
+For Xcode 15.3+, plugins should instead specify `CompatibleProductBuildVersions` in their `Info.plist` file, based on Xcode's build version (like `15E204a`).
 
 These two compatibility values can exist side-by-side:
 
 ```xml
-<key>DTXcodeBuildCompatibleVersions</key>
+<key>CompatibleProductBuildVersions</key>
 <array>
-  <string>15E5178</string>
-  <string>15E5188</string>
+  <string>15E204a</string>  <!-- 15.3 -->
+  <string>15E5178i</string> <!-- 15.3b1 -->
 </array>
 <key>DVTPlugInCompatibilityUUIDs</key>
 <array>
-  <string>EFD92DF8-D0A2-4C92-B6E3-9B3CD7E8DC19</string>
-  <string>8BAA96B4-5225-471B-B124-D32A349B8106</string>
-  <string>7A3A18B7-4C08-46F0-A96A-AB686D315DF0</string>
+  <string>EFD92DF8-D0A2-4C92-B6E3-9B3CD7E8DC19</string> <!-- 13.4 -->
+  <string>7A3A18B7-4C08-46F0-A96A-AB686D315DF0</string> <!-- 13.2 -->
+  <string>8BAA96B4-5225-471B-B124-D32A349B8106</string> <!-- 13.0 -->
 </array>
 ```
 

XcodePluginLoader.xcodeproj/project.pbxproj

@@ -23,6 +23,7 @@
 		020463A72B7535A000BF01DB /* ClassLoadObserver.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = ClassLoadObserver.h; sourceTree = "<group>"; };
 		020463A82B7535A000BF01DB /* ClassLoadObserver.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = ClassLoadObserver.m; sourceTree = "<group>"; };
 		020463AB2B753EF800BF01DB /* DVTPlugInManager.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = DVTPlugInManager.h; sourceTree = "<group>"; };
+		02AE2E362B9F46F4006AF5FD /* NSProcessInfo+PBXTSPlatformAdditions.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "NSProcessInfo+PBXTSPlatformAdditions.h"; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -68,6 +69,7 @@
 			isa = PBXGroup;
 			children = (
 				020463AB2B753EF800BF01DB /* DVTPlugInManager.h */,
+				02AE2E362B9F46F4006AF5FD /* NSProcessInfo+PBXTSPlatformAdditions.h */,
 				020463A62B75355700BF01DB /* XcodePlugin.h */,
 			);
 			path = XcodeHeaders;

XcodePluginLoader/XcodeHeaders/NSProcessInfo+PBXTSPlatformAdditions.h

@@ -0,0 +1,10 @@
+#import <Foundation/Foundation.h>
+
+/**
+ Based on `NSProcessInfo(PBXTSPlatformAdditions)` category in Xcode 15.2
+ */
+@interface NSProcessInfo (PBXTSPlatformAdditions)
+
+- (NSString *)xcodeProductBuildVersion;
+
+@end

XcodePluginLoader/XcodePluginLoader.m

@@ -6,6 +6,7 @@
 
 #import "ClassLoadObserver.h"
 #import "XcodeHeaders/DVTPlugInManager.h"
+#import "NSProcessInfo+PBXTSPlatformAdditions.h"
 #import "XcodeHeaders/XcodePlugin.h"
 
 /**
@@ -24,9 +25,12 @@ @implementation XcodePluginLoader
 - (void)start {
     NSLog(@"[XcodePluginLoader] Waiting for required classes to load");
 
-    // Wait for `DVTPlugInManager` to load before performing actual plugin loading
+    // Wait for classes to load before performing actual plugin loading
     __weak typeof(self) weakSelf = self;
-    self.classLoadObserver = [ClassLoadObserver observerForClasses:@[@"DVTPlugInManager"] completion:^{
+    self.classLoadObserver = [ClassLoadObserver observerForClasses:@[
+        @"PBXTSTask", // Needed for Xcode 15.3+ compatibility checks (as a proxy for NSProcessInfo(PBXTSPlatformAdditions) being loaded)
+        @"DVTPlugInManager" // Needed for pre Xcode 15.3 compatibility checks
+    ] completion:^{
         [weakSelf loadPlugins];
     }];
 }
@@ -73,44 +77,37 @@ - (void)loadPlugins {
             return;
         }
 
-        // Run compatibility check using `DTXcodeBuildCompatibleVersions` (needed for Xcode 15.3+)
-        NSString *xcodeBuildVersion = [[NSBundle mainBundle] objectForInfoDictionaryKey:@"DTXcodeBuild"];
-        NSArray<NSString *> *compatibleBuildVersions = [bundle objectForInfoDictionaryKey:@"DTXcodeBuildCompatibleVersions"];
+        // Run compatibility check using `ProductBuildVersion` (needed for Xcode 15.3+).
+        // Start by getting Xcode's `ProductBuildVersion`
+        NSProcessInfo *processInfo = [NSProcessInfo processInfo];
+        NSString *xcodeBuildVersion;
+        if ([processInfo respondsToSelector:@selector(xcodeProductBuildVersion)]) {
+            xcodeBuildVersion = [[NSProcessInfo processInfo] xcodeProductBuildVersion];
+        }
+
+        // Then get all `CompatibleProductBuildVersions` values from the plugin and compare
+        NSArray<NSString *> *compatibleBuildVersions = [bundle objectForInfoDictionaryKey:@"CompatibleProductBuildVersions"];
         BOOL hasCompatibleBuildVersion = NO;
-        if (compatibleBuildVersions) {
+        if (xcodeBuildVersion && compatibleBuildVersions) {
             if (![compatibleBuildVersions isKindOfClass:[NSArray class]]) {
-                NSLog(@"[XcodePluginLoader] Skipping %@ (invalid DTXcodeBuildCompatibleVersions format)", potentialBundleName);
+                NSLog(@"[XcodePluginLoader] Skipping %@ (invalid CompatibleProductBuildVersions format)", potentialBundleName);
                 return;
             }
 
-            compatibleBuildVersions = [compatibleBuildVersions sortedArrayUsingSelector:@selector(length)];
+            // Check for a match
             for (NSString *buildVersion in compatibleBuildVersions) {
-                if ([xcodeBuildVersion isEqualToString:buildVersion]) {
+                if ([buildVersion isEqualToString:xcodeBuildVersion]) {
                     hasCompatibleBuildVersion = YES;
-                    NSLog(@"[XcodePluginLoader] %@ is compatible with DTXcodeBuild version %@", potentialBundleName, xcodeBuildVersion);
+                    NSLog(@"[XcodePluginLoader] %@ is compatible with ProductBuildVersion version %@", potentialBundleName, xcodeBuildVersion);
                     break;
                 }
-
-                // Apple sometimes releases multiple builds of Xcode using the same version number
-                // (e.g., some people will have Xcode 13.3b1 with a build number of "15E5178i", others
-                // may have "15E5178b"). Treat the lowercase suffix as optional
-                if ([xcodeBuildVersion hasPrefix:buildVersion]) {
-                    NSString *unmatchedBuildVersionString = [xcodeBuildVersion substringFromIndex:[buildVersion length]];
-                    NSCharacterSet *nonLowercaseLetters = [[NSCharacterSet lowercaseLetterCharacterSet] invertedSet];
-                    NSRange rangeOfNonLowercaseLetters = [unmatchedBuildVersionString rangeOfCharacterFromSet:nonLowercaseLetters];
-                    if (rangeOfNonLowercaseLetters.location == NSNotFound) {
-                        hasCompatibleBuildVersion = YES;
-                        NSLog(@"[XcodePluginLoader] %@ is compatible because Xcode has a more-specific DTXcodeBuild version (Xcode version %@, compatible version: %@)", potentialBundleName, xcodeBuildVersion, buildVersion);
-                        break;
-                    }
-                }
             }
         }
 
         // Fall back to doing a compatibility check using `DVTPlugInCompatibilityUUIDs`
         // (matches Xcode's original plugin loader behavior, but is only available on Xcode 15.2 or older)
         if (!hasCompatibleBuildVersion) {
-            NSLog(@"[XcodePluginLoader] No DTXcodeBuildCompatibleVersions in %@ matching version %@. Falling back to DVTPlugInCompatibilityUUIDs", potentialBundleName, xcodeBuildVersion);
+            NSLog(@"[XcodePluginLoader] No CompatibleProductBuildVersions in %@ matching version %@. Falling back to DVTPlugInCompatibilityUUIDs", potentialBundleName, xcodeBuildVersion);
 
             // Read the list of compatibility UUIDs specified by the plugin that we're loading
             NSArray<NSString *> *compatibilityUUIDs = [bundle objectForInfoDictionaryKey:@"DVTPlugInCompatibilityUUIDs"];