Fix missing iOS flags for SwiftPM packages (for ~/Library/Developer/Xcode/*/DerivedData/* files related to project)

[mishabunte]

Fix: SwiftPM/CocoaPods source files in
SourcePackages/checkouts/* were indexed with MacOSX.sdk because the
upward search never found a .compile-* file.

Change:

findSwiftModuleRoot() accepts an optional start directory.

On a miss, InferFlagsForSwift() retries from os.getcwd() (workspace
root), where the real .compile-* lives.

Result: package sources now receive the correct iOS/iOS-sim flags, so
SourceKit-LSP regains hover and go-to-definition for library code.

[SolaWing]

Normally, xcode-build-server will find and use the corresponding compile file through the configuration in buildServer.json to provide compilation information. Infer Flags indicates that the corresponding compilation information is not found under the current buildServer.json configuration. This is just a fallback configuration and cannot guarantee accuracy. The .compile file information in the current directory usually is the same as the buildServer.json generated by xcode-build-server parse. Therefore, if the information in buildServer.json was not found before, there should be no corresponding information in the .compile file in the current directory.

On the other hand, SourcePackages/checkouts/* is outside the current directory. Most editors will generate a new root directory. There is no buildServer.json in this root directory, and sourcekit-lsp will not get flags through BSP.

So I am curious about your Integrated environment and configuration. I will try to reproduce the usage scenario and see if there is a better solution.

[mishabunte]

I’m working on this project: https://github.com/mishabunte/unstoppable-wallet-ios

1. I cloned the repository to ~/prj/unstoppable-wallet-ios and built it.
2. I generated buildServer.json in the project root.
3. After building, a .compile file appeared in the project root (~/prj/unstoppable-wallet-ios).
4. I opened a source file from the project, e.g. Modules/Wallet/Views/BalanceButtonsView.swift.
5. xcode-build-server (findSwiftModuleRoot) finds the .compile file, so LspDefinition works—because it can resolve the correct compilation flags.
6. From that file, I use LspDefinition to jump to the PrimaryButton class.
7. PrimaryButton.swift isn’t part of the app’s source; it’s from a dependency located at: ~/Library/Developer/Xcode/DerivedData/UnstoppableWallet-adhiqabesrsupjdlzfgzqspnbqlj/SourcePackages/checkouts/ComponentKit.Swift/Sources/ComponentKit/Classes/Buttons/PrimaryButton.swift
8. When findSwiftModuleRoot walks up the path starting in ~/Library/Developer/Xcode/DerivedData/.../ComponentKit.Swift/Sources/ComponentKit/Classes/Buttons/, it can’t find a .compile file. As a result, SourceKit-LSP features fail because xcode-build-server doesn’t know the compilation flags for that library file.

Fix: I added a fallback in InferFlagsForSwift and findSwiftModuleRoot that checks the current working directory if no .compile file is found. With this change, I can navigate both the project’s source code and the dependency sources.

[SolaWing]

see https://github.com/SolaWing/xcode-build-server/blob/5d1012ce5d008c77cec8be963d4c525ddb683635/server.py#L121C1-L121C73
flags = GetFlags(file_path, self.compile_file, store=self.store)

BSP server already pass current compile_file to get flags, if it contains flags for file, there shouldn't enter the infer branch. Except you start another BSP server instance for different root.

Did you have any buildServer.json in parent directory of ~/Library/Developer/Xcode/DerivedData/.../ComponentKit.Swift/Sources/ComponentKit/Classes/Buttons/

Or Can upload your logs? it can be export to a file by start LSP with environment XBS_LOGPATH=/tmp/xbs.log