fix: skip mapping aggregate targets

Author: fortmarek

Package.resolved

@@ -66,7 +66,8 @@ struct PBXProjectMapper: PBXProjectMapping {
         let localPackagePaths = try await collectAllPackages(from: pbxProject.mainGroup, xcodeProj: xcodeProj)
 
         // Map PBXTargets to domain Targets
-        let targets = try await withThrowingTaskGroup(of: Target.self, returning: [Target].self) { taskGroup in
+        let targets = try await withThrowingTaskGroup(of: Target?.self, returning: [Target].self) { taskGroup in
+            let projectNativeTargets = projectNativeTargets
             for pbxTarget in pbxProject.targets {
                 taskGroup.addTask {
                     try await targetMapper.map(
@@ -80,7 +81,9 @@ struct PBXProjectMapper: PBXProjectMapping {
 
             var targets: [Target] = []
             for try await target in taskGroup {
-                targets.append(target)
+                if let target {
+                    targets.append(target)
+                }
             }
 
             return targets

Sources/XcodeGraphMapper/Mappers/Project/PBXProjectMapper.swift

@@ -49,7 +49,7 @@ protocol PBXTargetMapping {
         xcodeProj: XcodeProj,
         projectNativeTargets: [String: ProjectNativeTarget],
         packages: [AbsolutePath]
-    ) async throws -> Target
+    ) async throws -> Target?
 }
 
 // swiftlint:disable function_body_length
@@ -102,7 +102,11 @@ struct PBXTargetMapper: PBXTargetMapping {
         xcodeProj: XcodeProj,
         projectNativeTargets: [String: ProjectNativeTarget],
         packages: [AbsolutePath]
-    ) async throws -> Target {
+    ) async throws -> Target? {
+        // `XcodeGraph` currently doesn't support representing aggregate targets
+        if pbxTarget is PBXAggregateTarget {
+            return nil
+        }
         let platform = try pbxTarget.platform()
         let deploymentTargets = pbxTarget.deploymentTargets()
         let productType = pbxTarget.productType?.mapProductType()

Sources/XcodeGraphMapper/Mappers/Targets/PBXTargetMapper.swift

@@ -26,11 +26,13 @@ struct PBXTargetMapperTests: Sendable {
         // When
         let mapper = PBXTargetMapper()
 
-        let mapped = try await mapper.map(
-            pbxTarget: target,
-            xcodeProj: xcodeProj,
-            projectNativeTargets: [:],
-            packages: []
+        let mapped = try #require(
+            try await mapper.map(
+                pbxTarget: target,
+                xcodeProj: xcodeProj,
+                projectNativeTargets: [:],
+                packages: []
+            )
         )
 
         // Then
@@ -54,11 +56,13 @@ struct PBXTargetMapperTests: Sendable {
         let mapper = PBXTargetMapper()
 
         // When
-        let mapped = try await mapper.map(
-            pbxTarget: target,
-            xcodeProj: xcodeProj,
-            projectNativeTargets: [:],
-            packages: []
+        let mapped = try #require(
+            try await mapper.map(
+                pbxTarget: target,
+                xcodeProj: xcodeProj,
+                projectNativeTargets: [:],
+                packages: []
+            )
         )
 
         // Then
@@ -81,11 +85,13 @@ struct PBXTargetMapperTests: Sendable {
         let mapper = PBXTargetMapper()
 
         // When
-        let mapped = try await mapper.map(
-            pbxTarget: target,
-            xcodeProj: xcodeProj,
-            projectNativeTargets: [:],
-            packages: []
+        let mapped = try #require(
+            try await mapper.map(
+                pbxTarget: target,
+                xcodeProj: xcodeProj,
+                projectNativeTargets: [:],
+                packages: []
+            )
         )
 
         // Then
@@ -110,11 +116,13 @@ struct PBXTargetMapperTests: Sendable {
         let mapper = PBXTargetMapper()
 
         // When
-        let mapped = try await mapper.map(
-            pbxTarget: target,
-            xcodeProj: xcodeProj,
-            projectNativeTargets: [:],
-            packages: []
+        let mapped = try #require(
+            try await mapper.map(
+                pbxTarget: target,
+                xcodeProj: xcodeProj,
+                projectNativeTargets: [:],
+                packages: []
+            )
         )
 
         // Then
@@ -151,11 +159,13 @@ struct PBXTargetMapperTests: Sendable {
         let mapper = PBXTargetMapper()
 
         // When
-        let mapped = try await mapper.map(
-            pbxTarget: target,
-            xcodeProj: xcodeProj,
-            projectNativeTargets: [:],
-            packages: []
+        let mapped = try #require(
+            try await mapper.map(
+                pbxTarget: target,
+                xcodeProj: xcodeProj,
+                projectNativeTargets: [:],
+                packages: []
+            )
         )
 
         // Then
@@ -243,13 +253,15 @@ struct PBXTargetMapperTests: Sendable {
             )
 
             // When
-            let mapped = try await mapper.map(
-                pbxTarget: target,
-                xcodeProj: xcodeProj,
-                projectNativeTargets: [:],
-                packages: [
-                    packagePath,
-                ]
+            let mapped = try #require(
+                try await mapper.map(
+                    pbxTarget: target,
+                    xcodeProj: xcodeProj,
+                    projectNativeTargets: [:],
+                    packages: [
+                        packagePath,
+                    ]
+                )
             )
 
             // Then
@@ -331,7 +343,7 @@ struct PBXTargetMapperTests: Sendable {
         )
 
         // Then
-        #expect(mapped.metadata.tags == Set(["tag1", "tag2", "tag3"]))
+        #expect(mapped?.metadata.tags == Set(["tag1", "tag2", "tag3"]))
     }
 
     @Test("Maps entitlements when CODE_SIGN_ENTITLEMENTS is set")
@@ -389,7 +401,7 @@ struct PBXTargetMapperTests: Sendable {
         )
 
         // Then
-        #expect(mapped.entitlements == .file(
+        #expect(mapped?.entitlements == .file(
             path: entitlementsPath,
             configuration: BuildConfiguration(name: "Debug", variant: .debug)
         ))
@@ -462,7 +474,7 @@ struct PBXTargetMapperTests: Sendable {
 
         // Then
         #expect({
-            switch mapped.infoPlist {
+            switch mapped?.infoPlist {
             case let .file(path, _):
                 return path == plistPath
             default:
@@ -471,6 +483,29 @@ struct PBXTargetMapperTests: Sendable {
         }() == true)
     }
 
+    @Test
+    func testMapAggregateTarget() async throws {
+        // Given
+        let xcodeProj = try await XcodeProj.test()
+        let target = PBXAggregateTarget(
+            name: "App"
+        )
+
+        try xcodeProj.write(path: xcodeProj.path!)
+        let mapper = PBXTargetMapper()
+
+        // When
+        let mapped = try await mapper.map(
+            pbxTarget: target,
+            xcodeProj: xcodeProj,
+            projectNativeTargets: [:],
+            packages: []
+        )
+
+        // Then
+        #expect(mapped == nil)
+    }
+
     // MARK: - Helper Methods
 
     private func createTarget(