mirror of
https://github.com/microsoft/vscode.git
synced 2026-06-03 14:15:56 +01:00
Benjamin Pasero
381 lines
13 KiB
TypeScript
381 lines
13 KiB
TypeScript
/*---------------------------------------------------------------------------------------------
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
*--------------------------------------------------------------------------------------------*/
|
|
|
|
import * as assert from 'assert';
|
|
import { IInstantiationService } from 'vs/platform/instantiation/common/instantiation';
|
|
import { EncodingMode } from 'vs/workbench/common/editor';
|
|
import { TextFileEditorModel, SaveSequentializer } from 'vs/workbench/services/textfile/common/textFileEditorModel';
|
|
import { ITextFileService, ModelState, StateChange } from 'vs/workbench/services/textfile/common/textfiles';
|
|
import { workbenchInstantiationService, TestTextFileService, createFileInput, TestFileService } from 'vs/workbench/test/workbenchTestServices';
|
|
import { toResource } from 'vs/base/test/common/utils';
|
|
import { TextFileEditorModelManager } from 'vs/workbench/services/textfile/common/textFileEditorModelManager';
|
|
import { FileOperationResult, FileOperationError, IFileService, snapshotToString } from 'vs/platform/files/common/files';
|
|
import { IModelService } from 'vs/editor/common/services/modelService';
|
|
import { timeout } from 'vs/base/common/async';
|
|
|
|
class ServiceAccessor {
|
|
constructor(@ITextFileService public textFileService: TestTextFileService, @IModelService public modelService: IModelService, @IFileService public fileService: TestFileService) {
|
|
}
|
|
}
|
|
|
|
function getLastModifiedTime(model: TextFileEditorModel): number {
|
|
const stat = model.getStat();
|
|
|
|
return stat ? stat.mtime : -1;
|
|
}
|
|
|
|
suite('Files - TextFileEditorModel', () => {
|
|
|
|
let instantiationService: IInstantiationService;
|
|
let accessor: ServiceAccessor;
|
|
let content: string;
|
|
|
|
setup(() => {
|
|
instantiationService = workbenchInstantiationService();
|
|
accessor = instantiationService.createInstance(ServiceAccessor);
|
|
content = accessor.fileService.getContent();
|
|
});
|
|
|
|
teardown(() => {
|
|
(<TextFileEditorModelManager>accessor.textFileService.models).clear();
|
|
TextFileEditorModel.setSaveParticipant(null); // reset any set participant
|
|
accessor.fileService.setContent(content);
|
|
});
|
|
|
|
test('Save', async function () {
|
|
const model: TextFileEditorModel = instantiationService.createInstance(TextFileEditorModel, toResource.call(this, '/path/index_async.txt'), 'utf8');
|
|
|
|
await model.load();
|
|
|
|
model.textEditorModel!.setValue('bar');
|
|
assert.ok(getLastModifiedTime(model) <= Date.now());
|
|
|
|
await model.save();
|
|
|
|
assert.ok(model.getLastSaveAttemptTime() <= Date.now());
|
|
assert.ok(!model.isDirty());
|
|
|
|
model.dispose();
|
|
assert.ok(!accessor.modelService.getModel(model.getResource()));
|
|
});
|
|
|
|
test('setEncoding - encode', function () {
|
|
const model: TextFileEditorModel = instantiationService.createInstance(TextFileEditorModel, toResource.call(this, '/path/index_async.txt'), 'utf8');
|
|
|
|
model.setEncoding('utf8', EncodingMode.Encode); // no-op
|
|
assert.equal(getLastModifiedTime(model), -1);
|
|
|
|
model.setEncoding('utf16', EncodingMode.Encode);
|
|
|
|
assert.ok(getLastModifiedTime(model) <= Date.now()); // indicates model was saved due to encoding change
|
|
|
|
model.dispose();
|
|
});
|
|
|
|
test('setEncoding - decode', async function () {
|
|
const model: TextFileEditorModel = instantiationService.createInstance(TextFileEditorModel, toResource.call(this, '/path/index_async.txt'), 'utf8');
|
|
|
|
model.setEncoding('utf16', EncodingMode.Decode);
|
|
|
|
await timeout(0);
|
|
assert.ok(model.isResolved()); // model got loaded due to decoding
|
|
model.dispose();
|
|
});
|
|
|
|
test('disposes when underlying model is destroyed', async function () {
|
|
const model: TextFileEditorModel = instantiationService.createInstance(TextFileEditorModel, toResource.call(this, '/path/index_async.txt'), 'utf8');
|
|
|
|
await model.load();
|
|
|
|
model.textEditorModel!.dispose();
|
|
assert.ok(model.isDisposed());
|
|
});
|
|
|
|
test('Load does not trigger save', async function () {
|
|
const model = instantiationService.createInstance(TextFileEditorModel, toResource.call(this, '/path/index.txt'), 'utf8');
|
|
assert.ok(model.hasState(ModelState.SAVED));
|
|
|
|
model.onDidStateChange(e => {
|
|
assert.ok(e !== StateChange.DIRTY && e !== StateChange.SAVED);
|
|
});
|
|
|
|
await model.load();
|
|
assert.ok(model.isResolved());
|
|
model.dispose();
|
|
assert.ok(!accessor.modelService.getModel(model.getResource()));
|
|
});
|
|
|
|
test('Load returns dirty model as long as model is dirty', async function () {
|
|
const model = instantiationService.createInstance(TextFileEditorModel, toResource.call(this, '/path/index_async.txt'), 'utf8');
|
|
|
|
await model.load();
|
|
model.textEditorModel!.setValue('foo');
|
|
assert.ok(model.isDirty());
|
|
assert.ok(model.hasState(ModelState.DIRTY));
|
|
|
|
await model.load();
|
|
assert.ok(model.isDirty());
|
|
model.dispose();
|
|
});
|
|
|
|
test('Revert', async function () {
|
|
let eventCounter = 0;
|
|
|
|
const model = instantiationService.createInstance(TextFileEditorModel, toResource.call(this, '/path/index_async.txt'), 'utf8');
|
|
|
|
model.onDidStateChange(e => {
|
|
if (e === StateChange.REVERTED) {
|
|
eventCounter++;
|
|
}
|
|
});
|
|
|
|
await model.load();
|
|
model.textEditorModel!.setValue('foo');
|
|
assert.ok(model.isDirty());
|
|
|
|
await model.revert();
|
|
assert.ok(!model.isDirty());
|
|
assert.equal(model.textEditorModel!.getValue(), 'Hello Html');
|
|
assert.equal(eventCounter, 1);
|
|
model.dispose();
|
|
});
|
|
|
|
test('Revert (soft)', async function () {
|
|
let eventCounter = 0;
|
|
|
|
const model = instantiationService.createInstance(TextFileEditorModel, toResource.call(this, '/path/index_async.txt'), 'utf8');
|
|
|
|
model.onDidStateChange(e => {
|
|
if (e === StateChange.REVERTED) {
|
|
eventCounter++;
|
|
}
|
|
});
|
|
|
|
await model.load();
|
|
model.textEditorModel!.setValue('foo');
|
|
assert.ok(model.isDirty());
|
|
|
|
await model.revert(true /* soft revert */);
|
|
assert.ok(!model.isDirty());
|
|
assert.equal(model.textEditorModel!.getValue(), 'foo');
|
|
assert.equal(eventCounter, 1);
|
|
model.dispose();
|
|
});
|
|
|
|
test('Load and undo turns model dirty', async function () {
|
|
const model: TextFileEditorModel = instantiationService.createInstance(TextFileEditorModel, toResource.call(this, '/path/index_async.txt'), 'utf8');
|
|
await model.load();
|
|
accessor.fileService.setContent('Hello Change');
|
|
|
|
await model.load();
|
|
model.textEditorModel!.undo();
|
|
assert.ok(model.isDirty());
|
|
});
|
|
|
|
test('File not modified error is handled gracefully', async function () {
|
|
let model: TextFileEditorModel = instantiationService.createInstance(TextFileEditorModel, toResource.call(this, '/path/index_async.txt'), 'utf8');
|
|
|
|
await model.load();
|
|
|
|
const mtime = getLastModifiedTime(model);
|
|
accessor.textFileService.setResolveTextContentErrorOnce(new FileOperationError('error', FileOperationResult.FILE_NOT_MODIFIED_SINCE));
|
|
|
|
model = await model.load() as TextFileEditorModel;
|
|
|
|
assert.ok(model);
|
|
assert.equal(getLastModifiedTime(model), mtime);
|
|
model.dispose();
|
|
});
|
|
|
|
test('Load error is handled gracefully if model already exists', async function () {
|
|
let model: TextFileEditorModel = instantiationService.createInstance(TextFileEditorModel, toResource.call(this, '/path/index_async.txt'), 'utf8');
|
|
|
|
await model.load();
|
|
accessor.textFileService.setResolveTextContentErrorOnce(new FileOperationError('error', FileOperationResult.FILE_NOT_FOUND));
|
|
|
|
model = await model.load() as TextFileEditorModel;
|
|
assert.ok(model);
|
|
model.dispose();
|
|
});
|
|
|
|
test('save() and isDirty() - proper with check for mtimes', async function () {
|
|
const input1 = createFileInput(instantiationService, toResource.call(this, '/path/index_async2.txt'));
|
|
const input2 = createFileInput(instantiationService, toResource.call(this, '/path/index_async.txt'));
|
|
|
|
const model1 = await input1.resolve() as TextFileEditorModel;
|
|
const model2 = await input2.resolve() as TextFileEditorModel;
|
|
|
|
model1.textEditorModel!.setValue('foo');
|
|
|
|
const m1Mtime = model1.getStat().mtime;
|
|
const m2Mtime = model2.getStat().mtime;
|
|
assert.ok(m1Mtime > 0);
|
|
assert.ok(m2Mtime > 0);
|
|
|
|
assert.ok(accessor.textFileService.isDirty());
|
|
assert.ok(accessor.textFileService.isDirty(toResource.call(this, '/path/index_async2.txt')));
|
|
assert.ok(!accessor.textFileService.isDirty(toResource.call(this, '/path/index_async.txt')));
|
|
|
|
model2.textEditorModel!.setValue('foo');
|
|
assert.ok(accessor.textFileService.isDirty(toResource.call(this, '/path/index_async.txt')));
|
|
|
|
await timeout(10);
|
|
await accessor.textFileService.saveAll();
|
|
assert.ok(!accessor.textFileService.isDirty(toResource.call(this, '/path/index_async.txt')));
|
|
assert.ok(!accessor.textFileService.isDirty(toResource.call(this, '/path/index_async2.txt')));
|
|
assert.ok(model1.getStat().mtime > m1Mtime);
|
|
assert.ok(model2.getStat().mtime > m2Mtime);
|
|
assert.ok(model1.getLastSaveAttemptTime() > m1Mtime);
|
|
assert.ok(model2.getLastSaveAttemptTime() > m2Mtime);
|
|
|
|
model1.dispose();
|
|
model2.dispose();
|
|
});
|
|
|
|
test('Save Participant', async function () {
|
|
let eventCounter = 0;
|
|
const model: TextFileEditorModel = instantiationService.createInstance(TextFileEditorModel, toResource.call(this, '/path/index_async.txt'), 'utf8');
|
|
|
|
model.onDidStateChange(e => {
|
|
if (e === StateChange.SAVED) {
|
|
assert.equal(snapshotToString(model.createSnapshot()!), 'bar');
|
|
assert.ok(!model.isDirty());
|
|
eventCounter++;
|
|
}
|
|
});
|
|
|
|
TextFileEditorModel.setSaveParticipant({
|
|
participate: (model) => {
|
|
assert.ok(model.isDirty());
|
|
model.textEditorModel.setValue('bar');
|
|
assert.ok(model.isDirty());
|
|
eventCounter++;
|
|
return Promise.resolve();
|
|
}
|
|
});
|
|
|
|
await model.load();
|
|
model.textEditorModel!.setValue('foo');
|
|
|
|
await model.save();
|
|
model.dispose();
|
|
assert.equal(eventCounter, 2);
|
|
});
|
|
|
|
test('Save Participant, async participant', async function () {
|
|
|
|
const model: TextFileEditorModel = instantiationService.createInstance(TextFileEditorModel, toResource.call(this, '/path/index_async.txt'), 'utf8');
|
|
|
|
TextFileEditorModel.setSaveParticipant({
|
|
participate: (model) => {
|
|
return timeout(10);
|
|
}
|
|
});
|
|
|
|
await model.load();
|
|
model.textEditorModel!.setValue('foo');
|
|
|
|
const now = Date.now();
|
|
await model.save();
|
|
assert.ok(Date.now() - now >= 10);
|
|
model.dispose();
|
|
});
|
|
|
|
test('Save Participant, bad participant', async function () {
|
|
const model: TextFileEditorModel = instantiationService.createInstance(TextFileEditorModel, toResource.call(this, '/path/index_async.txt'), 'utf8');
|
|
|
|
TextFileEditorModel.setSaveParticipant({
|
|
participate: (model) => {
|
|
return Promise.reject(new Error('boom'));
|
|
}
|
|
});
|
|
|
|
await model.load();
|
|
model.textEditorModel!.setValue('foo');
|
|
|
|
await model.save();
|
|
model.dispose();
|
|
});
|
|
|
|
test('SaveSequentializer - pending basics', async function () {
|
|
const sequentializer = new SaveSequentializer();
|
|
|
|
assert.ok(!sequentializer.hasPendingSave());
|
|
assert.ok(!sequentializer.hasPendingSave(2323));
|
|
assert.ok(!sequentializer.pendingSave);
|
|
|
|
// pending removes itself after done
|
|
await sequentializer.setPending(1, Promise.resolve());
|
|
assert.ok(!sequentializer.hasPendingSave());
|
|
assert.ok(!sequentializer.hasPendingSave(1));
|
|
assert.ok(!sequentializer.pendingSave);
|
|
|
|
// pending removes itself after done (use timeout)
|
|
sequentializer.setPending(2, timeout(1));
|
|
assert.ok(sequentializer.hasPendingSave());
|
|
assert.ok(sequentializer.hasPendingSave(2));
|
|
assert.ok(!sequentializer.hasPendingSave(1));
|
|
assert.ok(sequentializer.pendingSave);
|
|
|
|
await timeout(2);
|
|
assert.ok(!sequentializer.hasPendingSave());
|
|
assert.ok(!sequentializer.hasPendingSave(2));
|
|
assert.ok(!sequentializer.pendingSave);
|
|
});
|
|
|
|
test('SaveSequentializer - pending and next (finishes instantly)', async function () {
|
|
const sequentializer = new SaveSequentializer();
|
|
|
|
let pendingDone = false;
|
|
sequentializer.setPending(1, timeout(1).then(() => { pendingDone = true; return; }));
|
|
|
|
// next finishes instantly
|
|
let nextDone = false;
|
|
const res = sequentializer.setNext(() => Promise.resolve(null).then(() => { nextDone = true; return; }));
|
|
|
|
await res;
|
|
assert.ok(pendingDone);
|
|
assert.ok(nextDone);
|
|
});
|
|
|
|
test('SaveSequentializer - pending and next (finishes after timeout)', async function () {
|
|
const sequentializer = new SaveSequentializer();
|
|
|
|
let pendingDone = false;
|
|
sequentializer.setPending(1, timeout(1).then(() => { pendingDone = true; return; }));
|
|
|
|
// next finishes after timeout
|
|
let nextDone = false;
|
|
const res = sequentializer.setNext(() => timeout(1).then(() => { nextDone = true; return; }));
|
|
|
|
await res;
|
|
assert.ok(pendingDone);
|
|
assert.ok(nextDone);
|
|
});
|
|
|
|
test('SaveSequentializer - pending and multiple next (last one wins)', async function () {
|
|
const sequentializer = new SaveSequentializer();
|
|
|
|
let pendingDone = false;
|
|
sequentializer.setPending(1, timeout(1).then(() => { pendingDone = true; return; }));
|
|
|
|
// next finishes after timeout
|
|
let firstDone = false;
|
|
let firstRes = sequentializer.setNext(() => timeout(2).then(() => { firstDone = true; return; }));
|
|
|
|
let secondDone = false;
|
|
let secondRes = sequentializer.setNext(() => timeout(3).then(() => { secondDone = true; return; }));
|
|
|
|
let thirdDone = false;
|
|
let thirdRes = sequentializer.setNext(() => timeout(4).then(() => { thirdDone = true; return; }));
|
|
|
|
await Promise.all([firstRes, secondRes, thirdRes]);
|
|
assert.ok(pendingDone);
|
|
assert.ok(!firstDone);
|
|
assert.ok(!secondDone);
|
|
assert.ok(thirdDone);
|
|
});
|
|
});
|