Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Skip traversal for targets with a dependency on macros in linter. #6210

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
15 changes: 14 additions & 1 deletion Sources/TuistGenerator/Linter/StaticProductsGraphLinter.swift
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,20 @@ class StaticProductsGraphLinter: StaticProductsGraphLinting {
return isTestsBundle && hasHost
}

let links = linkedBy.subtracting(hostedTestBundles)
/// Targets with a dependency on macros should skip traversal.
let targetsWithMacros = linkedBy.filter { dependency -> Bool in
guard case let .target(name, path) = dependency else {
return false
}

let hasMacros = graphTraverser.allTargetDependencies(path: path, name: name)
.contains(where: { $0.target.product == .macro })
return hasMacros
}

let links = linkedBy
.subtracting(hostedTestBundles)
.subtracting(targetsWithMacros)

guard links.count > 1 else {
return []
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1289,6 +1289,60 @@ class StaticProductsGraphLinterTests: XCTestCase {
XCTAssertEqual(results, [])
}

func test_lint_whenMacrosLinkedTwice() throws {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for adding this test πŸ‘

If I followed along this use case the static framework is linked twice!

example

Mind elaborating on how this can be a false positive?

// Given
let path: AbsolutePath = "/project"
let app = Target.test(name: "App")

let dynamicFrameworkA = Target.test(name: "FrameworkA", product: .framework)
let dynamicFrameworkB = Target.test(name: "FrameworkB", product: .framework)

let macroStaticFramework = Target.test(name: "MacroStaticFramework", product: .staticFramework)
let macroExecutable = Target.test(name: "Macro", product: .macro)
let swiftSyntax = Target.test(name: "SwiftSyntax", product: .staticLibrary)

let project = Project
.test(targets: [app, dynamicFrameworkA, dynamicFrameworkB, macroExecutable])

let appDependency = GraphDependency.target(name: app.name, path: path)
let dynamicFrameworkADependency = GraphDependency.target(name: dynamicFrameworkA.name, path: path)
let dynamicFrameworkBDependency = GraphDependency.target(name: dynamicFrameworkB.name, path: path)
let macroStaticFrameworkDependency = GraphDependency.target(name: macroStaticFramework.name, path: path)
let macroExecutableDependency = GraphDependency.target(name: macroExecutable.name, path: path)
let swiftSyntaxDependency = GraphDependency.target(name: swiftSyntax.name, path: path)

let dependencies: [GraphDependency: Set<GraphDependency>] = [
appDependency: Set([dynamicFrameworkADependency, dynamicFrameworkBDependency]),
dynamicFrameworkADependency: Set([macroStaticFrameworkDependency]),
dynamicFrameworkBDependency: Set([macroStaticFrameworkDependency]),
macroStaticFrameworkDependency: Set([macroExecutableDependency]),
macroExecutableDependency: Set([swiftSyntaxDependency]),
]

let graph = Graph.test(
path: path,
projects: [path: project],
targets: [path: [
app.name: app,
dynamicFrameworkA.name: dynamicFrameworkA,
dynamicFrameworkB.name: dynamicFrameworkB,
macroStaticFramework.name: macroStaticFramework,
macroExecutable.name: macroExecutable,
swiftSyntax.name: swiftSyntax,
]],
dependencies: dependencies
)

let config = Config.test()
let graphTraverser = GraphTraverser(graph: graph)

// When
let results = subject.lint(graphTraverser: graphTraverser, config: config)

// Then
XCTAssertEqual(results, [])
}

// MARK: - Helpers

private func warning(product node: String, type: String = "Target", linkedBy: [GraphDependency]) -> LintingIssue {
Expand Down