Merge pull request #1384 from ahoppen/allow-modules-with-errors-when-indexing

Add a few more arguments to allow errors during indexing

Author: ahoppen

Sources/SemanticIndex/UpdateIndexStoreTaskDescription.swift

@@ -430,11 +430,6 @@ private func adjustSwiftCompilerArgumentsForIndexStoreUpdate(
     .option("output-file-map", [.singleDash], [.separatedBySpace, .separatedByEqualSign]),
   ]
 
-  let removeFrontendFlags = [
-    "-experimental-skip-non-inlinable-function-bodies",
-    "-experimental-skip-all-function-bodies",
-  ]
-
   var result: [String] = []
   result.reserveCapacity(compilerArguments.count)
   var iterator = compilerArguments.makeIterator()
@@ -448,18 +443,14 @@ private func adjustSwiftCompilerArgumentsForIndexStoreUpdate(
     case nil:
       break
     }
-    if argument == "-Xfrontend" {
-      if let nextArgument = iterator.next() {
-        if removeFrontendFlags.contains(nextArgument) {
-          continue
-        }
-        result += [argument, nextArgument]
-        continue
-      }
-    }
     result.append(argument)
   }
+  result += supplementalClangIndexingArgs.flatMap { ["-Xcc", $0] }
   result += [
+    // Preparation produces modules with errors. We should allow reading them.
+    "-Xfrontend", "-experimental-allow-module-with-compiler-errors",
+    // Avoid emitting the ABI descriptor, we don't need it
+    "-Xfrontend", "-empty-abi-descriptor",
     "-index-file",
     "-index-file-path", fileToIndex.pseudoPath,
     // batch mode is not compatible with -index-file
@@ -520,12 +511,40 @@ private func adjustClangCompilerArgumentsForIndexStoreUpdate(
     }
     result.append(argument)
   }
+  result += supplementalClangIndexingArgs
   result.append(
     "-fsyntax-only"
   )
   return result
 }
 
+#if compiler(>=6.1)
+#warning(
+  "Remove -fmodules-validate-system-headers from supplementalClangIndexingArgs once all supported Swift compilers have https://github.com/apple/swift/pull/74063"
+)
+#endif
+
+fileprivate let supplementalClangIndexingArgs: [String] = [
+  // Retain extra information for indexing
+  "-fretain-comments-from-system-headers",
+  // Pick up macro definitions during indexing
+  "-Xclang", "-detailed-preprocessing-record",
+
+  // libclang uses 'raw' module-format. Match it so we can reuse the module cache and PCHs that libclang uses.
+  "-Xclang", "-fmodule-format=raw",
+
+  // Be less strict - we want to continue and typecheck/index as much as possible
+  "-Xclang", "-fallow-pch-with-compiler-errors",
+  "-Xclang", "-fallow-pcm-with-compiler-errors",
+  "-Wno-non-modular-include-in-framework-module",
+  "-Wno-incomplete-umbrella",
+
+  // sourcekitd adds `-fno-modules-validate-system-headers` before https://github.com/apple/swift/pull/74063.
+  // This completely disables system module validation and never re-builds pcm for system modules. The intended behavior
+  // is to only re-build those PCMs once per sourcekitd session.
+  "-fmodules-validate-system-headers",
+]
+
 fileprivate extension Sequence {
   /// Returns `true` if this sequence contains an element that is equal to an element in `otherSequence` when
   /// considering two elements as equal if they satisfy `predicate`.

Tests/SourceKitLSPTests/BackgroundIndexingTests.swift

@@ -887,4 +887,47 @@ final class BackgroundIndexingTests: XCTestCase {
     _ = try project.openDocument("Lib.swift")
     _ = try await project.testClient.send(BarrierRequest())
   }
+
+  func testImportPreparedModuleWithFunctionBodiesSkipped() async throws {
+    // This test case was crashing the indexing compiler invocation for Client if Lib was built for index preparation
+    // (using `-enable-library-evolution -experimental-skip-all-function-bodies -experimental-lazy-typecheck`) but x
+    // Client was not indexed with `-experimental-allow-module-with-compiler-errors`. rdar://129071600
+    let project = try await SwiftPMTestProject(
+      files: [
+        "Lib/Lib.swift": """
+        public class TerminalController {
+          public var 1️⃣width: Int { 1 }
+        }
+        """,
+        "Client/Client.swift": """
+        import Lib
+
+        func test(terminal: TerminalController) {
+          let width = terminal.width
+        }
+        """,
+      ],
+      manifest: """
+        // swift-tools-version: 5.7
+
+        import PackageDescription
+
+        let package = Package(
+          name: "MyLibrary",
+          targets: [
+            .target(name: "Lib"),
+            .target(name: "Client", dependencies: ["Lib"]),
+          ]
+        )
+        """,
+      enableBackgroundIndexing: true
+    )
+    let (uri, positions) = try project.openDocument("Lib.swift")
+
+    // Check that we indexed `Client.swift` by checking that we return a rename location within it.
+    let result = try await project.testClient.send(
+      RenameRequest(textDocument: TextDocumentIdentifier(uri), position: positions["1️⃣"], newName: "height")
+    )
+    XCTAssertEqual((result?.changes?.keys).map(Set.init), [uri, try project.uri(for: "Client.swift")])
+  }
 }