In Theia 1.62 the event vscode.workspace.onWillSaveTextDocument is not triggered anymore

[safisa]

Hi,
I have a vscode extension that uses the vscode.workspace.onWillSaveTextDocument API. I see that in the latest Theia 1.62 this API is not triggered anymore.
NOTE that it is NOT working on custom editors only.

Is it a regression issue in Theia?

[JonasHelming]

@rschnekenbu

[rschnekenbu]

I need to check if this could be a regression from #15555.
@safisa, can you tell me which extension you are using that triggers this API? I would need to create a new one otherwise, as the vscode extension samples does not use it.

[rschnekenbu]

If you cannot share it, I will create a sample one

[safisa]

Hi @rschnekenbu,
Note that I have updated the description above to indicate that this regression issue happens only on custom editors.
Anyways, we have a massive extension that utilizes this API, so I can't share it.
But, I have built a small one that demonstrates it, and you can check it on a text editor where it should work, and on a custom editor where it does not work. When you try it on older Theia versions (I tried 1.57), it worked on both types.

Here is the extension code:

export function activate(context: vscode.ExtensionContext) {
    let channel = vscode.window.createOutputChannel("willSave Test");

    // Register the onWillSaveTextDocument event
    vscode.workspace.onWillSaveTextDocument(event => {
        // Log a message when a document is about to be saved
        channel.appendLine(`Document ${event.document.uri} is about to be saved`);

        let p = new Promise((resolve, reject) => {
            channel.appendLine(`Pre save`);
            let data = event.document.getText();
            // data manipulation...
            resolve(data);
        }).then(res => {
            let textRange = new vscode.Range(0, 0, event.document.lineCount, 0);
            let textEdit = vscode.TextEdit.replace(textRange, `${res}`);
            return [textEdit];
        });
        event.waitUntil(p);

        p.then(res => {
            if (res) {
                channel.appendLine(`Post save`);
                //this.postSave(doc.uri, res[0].newText);
            }
        });

    });
}

And here is the vsix file:
willsavetest-0.0.1.vsix.zip

Thanks

[safisa]

Hi @JonasHelming , @rschnekenbu
I think we should move this thread to the issues section, as it is a regression in the vscode.workspace.onWillSaveTextDocument API over custom editors.
Anyone using this onWillSaveTextDocument API with custom editors (to do data manipulations before saving) will be affected when upgrading to 1.62, so it is a major issue.
Can you move it to the issues section? Or, do I need to open a new issue with the same details above?
Thanks

[tsmaeder]

@safisa probably easier if you open an issue.

[rschnekenbu]

@safisa , I opened #15770.