fix(cli): use product name as module name for SPM wrapper targets (tuist#9370)

Author: pepicrft

cli/Sources/TuistLoader/SwiftPackageManager/PackageInfoMapper.swift

@@ -374,6 +374,48 @@ public struct PackageInfoMapper: PackageInfoMapping {
             .replacingOccurrences(of: "+", with: "_")
     }
 
+    private static func effectiveModuleName(
+        targetName: String,
+        products: Set<PackageInfo.Product>,
+        packageTargets: [PackageInfo.Target]
+    ) -> String {
+        guard products.count == 1,
+              let singleProduct = products.first,
+              singleProduct.targets.count == 1,
+              singleProduct.targets.first == targetName,
+              singleProduct.name != targetName,
+              targetName.hasPrefix(singleProduct.name)
+        else { return targetName }
+
+        let targetsByName = Dictionary(uniqueKeysWithValues: packageTargets.map { ($0.name, $0) })
+        var visited = Set<String>()
+        var queue = [targetName]
+
+        while let currentTargetName = queue.popLast() {
+            guard visited.insert(currentTargetName).inserted,
+                  let currentTarget = targetsByName[currentTargetName]
+            else { continue }
+
+            for dependency in currentTarget.dependencies {
+                let dependencyName: String
+                switch dependency {
+                case let .target(name, _), let .byName(name, _), let .product(name, _, _, _):
+                    dependencyName = name
+                }
+
+                if dependencyName == singleProduct.name {
+                    return targetName
+                }
+
+                if targetsByName[dependencyName] != nil {
+                    queue.append(dependencyName)
+                }
+            }
+        }
+
+        return singleProduct.name
+    }
+
     // swiftlint:disable:next function_body_length
     private func map(
         target: PackageInfo.Target,
@@ -440,9 +482,12 @@ public struct PackageInfoMapper: PackageInfoMapping {
 
             moduleMap = ModuleMap.custom(moduleMapPath, umbrellaHeaderPath: nil)
         case .regular:
+            let effectiveName = PackageInfoMapper.effectiveModuleName(
+                targetName: target.name, products: products, packageTargets: packageInfo.targets
+            )
             moduleMap = try await moduleMapGenerator.generate(
                 packageDirectory: path,
-                moduleName: target.name,
+                moduleName: effectiveName,
                 publicHeadersPath: target.publicHeadersPath(packageFolder: path)
             )
         default:
@@ -573,7 +618,12 @@ public struct PackageInfoMapper: PackageInfoMapping {
 
         let targetName = packageModuleAliases[packageInfo.name]?[target.name] ?? target.name
         let sanitizedTargetName = PackageInfoMapper.sanitize(targetName: targetName)
-        let productName = sanitizedTargetName.replacingOccurrences(of: "-", with: "_")
+        let effectiveName = PackageInfoMapper.effectiveModuleName(
+            targetName: target.name, products: products, packageTargets: packageInfo.targets
+        )
+        let aliasedEffectiveName = packageModuleAliases[packageInfo.name]?[effectiveName] ?? effectiveName
+        let productName = PackageInfoMapper.sanitize(targetName: aliasedEffectiveName)
+            .replacingOccurrences(of: "-", with: "_")
 
         let settings = try await Settings.from(
             target: target,
@@ -760,6 +810,11 @@ extension ProjectDescription.Product {
         if let productType = productTypes[name] {
             return ProjectDescription.Product.from(product: productType)
         }
+        for product in products {
+            if let productType = productTypes[product.name] {
+                return ProjectDescription.Product.from(product: productType)
+            }
+        }
 
         var hasAutomaticProduct = false
         let product: ProjectDescription.Product? = products.reduce(nil) { result, product in

cli/Tests/TuistAutomationAcceptanceTests/BuildAcceptanceTests.swift

@@ -279,7 +279,17 @@ final class BuildAcceptanceTestMultiplatformAppWithMacrosAndEmbeddedWatchOSApp:
         try await setUpFixture("generated_multiplatform_app_with_macros_and_embedded_watchos_app")
         try await run(InstallCommand.self)
         try await run(GenerateCommand.self)
-        try await run(BuildCommand.self, "App", "--platform", "ios")
+        do {
+            try await run(BuildCommand.self, "App", "--platform", "ios")
+        } catch {
+            let message = String(describing: error)
+            if message.contains("must be installed in order to run the scheme"),
+               message.contains("watchOS")
+            {
+                throw XCTSkip("Skipping because the required watchOS simulator runtime is not installed.")
+            }
+            throw error
+        }
     }
 }
 

cli/Tests/TuistCacheEEAcceptanceTests/TuistCacheEEAcceptanceTests.swift

@@ -193,81 +193,6 @@ struct TuistCacheEEAcceptanceTests {
         TuistTest.expectLogs("note: 60 hits / 60 cacheable tasks (100%)")
     }
 
-    @Test(
-        .inTemporaryDirectory,
-        .withMockedEnvironment(inheritingVariables: ["PATH"]),
-        .withMockedNoora,
-        .withMockedLogger(forwardLogs: true),
-        .withFixtureConnectedToCanary("generated_project_with_caching_enabled"),
-        .withTestingSimulator("iPhone 17")
-    ) func generated_project_with_caching_enabled() async throws {
-        // Given
-        let fixtureDirectory = try #require(TuistTest.fixtureDirectory)
-        let xcodeprojPath = fixtureDirectory.appending(component: "App.xcodeproj")
-        let simulator = try #require(Simulator.testing)
-        let fileSystem = FileSystem()
-        let temporaryDirectory = try #require(FileSystem.temporaryTestDirectory)
-        let environment = try #require(Environment.mocked)
-        environment.stateDirectory = try await fileSystem.currentWorkingDirectory()
-        let fixtureFullHandle = try #require(TuistTest.fixtureFullHandle)
-
-        try await fileSystem.writeText(
-            """
-            import ProjectDescription
-
-            let tuist = Tuist(
-                fullHandle: "\(fixtureFullHandle)",
-                url: "\(Environment.current.variables["TUIST_URL"] ?? "https://canary.tuist.dev")",
-                project: .tuist(
-                    generationOptions: .options(
-                        enableCaching: true
-                    )
-                )
-            )
-            """,
-            at: fixtureDirectory.appending(components: "Tuist.swift"),
-            options: Set([.overwrite])
-        )
-
-        let backgroundTask = Task {
-            while !Task.isCancelled {
-                try await TuistTest.run(
-                    CacheStartCommand.self,
-                    [fixtureFullHandle, "--url", Environment.current.variables["TUIST_URL"] ?? "https://canary.tuist.dev"]
-                )
-            }
-        }
-
-        defer {
-            backgroundTask.cancel()
-        }
-
-        let remoteCacheServicePath = environment.stateDirectory
-            .appending(component: "\(fixtureFullHandle.replacingOccurrences(of: "/", with: "_")).sock")
-
-        try await TuistTest.run(GenerateCommand.self, ["--path", fixtureDirectory.pathString, "--no-open"])
-        resetUI()
-
-        let arguments = [
-            "-scheme", "App",
-            "-destination", simulator.description,
-            "-project", xcodeprojPath.pathString,
-            "-derivedDataPath", temporaryDirectory.pathString,
-            "CODE_SIGN_IDENTITY=",
-            "CODE_SIGNING_REQUIRED=NO",
-            "CODE_SIGNING_ALLOWED=NO",
-            "COMPILATION_CACHE_REMOTE_SERVICE_PATH=\(remoteCacheServicePath.pathString)",
-        ]
-        try await TuistTest.run(XcodeBuildBuildCommand.self, arguments)
-        TuistTest.expectLogs("cacheable tasks (0%)")
-        resetUI()
-
-        try await fileSystem.remove(temporaryDirectory)
-
-        try await TuistTest.run(XcodeBuildBuildCommand.self, arguments)
-        TuistTest.expectLogs("cacheable tasks (100%)")
-    }
-
     @Test(
         .inTemporaryDirectory,
         .withMockedEnvironment(inheritingVariables: ["PATH"]),

cli/Tests/TuistCacheEEAcceptanceTests/TuistCacheEECanaryAcceptanceTests.swift

@@ -15,6 +15,7 @@ import TuistTesting
 import XcodeProj
 
 @testable import TuistCacheEE
+@testable import TuistKit
 
 struct TuistCacheEECanaryAcceptanceTests {
     private func enableLegacyCache() {
@@ -590,4 +591,78 @@ struct TuistCacheEECanaryAcceptanceTests {
             "Framework1", by: "App", xcodeprojPath: xcodeprojPath
         )
     }
+
+    @Test(
+        .inTemporaryDirectory,
+        .withMockedEnvironment(inheritingVariables: ["PATH"]),
+        .withMockedNoora,
+        .withMockedLogger(forwardLogs: true),
+        .withFixtureConnectedToCanary("generated_project_with_caching_enabled"),
+        .withTestingSimulator("iPhone 17")
+    ) func generated_project_with_caching_enabled() async throws {
+        let fixtureDirectory = try #require(TuistTest.fixtureDirectory)
+        let xcodeprojPath = fixtureDirectory.appending(component: "App.xcodeproj")
+        let simulator = try #require(Simulator.testing)
+        let fileSystem = FileSystem()
+        let temporaryDirectory = try #require(FileSystem.temporaryTestDirectory)
+        let environment = try #require(Environment.mocked)
+        environment.stateDirectory = try await fileSystem.currentWorkingDirectory()
+        let fixtureFullHandle = try #require(TuistTest.fixtureFullHandle)
+
+        try await fileSystem.writeText(
+            """
+            import ProjectDescription
+
+            let tuist = Tuist(
+                fullHandle: "\(fixtureFullHandle)",
+                url: "\(Environment.current.variables["TUIST_URL"] ?? "https://canary.tuist.dev")",
+                project: .tuist(
+                    generationOptions: .options(
+                        enableCaching: true
+                    )
+                )
+            )
+            """,
+            at: fixtureDirectory.appending(components: "Tuist.swift"),
+            options: Set([.overwrite])
+        )
+
+        let backgroundTask = Task {
+            while !Task.isCancelled {
+                try await TuistTest.run(
+                    CacheStartCommand.self,
+                    [fixtureFullHandle, "--url", Environment.current.variables["TUIST_URL"] ?? "https://canary.tuist.dev"]
+                )
+            }
+        }
+
+        defer {
+            backgroundTask.cancel()
+        }
+
+        let remoteCacheServicePath = environment.stateDirectory
+            .appending(component: "\(fixtureFullHandle.replacingOccurrences(of: "/", with: "_")).sock")
+
+        try await TuistTest.run(GenerateCommand.self, ["--path", fixtureDirectory.pathString, "--no-open"])
+        resetUI()
+
+        let arguments = [
+            "-scheme", "App",
+            "-destination", simulator.description,
+            "-project", xcodeprojPath.pathString,
+            "-derivedDataPath", temporaryDirectory.pathString,
+            "CODE_SIGN_IDENTITY=",
+            "CODE_SIGNING_REQUIRED=NO",
+            "CODE_SIGNING_ALLOWED=NO",
+            "COMPILATION_CACHE_REMOTE_SERVICE_PATH=\(remoteCacheServicePath.pathString)",
+        ]
+        try await TuistTest.run(XcodeBuildBuildCommand.self, arguments)
+        TuistTest.expectLogs("cacheable tasks (0%)")
+        resetUI()
+
+        try await fileSystem.remove(temporaryDirectory)
+
+        try await TuistTest.run(XcodeBuildBuildCommand.self, arguments)
+        TuistTest.expectLogs("cacheable tasks (100%)")
+    }
 }