Migrate FileHandler.resolveSymlink to FileSystem (tuist#6825)

fortmarek · web-flow · commit e0c4edf0d00a · 2024-10-08T14:59:41.000+02:00
* Migrate FileHandler.resolveSymlink to FileSystem

* Revert to using /var instead of /private/var in acceptance tests

* Fix RunAcceptanceTestCommandLineToolBasic test
diff --git a/Sources/TuistAcceptanceTesting/TuistAcceptanceTestCase.swift b/Sources/TuistAcceptanceTesting/TuistAcceptanceTestCase.swift
@@ -70,13 +70,6 @@ open class TuistAcceptanceTestCase: XCTestCase {
             .appending(component: "fixtures")
 
         fixturePath = fixtureTemporaryDirectory.path.appending(component: fixture.path)
-        if fixturePath.components[1] == "var" {
-            // `resolveSymlinks` doesn't seem to properly resolve /var to /private/var when running the fixture in a temporary
-            // directory.
-            // The project needs to be reference by its full absolute path without symlinks.
-            fixturePath = try AbsolutePath(validating: "/private")
-                .appending(components: Array(fixturePath.components.dropFirst()))
-        }
 
         try FileHandler.shared.copy(
             from: fixturesPath.appending(component: fixture.path),
diff --git a/Sources/TuistKit/ProjectEditor/ProjectEditor.swift b/Sources/TuistKit/ProjectEditor/ProjectEditor.swift
@@ -1,3 +1,4 @@
+import FileSystem
 import Foundation
 import Mockable
 import Path
@@ -216,18 +217,24 @@ final class ProjectEditor: ProjectEditing {
         plugins: Plugins,
         onlyCurrentDirectory: Bool
     ) async throws -> [EditablePluginManifest] {
-        let loadedEditablePluginManifests = try plugins.projectDescriptionHelpers
+        let loadedEditablePluginManifests = plugins.projectDescriptionHelpers
             .filter { $0.location == .local }
-            .map { EditablePluginManifest(name: $0.name, path: try FileHandler.shared.resolveSymlinks($0.path.parentDirectory)) }
+            .map {
+                EditablePluginManifest(
+                    name: $0.name,
+                    path: $0.path.parentDirectory
+                )
+            }
 
         let localEditablePluginManifests = try await manifestFilesLocator.locatePluginManifests(
             at: path,
             excluding: excluding,
             onlyCurrentDirectory: onlyCurrentDirectory
-        ).map {
+        )
+        .map {
             EditablePluginManifest(
                 name: $0.parentDirectory.basename,
-                path: try FileHandler.shared.resolveSymlinks($0.parentDirectory)
+                path: $0.parentDirectory
             )
         }
 
diff --git a/Sources/TuistLoader/Loaders/SwiftPackageManagerGraphLoader.swift b/Sources/TuistLoader/Loaders/SwiftPackageManagerGraphLoader.swift
@@ -115,7 +115,12 @@ public final class SwiftPackageManagerGraphLoader: SwiftPackageManagerGraphLoadi
                 guard let path = dependency.packageRef.path ?? dependency.packageRef.location else {
                     throw SwiftPackageManagerGraphGeneratorError.missingPathInLocalSwiftPackage(name)
                 }
-                packageFolder = try AbsolutePath(validating: path)
+                // There's a bug in the `relative` implementation that produces the wrong path when using a symbolic link.
+                // This leads to nonexisting path in the `ModuleMapMapper` that relies on that method.
+                // To get around this, we're aligning paths from `workspace-state.json` with the /var temporary directory.
+                packageFolder = try AbsolutePath(
+                    validating: path.replacingOccurrences(of: "/private/var", with: "/var")
+                )
             case "registry":
                 let registryFolder = path.appending(try RelativePath(validating: "registry/downloads"))
                 packageFolder = registryFolder.appending(try RelativePath(validating: dependency.subpath))
diff --git a/Sources/TuistLoader/SwiftPackageManager/PackageInfoMapper.swift b/Sources/TuistLoader/SwiftPackageManager/PackageInfoMapper.swift
@@ -870,8 +870,8 @@ extension ProjectDescription.ResourceFileElements {
         {
             let absolutePathGlob = resourceAbsolutePath.extension != nil ? resourceAbsolutePath : resourceAbsolutePath
                 .appending(component: "**")
-            if try excludedPaths
-                .contains(where: { try FileHandler.shared.resolveSymlinks(absolutePathGlob).isDescendantOfOrEqual(to: $0) })
+            if excludedPaths
+                .contains(where: { absolutePathGlob.isDescendantOfOrEqual(to: $0) })
             {
                 return nil
             }
@@ -927,7 +927,7 @@ extension ProjectDescription.ResourceFileElements {
                     }
                 }
             )
-            resourceFileElements += try defaultResourcePaths(from: path) { candidateURL in
+            resourceFileElements += try await defaultResourcePaths(from: path) { candidateURL in
                 let candidatePath = AbsolutePath(stringLiteral: candidateURL.path)
                 let candidateNotInExcludedDirectory = excludedPaths.allSatisfy { !$0.isAncestorOfOrEqual(to: candidatePath) }
                 return candidateNotInExcludedDirectory
diff --git a/Sources/TuistSupport/Utils/FileHandler.swift b/Sources/TuistSupport/Utils/FileHandler.swift
@@ -86,7 +86,6 @@ public protocol FileHandling: AnyObject {
     func urlSafeBase64MD5(path: Path.AbsolutePath) throws -> String
     func fileSize(path: Path.AbsolutePath) throws -> UInt64
     func changeExtension(path: Path.AbsolutePath, to newExtension: String) throws -> Path.AbsolutePath
-    func resolveSymlinks(_ path: Path.AbsolutePath) throws -> Path.AbsolutePath
     func fileAttributes(at path: Path.AbsolutePath) throws -> [FileAttributeKey: Any]
     func filesAndDirectoriesContained(in path: Path.AbsolutePath) throws -> [Path.AbsolutePath]?
     func zipItem(at sourcePath: Path.AbsolutePath, to destinationPath: Path.AbsolutePath) throws
@@ -353,10 +352,6 @@ public class FileHandler: FileHandling {
         try fileManager.createSymbolicLink(atPath: path.pathString, withDestinationPath: destination.pathString)
     }
 
-    public func resolveSymlinks(_ path: Path.AbsolutePath) throws -> Path.AbsolutePath {
-        try .init(validating: TSCBasic.resolveSymlinks(.init(validating: path.pathString)).pathString)
-    }
-
     public func fileAttributes(at path: Path.AbsolutePath) throws -> [FileAttributeKey: Any] {
         try fileManager.attributesOfItem(atPath: path.pathString)
     }
diff --git a/Tests/TuistGeneratorTests/Generator/WorkspaceStructureGeneratorTests.swift b/Tests/TuistGeneratorTests/Generator/WorkspaceStructureGeneratorTests.swift
@@ -405,10 +405,6 @@ final class WorkspaceStructureGeneratorTests: XCTestCase {
             []
         }
 
-        func resolveSymlinks(_ path: AbsolutePath) -> AbsolutePath {
-            path
-        }
-
         func fileAttributes(at _: AbsolutePath) throws -> [FileAttributeKey: Any] {
             [:]
         }
diff --git a/Tests/TuistKitAcceptanceTests/RunAcceptanceTests.swift b/Tests/TuistKitAcceptanceTests/RunAcceptanceTests.swift
@@ -8,8 +8,6 @@ import XCTest
 final class RunAcceptanceTestCommandLineToolBasic: TuistAcceptanceTestCase {
     func test_command_line_tool_basic() async throws {
         try await setUpFixture(.commandLineToolBasic)
-        fixturePath = try AbsolutePath(validating: "/")
-            .appending(components: Array(fixturePath.components.dropFirst(2)))
         try await run(InstallCommand.self)
         try await run(RunCommand.self, "CommandLineTool")
     }
diff --git a/Tests/TuistKitTests/ProjectEditor/ProjectEditorTests.swift b/Tests/TuistKitTests/ProjectEditor/ProjectEditorTests.swift
@@ -240,6 +240,10 @@ final class ProjectEditorTests: TuistUnitTestCase {
             directory.appending(components: "C", "Plugin.swift"),
             directory.appending(components: "D", "Plugin.swift"),
         ]
+        for pluginManifest in pluginManifests {
+            try await fileSystem.makeDirectory(at: pluginManifest.parentDirectory)
+            try await fileSystem.touch(pluginManifest)
+        }
         let tuistPath = try AbsolutePath(validating: ProcessInfo.processInfo.arguments.first!)
 
         // When

Original file line number	Diff line number	Diff line change
`@@ -870,8 +870,8 @@ extension ProjectDescription.ResourceFileElements {`
`870`	`870`	`{`
`871`	`871`	`let absolutePathGlob = resourceAbsolutePath.extension != nil ? resourceAbsolutePath : resourceAbsolutePath`
`872`	`872`	`.appending(component: "**")`
`873`		`- if try excludedPaths`
`874`		`- .contains(where: { try FileHandler.shared.resolveSymlinks(absolutePathGlob).isDescendantOfOrEqual(to: $0) })`
	`873`	`+ if excludedPaths`
	`874`	`+ .contains(where: { absolutePathGlob.isDescendantOfOrEqual(to: $0) })`
`875`	`875`	`{`
`876`	`876`	`return nil`
`877`	`877`	`}`
`@@ -927,7 +927,7 @@ extension ProjectDescription.ResourceFileElements {`
`927`	`927`	`}`
`928`	`928`	`}`
`929`	`929`	`)`
`930`		`- resourceFileElements += try defaultResourcePaths(from: path) { candidateURL in`
	`930`	`+ resourceFileElements += try await defaultResourcePaths(from: path) { candidateURL in`
`931`	`931`	`let candidatePath = AbsolutePath(stringLiteral: candidateURL.path)`
`932`	`932`	`let candidateNotInExcludedDirectory = excludedPaths.allSatisfy { !$0.isAncestorOfOrEqual(to: candidatePath) }`
`933`	`933`	`return candidateNotInExcludedDirectory`
Original file line number	Diff line number	Diff line change
`@@ -405,10 +405,6 @@ final class WorkspaceStructureGeneratorTests: XCTestCase {`
`405`	`405`	`[]`
`406`	`406`	`}`
`407`	`407`
`408`		`- func resolveSymlinks(_ path: AbsolutePath) -> AbsolutePath {`
`409`		`- path`
`410`		`- }`
`411`		`-`
`412`	`408`	`func fileAttributes(at _: AbsolutePath) throws -> [FileAttributeKey: Any] {`
`413`	`409`	`[:]`
`414`	`410`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,6 @@ import XCTest`
`8`	`8`	`final class RunAcceptanceTestCommandLineToolBasic: TuistAcceptanceTestCase {`
`9`	`9`	`func test_command_line_tool_basic() async throws {`
`10`	`10`	`try await setUpFixture(.commandLineToolBasic)`
`11`		`- fixturePath = try AbsolutePath(validating: "/")`
`12`		`- .appending(components: Array(fixturePath.components.dropFirst(2)))`
`13`	`11`	`try await run(InstallCommand.self)`
`14`	`12`	`try await run(RunCommand.self, "CommandLineTool")`
`15`	`13`	`}`