Merge pull request #1782 from ahoppen/diagnostic-timeout-repeat

Fix nondeterministic test failure for tests that await next diagnostic notification

Author: ahoppen

Tests/SourceKitLSPTests/BuildSystemTests.swift

@@ -120,7 +120,9 @@ final class BuildSystemTests: XCTestCase {
     await buildSystem.setBuildSettings(for: doc, to: newSettings)
 
     try await repeatUntilExpectedResult {
-      let refreshedDiags = try await testClient.nextDiagnosticsNotification(timeout: .seconds(1))
+      guard let refreshedDiags = try? await testClient.nextDiagnosticsNotification(timeout: .seconds(1)) else {
+        return false
+      }
       return try text == documentManager.latestSnapshot(doc).text && refreshedDiags.diagnostics.count == 0
     }
   }

Tests/SourceKitLSPTests/MainFilesProviderTests.swift

@@ -195,14 +195,14 @@ final class MainFilesProviderTests: XCTestCase {
       DidChangeWatchedFilesNotification(changes: [FileEvent(uri: fancyLibraryUri, type: .changed)])
     )
 
-    // 'MyFancyLibrary.c' now also includes 'shared.h'. Since it lexicographically preceeds MyLibrary, we should use its
+    // 'MyFancyLibrary.c' now also includes 'shared.h'. Since it lexicographically precedes MyLibrary, we should use its
     // build settings.
     // `clangd` may return diagnostics from the old build settings sometimes (I believe when it's still building the
     // preamble for shared.h when the new build settings come in). Check that it eventually returns the correct
     // diagnostics.
     try await repeatUntilExpectedResult {
-      let refreshedDiags = try await project.testClient.nextDiagnosticsNotification(timeout: .seconds(1))
-      guard let diagnostic = refreshedDiags.diagnostics.only else {
+      let refreshedDiags = try? await project.testClient.nextDiagnosticsNotification(timeout: .seconds(1))
+      guard let diagnostic = refreshedDiags?.diagnostics.only else {
         return false
       }
       return diagnostic.message == "Unused variable 'fromMyFancyLibrary'"