Watch for zls-build-info.json changes

src/DocumentStore.zig

@@ -653,7 +653,7 @@ pub fn refreshDocument(self: *DocumentStore, uri: Uri, new_text: [:0]const u8) !
     handle.cimports = try collectCIncludes(self.allocator, handle.tree);
 }
 
-/// Invalidates a build files.
+/// Invalidates a build file.
 /// **Thread safe** takes an exclusive lock
 pub fn invalidateBuildFile(self: *DocumentStore, build_file_uri: Uri) error{OutOfMemory}!void {
     std.debug.assert(std.process.can_spawn);
@@ -675,6 +675,23 @@ pub fn invalidateBuildFile(self: *DocumentStore, build_file_uri: Uri) error{OutO
     build_file.setBuildConfig(build_config);
 }
 
+/// **Thread safe** takes an exclusive lock
+pub fn invalidateZlsBuildInfo(self: *DocumentStore, zls_build_info_uri: Uri) error{OutOfMemory}!void {
+    const zls_build_info_path = URI.parse(self.allocator, zls_build_info_uri) catch |err| switch (err) {
+        error.OutOfMemory => return error.OutOfMemory,
+        else => return,
+    };
+    defer self.allocator.free(zls_build_info_path);
+
+    const build_file_path = try std.fs.path.join(self.allocator, &.{ std.fs.path.dirname(std.fs.path.dirname(zls_build_info_path).?).?, "build.zig" });
+    defer self.allocator.free(build_file_path);
+
+    const build_file_uri = try URI.fromPath(self.allocator, build_file_path);
+    defer self.allocator.free(build_file_uri);
+
+    try self.invalidateBuildFile(build_file_uri);
+}
+
 /// The `DocumentStore` represents a graph structure where every
 /// handle/document is a node and every `@import` and `@cImport` represent
 /// a directed edge.

src/Server.zig

@@ -79,6 +79,7 @@ const ClientCapabilities = struct {
     /// https://github.com/zigtools/zls/pull/261
     max_detail_length: u32 = 1024 * 1024,
     workspace_folders: []types.URI = &.{},
+    supports_workspace_didChangeWatchedFiles: bool = false,
 
     fn deinit(self: *ClientCapabilities, allocator: std.mem.Allocator) void {
         for (self.workspace_folders) |uri| allocator.free(uri);
@@ -479,6 +480,10 @@ fn initializeHandler(server: *Server, _: std.mem.Allocator, request: types.Initi
                 server.client_capabilities.supports_workspace_did_change_configuration_dynamic_registration = true;
             }
         }
+
+        if (workspace.didChangeWatchedFiles) |did_change_watched_files| {
+            server.client_capabilities.supports_workspace_didChangeWatchedFiles = did_change_watched_files.dynamicRegistration orelse false;
+        }
     }
 
     if (request.workspaceFolders) |workspace_folders| {
@@ -618,7 +623,18 @@ fn initializedHandler(server: *Server, _: std.mem.Allocator, notification: types
     server.status = .initialized;
 
     if (!server.recording_enabled and server.client_capabilities.supports_workspace_did_change_configuration_dynamic_registration) {
-        try server.registerCapability("workspace/didChangeConfiguration");
+        try server.registerCapability("workspace/didChangeConfiguration", .{});
+    }
+
+    if (server.client_capabilities.supports_workspace_didChangeWatchedFiles) {
+        try server.registerCapability("workspace/didChangeWatchedFiles", .{
+            .watchers = &.{
+                .{
+                    .globPattern = .{ .Pattern = "zig-cache/zls-build-info.json" },
+                    .kind = .Change,
+                },
+            },
+        });
     }
 
     if (server.client_capabilities.supports_configuration)
@@ -650,7 +666,23 @@ fn setTraceHandler(server: *Server, _: std.mem.Allocator, request: types.SetTrac
     }
 }
 
-fn registerCapability(server: *Server, method: []const u8) Error!void {
+pub fn RegistrationOptions(comptime method: []const u8) type {
+    for (types.notification_metadata) |notif| {
+        if (std.mem.eql(u8, method, notif.method)) return notif.registration.Options orelse void;
+    }
+
+    for (types.request_metadata) |req| {
+        if (std.mem.eql(u8, method, req.method)) return req.registration.Options orelse void;
+    }
+
+    @compileError("No registration options available for method " ++ method);
+}
+
+fn registerCapability(
+    server: *Server,
+    comptime method: []const u8,
+    registration_options: RegistrationOptions(method),
+) Error!void {
     const id = try std.fmt.allocPrint(server.allocator, "register-{s}", .{method});
     defer server.allocator.free(id);
 
@@ -659,12 +691,15 @@ fn registerCapability(server: *Server, method: []const u8) Error!void {
     const json_message = try server.sendToClientRequest(
         .{ .string = id },
         "client/registerCapability",
-        types.RegistrationParams{ .registrations = &.{
-            types.Registration{
-                .id = id,
-                .method = method,
+        .{
+            .registrations = &.{
+                .{
+                    .id = id,
+                    .method = method,
+                    .registerOptions = registration_options,
+                },
             },
-        } },
+        },
     );
     server.allocator.free(json_message);
 }
@@ -1145,6 +1180,19 @@ fn resolveConfiguration(server: *Server, config_arena: std.mem.Allocator, config
     }
 }
 
+fn didChangeWatchedFilesHandler(server: *Server, arena: std.mem.Allocator, notification: types.DidChangeWatchedFilesParams) Error!void {
+    _ = arena;
+
+    std.log.info("DID CHANGE!", .{});
+
+    for (notification.changes) |change| {
+        std.log.info("DID CHANGE! {s}", .{change.uri});
+        if (std.mem.indexOf(u8, change.uri, "zls-build-info.json") != null) {
+            try server.document_store.invalidateZlsBuildInfo(change.uri);
+        }
+    }
+}
+
 fn openDocumentHandler(server: *Server, _: std.mem.Allocator, notification: types.DidOpenTextDocumentParams) Error!void {
     if (notification.textDocument.text.len > DocumentStore.max_document_size) {
         log.err("open document `{s}` failed: text size ({d}) is above maximum length ({d})", .{
@@ -1712,6 +1760,7 @@ pub const Message = struct {
         @"textDocument/didClose": types.DidCloseTextDocumentParams,
         @"workspace/didChangeWorkspaceFolders": types.DidChangeWorkspaceFoldersParams,
         @"workspace/didChangeConfiguration": types.DidChangeConfigurationParams,
+        @"workspace/didChangeWatchedFiles": types.DidChangeWatchedFilesParams,
         unknown: []const u8,
     };
 
@@ -1870,6 +1919,7 @@ pub const Message = struct {
                 .@"textDocument/didClose",
                 .@"workspace/didChangeWorkspaceFolders",
                 .@"workspace/didChangeConfiguration",
+                .@"workspace/didChangeWatchedFiles",
                 => return true,
                 .unknown => return false,
             },
@@ -2082,6 +2132,7 @@ pub fn sendNotificationSync(server: *Server, arena: std.mem.Allocator, comptime
         .@"textDocument/didClose" => try server.closeDocumentHandler(arena, params),
         .@"workspace/didChangeWorkspaceFolders" => try server.didChangeWorkspaceFoldersHandler(arena, params),
         .@"workspace/didChangeConfiguration" => try server.didChangeConfigurationHandler(arena, params),
+        .@"workspace/didChangeWatchedFiles" => try server.didChangeWatchedFilesHandler(arena, params),
         .unknown => return,
     };
 }