Mapping Performance Woes

[mickeyl]

Because of [https://github.com/tuist/XcodeProj/issues/880], I have just migrated my project from using XcodeProj to XcodeGraph and I'm seeing a major performance regression. On a typical app project,

with only a handful of files and dependencies, the call try await mapper.map(at: self.projectPath) takes a whopping 6(!) seconds (in release mode, on a 20-core Mac Studio) to parse the project.

Since my project itself only has few files, it can only be the scanning of the dependencies ­– which are completely irrelevant for my project as I'm only interested in the main target resource files. Is there a way to defer some of the work to when I'm actually accessing the properties?

[dosubot]

Hey @mickeyl! I'm here to help you with any bugs, questions, or contributions you have in mind. Let's work together to resolve any issues you're experiencing.

To address the performance regression you're experiencing with XcodeGraph, you can consider using the filtering mechanisms available in the tool to exclude or ignore certain dependencies during the mapping process. XcodeGraph provides options to skip test targets, external dependencies, and filter targets based on specific platforms or names. This can help reduce the workload during the initial parsing by focusing only on the relevant parts of your project.

Here are some specific options you can use:

1. Skip Test Targets: If your project doesn't require test targets during the initial mapping, you can set skipTestTargets to true.

2. Skip External Dependencies: If external dependencies are not needed immediately, you can set skipExternalDependencies to true.

3. Platform and Target Name Filtering: Use platformToFilter and targetsToFilter to narrow down the targets that are processed during mapping.

These options can help defer the processing of irrelevant dependencies until they are actually needed, potentially improving performance ^[1].

Additionally, consider using the PruneOrphanExternalTargetsGraphMapper to remove unnecessary external targets that are not required for your main target resource files ^[2].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other}

[mickeyl]

@dosu The sources point to extensions of XcodeGraph, so it doesn't seem to be a feature of the main package.

[dosubot]

The filtering mechanism to exclude or ignore certain dependencies during the mapping process is indeed part of an extension of the XcodeGraph package, as seen in the Sources/TuistGenerator/Extensions/Graph+Extras.swift file ^[1]. If you're looking for performance improvements within the main XcodeGraph package itself, there are no specific built-in performance optimization techniques or configuration options documented that can be adjusted to improve performance. You might need to explore custom solutions or optimizations based on your specific use case.

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other}