vscode: showTextDocument returned the wrong editor when called multiple times concurrently

It seems like there may be some race condition in showTextDocument where if it’s called multiple times before the previous has completed, each call returns the last editor to be opened.

Here I have an array of two items short_test.dart and short2_test.dart and I call openTextDocument and showTextDocument for each. However the resulting editors both point at short2_test.dart:

The results from openTextDocument are correct in both cases, it’s only showTextDocument that seems to be misbehaving.

About this issue

Original URL
State: closed
Created 3 years ago
Comments: 18 (17 by maintainers)

Commits related to this issue

editors - return `undefined` from `openEditor` when operation cancelled (fix #134786) — committed to microsoft/vscode by bpasero 3 years ago

Most upvoted comments

I pushed a change to return undefined when openEditor operation is cancelled by another operation.

Given the sample code in this issue, I see that we now throw an exception back to the extension:

ERR [Extension Host] Error: Could NOT open editor for "file:///Users/bpasero/Desktop/test-ts/package.json".
	at ExtHostEditors.showTextDocument (/Users/bpasero/Development/Microsoft/monaco/out/vs/workbench/api/common/extHostTextEditors.js:69:23)
	at processTicksAndRejections (internal/process/task_queues.js:93:5)

Originating from:

https://github.com/microsoft/vscode/blob/f523f65f3985eb6493cae5d219de35f1d7ba6f7a/src/vs/workbench/api/common/extHostTextEditors.ts#L91

I suppose extensions had to deal with this error before already as it is not a new error, but it may appear now in more cases.

bpasero on Nov 1, 2021

Yeah, I tried that one first too, but it also worked (did the thing I wanted, without exceptions). I don’t know if that really verifies the fix or not though, but I certainly can’t reproduce any bug now 😃

DanTup on Nov 22, 2021

I think an easier fix that doesn’t involve overloads is to simply return undefined when we detect that the openEditor call was cancelled. Since we already spec it that way, callers should be able to handle that.

Pushing to November though to get this out in debt week given it may still break something.

bpasero on Oct 25, 2021