refactor(language_server): prepare for dynamicRegistration of fileWatchers

Author: Sysix

crates/oxc_language_server/src/main.rs

@@ -2,6 +2,7 @@ use futures::future::join_all;
 use log::{debug, info, warn};
 use options::{Options, Run, WorkspaceOption};
 use rustc_hash::FxBuildHasher;
+use serde_json::json;
 use std::str::FromStr;
 use tokio::sync::{Mutex, OnceCell, SetError};
 use tower_lsp_server::{
@@ -10,9 +11,10 @@ use tower_lsp_server::{
     lsp_types::{
         CodeActionParams, CodeActionResponse, ConfigurationItem, Diagnostic,
         DidChangeConfigurationParams, DidChangeTextDocumentParams, DidChangeWatchedFilesParams,
-        DidChangeWorkspaceFoldersParams, DidCloseTextDocumentParams, DidOpenTextDocumentParams,
-        DidSaveTextDocumentParams, ExecuteCommandParams, InitializeParams, InitializeResult,
-        InitializedParams, ServerInfo, Uri, WorkspaceEdit,
+        DidChangeWatchedFilesRegistrationOptions, DidChangeWorkspaceFoldersParams,
+        DidCloseTextDocumentParams, DidOpenTextDocumentParams, DidSaveTextDocumentParams,
+        ExecuteCommandParams, InitializeParams, InitializeResult, InitializedParams, Registration,
+        ServerInfo, Uri, WorkspaceEdit,
     },
 };
 // #
@@ -152,26 +154,43 @@ impl LanguageServer for Backend {
             }
         }
 
-        if needed_configurations.is_empty() {
-            return;
+        if !needed_configurations.is_empty() {
+            let configurations = if capabilities.workspace_configuration {
+                self.request_workspace_configuration(needed_configurations.keys().collect()).await
+            } else {
+                // every worker should be initialized already in `initialize` request
+                vec![Some(Options::default()); needed_configurations.len()]
+            };
+
+            for (index, worker) in needed_configurations.values().enumerate() {
+                worker
+                    .init_linter(
+                        configurations
+                            .get(index)
+                            .unwrap_or(&None)
+                            .as_ref()
+                            .unwrap_or(&Options::default()),
+                    )
+                    .await;
+            }
         }
 
-        let configurations = if capabilities.workspace_configuration {
-            self.request_workspace_configuration(needed_configurations.keys().collect()).await
-        } else {
-            // every worker should be initialized already in `initialize` request
-            vec![Some(Options::default()); needed_configurations.len()]
-        };
+        // init all file watchers
+        if capabilities.dynamic_watchers {
+            let mut watchers = vec![];
+            for worker in workers {
+                watchers.extend(worker.init_watchers().await);
+            }
 
-        for (index, worker) in needed_configurations.values().enumerate() {
-            worker
-                .init_linter(
-                    configurations
-                        .get(index)
-                        .unwrap_or(&None)
-                        .as_ref()
-                        .unwrap_or(&Options::default()),
-                )
+            let _ = self
+                .client
+                .register_capability(vec![Registration {
+                    id: "global-watcher".to_string(), // ToDo: send it with an identifier so we can remove it when needed
+                    method: "workspace/didChangeWatchedFiles".to_string(),
+                    register_options: Some(json!(DidChangeWatchedFilesRegistrationOptions {
+                        watchers
+                    })),
+                }])
                 .await;
         }
     }

crates/oxc_language_server/src/worker.rs

@@ -5,7 +5,10 @@ use rustc_hash::FxBuildHasher;
 use tokio::sync::{Mutex, RwLock};
 use tower_lsp_server::{
     UriExt,
-    lsp_types::{CodeActionOrCommand, Diagnostic, FileEvent, Range, TextEdit, Uri},
+    lsp_types::{
+        CodeActionOrCommand, Diagnostic, FileEvent, FileSystemWatcher, GlobPattern, OneOf, Range,
+        RelativePattern, TextEdit, Uri, WatchKind,
+    },
 };
 
 use crate::{
@@ -50,6 +53,31 @@ impl WorkspaceWorker {
         *self.server_linter.write().await = Some(ServerLinter::new(&self.root_uri, options));
     }
 
+    pub async fn init_watchers(&self) -> Vec<FileSystemWatcher> {
+        // ToDo: check with ServerLinter for `extends` files (oxc-project/oxc@10373)
+
+        let mut path_watchers = vec![];
+        if let Some(config_path) = &self.options.lock().await.config_path {
+            path_watchers.push(FileSystemWatcher {
+                glob_pattern: GlobPattern::Relative(RelativePattern {
+                    base_uri: OneOf::Right(self.root_uri.clone()),
+                    pattern: config_path.to_string(),
+                }),
+                kind: Some(WatchKind::all()), // created, deleted, changed
+            });
+        } else {
+            path_watchers.push(FileSystemWatcher {
+                glob_pattern: GlobPattern::Relative(RelativePattern {
+                    base_uri: OneOf::Right(self.root_uri.clone()),
+                    pattern: "**/.oxlintrc.json".to_string(),
+                }),
+                kind: Some(WatchKind::all()), // created, deleted, changed
+            });
+        }
+
+        path_watchers
+    }
+
     pub async fn needs_init_linter(&self) -> bool {
         self.server_linter.read().await.is_none()
     }

editors/vscode/client/ConfigService.ts

@@ -1,7 +1,7 @@
 import { ConfigurationChangeEvent, Uri, workspace, WorkspaceFolder } from 'vscode';
 import { IDisposable } from './types';
 import { VSCodeConfig } from './VSCodeConfig';
-import { oxlintConfigFileName, WorkspaceConfig, WorkspaceConfigInterface } from './WorkspaceConfig';
+import { WorkspaceConfig, WorkspaceConfigInterface } from './WorkspaceConfig';
 
 export class ConfigService implements IDisposable {
   public static readonly namespace = 'oxc';
@@ -70,16 +70,6 @@ export class ConfigService implements IDisposable {
     return false;
   }
 
-  public getOxlintCustomConfigs(): string[] {
-    const customConfigs: string[] = [];
-    for (const [path, config] of this.workspaceConfigs.entries()) {
-      if (config.configPath && config.configPath !== oxlintConfigFileName) {
-        customConfigs.push(`${path}/${config.configPath}`);
-      }
-    }
-    return customConfigs;
-  }
-
   private async onVscodeConfigChange(event: ConfigurationChangeEvent): Promise<void> {
     let isConfigChanged = false;
 

editors/vscode/client/extension.ts

@@ -3,7 +3,6 @@ import { promises as fsPromises } from 'node:fs';
 import {
   commands,
   ExtensionContext,
-  FileSystemWatcher,
   StatusBarAlignment,
   StatusBarItem,
   ThemeColor,
@@ -23,7 +22,6 @@ import { Executable, LanguageClient, LanguageClientOptions, ServerOptions } from
 
 import { join } from 'node:path';
 import { ConfigService } from './ConfigService';
-import { oxlintConfigFileName } from './WorkspaceConfig';
 
 const languageClientName = 'oxc';
 const outputChannelName = 'Oxc';
@@ -44,8 +42,6 @@ let client: LanguageClient | undefined;
 
 let myStatusBarItem: StatusBarItem;
 
-const globalWatchers: FileSystemWatcher[] = [];
-
 export async function activate(context: ExtensionContext) {
   const configService = new ConfigService();
   const restartCommand = commands.registerCommand(
@@ -122,7 +118,6 @@ export async function activate(context: ExtensionContext) {
   );
 
   const outputChannel = window.createOutputChannel(outputChannelName, { log: true });
-  const fileWatchers = createFileEventWatchers(configService.getOxlintCustomConfigs());
 
   context.subscriptions.push(
     applyAllFixesFile,
@@ -131,11 +126,6 @@ export async function activate(context: ExtensionContext) {
     toggleEnable,
     configService,
     outputChannel,
-    {
-      dispose: () => {
-        globalWatchers.forEach((watcher) => watcher.dispose());
-      },
-    },
   );
 
   async function findBinary(): Promise<string> {
@@ -209,10 +199,6 @@ export async function activate(context: ExtensionContext) {
       language: lang,
       scheme: 'file',
     })),
-    synchronize: {
-      // Notify the server about file config changes in the workspace
-      fileEvents: fileWatchers,
-    },
     initializationOptions: configService.languageServerConfig,
     outputChannel,
     traceOutputChannel: outputChannel,
@@ -294,13 +280,9 @@ export async function activate(context: ExtensionContext) {
       return;
     }
 
-    if (needRestart) {
-      client.clientOptions.synchronize = client.clientOptions.synchronize ?? {};
-      client.clientOptions.synchronize.fileEvents = createFileEventWatchers(configService.getOxlintCustomConfigs());
-
-      if (client.isRunning()) {
-        await client.restart();
-      }
+    // Server does not support currently adding/removing watchers on the fly
+    if (needRestart && client.isRunning()) {
+      await client.restart();
     }
   });
 
@@ -317,9 +299,7 @@ export async function activate(context: ExtensionContext) {
     client.clientOptions.initializationOptions = this.languageServerConfig;
 
     if (configService.effectsWorkspaceConfigPathChange(event)) {
-      client.clientOptions.synchronize = client.clientOptions.synchronize ?? {};
-      client.clientOptions.synchronize.fileEvents = createFileEventWatchers(this.getOxlintCustomConfigs());
-
+      // Server does not support currently adding/removing watchers on the fly
       if (client.isRunning()) {
         await client.restart();
       }
@@ -366,23 +346,3 @@ export async function deactivate(): Promise<void> {
   await client.stop();
   client = undefined;
 }
-
-// FileSystemWatcher are not ready on the start and can take some seconds on bigger repositories
-function createFileEventWatchers(configAbsolutePaths: string[]): FileSystemWatcher[] {
-  // cleanup old watchers
-  globalWatchers.forEach((watcher) => watcher.dispose());
-  globalWatchers.length = 0;
-
-  // create new watchers
-  let localWatchers: FileSystemWatcher[] = [];
-  if (configAbsolutePaths.length) {
-    localWatchers = configAbsolutePaths.map((path) => workspace.createFileSystemWatcher(path));
-  }
-
-  localWatchers.push(workspace.createFileSystemWatcher(`**/${oxlintConfigFileName}`));
-
-  // assign watchers to global variable, so we can cleanup them on next call
-  globalWatchers.push(...localWatchers);
-
-  return localWatchers;
-}