Flush the NonDarwinLogger before shutting down SourceKitLSPServer

ahoppen · ahoppen · commit f7ab6c5e715e · 2025-01-20T19:56:25.000-08:00
This ensures that we don't drop any log messages when stopping the LSP server, in particular while running tests.
diff --git a/Sources/SourceKitLSP/SourceKitLSPServer.swift b/Sources/SourceKitLSP/SourceKitLSPServer.swift
@@ -1158,6 +1158,8 @@ extension SourceKitLSPServer {
       await workspace.buildSystemManager.setMainFilesProvider(nil)
       workspace.closeIndex()
     }
+    // Make sure we emit all pending log messages. When we're not using `NonDarwinLogger` this is a no-op.
+    await NonDarwinLogger.flush()
   }
 
   func shutdown(_ request: ShutdownRequest) async throws -> ShutdownRequest.Response {

Original file line number	Diff line number	Diff line change
`@@ -1158,6 +1158,8 @@ extension SourceKitLSPServer {`
`1158`	`1158`	`await workspace.buildSystemManager.setMainFilesProvider(nil)`
`1159`	`1159`	`workspace.closeIndex()`
`1160`	`1160`	`}`
	`1161`	+ // Make sure we emit all pending log messages. When we're not using `NonDarwinLogger` this is a no-op.
	`1162`	`+ await NonDarwinLogger.flush()`
`1161`	`1163`	`}`
`1162`	`1164`
`1163`	`1165`	`func shutdown(_ request: ShutdownRequest) async throws -> ShutdownRequest.Response {`