Implement large file confirmation for file working copy editors

[jrieken]

Testing #171743

• vscode desktop
• have a 2BG file
• in the explorer, right+click and open in HEX editor
• 🐛 no warning

[bpasero]

Yeah it will only apply to text editors, I will update the test plan item and maybe the setting should change to workbench.textEditorLargeFileConfirmation.

[jrieken]

same is true for notebooks (and I guess for any custom editor)

[bpasero]

Yeah, it is currently only implemented for text editors, though the underlying logic for file size limits is available to anyone from the file service via the limits option:

vscode/src/vs/platform/files/common/files.ts

Line 321 in 569f3d1

readonly limits?: IFileReadLimits;

We can probably implement it for notebooks, by adding the limit here:

vscode/src/vs/workbench/services/workingCopy/common/storedFileWorkingCopy.ts

Line 556 in 569f3d1

const content = await this.fileService.readFileStream(this.resource, { etag });

But for custom editors that are not text based, the loading of data is not under our control...

[jrieken]

+1 for doing this for editors that we ship out of the box /cc @roblourens @rebornix

[bpasero]

I can see to add this for notebooks, but custom editors that do file loading on their own will probably not be so easy to get working with that setting.

[rebornix]

I can see to add this for notebooks

I was expecting this to auto opt-in feature for working copy but it seems it requires us to handle it in editor input or editor level?

[bpasero]

I have not started the investigation yet, but yeah it might be on the editor level and not generic.

Update: this needs to be implemented in editor inputs and editors currently if we want to avoid throwing the error when any working copy is resolved. My intention was to limit this new error to editor resolving only because there we have a UI for the user to resolve it. If we were to have this size limit in a generic way, anyone resolving a model would potentially have to deal with this error.

For text files, the limit is installed here:

vscode/src/vs/workbench/contrib/files/browser/editors/fileEditorInput.ts

Lines 330 to 338 in 43db9d2

	await this.textFileService.files.resolve(this.resource, {
	languageId: this.preferredLanguageId,
	encoding: this.preferredEncoding,
	contents: typeof preferredContents === 'string' ? createTextBufferFactory(preferredContents) : undefined,
	reload: { async: true }, // trigger a reload of the model if it exists already but do not wait to show the model
	allowBinary: this.forceOpenAs === ForceOpenAs.Text,
	reason: TextFileResolveReason.EDITOR,
	limits: this.ensureLimits(options)
	});

And the editor handling part is here:

vscode/src/vs/workbench/contrib/files/browser/editors/textFileEditor.ts

Lines 187 to 197 in 43db9d2

	// Handle case where a file is too large to open without confirmation
	if ((<FileOperationError>error).fileOperationResult === FileOperationResult.FILE_TOO_LARGE && this.group) {
	let message: string;
	if (error instanceof TooLargeFileOperationError) {
	message = localize('fileTooLargeForHeapErrorWithSize', "The file is not displayed in the text editor because it is very large ({0}).", ByteSize.formatSize(error.size));
	} else {
	message = localize('fileTooLargeForHeapErrorWithoutSize', "The file is not displayed in the text editor because it is very large.");
	}
	throw createTooLargeFileError(this.group, input, options, message, this.preferencesService);
	}

[bpasero]

Notebook support is coming: