Reopen Editor with breaks --wait behavior

[eamodio]

Because Reopen Editor with seems to close the current document, and re-open it again in with the new editor, this break the --wait behavior. IMO, switching editors, shouldn't cause the document to be closed/opened nor break --wait

FYI, this causes issues for the new GitLens rebase editor, as it relies on the --wait behavior.

[lramos15]

/cc @bpasero For more weird --wait cases. This is because internally a replace is just an open -> close which triggers the wait

[bpasero]

When we detect --wait we install a listener to observe editors closing, e.g. here:

vscode/src/vs/workbench/electron-sandbox/window.ts

Line 665 in a14600c

await this.instantiationService.invokeFunction(accessor => whenEditorClosed(accessor, resourcesToWaitFor));

To then delete a wait marker file which the calling side polls on for deletion before returning:

vscode/src/vs/workbench/electron-sandbox/window.ts

Line 668 in a14600c

await this.fileService.del(waitMarkerFile);

The code for observing editors closing probably needs to be made more clever around the fact that editors can reopen:

vscode/src/vs/workbench/browser/editor.ts

Line 174 in eebf8e8

const listener = editorService.onDidCloseEditor(async event => {

Currently we just listen to onDidCloseEditor which will fire even for the reopen case.

Some ideas:

• enrich the IEditorCloseEvent to carry a boolean that can be used to figure out if the editor was closed because it was reopened
• instead of reacting to the close event directly, add some debouncing to give the reopen a chance to bring up the new editor

Not a big fan of the debouncing because that solution sounds fragile to me. A property would make more sense to me.

Note that we already have a replaced property on IEditorCloseEvent which maybe is a bit misleading: it does not tell whether the editor was replaced from a replaceEditors call, but rather indicates that the editor was in preview mode and got replaced because another editor was opened (here). Maybe the property could still be reused though.

[bpasero]

Given my recent change in this area, if we were to enrich EditorCloseContext with another context for the reopen, we can easily fix this:

vscode/src/vs/workbench/common/editor.ts

Line 736 in cc4ace1

export enum EditorCloseContext {

[lramos15]

Given my recent change in this area, if we were to enrich EditorCloseContext with another context for the reopen, we can easily fix this:

vscode/src/vs/workbench/common/editor.ts

Line 736 in cc4ace1

export enum EditorCloseContext {

This sounds like a good solution

[lramos15]

Tested this and it seems the REPLACE closed context is passed in the wait works properly.