Edit command is stuck in infinite loop because of recursive symbolic links

[roanutil]

What happened?

Run tuist edit in a project where purchases-ios package is cloned. It may be cloned into ./Tuist/.build/... or ./Tuist/Dependencies/....

For some reason, this package contains symbolic links back to its root directory. For example: purchases-root. When Tuist runs the edit command, it eventually goes down a call stack like this:

• EditCommand.run
• EditService.run
• ProjectEditor.edit
• ManifestFilesLocator.locateProjectManifests
• ManifestFilesLocator.fetchTuistManifestsFilePaths
• FileHandler.glob
• AbsolutePath.glob
• Glob.init
• Glob.expandGlobStar
• FileManager.subdirectoriesResolvingSymbolicLinks

This is where it gets in trouble. There is no guard against an infinite search because a symbolic link leads to a location above itself.

How do we reproduce it?

• Add purchases-ios package as a dependency to a tuist workspace
• Run tuist fetch
• Run tuist edit

Error log

the tuist edit command will hang because it's in a loop

macOS version

14.2

Tuist version

3.35.4

Xcode version

15.1.0

[haifengkao]

same here. it's quite silly

relativeSubpath

Tuist/.build/checkouts/purchases-ios/Tests/InstallationTests/CarthageInstallation/purchases-root/Tests/InstallationTests/CarthageInstallation/purchases-root/Tests/InstallationTests/CarthageInstallation/purchases-root/Tests/InstallationTests/CarthageInstallation/purchases-root/Tests/InstallationTests/CarthageInstallation/purchases-root/Tests/InstallationTests/CarthageInstallation/purchases-root/Tests/InstallationTests/CarthageInstallation/purchases-root/Tests/InstallationTests/CarthageInstallation/purchases-root/ci_scripts/Tests/InstallationTests/CarthageInstallation/purchases-root/ci_scripts/Tests/InstallationTests/CarthageInstallation/purchases-root/ci_scripts/Tests/InstallationTests/CarthageInstallation/purchases-root