Fix how public headers are collected from PodSpec (#840)

ekharkunov · web-flow · commit ffff6387dad5 · 2026-02-02T17:20:35.000+02:00
* Enumate source headers as public header in case if no public_headers_files is defined. Add tests. Add test cleanup

* Enumerate platform-dependant source_files from pod spec
diff --git a/server/src/main/java/com/defold/extender/services/cocoapods/PodBuildSpec.java b/server/src/main/java/com/defold/extender/services/cocoapods/PodBuildSpec.java
@@ -345,8 +345,16 @@ void addPodIncludePaths(String pattern) {
     }
 
     void collectSourceFilesFromSpec(PodSpec spec) {
-        for (String pattern : spec.publicHeadersPatterns) {
-            this.publicHeaders.addAll(PodUtils.listFilesGlob(this.dir, pattern));
+        // if no public_header_files specified treat source headers as public
+        if (!spec.publicHeadersPatterns.isEmpty()) {
+            for (String pattern : spec.publicHeadersPatterns) {
+                this.publicHeaders.addAll(PodUtils.listFilesGlob(this.dir, pattern));
+            }
+        } else {
+            for (String pattern : spec.sourceFilesPatterns) {
+                List<File> src = PodUtils.listFilesGlob(this.dir, pattern);
+                this.publicHeaders.addAll(src.stream().filter(f -> { return PodUtils.isHeaderFile(f.getName()); }).toList());
+            }
         }
 
         Iterator<String> it = spec.sourceFilesPatterns.iterator();
diff --git a/server/src/main/java/com/defold/extender/services/cocoapods/PodSpecParser.java b/server/src/main/java/com/defold/extender/services/cocoapods/PodSpecParser.java
@@ -141,6 +141,7 @@ public static PodSpec createPodSpec(JSONObject specJson, PodUtils.Platform selec
         // find source and header files
         // https://guides.cocoapods.org/syntax/podspec.html#source_files
         spec.sourceFilesPatterns.addAll(getAsList(specJson, "source_files"));
+        if (platformSettings != null) spec.sourceFilesPatterns.addAll(getAsList(platformSettings, "source_files"));
 
         return spec;
     }
diff --git a/server/src/test/java/com/defold/extender/services/cocoapods/PodBuildSpecTest.java b/server/src/test/java/com/defold/extender/services/cocoapods/PodBuildSpecTest.java
@@ -9,10 +9,12 @@
 import java.nio.file.Path;
 import java.nio.file.StandardCopyOption;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Map;
 
 import javax.naming.InvalidNameException;
 
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.TestInfo;
@@ -42,7 +44,25 @@ public void setUp(TestInfo testInfo) throws IOException, InvalidNameException {
         this.buildDir.mkdir();
         this.podsDir = new File(this.workingDir, "pods");
         this.podsDir.mkdir();
-        this.workingDir.deleteOnExit();
+    }
+
+    @AfterEach
+    public void tearDown() throws IOException {
+        if (this.workingDir != null && this.workingDir.exists()) {
+            deleteRecursively(this.workingDir.toPath());
+        }
+    }
+
+    private void deleteRecursively(Path path) throws IOException {
+        Files.walk(path)
+            .sorted((a, b) -> b.compareTo(a)) // reverse order to delete children first
+            .forEach(p -> {
+                try {
+                    Files.delete(p);
+                } catch (IOException e) {
+                    // ignore cleanup errors
+                }
+            });
     }
 
     @Test
@@ -107,9 +127,9 @@ public void testCompilationFlags() throws IOException, ExtenderException {
     public void testNestedPodSpecName() throws IOException, ExtenderException {
         String jsonSpec = Files.readString(Path.of("test-data/pod_specs/YandexMobileMetrica.json"));
         XCConfigParser parser = new XCConfigParser(this.buildDir, this.podsDir, PodUtils.Platform.IPHONEOS, "Debug", "arm64");
-        File sentryTargetFolder = Path.of(this.podsDir.toString(), "Target Support Files", "YandexMobileMetrica").toFile();
-        sentryTargetFolder.mkdirs();
-        Files.copy(Path.of("test-data/xcconfigs/YandexMobileMetrica.xcconfig"), Path.of(sentryTargetFolder.toString(), "YandexMobileMetrica.debug.xcconfig"), StandardCopyOption.REPLACE_EXISTING);
+        File metricaTargetFolder = Path.of(this.podsDir.toString(), "Target Support Files", "YandexMobileMetrica").toFile();
+        metricaTargetFolder.mkdirs();
+        Files.copy(Path.of("test-data/xcconfigs/YandexMobileMetrica.xcconfig"), Path.of(metricaTargetFolder.toString(), "YandexMobileMetrica.debug.xcconfig"), StandardCopyOption.REPLACE_EXISTING);
 
         PodSpec podSpec = PodSpecParser.createPodSpec(PodSpecParser.parseJson(jsonSpec), PodUtils.Platform.IPHONEOS, null);
         CocoaPodsServiceBuildState cocoapodsState = new CocoaPodsServiceBuildState();
@@ -128,4 +148,190 @@ public void testNestedPodSpecName() throws IOException, ExtenderException {
         PodBuildSpec buildSpec = new PodBuildSpec(args, podSpec);
         assertEquals(buildSpec.name, "YandexMobileMetrica");
     }
+
+    @Test
+    public void testPublicHeaderPatternMatch() throws IOException, ExtenderException {
+        String jsonSpec = Files.readString(Path.of("test-data/pod_specs/Sentry.json"));
+        XCConfigParser parser = new XCConfigParser(this.buildDir, this.podsDir, PodUtils.Platform.IPHONEOS, "Debug", "arm64");
+        File sentryTargetFolder = Path.of(this.podsDir.toString(), "Target Support Files", "Sentry").toFile();
+        sentryTargetFolder.mkdirs();
+        Files.copy(Path.of("test-data/xcconfigs/Sentry.xcconfig"), Path.of(sentryTargetFolder.toString(), "Sentry.debug.xcconfig"), StandardCopyOption.REPLACE_EXISTING);
+
+        // Files matching public_header_files pattern: Sources/Sentry/Public/*.h
+        List<String> publicHeaderFiles = List.of(
+            "Sources/Sentry/Public/SentrySDK.h",
+            "Sources/Sentry/Public/SentryClient.h",
+            "Sources/Sentry/Public/SentryOptions.h"
+        );
+
+        // Files NOT matching the pattern (should not be included in publicHeaders)
+        List<String> otherFiles = List.of(
+            "Sources/Sentry/Private/SentryPrivate.h",
+            "Sources/Sentry/SentryInternal.h",
+            "Sources/Sentry/Public/SentrySDK.m",
+            "Sources/SentryCrash/SentryCrash.h"
+        );
+
+        // Create all files
+        Path sentrySourcesDir = Path.of(this.podsDir.toString(), "Sentry");
+        for (String filePath : publicHeaderFiles) {
+            Path fullPath = sentrySourcesDir.resolve(filePath);
+            Files.createDirectories(fullPath.getParent());
+            Files.createFile(fullPath);
+        }
+        for (String filePath : otherFiles) {
+            Path fullPath = sentrySourcesDir.resolve(filePath);
+            Files.createDirectories(fullPath.getParent());
+            Files.createFile(fullPath);
+        }
+
+        PodSpec podSpec = PodSpecParser.createPodSpec(PodSpecParser.parseJson(jsonSpec), PodUtils.Platform.IPHONEOS, null);
+        CocoaPodsServiceBuildState cocoapodsState = new CocoaPodsServiceBuildState();
+        cocoapodsState.workingDir = this.workingDir;
+        cocoapodsState.podsDir = this.podsDir;
+        cocoapodsState.selectedPlatform = PodUtils.Platform.IPHONEOS;
+
+        CreateBuildSpecArgs args = new CreateBuildSpecArgs.Builder()
+            .setConfigParser(parser)
+            .setCocoapodsBuildState(cocoapodsState)
+            .setJobContext(this.jobContext)
+            .build();
+        args.buildDir = this.buildDir;
+        args.configuration = "Debug";
+
+        PodBuildSpec buildSpec = new PodBuildSpec(args, podSpec);
+        buildSpec.addSubSpec(podSpec.getSubspec("Core"));
+
+        // Verify only the public_header_files pattern matches are included
+        for (String headerFile : publicHeaderFiles) {
+            Path expectedPath = sentrySourcesDir.resolve(headerFile);
+            assertTrue(
+                buildSpec.publicHeaders.stream().anyMatch(h -> h.getAbsolutePath().equals(expectedPath.toString())),
+                "publicHeaders should contain: " + expectedPath
+            );
+        }
+
+        assertEquals(publicHeaderFiles.size(), buildSpec.publicHeaders.size(),
+            "publicHeaders should contain exactly " + publicHeaderFiles.size() + " files");
+    }
+
+    @Test
+    public void testNoPublicHeaderPattern() throws IOException, ExtenderException {
+        String jsonSpec = Files.readString(Path.of("test-data/pod_specs/AppAuth.json"));
+        XCConfigParser parser = new XCConfigParser(this.buildDir, this.podsDir, PodUtils.Platform.IPHONEOS, "Debug", "arm64");
+        File appAuthTargetFolder = Path.of(this.podsDir.toString(), "Target Support Files", "AppAuth").toFile();
+        appAuthTargetFolder.mkdirs();
+        Files.copy(Path.of("test-data/xcconfigs/AppAuth.xcconfig"), Path.of(appAuthTargetFolder.toString(), "AppAuth.debug.xcconfig"), StandardCopyOption.REPLACE_EXISTING);
+
+        List<String> tmpFiles = List.of(
+            "AppAuth.h",
+            "AppAuth/iOS/OIDAuthState+IOS.h",
+            "AppAuth/iOS/OIDAuthState+IOS.m",
+            "AppAuth/iOS/OIDAuthorizationService+IOS.h",
+            "AppAuth/iOS/OIDAuthorizationService+IOS.m",
+            "AppAuth/iOS/OIDExternalUserAgentCatalyst.h",
+            "AppAuth/iOS/OIDExternalUserAgentCatalyst.m",
+            "AppAuth/iOS/OIDExternalUserAgentIOS.h",
+            "AppAuth/iOS/OIDExternalUserAgentIOS.m",
+            "AppAuth/iOS/OIDExternalUserAgentIOSCustomBrowser.h",
+            "AppAuth/iOS/OIDExternalUserAgentIOSCustomBrowser.m",
+            "AppAuthCore.h",
+            "AppAuthCore/OIDAuthState.h",
+            "AppAuthCore/OIDAuthState.m",
+            "AppAuthCore/OIDAuthStateChangeDelegate.h",
+            "AppAuthCore/OIDAuthStateErrorDelegate.h",
+            "AppAuthCore/OIDAuthorizationRequest.h",
+            "AppAuthCore/OIDAuthorizationRequest.m",
+            "AppAuthCore/OIDAuthorizationResponse.h",
+            "AppAuthCore/OIDAuthorizationResponse.m",
+            "AppAuthCore/OIDAuthorizationService.h",
+            "AppAuthCore/OIDAuthorizationService.m",
+            "AppAuthCore/OIDClientMetadataParameters.h",
+            "AppAuthCore/OIDClientMetadataParameters.m",
+            "AppAuthCore/OIDDefines.h",
+            "AppAuthCore/OIDEndSessionRequest.h",
+            "AppAuthCore/OIDEndSessionRequest.m",
+            "AppAuthCore/OIDEndSessionResponse.h",
+            "AppAuthCore/OIDEndSessionResponse.m",
+            "AppAuthCore/OIDError.h",
+            "AppAuthCore/OIDError.m",
+            "AppAuthCore/OIDErrorUtilities.h",
+            "AppAuthCore/OIDErrorUtilities.m",
+            "AppAuthCore/OIDExternalUserAgent.h",
+            "AppAuthCore/OIDExternalUserAgentRequest.h",
+            "AppAuthCore/OIDExternalUserAgentSession.h",
+            "AppAuthCore/OIDFieldMapping.h",
+            "AppAuthCore/OIDFieldMapping.m",
+            "AppAuthCore/OIDGrantTypes.h",
+            "AppAuthCore/OIDGrantTypes.m",
+            "AppAuthCore/OIDIDToken.h",
+            "AppAuthCore/OIDIDToken.m",
+            "AppAuthCore/OIDRegistrationRequest.h",
+            "AppAuthCore/OIDRegistrationRequest.m",
+            "AppAuthCore/OIDRegistrationResponse.h",
+            "AppAuthCore/OIDRegistrationResponse.m",
+            "AppAuthCore/OIDResponseTypes.h",
+            "AppAuthCore/OIDResponseTypes.m",
+            "AppAuthCore/OIDScopeUtilities.h",
+            "AppAuthCore/OIDScopeUtilities.m",
+            "AppAuthCore/OIDScopes.h",
+            "AppAuthCore/OIDScopes.m",
+            "AppAuthCore/OIDServiceConfiguration.h",
+            "AppAuthCore/OIDServiceConfiguration.m",
+            "AppAuthCore/OIDServiceDiscovery.h",
+            "AppAuthCore/OIDServiceDiscovery.m",
+            "AppAuthCore/OIDTokenRequest.h",
+            "AppAuthCore/OIDTokenRequest.m",
+            "AppAuthCore/OIDTokenResponse.h",
+            "AppAuthCore/OIDTokenResponse.m",
+            "AppAuthCore/OIDTokenUtilities.h",
+            "AppAuthCore/OIDTokenUtilities.m",
+            "AppAuthCore/OIDURLQueryComponent.h",
+            "AppAuthCore/OIDURLQueryComponent.m",
+            "AppAuthCore/OIDURLSessionProvider.h",
+            "AppAuthCore/OIDURLSessionProvider.m",
+            "AppAuthCore/Resources/PrivacyInfo.xcprivacy"
+        );
+
+        // Create empty files at enumerated paths
+        Path appAuthSourcesDir = Path.of(this.podsDir.toString(), "AppAuth", "Sources");
+        for (String filePath : tmpFiles) {
+            Path fullPath = appAuthSourcesDir.resolve(filePath);
+            Files.createDirectories(fullPath.getParent());
+            Files.createFile(fullPath);
+        }
+
+
+        PodSpec podSpec = PodSpecParser.createPodSpec(PodSpecParser.parseJson(jsonSpec), PodUtils.Platform.IPHONEOS, null);
+        CocoaPodsServiceBuildState cocoapodsState = new CocoaPodsServiceBuildState();
+        cocoapodsState.workingDir = this.workingDir;
+        cocoapodsState.podsDir = this.podsDir;
+        cocoapodsState.selectedPlatform = PodUtils.Platform.IPHONEOS;
+
+        CreateBuildSpecArgs args = new CreateBuildSpecArgs.Builder()
+            .setConfigParser(parser)
+            .setCocoapodsBuildState(cocoapodsState)
+            .setJobContext(this.jobContext)
+            .build();
+        args.buildDir = this.buildDir;
+        args.configuration = "Debug";
+
+        PodBuildSpec buildSpec = new PodBuildSpec(args, podSpec);
+        buildSpec.addSubSpec(podSpec.getSubspec("Core"));
+        buildSpec.addSubSpec(podSpec.getSubspec("ExternalUserAgent"));
+        List<String> expectedHeaders = tmpFiles.stream()
+            .filter(f -> f.endsWith(".h"))
+            .toList();
+
+        for (String headerFile : expectedHeaders) {
+            Path expectedPath = appAuthSourcesDir.resolve(headerFile);
+            assertTrue(
+                buildSpec.publicHeaders.stream().anyMatch(h -> h.getAbsolutePath().equals(expectedPath.toString())),
+                "publicHeaders should contain: " + expectedPath
+            );
+        }
+
+        assertEquals(expectedHeaders.size(), buildSpec.publicHeaders.size(),
+            "publicHeaders should contain exactly " + expectedHeaders.size() + " files");
+    }
 }
diff --git a/server/src/test/java/com/defold/extender/services/cocoapods/PodSpecParserTest.java b/server/src/test/java/com/defold/extender/services/cocoapods/PodSpecParserTest.java
@@ -103,4 +103,20 @@ public void testDefaultSubspecs() throws ExtenderException, IOException {
         };
         assertArrayEquals(expectedValues, podSpec.defaultSubspecs.toArray());
     }
+
+    @Test
+    public void testSourceFlesFromPlatform() throws IOException, ExtenderException {
+        String jsonSpec = Files.readString(Path.of("test-data/pod_specs/AppAuth.json"));
+        PodSpec podSpec = PodSpecParser.createPodSpec(PodSpecParser.parseJson(jsonSpec), PodUtils.Platform.IPHONEOS, null);
+
+        PodSpec subSpec = podSpec.getSubspec("ExternalUserAgent");
+        String[] expectedPatterns = new String[]{
+            "Sources/AppAuth.h",
+            "Sources/AppAuth/*.h",
+            "Sources/AppAuth/*.m",
+            "Sources/AppAuth/iOS/**/*.h",
+            "Sources/AppAuth/iOS/**/*.m"
+        };
+        assertArrayEquals(expectedPatterns, subSpec.sourceFilesPatterns.toArray());
+    }
 }
diff --git a/server/test-data/pod_specs/AppAuth.json b/server/test-data/pod_specs/AppAuth.json
@@ -0,0 +1,82 @@
+{
+  "name": "AppAuth",
+  "version": "2.0.0",
+  "summary": "AppAuth for iOS and macOS is a client SDK for communicating with OAuth 2.0 and OpenID Connect providers.",
+  "description": "AppAuth for iOS and macOS is a client SDK for communicating with [OAuth 2.0]\n(https://tools.ietf.org/html/rfc6749) and [OpenID Connect]\n(http://openid.net/specs/openid-connect-core-1_0.html) providers. It strives to\ndirectly map the requests and responses of those specifications, while following\nthe idiomatic style of the implementation language. In addition to mapping the\nraw protocol flows, convenience methods are available to assist with common\ntasks like performing an action with fresh tokens.\n\nIt follows the OAuth 2.0 for Native Apps best current practice\n([RFC 8252](https://tools.ietf.org/html/rfc8252)).",
+  "homepage": "https://openid.github.io/AppAuth-iOS",
+  "license": "Apache License, Version 2.0",
+  "authors": {
+    "William Denniss": "wdenniss@google.com",
+    "Steven E Wright": "stevewright@google.com",
+    "Julien Bodet": "julien.bodet92@gmail.com"
+  },
+  "platforms": {
+    "ios": "12.0",
+    "osx": "10.12",
+    "watchos": "2.0",
+    "tvos": "9.0"
+  },
+  "source": {
+    "git": "https://github.com/openid/AppAuth-iOS.git",
+    "tag": "2.0.0"
+  },
+  "requires_arc": true,
+  "pod_target_xcconfig": {
+    "DEFINES_MODULE": "YES"
+  },
+  "default_subspecs": [
+    "Core",
+    "ExternalUserAgent"
+  ],
+  "subspecs": [
+    {
+      "name": "Core",
+      "source_files": [
+        "Sources/AppAuthCore.h",
+        "Sources/AppAuthCore/*.{h,m}"
+      ],
+      "resource_bundles": {
+        "AppAuthCore_Privacy": [
+          "Sources/AppAuthCore/Resources/PrivacyInfo.xcprivacy"
+        ]
+      }
+    },
+    {
+      "name": "ExternalUserAgent",
+      "dependencies": {
+        "AppAuth/Core": [
+
+        ]
+      },
+      "source_files": [
+        "Sources/AppAuth.h",
+        "Sources/AppAuth/*.{h,m}"
+      ],
+      "ios": {
+        "source_files": "Sources/AppAuth/iOS/**/*.{h,m}",
+        "frameworks": "SafariServices",
+        "weak_frameworks": "AuthenticationServices"
+      },
+      "platforms": {
+        "ios": "12.0",
+        "osx": "10.12"
+      },
+      "osx": {
+        "source_files": "Sources/AppAuth/macOS/**/*.{h,m}",
+        "weak_frameworks": "AuthenticationServices"
+      }
+    },
+    {
+      "name": "TV",
+      "source_files": [
+        "Sources/AppAuthTV.h",
+        "Sources/AppAuthTV/*.{h,m}"
+      ],
+      "dependencies": {
+        "AppAuth/Core": [
+
+        ]
+      }
+    }
+  ]
+}
diff --git a/server/test-data/xcconfigs/AppAuth.xcconfig b/server/test-data/xcconfigs/AppAuth.xcconfig
@@ -0,0 +1,14 @@
+CLANG_WARN_QUOTED_INCLUDE_IN_FRAMEWORK_HEADER = NO
+CONFIGURATION_BUILD_DIR = ${PODS_CONFIGURATION_BUILD_DIR}/AppAuth
+DEFINES_MODULE = YES
+GCC_PREPROCESSOR_DEFINITIONS = $(inherited) COCOAPODS=1
+OTHER_LDFLAGS = $(inherited) -framework "SafariServices" -weak_framework "AuthenticationServices"
+PODS_BUILD_DIR = ${BUILD_DIR}
+PODS_CONFIGURATION_BUILD_DIR = ${PODS_BUILD_DIR}/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)
+PODS_DEVELOPMENT_LANGUAGE = ${DEVELOPMENT_LANGUAGE}
+PODS_ROOT = ${SRCROOT}
+PODS_TARGET_SRCROOT = ${PODS_ROOT}/AppAuth
+PODS_XCFRAMEWORKS_BUILD_DIR = $(PODS_CONFIGURATION_BUILD_DIR)/XCFrameworkIntermediates
+PRODUCT_BUNDLE_IDENTIFIER = org.cocoapods.${PRODUCT_NAME:rfc1034identifier}
+SKIP_INSTALL = YES
+USE_RECURSIVE_SCRIPT_INPUTS_IN_SCRIPT_PHASES = YES

Original file line number	Diff line number	Diff line change
`@@ -141,6 +141,7 @@ public static PodSpec createPodSpec(JSONObject specJson, PodUtils.Platform selec`
`141`	`141`	`// find source and header files`
`142`	`142`	`// https://guides.cocoapods.org/syntax/podspec.html#source_files`
`143`	`143`	`spec.sourceFilesPatterns.addAll(getAsList(specJson, "source_files"));`
	`144`	`+ if (platformSettings != null) spec.sourceFilesPatterns.addAll(getAsList(platformSettings, "source_files"));`
`144`	`145`
`145`	`146`	`return spec;`
`146`	`147`	`}`