averello/sourcekit-lsp
1
0
Fork 0
mirror of https://github.com/apple/sourcekit-lsp.git synced 2026-03-02 18:23:24 +01:00
Code Issues Packages Projects Releases Wiki Activity

Rename note to notification throughout the codebase wherever necessary

Browse Source
This commit is contained in:
Lokesh.T.R
2024-05-25 15:07:38 +00:00
committed by Lokesh T R
parent c2bf81cfcd
commit 087ea64ed3
9 changed files with 93 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
Sources/LSPTestSupport/TestJSONRPCConnection.swift
View File

@@ -111,11 +111,11 @@ public actor TestClient: MessageHandler {
}
public func appendOneShotNotificationHandler<N: NotificationType>(_ handler: @escaping (N) -> Void) {
oneShotNotificationHandlers.append({ anyNote in
guard let note = anyNote as? N else {
fatalError("received notification of the wrong type \(anyNote); expected \(N.self)")
oneShotNotificationHandlers.append({ anyNotification in
guard let notification = anyNotification as? N else {
fatalError("received notification of the wrong type \(anyNotification); expected \(N.self)")
}
handler(note)
handler(notification)
})
}

32
Sources/SourceKitLSP/Clang/ClangLanguageService.swift
View File

@@ -464,30 +464,30 @@ extension ClangLanguageService {
// MARK: - Text synchronization
public func openDocument(_ note: DidOpenTextDocumentNotification) async {
openDocuments[note.textDocument.uri] = note.textDocument.language
public func openDocument(_ notification: DidOpenTextDocumentNotification) async {
openDocuments[notification.textDocument.uri] = notification.textDocument.language
// Send clangd the build settings for the new file. We need to do this before
// sending the open notification, so that the initial diagnostics already
// have build settings.
await documentUpdatedBuildSettings(note.textDocument.uri)
clangd.send(note)
await documentUpdatedBuildSettings(notification.textDocument.uri)
clangd.send(notification)
}
public func closeDocument(_ note: DidCloseTextDocumentNotification) {
openDocuments[note.textDocument.uri] = nil
clangd.send(note)
public func closeDocument(_ notification: DidCloseTextDocumentNotification) {
openDocuments[notification.textDocument.uri] = nil
clangd.send(notification)
}
public func changeDocument(_ note: DidChangeTextDocumentNotification) {
clangd.send(note)
public func changeDocument(_ notification: DidChangeTextDocumentNotification) {
clangd.send(notification)
}
public func willSaveDocument(_ note: WillSaveTextDocumentNotification) {
public func willSaveDocument(_ notification: WillSaveTextDocumentNotification) {
}
public func didSaveDocument(_ note: DidSaveTextDocumentNotification) {
clangd.send(note)
public func didSaveDocument(_ notification: DidSaveTextDocumentNotification) {
clangd.send(notification)
}
// MARK: - Build System Integration
@@ -505,13 +505,13 @@ extension ClangLanguageService {
if let compileCommand = clangBuildSettings?.compileCommand,
let pathString = (try? AbsolutePath(validating: url.path))?.pathString
{
let note = DidChangeConfigurationNotification(
let notification = DidChangeConfigurationNotification(
settings: .clangd(
ClangWorkspaceSettings(
compilationDatabaseChanges: [pathString: compileCommand])
)
)
clangd.send(note)
clangd.send(notification)
}
}
@@ -519,12 +519,12 @@ extension ClangLanguageService {
// In order to tell clangd to reload an AST, we send it an empty `didChangeTextDocument`
// with `forceRebuild` set in case any missing header files have been added.
// This works well for us as the moment since clangd ignores the document version.
let note = DidChangeTextDocumentNotification(
let notification = DidChangeTextDocumentNotification(
textDocument: VersionedTextDocumentIdentifier(uri, version: 0),
contentChanges: [],
forceRebuild: true
)
clangd.send(note)
clangd.send(notification)
}
// MARK: - Text Document

16
Sources/SourceKitLSP/DocumentManager.swift
View File

@@ -210,17 +210,17 @@ extension DocumentManager {
/// Convenience wrapper for `open(_:language:version:text:)` that logs on failure.
@discardableResult
func open(_ note: DidOpenTextDocumentNotification) -> DocumentSnapshot? {
let doc = note.textDocument
func open(_ notification: DidOpenTextDocumentNotification) -> DocumentSnapshot? {
let doc = notification.textDocument
return orLog("failed to open document", level: .error) {
try open(doc.uri, language: doc.language, version: doc.version, text: doc.text)
}
}
/// Convenience wrapper for `close(_:)` that logs on failure.
func close(_ note: DidCloseTextDocumentNotification) {
func close(_ notification: DidCloseTextDocumentNotification) {
orLog("failed to close document", level: .error) {
try close(note.textDocument.uri)
try close(notification.textDocument.uri)
}
}
@@ -228,13 +228,13 @@ extension DocumentManager {
/// that logs on failure.
@discardableResult
func edit(
_ note: DidChangeTextDocumentNotification
_ notification: DidChangeTextDocumentNotification
) -> (preEditSnapshot: DocumentSnapshot, postEditSnapshot: DocumentSnapshot, edits: [SourceEdit])? {
return orLog("failed to edit document", level: .error) {
return try edit(
note.textDocument.uri,
newVersion: note.textDocument.version,
edits: note.contentChanges
notification.textDocument.uri,
newVersion: notification.textDocument.version,
edits: notification.contentChanges
)
}
}

10
Sources/SourceKitLSP/LanguageService.swift
View File

@@ -98,13 +98,13 @@ public protocol LanguageService: AnyObject, Sendable {
/// Sent to open up a document on the Language Server.
/// This may be called before or after a corresponding
/// `documentUpdatedBuildSettings` call for the same document.
func openDocument(_ note: DidOpenTextDocumentNotification) async
func openDocument(_ notification: DidOpenTextDocumentNotification) async
/// Sent to close a document on the Language Server.
func closeDocument(_ note: DidCloseTextDocumentNotification) async
func changeDocument(_ note: DidChangeTextDocumentNotification) async
func willSaveDocument(_ note: WillSaveTextDocumentNotification) async
func didSaveDocument(_ note: DidSaveTextDocumentNotification) async
func closeDocument(_ notification: DidCloseTextDocumentNotification) async
func changeDocument(_ notification: DidChangeTextDocumentNotification) async
func willSaveDocument(_ notification: WillSaveTextDocumentNotification) async
func didSaveDocument(_ notification: DidSaveTextDocumentNotification) async
// MARK: - Build System Integration

20
Sources/SourceKitLSP/SourceKitLSPServer.swift
View File

@@ -1269,12 +1269,12 @@ extension SourceKitLSPServer {
await openDocument(notification, workspace: workspace)
}
private func openDocument(_ note: DidOpenTextDocumentNotification, workspace: Workspace) async {
private func openDocument(_ notification: DidOpenTextDocumentNotification, workspace: Workspace) async {
// Immediately open the document even if the build system isn't ready. This is important since
// we check that the document is open when we receive messages from the build system.
documentManager.open(note)
documentManager.open(notification)
let textDocument = note.textDocument
let textDocument = notification.textDocument
let uri = textDocument.uri
let language = textDocument.language
@@ -1286,7 +1286,7 @@ extension SourceKitLSPServer {
await workspace.buildSystemManager.registerForChangeNotifications(for: uri, language: language)
// If the document is ready, we can immediately send the notification.
await service.openDocument(note)
await service.openDocument(notification)
}
func closeDocument(_ notification: DidCloseTextDocumentNotification) async {
@@ -1300,16 +1300,16 @@ extension SourceKitLSPServer {
await self.closeDocument(notification, workspace: workspace)
}
func closeDocument(_ note: DidCloseTextDocumentNotification, workspace: Workspace) async {
func closeDocument(_ notification: DidCloseTextDocumentNotification, workspace: Workspace) async {
// Immediately close the document. We need to be sure to clear our pending work queue in case
// the build system still isn't ready.
documentManager.close(note)
documentManager.close(notification)
let uri = note.textDocument.uri
let uri = notification.textDocument.uri
await workspace.buildSystemManager.unregisterForChangeNotifications(for: uri)
await workspace.documentService.value[uri]?.closeDocument(note)
await workspace.documentService.value[uri]?.closeDocument(notification)
}
func changeDocument(_ notification: DidChangeTextDocumentNotification) async {
@@ -1336,10 +1336,10 @@ extension SourceKitLSPServer {
}
func didSaveDocument(
_ note: DidSaveTextDocumentNotification,
_ notification: DidSaveTextDocumentNotification,
languageService: LanguageService
) async {
await languageService.didSaveDocument(note)
await languageService.didSaveDocument(notification)
}
func didChangeWorkspaceFolders(_ notification: DidChangeWorkspaceFoldersNotification) async {

38
Sources/SourceKitLSP/Swift/SwiftLanguageService.swift
View File

@@ -392,17 +392,17 @@ extension SwiftLanguageService {
])
}
public func openDocument(_ note: DidOpenTextDocumentNotification) async {
cancelInFlightPublishDiagnosticsTask(for: note.textDocument.uri)
await diagnosticReportManager.removeItemsFromCache(with: note.textDocument.uri)
public func openDocument(_ notification: DidOpenTextDocumentNotification) async {
cancelInFlightPublishDiagnosticsTask(for: notification.textDocument.uri)
await diagnosticReportManager.removeItemsFromCache(with: notification.textDocument.uri)
guard let snapshot = self.documentManager.open(note) else {
guard let snapshot = self.documentManager.open(notification) else {
// Already logged failure.
return
}
let buildSettings = await self.buildSettings(for: snapshot.uri)
if buildSettings == nil || buildSettings!.isFallback, let fileUrl = note.textDocument.uri.fileURL {
if buildSettings == nil || buildSettings!.isFallback, let fileUrl = notification.textDocument.uri.fileURL {
// Do not show this notification for non-file URIs to make sure we don't see this notificaiton for newly created
// files (which get opened as with a `untitled:Unitled-1` URI by VS Code.
sourceKitLSPServer?.sendNotificationToClient(
@@ -419,17 +419,17 @@ extension SwiftLanguageService {
let req = openDocumentSourcekitdRequest(snapshot: snapshot, compileCommand: buildSettings)
_ = try? await self.sourcekitd.send(req, fileContents: snapshot.text)
await publishDiagnosticsIfNeeded(for: note.textDocument.uri)
await publishDiagnosticsIfNeeded(for: notification.textDocument.uri)
}
public func closeDocument(_ note: DidCloseTextDocumentNotification) async {
cancelInFlightPublishDiagnosticsTask(for: note.textDocument.uri)
inFlightPublishDiagnosticsTasks[note.textDocument.uri] = nil
await diagnosticReportManager.removeItemsFromCache(with: note.textDocument.uri)
public func closeDocument(_ notification: DidCloseTextDocumentNotification) async {
cancelInFlightPublishDiagnosticsTask(for: notification.textDocument.uri)
inFlightPublishDiagnosticsTasks[notification.textDocument.uri] = nil
await diagnosticReportManager.removeItemsFromCache(with: notification.textDocument.uri)
self.documentManager.close(note)
self.documentManager.close(notification)
let req = closeDocumentSourcekitdRequest(uri: note.textDocument.uri)
let req = closeDocumentSourcekitdRequest(uri: notification.textDocument.uri)
_ = try? await self.sourcekitd.send(req, fileContents: nil)
}
@@ -511,8 +511,8 @@ extension SwiftLanguageService {
}
}
public func changeDocument(_ note: DidChangeTextDocumentNotification) async {
cancelInFlightPublishDiagnosticsTask(for: note.textDocument.uri)
public func changeDocument(_ notification: DidChangeTextDocumentNotification) async {
cancelInFlightPublishDiagnosticsTask(for: notification.textDocument.uri)
let keys = self.keys
struct Edit {
@@ -521,14 +521,14 @@ extension SwiftLanguageService {
let replacement: String
}
guard let (preEditSnapshot, postEditSnapshot, edits) = self.documentManager.edit(note) else {
guard let (preEditSnapshot, postEditSnapshot, edits) = self.documentManager.edit(notification) else {
return
}
for edit in edits {
let req = sourcekitd.dictionary([
keys.request: self.requests.editorReplaceText,
keys.name: note.textDocument.uri.pseudoPath,
keys.name: notification.textDocument.uri.pseudoPath,
keys.enableSyntaxMap: 0,
keys.enableStructure: 0,
keys.enableDiagnostics: 0,
@@ -558,14 +558,14 @@ extension SwiftLanguageService {
edits: concurrentEdits
)
await publishDiagnosticsIfNeeded(for: note.textDocument.uri)
await publishDiagnosticsIfNeeded(for: notification.textDocument.uri)
}
public func willSaveDocument(_ note: WillSaveTextDocumentNotification) {
public func willSaveDocument(_ notification: WillSaveTextDocumentNotification) {
}
public func didSaveDocument(_ note: DidSaveTextDocumentNotification) {
public func didSaveDocument(_ notification: DidSaveTextDocumentNotification) {
}

48
Tests/LanguageServerProtocolJSONRPCTests/ConnectionTests.swift
View File

@@ -54,37 +54,37 @@ class ConnectionTests: XCTestCase {
func testMessageBuffer() async throws {
let client = connection.client
let clientConnection = connection.clientToServerConnection
let expectation = self.expectation(description: "note received")
let expectation = self.expectation(description: "notfication received")
await client.appendOneShotNotificationHandler { (note: EchoNotification) in
XCTAssertEqual(note.string, "hello!")
await client.appendOneShotNotificationHandler { (notification: EchoNotification) in
XCTAssertEqual(notification.string, "hello!")
expectation.fulfill()
}
let note1 = try JSONEncoder().encode(JSONRPCMessage.notification(EchoNotification(string: "hello!")))
let note2 = try JSONEncoder().encode(JSONRPCMessage.notification(EchoNotification(string: "no way!")))
let notification1 = try JSONEncoder().encode(JSONRPCMessage.notification(EchoNotification(string: "hello!")))
let notification2 = try JSONEncoder().encode(JSONRPCMessage.notification(EchoNotification(string: "no way!")))
let note1Str: String = "Content-Length: \(note1.count)\r\n\r\n\(String(data: note1, encoding: .utf8)!)"
let note2Str: String = "Content-Length: \(note2.count)\r\n\r\n\(String(data: note2, encoding: .utf8)!)"
let notification1Str: String = "Content-Length: \(notification1.count)\r\n\r\n\(String(data: notification1, encoding: .utf8)!)"
let notfication2Str: String = "Content-Length: \(notification2.count)\r\n\r\n\(String(data: notification2, encoding: .utf8)!)"
for b in note1Str.utf8.dropLast() {
for b in notification1Str.utf8.dropLast() {
clientConnection.send(_rawData: [b].withUnsafeBytes { DispatchData(bytes: $0) })
}
clientConnection.send(
_rawData: [note1Str.utf8.last!, note2Str.utf8.first!].withUnsafeBytes { DispatchData(bytes: $0) }
_rawData: [notification1Str.utf8.last!, notfication2Str.utf8.first!].withUnsafeBytes { DispatchData(bytes: $0) }
)
try await fulfillmentOfOrThrow([expectation])
let expectation2 = self.expectation(description: "note received")
let expectation2 = self.expectation(description: "notification received")
await client.appendOneShotNotificationHandler { (note: EchoNotification) in
XCTAssertEqual(note.string, "no way!")
await client.appendOneShotNotificationHandler { (notification: EchoNotification) in
XCTAssertEqual(notification.string, "no way!")
expectation2.fulfill()
}
for b in note2Str.utf8.dropFirst() {
for b in notfication2Str.utf8.dropFirst() {
clientConnection.send(_rawData: [b].withUnsafeBytes { DispatchData(bytes: $0) })
}
@@ -117,12 +117,12 @@ class ConnectionTests: XCTestCase {
try await fulfillmentOfOrThrow([expectation, expectation2])
}
func testEchoNote() async throws {
func testEchoNotification() async throws {
let client = connection.client
let expectation = self.expectation(description: "note received")
let expectation = self.expectation(description: "notification received")
await client.appendOneShotNotificationHandler { (note: EchoNotification) in
XCTAssertEqual(note.string, "hello!")
await client.appendOneShotNotificationHandler { (notification: EchoNotification) in
XCTAssertEqual(notification.string, "hello!")
expectation.fulfill()
}
@@ -150,13 +150,13 @@ class ConnectionTests: XCTestCase {
func testUnknownNotification() async throws {
let client = connection.client
let expectation = self.expectation(description: "note received")
let expectation = self.expectation(description: "notification received")
struct UnknownNote: NotificationType {
struct UnknownNotification: NotificationType {
static let method: String = "unknown"
}
client.send(UnknownNote())
client.send(UnknownNotification())
// Nothing bad should happen; check that the next request works.
@@ -191,7 +191,7 @@ class ConnectionTests: XCTestCase {
func testSendAfterClose() async throws {
let client = connection.client
let expectation = self.expectation(description: "note received")
let expectation = self.expectation(description: "notification received")
connection.clientToServerConnection.close()
@@ -214,7 +214,7 @@ class ConnectionTests: XCTestCase {
let server = connection.server
let expectation = self.expectation(description: "received notification")
await client.appendOneShotNotificationHandler { (note: EchoNotification) in
await client.appendOneShotNotificationHandler { (notification: EchoNotification) in
expectation.fulfill()
}
@@ -281,8 +281,8 @@ class ConnectionTests: XCTestCase {
func testMessageWithMissingParameter() async throws {
let expectation = self.expectation(description: "Received ShowMessageNotification")
await connection.client.appendOneShotNotificationHandler { (note: ShowMessageNotification) in
XCTAssertEqual(note.type, .error)
await connection.client.appendOneShotNotificationHandler { (notification: ShowMessageNotification) in
XCTAssertEqual(notification.type, .error)
expectation.fulfill()
}

8
Tests/LanguageServerProtocolTests/ConnectionTests.swift
View File

@@ -60,12 +60,12 @@ class ConnectionTests: XCTestCase {
try await fulfillmentOfOrThrow([expectation, expectation2])
}
func testEchoNote() async throws {
func testEchoNotification() async throws {
let client = connection.client
let expectation = self.expectation(description: "note received")
let expectation = self.expectation(description: "notification received")
await client.appendOneShotNotificationHandler { (note: EchoNotification) in
XCTAssertEqual(note.string, "hello!")
await client.appendOneShotNotificationHandler { (notification: EchoNotification) in
XCTAssertEqual(notification.string, "hello!")
expectation.fulfill()
}

6
Tests/SourceKitLSPTests/LocalSwiftTests.swift
View File

@@ -419,7 +419,7 @@ final class LocalSwiftTests: XCTestCase {
)
}
func testFixitsAreIncludedInPublishDiagnosticsNotes() async throws {
func testFixitsAreIncludedInPublishDiagnosticsNotifications() async throws {
let testClient = try await TestSourceKitLSPClient(usePullDiagnostics: false)
let url = URL(fileURLWithPath: "/\(UUID())/a.swift")
let uri = DocumentURI(url)
@@ -585,7 +585,7 @@ final class LocalSwiftTests: XCTestCase {
)
}
func testFixitsAreReturnedFromCodeActionsNotes() async throws {
func testFixitsAreReturnedFromCodeActionsNotifications() async throws {
let testClient = try await TestSourceKitLSPClient(capabilities: quickFixCapabilities, usePullDiagnostics: false)
let url = URL(fileURLWithPath: "/\(UUID())/a.swift")
let uri = DocumentURI(url)
@@ -691,7 +691,7 @@ final class LocalSwiftTests: XCTestCase {
)
}
func testMuliEditFixitCodeActionNote() async throws {
func testMuliEditFixitCodeActionNotifications() async throws {
let testClient = try await TestSourceKitLSPClient(capabilities: quickFixCapabilities, usePullDiagnostics: false)
let url = URL(fileURLWithPath: "/\(UUID())/a.swift")
let uri = DocumentURI(url)