Merge pull request #16 from justeattakeaway/swift-package-registry-opt-in

albertodebortoli · web-flow · commit 40fd8e196d17 · 2025-06-16T11:41:48.000+02:00
Allow Swift Registry opt-in (off by default)
diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/GeneratePackage.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/GeneratePackage.xcscheme
@@ -78,6 +78,10 @@
             argument = "--template Templates/Package.stencil"
             isEnabled = "YES">
          </CommandLineArgument>
+         <CommandLineArgument
+            argument = "--use-swift-registry"
+            isEnabled = "NO">
+         </CommandLineArgument>
          <CommandLineArgument
             argument = "--dependencies-as-binary-targets"
             isEnabled = "NO">
diff --git a/.swiftpm/xcode/xcshareddata/xcschemes/GenerateTuistPackage.xcscheme b/.swiftpm/xcode/xcshareddata/xcschemes/GenerateTuistPackage.xcscheme
@@ -82,6 +82,10 @@
             argument = "--modules-relative-path Modules"
             isEnabled = "YES">
          </CommandLineArgument>
+         <CommandLineArgument
+            argument = "--use-swift-registry"
+            isEnabled = "NO">
+         </CommandLineArgument>
          <CommandLineArgument
             argument = "--output Tuist"
             isEnabled = "YES">
diff --git a/Sources/Commands/GeneratePackage.swift b/Sources/Commands/GeneratePackage.swift
@@ -15,6 +15,9 @@ struct GeneratePackage: AsyncParsableCommand {
     @Option(name: .long, help: "Path to a template file (supported formats: stencil).")
     var template: String
 
+    @Flag(name: .long, help: "Whether to use a Swift Registry.")
+    var useSwiftRegistry: Bool = false
+
     @OptionGroup()
     var cachingFlags: CachingFlags
 
@@ -52,7 +55,8 @@ struct GeneratePackage: AsyncParsableCommand {
             at: specUrl.deletingLastPathComponent(),
             filename: Constants.packageFile,
             specUrl: specUrl,
-            dependencyTreatment: dependencyTreatment
+            dependencyTreatment: dependencyTreatment,
+            useRegistry: useSwiftRegistry
         )
     }
 
@@ -82,7 +86,7 @@ struct GeneratePackage: AsyncParsableCommand {
         if !allowedSharedLocalDependencies.isEmpty {
             let specUrl = URL(filePath: spec, directoryHint: .notDirectory)
             let packageDependenciesUrl = URL(filePath: packageDependencies, directoryHint: .notDirectory)
-            let spec = try SpecGenerator().makeSpec(specUrl: specUrl, dependenciesUrl: packageDependenciesUrl)
+            let spec = try SpecGenerator().makeSpec(specUrl: specUrl, dependenciesUrl: packageDependenciesUrl, useRegistry: useSwiftRegistry)
             let validator = DependenciesValidator(allowedSharedLocalDependencies: allowedSharedLocalDependencies)
             try validator.validateSharedLocalDependencies(spec)
         }
diff --git a/Sources/Commands/GenerateTuistPackage.swift b/Sources/Commands/GenerateTuistPackage.swift
@@ -18,6 +18,9 @@ struct GenerateTuistPackage: AsyncParsableCommand {
     @Option(name: .long, help: "Path to a template file (supported formats: stencil).")
     var template: String
 
+    @Flag(name: .long, help: "Whether to use a Swift Registry.")
+    var useSwiftRegistry: Bool = false
+
     @Option(name: .long, help: "Path to a folder containing the modules in individual folders (default to 'Modules'). Relative to the root of the repository. Required if targetDependencies contains local dependencies.")
     var modulesRelativePath: String = "Modules"
 
@@ -37,7 +40,8 @@ struct GenerateTuistPackage: AsyncParsableCommand {
         try await generator.generateTuistPackage(
             at: outputPath,
             targetDependenciesUrl: targetDependenciesUrl,
-            modulesRelativePath: modulesRelativePath
+            modulesRelativePath: modulesRelativePath,
+            useRegistry: useSwiftRegistry
         )
     }
 
diff --git a/Sources/Core/ContentGenerator.swift b/Sources/Core/ContentGenerator.swift
@@ -4,12 +4,18 @@ import Foundation
 
 struct ContentGenerator {
 
-    func content(for spec: Spec, templateUrl: URL) throws -> Content {
+    func content(for spec: Spec, templateUrl: URL, useRegistry: Bool) throws -> Content {
         let templater = Templater(templateUrl: templateUrl)
-        return try templater.renderTemplate(context: spec.makeContext())
+        return try templater.renderTemplate(context: spec.makeContext(useRegistry: useRegistry))
     }
 
-    func content(packageDependencies: Dependencies, targetDependencies: TargetDependencies, templateUrl: URL, modulesRelativePath: String) throws -> Content {
+    func content(
+        packageDependencies: Dependencies,
+        targetDependencies: TargetDependencies,
+        templateUrl: URL,
+        modulesRelativePath: String,
+        useRegistry: Bool
+    ) throws -> Content {
         let localTargetDependencies = targetDependencies.dependencies
             .filter { $0.type == .local }
             .reduce(into: [TargetDependency]()) { result, element in
@@ -29,7 +35,7 @@ struct ContentGenerator {
             .map { localTargetDependency in
                 let localModule: [String: String] = [
                     "name": localTargetDependency.name,
-                    // the ../ is needed as Package.swift is meant ot be in the Tuist folder
+                    // the ../ is needed as Package.swift is meant to be in the Tuist folder
                     "path": "../\(modulesRelativePath)/\(localTargetDependency.name)"
                 ]
                 return localModule
@@ -51,7 +57,7 @@ struct ContentGenerator {
                     .isEmpty
             })
 
-        var final = Dependencies(dependencies: filteredDependencies).makeContext()
+        var final = Dependencies(dependencies: filteredDependencies).makeContext(useRegistry: useRegistry)
         final["local_modules"] = localModulesDicts
 
         let templater = Templater(templateUrl: templateUrl)
diff --git a/Sources/Core/Generator.swift b/Sources/Core/Generator.swift
@@ -29,9 +29,17 @@ struct Generator {
     }
 
     @discardableResult
-    func generatePackage(at outputUrl: URL, filename: String, specUrl: URL, dependencyTreatment: DependencyTreatment) async throws -> Path {
-        let spec = try SpecGenerator().makeSpec(specUrl: specUrl, dependenciesUrl: packageDependenciesUrl)
-        let content = try ContentGenerator().content(for: spec, templateUrl: templateUrl)
+    func generatePackage(at outputUrl: URL, filename: String, specUrl: URL, dependencyTreatment: DependencyTreatment, useRegistry: Bool) async throws -> Path {
+        let spec = try SpecGenerator().makeSpec(
+            specUrl: specUrl,
+            dependenciesUrl: packageDependenciesUrl,
+            useRegistry: useRegistry
+        )
+        let content = try ContentGenerator().content(
+            for: spec,
+            templateUrl: templateUrl,
+            useRegistry: useRegistry
+        )
         let outputFilePath = try writer.write(
             content: content,
             folder: outputUrl,
@@ -53,7 +61,11 @@ struct Generator {
                 versionRefsPath: versionRefsPath,
                 exclusions: exclusions
             )
-            let content = try ContentGenerator().content(for: convertedSpec, templateUrl: templateUrl)
+            let content = try ContentGenerator().content(
+                for: convertedSpec,
+                templateUrl: templateUrl,
+                useRegistry: useRegistry
+            )
             let path = try writer.write(
                 content: content,
                 folder: outputUrl,
@@ -65,15 +77,21 @@ struct Generator {
     }
 
     @discardableResult
-    func generateTuistPackage(at outputUrl: URL, targetDependenciesUrl: URL, modulesRelativePath: String) async throws -> Path {
+    func generateTuistPackage(
+        at outputUrl: URL,
+        targetDependenciesUrl: URL,
+        modulesRelativePath: String,
+        useRegistry: Bool
+    ) async throws -> Path {
         let packageDependencies: Dependencies = try DTOLoader().loadDTO(url: packageDependenciesUrl)
         let targetDependencies: TargetDependencies = try DTOLoader().loadDTO(url: targetDependenciesUrl)
 
         let content = try ContentGenerator().content(
             packageDependencies: packageDependencies,
             targetDependencies: targetDependencies,
             templateUrl: templateUrl,
-            modulesRelativePath: modulesRelativePath
+            modulesRelativePath: modulesRelativePath,
+            useRegistry: useRegistry
         )
         let outputFilePath = try writer.write(
             content: content,
diff --git a/Sources/Core/SpecGenerator.swift b/Sources/Core/SpecGenerator.swift
@@ -15,8 +15,9 @@ final class SpecGenerator {
     /// - Parameters:
     ///   - packagesFolder: Path  to the package spec.
     ///   - dependenciesUrl: Path  to the dependencies file.
+    ///   - useRegistry: Whether to use a Swift Registry.
     /// - Returns: A Spec model.
-    func makeSpec(specUrl: URL, dependenciesUrl: URL) throws -> Spec {
+    func makeSpec(specUrl: URL, dependenciesUrl: URL, useRegistry: Bool) throws -> Spec {
         let spec: Spec = try DTOLoader().loadDTO(url: specUrl)
         let dependencies: Dependencies = try DTOLoader().loadDTO(url: dependenciesUrl)
 
@@ -40,9 +41,15 @@ final class SpecGenerator {
             .compactMap { target -> Spec.Target in
                 let mappedDependencies = target.dependencies
                     .compactMap { dependency -> Spec.TargetDependency in
-                        let package = dependencies.dependencies.first(where: {
-                            $0.name == dependency.dependency
-                        })?.identifier ?? dependency.package
+                        let package = {
+                            if useRegistry {
+                                dependencies.dependencies.first(where: {
+                                    $0.name == dependency.dependency
+                                })?.identifier ?? dependency.package
+                            } else {
+                                dependency.package
+                            }
+                        }()
                         return Spec.TargetDependency(
                             name: dependency.name,
                             package: package,
diff --git a/Sources/Extensions/Dependencies+Context.swift b/Sources/Extensions/Dependencies+Context.swift
@@ -3,14 +3,14 @@
 import Foundation
 
 extension Dependencies {
-    func makeContext() -> [String: Any] {
+    func makeContext(useRegistry: Bool) -> [String: Any] {
         let remoteDependencies = self.dependencies.map { dependency in
             var dict: [String: String] = [
                 "name": dependency.name,
                 "url": dependency.url
             ]
 
-            if let identifier = dependency.identifier {
+            if useRegistry, let identifier = dependency.identifier {
                 dict["identifier"] = identifier
             }
 
diff --git a/Sources/Extensions/Spec+Context.swift b/Sources/Extensions/Spec+Context.swift
@@ -17,12 +17,16 @@ extension Spec.Product {
 }
 
 extension Spec.RemoteDependency {
-    func makeContext() -> [String: Any] {
+    func makeContext(useRegistry: Bool) -> [String: Any] {
         var retVal = [
             "name": name,
-            "url": url,
-            "identifier": identifier
+            "url": url
         ]
+
+        if useRegistry {
+            retVal["identifier"] = identifier
+        }
+
         if let ref {
             switch ref {
             case .branch(let value):
@@ -46,12 +50,12 @@ extension Spec {
         return nil
     }
     
-    func makeContext() -> [String: Any] {
+    func makeContext(useRegistry: Bool) -> [String: Any] {
         let values: [String: Any?] = [
             "package_name": name,
             "platforms": platforms,
             "local_dependencies": localDependencies,
-            "remote_dependencies": remoteDependencies.map { $0.makeContext() },
+            "remote_dependencies": remoteDependencies.map { $0.makeContext(useRegistry: useRegistry) },
             "products": products.map { $0.makeContext() },
             "targets": targets,
             "local_binary_targets": localBinaryTargets,
diff --git a/Tests/GeneratorTests.swift b/Tests/GeneratorTests.swift
@@ -20,7 +20,8 @@ final class GeneratorTests: XCTestCase {
         case complexTargets = "ComplexTargets"
         case executableProduct = "ExecutableProduct"
         case plugins = "PluginProduct"
-        case registry = "Registry"
+        case registryDisabled = "RegistryDisabled"
+        case registryEnabled = "RegistryEnabled"
         case dependenciesAsBinaryTargets = "DependenciesAsBinaryTargets"
         case dependenciesAsBinaryTargetsWithExclusions = "DependenciesAsBinaryTargetsWithExclusions"
         case tuist = "Tuist"
@@ -78,8 +79,12 @@ final class GeneratorTests: XCTestCase {
         try await assertPackage(for: .plugins)
     }
 
-    func test_registry() async throws {
-        try await assertPackage(for: .registry)
+    func test_registry_useRegistryFalse() async throws {
+        try await assertPackage(for: .registryDisabled, useRegistry: false)
+    }
+
+    func test_registry_useRegistryTrue() async throws {
+        try await assertPackage(for: .registryEnabled, useRegistry: true)
     }
 
     func test_dependenciesAsBinaryTargets() async throws {
@@ -94,7 +99,7 @@ final class GeneratorTests: XCTestCase {
         try await assertTuistPackage(for: .tuist)
     }
 
-    private func assertPackage(for packageType: PackageType) async throws {
+    private func assertPackage(for packageType: PackageType, useRegistry: Bool = false) async throws {
         for format in SupportedFormat.allCases {
             let specUrl = packagesFolderUrl
                 .appendingPathComponent(packageType.rawValue)
@@ -122,7 +127,8 @@ final class GeneratorTests: XCTestCase {
                 at: fileManager.temporaryDirectory,
                 filename: "Package.swift",
                 specUrl: specUrl,
-                dependencyTreatment: .standard
+                dependencyTreatment: .standard,
+                useRegistry: useRegistry
             )
 
             let sutPackageContent = try String(contentsOf: sutPackageUrl)
@@ -168,7 +174,8 @@ final class GeneratorTests: XCTestCase {
                     relativeDependenciesPath: "../.xcframeworks",
                     versionRefsPath: versionRefsUrl.path(),
                     exclusions: exclusions
-                )
+                ),
+                useRegistry: false
             )
 
             let sutPackageContent = try String(contentsOf: sutPackageUrl)
@@ -204,7 +211,8 @@ final class GeneratorTests: XCTestCase {
             let sutPackageUrl = try await generator.generateTuistPackage(
                 at: fileManager.temporaryDirectory,
                 targetDependenciesUrl: targetDependenciesUrl,
-                modulesRelativePath: "Modules"
+                modulesRelativePath: "Modules",
+                useRegistry: false
             )
 
             let sutPackageContent = try String(contentsOf: sutPackageUrl)
diff --git a/Tests/Resources/Packages/RegistryDisabled/Package.swift b/Tests/Resources/Packages/RegistryDisabled/Package.swift
@@ -0,0 +1,55 @@
+// swift-tools-version: 6.0
+
+// This file was automatically generated by PackageGenerator and is untracked
+// PLEASE DO NOT EDIT MANUALLY
+
+import PackageDescription
+
+let package = Package(
+    name: "Registry",
+    defaultLocalization: "en",
+    platforms: [.iOS(.v15)],
+    products: [
+        .library(
+            name: "Registry",
+            targets: ["TargetA"]
+        ),
+    ],
+    dependencies: [
+        .package(
+            path: "../LocalDependencies"
+        ),
+        .package(
+            url: "https://github.com/RemoteDependencyE",
+            exact: "3.0.0"
+        ),
+    ],
+    targets: [
+        .target(
+            name: "TargetA",
+            dependencies: [
+                .product(name: "LocalDependencyA", package: "LocalDependencyA"),
+                .product(name: "RemoteDependencyE_SDK", package: "RemoteDependencyE_SDK"),
+            ],
+            path: "Framework/Sources",
+            resources: [
+                .process("Resources")
+            ],
+            plugins: [
+            ]
+        ),
+        .testTarget(
+            name: "TargetATests",
+            dependencies: [
+                .byName(name: "TargetA"),
+                .product(name: "RemoteDependencyE_SDK", package: "RemoteDependencyE_SDK"),
+            ],
+            path: "Tests/Sources",
+            resources: [
+                .process("Resources")
+            ],
+            plugins: [
+            ]
+        ),
+    ]
+)
diff --git a/Tests/Resources/Packages/RegistryDisabled/RegistryDisabled.json b/Tests/Resources/Packages/RegistryDisabled/RegistryDisabled.json
diff --git a/Tests/Resources/Packages/RegistryDisabled/RegistryDisabled.yml b/Tests/Resources/Packages/RegistryDisabled/RegistryDisabled.yml
diff --git a/Tests/Resources/Packages/RegistryEnabled/Package.swift b/Tests/Resources/Packages/RegistryEnabled/Package.swift
diff --git a/Tests/Resources/Packages/RegistryEnabled/RegistryEnabled.json b/Tests/Resources/Packages/RegistryEnabled/RegistryEnabled.json
diff --git a/Tests/Resources/Packages/RegistryEnabled/RegistryEnabled.yml b/Tests/Resources/Packages/RegistryEnabled/RegistryEnabled.yml

Original file line number	Diff line number	Diff line change
`@@ -3,14 +3,14 @@`
`3`	`3`	`import Foundation`
`4`	`4`
`5`	`5`	`extension Dependencies {`
`6`		`- func makeContext() -> [String: Any] {`
	`6`	`+ func makeContext(useRegistry: Bool) -> [String: Any] {`
`7`	`7`	`let remoteDependencies = self.dependencies.map { dependency in`
`8`	`8`	`var dict: [String: String] = [`
`9`	`9`	`"name": dependency.name,`
`10`	`10`	`"url": dependency.url`
`11`	`11`	`]`
`12`	`12`
`13`		`- if let identifier = dependency.identifier {`
	`13`	`+ if useRegistry, let identifier = dependency.identifier {`
`14`	`14`	`dict["identifier"] = identifier`
`15`	`15`	`}`
`16`	`16`