Skip to content

Remove chokidar #1096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 21, 2025
Merged

Remove chokidar #1096

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a522ff6
Partially remove chokidar, setting up client file watching
nojaf May 19, 2025
3d11f18
Replace chokidar
nojaf May 19, 2025
5c4ca4e
Add changelog entry
nojaf May 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Replace chokidar
  • Loading branch information
@nojaf
nojaf committed May 20, 2025
commit 3d11f1869be2c4d2882b7b3b672085aba7a159d6
53 changes: 19 additions & 34 deletions server/src/incrementalCompilation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import * as cp from "node:child_process";
import semver from "semver";
import config, { send } from "./config";
import * as c from "./constants";
import * as chokidar from "chokidar";
import { fileCodeActions } from "./codeActions";
import { projectsFiles } from "./projectFiles";

Expand Down Expand Up @@ -92,38 +91,29 @@ const incrementallyCompiledFileInfo: Map<
const hasReportedFeatureFailedError: Set<string> = new Set();
const originalTypeFileToFilePath: Map<string, string> = new Map();

let incrementalFilesWatcher = chokidar
.watch([], {
awaitWriteFinish: {
stabilityThreshold: 1,
},
})
.on("all", (e, changedPath) => {
if (e !== "change" && e !== "unlink") return;
const filePath = originalTypeFileToFilePath.get(changedPath);
if (filePath != null) {
const entry = incrementallyCompiledFileInfo.get(filePath);
if (entry != null) {
export function incrementalCompilationFileChanged(changedPath: string) {
const filePath = originalTypeFileToFilePath.get(changedPath);
if (filePath != null) {
const entry = incrementallyCompiledFileInfo.get(filePath);
if (entry != null) {
if (debug()) {
console.log("[watcher] Cleaning up incremental files for " + filePath);
}
if (entry.compilation != null) {
if (debug()) {
console.log(
"[watcher] Cleaning up incremental files for " + filePath
);
}
if (entry.compilation != null) {
if (debug()) {
console.log("[watcher] Was compiling, killing");
}
clearTimeout(entry.compilation.timeout);
entry.killCompilationListeners.forEach((cb) => cb());
entry.compilation = null;
console.log("[watcher] Was compiling, killing");
}
cleanUpIncrementalFiles(
entry.file.sourceFilePath,
entry.project.rootPath
);
clearTimeout(entry.compilation.timeout);
entry.killCompilationListeners.forEach((cb) => cb());
entry.compilation = null;
}
cleanUpIncrementalFiles(
entry.file.sourceFilePath,
entry.project.rootPath
);
}
});
}
}

export function removeIncrementalFileFolder(
projectRootPath: string,
Expand Down Expand Up @@ -465,10 +455,6 @@ function triggerIncrementalCompilationOfFile(
incrementalFileCacheEntry.project.callArgs = figureOutBscArgs(
incrementalFileCacheEntry
);
// Set up watcher for relevant cmt/cmti
incrementalFilesWatcher.add([
incrementalFileCacheEntry.file.originalTypeFileLocation,
]);
originalTypeFileToFilePath.set(
incrementalFileCacheEntry.file.originalTypeFileLocation,
incrementalFileCacheEntry.file.sourceFilePath
Expand Down Expand Up @@ -781,7 +767,6 @@ export function handleClosedFile(filePath: string) {
cleanUpIncrementalFiles(filePath, entry.project.rootPath);
incrementallyCompiledFileInfo.delete(filePath);
originalTypeFileToFilePath.delete(entry.file.originalTypeFileLocation);
incrementalFilesWatcher.unwatch([entry.file.originalTypeFileLocation]);
}

export function getCodeActionsFromIncrementalCompilation(
Expand Down
86 changes: 42 additions & 44 deletions server/src/server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import * as v from "vscode-languageserver";
import * as rpc from "vscode-jsonrpc/node";
import * as path from "path";
import fs from "fs";
// TODO: check DidChangeWatchedFilesNotification.
import {
DidChangeWatchedFilesNotification,
DidOpenTextDocumentNotification,
DidChangeTextDocumentNotification,
DidCloseTextDocumentNotification,
Expand All @@ -14,6 +14,7 @@ import {
InlayHintParams,
CodeLensParams,
SignatureHelpParams,
InitializedNotification,
} from "vscode-languageserver-protocol";
import * as lookup from "./lookup";
import * as utils from "./utils";
Expand All @@ -27,6 +28,10 @@ import * as ic from "./incrementalCompilation";
import config, { extensionConfiguration } from "./config";
import { projectsFiles } from "./projectFiles";

// Absolute paths to all the workspace folders
// Configured during the initialize request
const workspaceFolders = new Set<string>();

// This holds client capabilities specific to our extension, and not necessarily
// related to the LS protocol. It's for enabling/disabling features that might
// work in one client, like VSCode, but perhaps not in others, like vim.
Expand Down Expand Up @@ -209,21 +214,18 @@ let deleteProjectConfigCache = async (rootPath: string) => {
}
};

let compilerLogsWatcher = chokidar
.watch([], {
awaitWriteFinish: {
stabilityThreshold: 1,
},
})
.on("all", async (_e, changedPath) => {
if (changedPath.includes("build.ninja")) {
async function onWorkspaceDidChangeWatchedFiles(
params: p.DidChangeWatchedFilesParams
) {
await Promise.all(params.changes.map(async (change) => {
if (change.uri.includes("build.ninja")) {
if (config.extensionConfiguration.cache?.projectConfig?.enable === true) {
let projectRoot = utils.findProjectRootOfFile(changedPath);
let projectRoot = utils.findProjectRootOfFile(change.uri);
if (projectRoot != null) {
await syncProjectConfigCache(projectRoot);
}
}
} else {
} else if (change.uri.includes("compiler.log")) {
try {
await sendUpdatedDiagnostics();
sendCompilationFinishedMessage();
Expand All @@ -236,13 +238,11 @@ let compilerLogsWatcher = chokidar
} catch {
console.log("Error while sending updated diagnostics");
}
} else {
ic.incrementalCompilationFileChanged(fileURLToPath(change.uri));
}
});

let stopWatchingCompilerLog = () => {
// TODO: cleanup of compilerLogs?
compilerLogsWatcher.close();
};
}));
}

type clientSentBuildAction = {
title: string;
Expand Down Expand Up @@ -280,13 +280,7 @@ let openedFile = async (fileUri: string, fileContent: string) => {
: false,
};
projectsFiles.set(projectRootPath, projectRootState);
compilerLogsWatcher.add(
path.join(projectRootPath, c.compilerLogPartialPath)
);
if (config.extensionConfiguration.cache?.projectConfig?.enable === true) {
compilerLogsWatcher.add(
path.join(projectRootPath, c.buildNinjaPartialPath)
);
await syncProjectConfigCache(projectRootPath);
}
}
Expand Down Expand Up @@ -364,12 +358,6 @@ let closedFile = async (fileUri: string) => {
root.openFiles.delete(filePath);
// clear diagnostics too if no open files open in said project
if (root.openFiles.size === 0) {
compilerLogsWatcher.unwatch(
path.join(projectRootPath, c.compilerLogPartialPath)
);
compilerLogsWatcher.unwatch(
path.join(projectRootPath, c.buildNinjaPartialPath)
);
await deleteProjectConfigCache(projectRootPath);
deleteProjectDiagnostics(projectRootPath);
if (root.bsbWatcherByEditor !== null) {
Expand Down Expand Up @@ -1051,7 +1039,7 @@ async function onMessage(msg: p.Message) {
} else {
process.exit(1);
}
} else if (msg.method === "initialized") {
} else if (msg.method === InitializedNotification.method) {
/*
The initialized notification is sent from the client to the server after the client received the result of the initialize request
but before the client is sending any other request or notification to the server.
Expand All @@ -1060,27 +1048,32 @@ async function onMessage(msg: p.Message) {
We use this to register the file watchers for the project.
The client can watch files for us and send us events via the `workspace/didChangeWatchedFiles`
*/
const watchers =
Array.from(projectsFiles.keys()).flatMap(projectRootPath => [
const watchers = Array.from(workspaceFolders).flatMap(
(projectRootPath) => [
{
globPattern: path.join(projectRootPath, c.compilerLogPartialPath),
kind: p.WatchKind.Change | p.WatchKind.Create,
kind: p.WatchKind.Change | p.WatchKind.Create | p.WatchKind.Delete,
},
{
globPattern: path.join(projectRootPath, c.buildNinjaPartialPath),
kind: p.WatchKind.Change | p.WatchKind.Create,
kind: p.WatchKind.Change | p.WatchKind.Create | p.WatchKind.Delete,
},
])
const registrationParams : p.RegistrationParams = {
registrations:[
{
id: "rescript_file_watcher",
method: p.DidChangeWatchedFilesNotification.method,
registerOptions: {
watchers
}
globPattern: `${path.join(projectRootPath, c.compilerDirPartialPath)}/**/*.{cmt,cmi}`,
kind: p.WatchKind.Change | p.WatchKind.Delete,
}
]
);
const registrationParams: p.RegistrationParams = {
registrations: [
{
id: "rescript_file_watcher",
method: DidChangeWatchedFilesNotification.method,
registerOptions: {
watchers,
},
},
],
};
const req: p.RequestMessage = {
jsonrpc: c.jsonrpcVersion,
Expand All @@ -1089,6 +1082,9 @@ async function onMessage(msg: p.Message) {
params: registrationParams,
};
send(req);
} else if (msg.method === DidChangeWatchedFilesNotification.method) {
const params = msg.params as p.DidChangeWatchedFilesParams;
await onWorkspaceDidChangeWatchedFiles(params);
} else if (msg.method === DidOpenTextDocumentNotification.method) {
let params = msg.params as p.DidOpenTextDocumentParams;
await openedFile(params.textDocument.uri, params.textDocument.text);
Expand Down Expand Up @@ -1134,6 +1130,10 @@ async function onMessage(msg: p.Message) {
} else if (msg.method === "initialize") {
// Save initial configuration, if present
let initParams = msg.params as InitializeParams;
for (const workspaceFolder of initParams.workspaceFolders || []) {
const workspaceRootPath = fileURLToPath(workspaceFolder.uri);
workspaceFolders.add(workspaceRootPath);
}
let initialConfiguration = initParams.initializationOptions
?.extensionConfiguration as extensionConfiguration | undefined;

Expand Down Expand Up @@ -1245,8 +1245,6 @@ async function onMessage(msg: p.Message) {
} else {
shutdownRequestAlreadyReceived = true;
// TODO: recheck logic around init/shutdown...
stopWatchingCompilerLog();
// TODO: delete bsb watchers

if (pullConfigurationPeriodically != null) {
clearInterval(pullConfigurationPeriodically);
Expand Down