untitled - encapsulate and update model within input (#201712)

Author: bpasero

src/vs/workbench/browser/parts/editor/textResourceEditor.ts

@@ -156,7 +156,7 @@ export class TextResourceEditor extends AbstractTextResourceEditor {
 	}
 
 	private onDidEditorPaste(e: IPasteEvent, codeEditor: ICodeEditor): void {
-		if (this.input instanceof UntitledTextEditorInput && this.input.model.hasLanguageSetExplicitly) {
+		if (this.input instanceof UntitledTextEditorInput && this.input.hasLanguageSetExplicitly) {
 			return; // do not override language if it was set explicitly
 		}
 
@@ -205,7 +205,7 @@ export class TextResourceEditor extends AbstractTextResourceEditor {
 		if (candidateLanguage && candidateLanguage.id !== PLAINTEXT_LANGUAGE_ID) {
 			if (this.input instanceof UntitledTextEditorInput && candidateLanguage.source === 'event') {
 				// High confidence, set language id at TextEditorModel level to block future auto-detection
-				this.input.model.setLanguageId(candidateLanguage.id);
+				this.input.setLanguageId(candidateLanguage.id);
 			} else {
 				textModel.setLanguage(this.languageService.createById(candidateLanguage.id));
 			}

src/vs/workbench/services/textfile/test/browser/textEditorService.test.ts

@@ -129,14 +129,14 @@ suite('TextEditorService', () => {
 		// Untyped Input (untitled with file path)
 		input = disposables.add(service.createTextEditor({ resource: URI.file('/some/path.txt'), forceUntitled: true, options: { selection: { startLineNumber: 1, startColumn: 1 } } }));
 		assert(input instanceof UntitledTextEditorInput);
-		assert.ok((input as UntitledTextEditorInput).model.hasAssociatedFilePath);
+		assert.ok((input as UntitledTextEditorInput).hasAssociatedFilePath);
 
 		// Untyped Input (untitled with untitled resource)
 		untypedInput = { resource: URI.parse('untitled://Untitled-1'), forceUntitled: true, options: { selection: { startLineNumber: 1, startColumn: 1 } } };
 		assert.ok(isUntitledResourceEditorInput(untypedInput));
 		input = disposables.add(service.createTextEditor(untypedInput));
 		assert(input instanceof UntitledTextEditorInput);
-		assert.ok(!(input as UntitledTextEditorInput).model.hasAssociatedFilePath);
+		assert.ok(!(input as UntitledTextEditorInput).hasAssociatedFilePath);
 
 		// Untyped input (untitled with custom resource, but forceUntitled)
 		untypedInput = { resource: URI.file('/fake'), forceUntitled: true };
@@ -149,7 +149,7 @@ suite('TextEditorService', () => {
 
 		input = disposables.add(service.createTextEditor({ resource: URI.parse('untitled-custom://some/path'), forceUntitled: true, options: { selection: { startLineNumber: 1, startColumn: 1 } } }));
 		assert(input instanceof UntitledTextEditorInput);
-		assert.ok((input as UntitledTextEditorInput).model.hasAssociatedFilePath);
+		assert.ok((input as UntitledTextEditorInput).hasAssociatedFilePath);
 
 		provider.dispose();
 

src/vs/workbench/services/untitled/common/untitledTextEditorHandler.ts

@@ -47,7 +47,7 @@ export class UntitledTextEditorInputSerializer implements IEditorSerializer {
 		const untitledTextEditorInput = editorInput as UntitledTextEditorInput;
 
 		let resource = untitledTextEditorInput.resource;
-		if (untitledTextEditorInput.model.hasAssociatedFilePath) {
+		if (untitledTextEditorInput.hasAssociatedFilePath) {
 			resource = toLocalResource(resource, this.environmentService.remoteAuthority, this.pathService.defaultUriScheme); // untitled with associated file path use the local schema
 		}
 
@@ -59,7 +59,7 @@ export class UntitledTextEditorInputSerializer implements IEditorSerializer {
 		const languageIdCandidate = untitledTextEditorInput.getLanguageId();
 		if (languageIdCandidate !== PLAINTEXT_LANGUAGE_ID) {
 			languageId = languageIdCandidate;
-		} else if (untitledTextEditorInput.model.hasLanguageSetExplicitly) {
+		} else if (untitledTextEditorInput.hasLanguageSetExplicitly) {
 			languageId = languageIdCandidate;
 		}
 

src/vs/workbench/services/untitled/common/untitledTextEditorInput.ts

@@ -18,7 +18,7 @@ import { IPathService } from 'vs/workbench/services/path/common/pathService';
 import { ITextEditorOptions } from 'vs/platform/editor/common/editor';
 import { IFilesConfigurationService } from 'vs/workbench/services/filesConfiguration/common/filesConfigurationService';
 import { ITextModelService } from 'vs/editor/common/services/resolverService';
-import { dispose, IReference } from 'vs/base/common/lifecycle';
+import { DisposableStore, dispose, IReference } from 'vs/base/common/lifecycle';
 import { ITextResourceConfigurationService } from 'vs/editor/common/services/textResourceConfiguration';
 
 /**
@@ -37,10 +37,11 @@ export class UntitledTextEditorInput extends AbstractTextResourceEditorInput imp
 	}
 
 	private modelResolve: Promise<void> | undefined = undefined;
+	private readonly modelDisposables = this._register(new DisposableStore());
 	private cachedUntitledTextEditorModelReference: IReference<IUntitledTextEditorModel> | undefined = undefined;
 
 	constructor(
-		readonly model: IUntitledTextEditorModel,
+		protected model: IUntitledTextEditorModel,
 		@ITextFileService textFileService: ITextFileService,
 		@ILabelService labelService: ILabelService,
 		@IEditorService editorService: IEditorService,
@@ -54,16 +55,31 @@ export class UntitledTextEditorInput extends AbstractTextResourceEditorInput imp
 		super(model.resource, undefined, editorService, textFileService, labelService, fileService, filesConfigurationService, textResourceConfigurationService);
 
 		this.registerModelListeners(model);
+
+		this._register(this.textFileService.untitled.onDidCreate(model => this.onDidCreateUntitledModel(model)));
 	}
 
 	private registerModelListeners(model: IUntitledTextEditorModel): void {
+		this.modelDisposables.clear();
 
 		// re-emit some events from the model
-		this._register(model.onDidChangeDirty(() => this._onDidChangeDirty.fire()));
-		this._register(model.onDidChangeName(() => this._onDidChangeLabel.fire()));
+		this.modelDisposables.add(model.onDidChangeDirty(() => this._onDidChangeDirty.fire()));
+		this.modelDisposables.add(model.onDidChangeName(() => this._onDidChangeLabel.fire()));
 
 		// a reverted untitled text editor model renders this input disposed
-		this._register(model.onDidRevert(() => this.dispose()));
+		this.modelDisposables.add(model.onDidRevert(() => this.dispose()));
+	}
+
+	private onDidCreateUntitledModel(model: IUntitledTextEditorModel): void {
+		if (isEqual(model.resource, this.model.resource) && model !== this.model) {
+
+			// Ensure that we keep our model up to date with
+			// the actual model from the service so that we
+			// never get out of sync with the truth.
+
+			this.model = model;
+			this.registerModelListeners(model);
+		}
 	}
 
 	override getName(): string {
@@ -116,6 +132,10 @@ export class UntitledTextEditorInput extends AbstractTextResourceEditorInput imp
 		return this.model.setEncoding(encoding);
 	}
 
+	get hasLanguageSetExplicitly() { return this.model.hasLanguageSetExplicitly; }
+
+	get hasAssociatedFilePath() { return this.model.hasAssociatedFilePath; }
+
 	setLanguageId(languageId: string, source?: string): void {
 		this.model.setLanguageId(languageId, source);
 	}

src/vs/workbench/services/untitled/common/untitledTextEditorService.ts

@@ -78,6 +78,11 @@ export interface IUntitledTextEditorModelManager {
 	 */
 	readonly onDidChangeLabel: Event<IUntitledTextEditorModel>;
 
+	/**
+	 * Events for when untitled text editor models are created.
+	 */
+	readonly onDidCreate: Event<IUntitledTextEditorModel>;
+
 	/**
 	 * Events for when untitled text editors are about to be disposed.
 	 */
@@ -143,6 +148,9 @@ export class UntitledTextEditorService extends Disposable implements IUntitledTe
 	private readonly _onDidChangeEncoding = this._register(new Emitter<IUntitledTextEditorModel>());
 	readonly onDidChangeEncoding = this._onDidChangeEncoding.event;
 
+	private readonly _onDidCreate = this._register(new Emitter<IUntitledTextEditorModel>());
+	readonly onDidCreate = this._onDidCreate.event;
+
 	private readonly _onWillDispose = this._register(new Emitter<IUntitledTextEditorModel>());
 	readonly onWillDispose = this._onWillDispose.event;
 
@@ -267,6 +275,9 @@ export class UntitledTextEditorService extends Disposable implements IUntitledTe
 		// Add to cache
 		this.mapResourceToModel.set(model.resource, model);
 
+		// Emit as event
+		this._onDidCreate.fire(model);
+
 		// If the model is dirty right from the beginning,
 		// make sure to emit this as an event
 		if (model.isDirty()) {

src/vs/workbench/services/untitled/test/browser/untitledTextEditor.test.ts

@@ -26,6 +26,10 @@ import { timeout } from 'vs/base/common/async';
 
 suite('Untitled text editors', () => {
 
+	class TestUntitledTextEditorInput extends UntitledTextEditorInput {
+		getModel() { return this.model; }
+	}
+
 	const disposables = new DisposableStore();
 	let instantiationService: IInstantiationService;
 	let accessor: TestServiceAccessor;
@@ -44,11 +48,19 @@ suite('Untitled text editors', () => {
 		const service = accessor.untitledTextEditorService;
 		const workingCopyService = accessor.workingCopyService;
 
-		const input1 = instantiationService.createInstance(UntitledTextEditorInput, service.create());
+		const events: IUntitledTextEditorModel[] = [];
+		disposables.add(service.onDidCreate(model => {
+			events.push(model);
+		}));
+
+		const input1 = instantiationService.createInstance(TestUntitledTextEditorInput, service.create());
 		await input1.resolve();
-		assert.strictEqual(service.get(input1.resource), input1.model);
+		assert.strictEqual(service.get(input1.resource), input1.getModel());
 		assert.ok(!accessor.untitledTextEditorService.isUntitledWithAssociatedResource(input1.resource));
 
+		assert.strictEqual(events.length, 1);
+		assert.strictEqual(events[0].resource.toString(), input1.getModel().resource.toString());
+
 		assert.ok(service.get(input1.resource));
 		assert.ok(!service.get(URI.file('testing')));
 
@@ -59,16 +71,16 @@ suite('Untitled text editors', () => {
 		assert.ok(!input1.hasCapability(EditorInputCapabilities.RequiresTrust));
 		assert.ok(!input1.hasCapability(EditorInputCapabilities.Scratchpad));
 
-		const input2 = instantiationService.createInstance(UntitledTextEditorInput, service.create());
-		assert.strictEqual(service.get(input2.resource), input2.model);
+		const input2 = instantiationService.createInstance(TestUntitledTextEditorInput, service.create());
+		assert.strictEqual(service.get(input2.resource), input2.getModel());
 
 		// toUntyped()
 		const untypedInput = input1.toUntyped({ preserveViewState: 0 });
 		assert.strictEqual(untypedInput.forceUntitled, true);
 
 		// get()
-		assert.strictEqual(service.get(input1.resource), input1.model);
-		assert.strictEqual(service.get(input2.resource), input2.model);
+		assert.strictEqual(service.get(input1.resource), input1.getModel());
+		assert.strictEqual(service.get(input2.resource), input2.getModel());
 
 		// revert()
 		await input1.revert(0);
@@ -80,6 +92,9 @@ suite('Untitled text editors', () => {
 		assert.strictEqual(await service.resolve({ untitledResource: input2.resource }), model);
 		assert.ok(service.get(model.resource));
 
+		assert.strictEqual(events.length, 2);
+		assert.strictEqual(events[1].resource.toString(), input2.resource.toString());
+
 		assert.ok(!input2.isDirty());
 
 		const resourcePromise = awaitDidChangeDirty(accessor.untitledTextEditorService);
@@ -214,10 +229,10 @@ suite('Untitled text editors', () => {
 		const service = accessor.untitledTextEditorService;
 		const workingCopyService = accessor.workingCopyService;
 
-		const untitled = disposables.add(instantiationService.createInstance(UntitledTextEditorInput, service.create({ initialValue: 'Hello World' })));
+		const untitled = disposables.add(instantiationService.createInstance(TestUntitledTextEditorInput, service.create({ initialValue: 'Hello World' })));
 		assert.ok(untitled.isDirty());
 
-		const backup = (await untitled.model.backup(CancellationToken.None)).content;
+		const backup = (await untitled.getModel().backup(CancellationToken.None)).content;
 		if (isReadableStream(backup)) {
 			const value = await streamToBuffer(backup as VSBufferReadableStream);
 			assert.strictEqual(value.toString(), 'Hello World');
@@ -307,9 +322,9 @@ suite('Untitled text editors', () => {
 		const model = disposables.add(service.create());
 		const input = disposables.add(instantiationService.createInstance(UntitledTextEditorInput, model));
 
-		assert.ok(!input.model.hasLanguageSetExplicitly);
+		assert.ok(!input.hasLanguageSetExplicitly);
 		input.setLanguageId(PLAINTEXT_LANGUAGE_ID);
-		assert.ok(input.model.hasLanguageSetExplicitly);
+		assert.ok(input.hasLanguageSetExplicitly);
 
 		assert.strictEqual(input.getLanguageId(), PLAINTEXT_LANGUAGE_ID);
 	});
@@ -327,9 +342,9 @@ suite('Untitled text editors', () => {
 		const input = disposables.add(instantiationService.createInstance(UntitledTextEditorInput, model));
 		disposables.add(await input.resolve());
 
-		assert.ok(!input.model.hasLanguageSetExplicitly);
+		assert.ok(!input.hasLanguageSetExplicitly);
 		model.textEditorModel!.setLanguage(accessor.languageService.createById(language));
-		assert.ok(input.model.hasLanguageSetExplicitly);
+		assert.ok(input.hasLanguageSetExplicitly);
 
 		assert.strictEqual(model.getLanguageId(), language);
 	});
@@ -346,12 +361,12 @@ suite('Untitled text editors', () => {
 		const input = disposables.add(instantiationService.createInstance(UntitledTextEditorInput, model));
 		await input.resolve();
 
-		assert.ok(!input.model.hasLanguageSetExplicitly);
+		assert.ok(!input.hasLanguageSetExplicitly);
 		model.textEditorModel!.setLanguage(
 			accessor.languageService.createById(language),
 			// This is really what this is testing
 			LanguageDetectionLanguageEventSource);
-		assert.ok(!input.model.hasLanguageSetExplicitly);
+		assert.ok(!input.hasLanguageSetExplicitly);
 
 		assert.strictEqual(model.getLanguageId(), language);
 	});