Merge pull request #1070 from ahoppen/ahoppen/invalid-compilation-db

Don’t crash if a compilation database is malformed JSON

Author: ahoppen

Sources/LSPLogging/OrLog.swift

@@ -17,7 +17,7 @@ import os
 private func logError(prefix: String, error: Error, level: LogLevel) {
   logger.log(
     level: level,
-    "\(prefix, privacy: .public)\(prefix.isEmpty ? "" : " ", privacy: .public)\(error.forLogging)"
+    "\(prefix, privacy: .public)\(prefix.isEmpty ? "" : ": ", privacy: .public)\(error.forLogging)"
   )
 }
 

Sources/SKCore/CompilationDatabase.swift

@@ -11,6 +11,7 @@
 //===----------------------------------------------------------------------===//
 
 import Foundation
+import LSPLogging
 import SKSupport
 
 import struct TSCBasic.AbsolutePath
@@ -81,13 +82,19 @@ public func tryLoadCompilationDatabase(
       try! RelativePath(validating: "build"),
     ]
   return
-    try! searchPaths
+    searchPaths
     .lazy
     .map { directory.appending($0) }
-    .compactMap {
-      try
-        (JSONCompilationDatabase(directory: $0, fileSystem)
-        ?? FixedCompilationDatabase(directory: $0, fileSystem))
+    .compactMap { searchPath in
+      orLog("Failed to load compilation database") { () -> CompilationDatabase? in
+        if let compDb = try JSONCompilationDatabase(directory: searchPath, fileSystem) {
+          return compDb
+        }
+        if let compDb = try FixedCompilationDatabase(directory: searchPath, fileSystem) {
+          return compDb
+        }
+        return nil
+      }
     }
     .first
 }

Tests/SKCoreTests/CompilationDatabaseTests.swift

@@ -267,6 +267,15 @@ final class CompilationDatabaseTests: XCTestCase {
     )
   }
 
+  func testInvalidCompilationDatabase() throws {
+    let fs = InMemoryFileSystem()
+    let dir = try AbsolutePath(validating: "/a")
+    try fs.createDirectory(dir)
+    try fs.writeFileContents(dir.appending(component: "compile_commands.json"), bytes: "")
+
+    XCTAssertNil(tryLoadCompilationDatabase(directory: dir, fs))
+  }
+
   func testCompilationDatabaseBuildSystem() async throws {
     try await checkCompilationDatabaseBuildSystem(
       """