Skip to content

Fix automatic refresh of server-side documents after save and compile #1678

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 2 commits into from
Dec 2, 2025
+66 −29
Merged

Fix automatic refresh of server-side documents after save and compile #1678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5404c39
Fix automatic refresh of server-side documents after save & compile
isc-bsaviano Dec 2, 2025
74dc2bd
Update file contents that are changed by a non-post-save compile
isc-bsaviano Dec 2, 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
14 changes: 14 additions & 0 deletions src/extension.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1897,6 +1897,20 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
sendCommandTelemetryEvent("showAllClassMembers");
if (uri instanceof vscode.Uri) showAllClassMembers(uri);
}),
vscode.workspace.onDidSaveTextDocument((d) => {
// If the document just saved is a server-side document that needs to be updated in the UI,
// then force VS Code to update the document's contents. This is needed if the document has
// been changed during a save, for example by adding or changing the Storage definition.
if (notIsfs(d.uri)) return;
const uriString = d.uri.toString();
if (fileSystemProvider.needsUpdate(uriString)) {
const activeDoc = vscode.window.activeTextEditor?.document;
if (activeDoc && !activeDoc.isDirty && !activeDoc.isClosed && activeDoc.uri.toString() == uriString) {
// Force VS Code to refresh the file's contents in the editor tab
vscode.commands.executeCommand("workbench.action.files.revert");
}
}
}),
// These three listeners are needed to keep track of which file events were caused by VS Code
// to support the "vscodeOnly" option for the objectscript.syncLocalChanges setting.
// They store the URIs of files that are about to be changed by VS Code.
Expand Down
81 changes: 52 additions & 29 deletions src/providers/FileSystemProvider/FileSystemProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,10 +268,29 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
private _bufferedEvents: vscode.FileChangeEvent[] = [];
private _fireSoonHandle?: NodeJS.Timeout;

/**
* The stringified URIs of all `isfs` documents that may have had
* their contents changed during the last time they were saved
*/
private readonly _needsUpdate: Set<string> = new Set();

public constructor() {
this.onDidChangeFile = this._emitter.event;
}

/**
* Check if this `isfs` document stringified URI was changed during
* the last time it was saved. This is used to force VS Code to update
* the editor tab containing the file.
*/
public needsUpdate(uriString: string): boolean {
if (this._needsUpdate.has(uriString)) {
this._needsUpdate.delete(uriString);
Copy link
Contributor

@gjsjohnmurray gjsjohnmurray Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if deletion from the _needsUpdate private Set should be done by a different method, As things stand we can't discover if a document needs to be updated without also implying we've updated it.

Copy link
Contributor Author

@isc-bsaviano isc-bsaviano Dec 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did this intentionally because I wanted the flag to always be cleared after it was checked the first time. It should only be checked once immediately after the write, and should be cleared even if the update failed somehow. I should harden this to always clear the _needsUpdate entry for the URI before any writeFile call so old values that are never checked can't survive between saves.

return true;
}
return false;
}

// Used by import and compile to make sure we notice its changes
public fireFileChanged(uri: vscode.Uri): void {
this._fireSoon({ type: vscode.FileChangeType.Changed, uri });
Expand Down Expand Up @@ -476,6 +495,9 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
overwrite: boolean;
}
): void | Thenable<void> {
const originalUriString = uri.toString();
const originalUri = vscode.Uri.parse(originalUriString);
this._needsUpdate.delete(originalUriString);
uri = redirectDotvscodeRoot(uri, new vscode.FileSystemError("Server does not have a /_vscode web application"));
if (uri.path.startsWith("/.")) {
throw new vscode.FileSystemError("dot-folders are not supported by server");
Expand Down Expand Up @@ -616,38 +638,17 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
// is part of the "write" operation from VS Code's point of view. This is required
// to prevent concurreny issues when VS Code refreshs its internal representaton of
// the file system while documents are being compiled.
return this.compile(uri, entry, update);
return this.compile(originalUri, entry, update);
} else if (update) {
// The file's contents may have changed as a result of the save,
// so make sure we notify VS Code and any watchers of the change
this._notifyOfFileChange(uri);
// so make sure VS Code updates the editor tab contents if needed
this._needsUpdate.add(originalUriString);
} else if (!created) {
this._fireSoon({ type: vscode.FileChangeType.Changed, uri });
this._fireSoon({ type: vscode.FileChangeType.Changed, uri: originalUri });
}
});
}

/**
* Notify VS Code and any watchers that the contents of `uri` changed.
* Use this function instead of firing the file change event directly
* when we need to force the VS Code UI to show the change. For example,
* if the server changed the document during a save.
*/
private _notifyOfFileChange(uri: vscode.Uri): void {
// The file's contents may have changed as a result of the save,
// so make sure we notify VS Code and any watchers of the change
const uriString = uri.toString();
if (vscode.window.activeTextEditor?.document.uri.toString() == uriString) {
setTimeout(() => {
const activeDoc = vscode.window.activeTextEditor?.document;
if (activeDoc && !activeDoc.isDirty && !activeDoc.isClosed && activeDoc.uri.toString() == uriString) {
// Force VS Code to refresh the file's contents in the editor UI
vscode.commands.executeCommand("workbench.action.files.revert");
}
}, 75);
}
}

/** Process a Document object that was successfully deleted. */
private async processDeletedDoc(doc: Document, uri: vscode.Uri, csp: boolean, project: boolean): Promise<void> {
const events: vscode.FileChangeEvent[] = [];
Expand Down Expand Up @@ -867,6 +868,9 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
*/
public async compile(uri: vscode.Uri, file?: File, update?: boolean): Promise<void> {
if (!uri || uri.scheme != FILESYSTEM_SCHEMA) return;
const originalUriString = uri.toString();
const originalUri = vscode.Uri.parse(originalUriString);
this._needsUpdate.delete(originalUriString);
uri = redirectDotvscodeRoot(uri, new vscode.FileSystemError("Server does not have a /_vscode web application"));
const compileList: string[] = [];
try {
Expand Down Expand Up @@ -914,17 +918,36 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
})
.catch(() => compileErrorMsg(conf))
);
if (update || (file && filesToUpdate.includes(file.fileName))) {
if (file && (update || filesToUpdate.includes(file.fileName))) {
// This file was just written and the write may have changed its contents or the
// compilation changed its contents. Therefore, we must force VS Code to update it.
this._notifyOfFileChange(uri);
this._needsUpdate.add(originalUriString);
}
if (filesToUpdate.length) {
// Force VS Code to refresh the active editor tab's contents if the file was changed
// by compilation and is NOT the file that was saved if this is a post-save compilation
const activeDoc = vscode.window.activeTextEditor?.document;
if (activeDoc && !activeDoc.isDirty && !activeDoc.isClosed) {
const activeDocUriString = activeDoc.uri.toString();
if (
!(file && activeDocUriString == originalUriString) &&
filesToUpdate.some(
(f) =>
DocumentContentProvider.getUri(f, undefined, undefined, undefined, originalUri)?.toString() ==
activeDocUriString
)
) {
// Force VS Code to refresh the contents in the active editor tab
vscode.commands.executeCommand("workbench.action.files.revert");
}
}
}
// Fire file changed events for all files changed by compilation
this._fireSoon(
...filesToUpdate.map((f) => {
return {
type: vscode.FileChangeType.Changed,
uri: DocumentContentProvider.getUri(f, undefined, undefined, undefined, uri),
uri: DocumentContentProvider.getUri(f, undefined, undefined, undefined, originalUri),
};
})
);
Expand All @@ -942,7 +965,7 @@ export class FileSystemProvider implements vscode.FileSystemProvider {
).map((f: string) => {
return {
type: vscode.FileChangeType.Changed,
uri: DocumentContentProvider.getUri(f, undefined, undefined, undefined, uri),
uri: DocumentContentProvider.getUri(f, undefined, undefined, undefined, originalUri),
};
})
);
Expand Down
Loading