Function forceDocumentCloseEvents

src/test/helpers.ts:498–525

(fileUri?: vs.Uri)

}

export async function forceDocumentCloseEvents(fileUri?: vs.Uri) {
	// To ensure that onDidCloseTextDocument fires for it, we need to fill
	// VS Code's text model buffer with dummy files. This is a horrible hack, but
	// otherwise, we'd have to wait 3 mins for the event to fire (which isn't practical)
	// or have tests behave differently (for example even if we mock the close/open,
	// we'd still see onDidChangeTextDocument events that might interfere with things
	// like the position trackers).
	const openedDummyUris: vs.Uri[] = [];
	const MAX_DUMMY_FILES = 65; // In testing, it seems to require around 58 files to trigger the cleanup. Round up a little to give some margin.
	for (let i = 0; i < MAX_DUMMY_FILES; i++) {
		// If we had a file uri, we only care about that one and can stop creating dummies when we see it's gone.
		if (fileUri && !vs.workspace.textDocuments.find((d) => d.uri.toString() === fileUri.toString())) {
			// File is already gone so we don't need to open any more dummies.
			break;
		}

		// Otherwise, open a dummy.
		// Unfortunately we have to also open the editor here, because otherwise
		// tabgroups will not contain it (at least not immediately), despite the editor
		// becoming visible. However this shouldn't interfere with anything because it's
		// a non-Dart file that we don't do anything with.
		const dummyUri = vs.Uri.parse(`untitled:dummy-${i}`);
		await vs.window.showTextDocument(dummyUri);
		openedDummyUris.push(dummyUri);
	}

	closeTabs(openedDummyUris);
}

/**
 * Closes a file, and ensures VS Code's onDidCloseTextDocument event fires.