Git: Failed to show text document , should show in editor #undefined

[bpasero]

Refs: #96279

I got this by clicking on the "Open File" quick action from the Git changes view.

[jrieken]

@joaomoreno Is the git extension using the showTextDocument-API and not the vscode.open-command?

[jrieken]

Oh, I see:

vscode/extensions/git/src/commands.ts

Lines 839 to 845 in cab6f95

	document = await workspace.openTextDocument(uri);
	} catch (error) {
	await commands.executeCommand<void>('vscode.open', uri, opts);
	continue;
	}
	// Check if active text editor has same path as other editor. we cannot compare via

Git is using the fact that a text document can be created as hint for opening a text editor. This will then also apply all custom text editors (fyi @mjbvz) and I feel that the API should always open a text editor then...

[joaomoreno]

I've called every possible method in our API/commands to be able to open documents from the git extension. The current approach is probably already the 53rd iteration.

Please just tell me what I should do there and I'll add a comment in there saying who suggested it, for the next time I have to change this.

[jrieken]

Yeah, git isn't to blame. This is two problems

• the showTextDocument-API must overrule the custom editor settings and always open a text editor
• there is no API to do the right thing, like open this URI with potentially these options

[bpasero]

@jrieken

the showTextDocument-API must overrule the custom editor settings and always open a text editor

We have a ignoreOverrides editor option that we could simply add to this options bag [1]

there is no API to do the right thing, like open this URI with potentially these options

Can you clarify what API is needed, wasn't sure I understand that message.

[1]

vscode/src/vs/workbench/api/browser/mainThreadEditors.ts

Lines 121 to 128 in 997b4c8

	const editorOptions: ITextEditorOptions = {
	preserveFocus: options.preserveFocus,
	pinned: options.pinned,
	selection: options.selection,
	// preserve pre 1.38 behaviour to not make group active when preserveFocus: true
	// but make sure to restore the editor to fix https://github.com/microsoft/vscode/issues/79633
	activation: options.preserveFocus ? EditorActivation.RESTORE : undefined
	};

[jrieken]

The showTextDocument-API has guarantee that it opens a text editor or errors. Therefore we cannot make it open a custom editor and need an API which doesn't return anything but accepts the union of all editor options. Like, open this uri as any editor, if it's a text editor use these options, if it's a foo editor use these options etc

[jrieken]

We have a ignoreOverrides editor option that we could simply add to this options bag [1]

👍 thanks. I have pushed a change that uses this flag

[bpasero]

Sounds good. I feel that we should then close this issue for the actual bug I filed and be able to verify it and have a new issue for the new API.

[jrieken]

Agreed - I'd say we fold the API request into the "expose editor tab model api request"