Smarter way of ensuring activation

Author: SSlinky

client/src/test/diagnostics.test.ts

@@ -5,7 +5,7 @@
 
 import * as vscode from 'vscode';
 import * as assert from 'assert';
-import { getDocUri, activate } from './helper';
+import { getDocUri, activate, runOnActivate } from './helper';
 import { toRange } from './util';
 
 suite('Should get diagnostics', () => {
@@ -147,8 +147,11 @@ suite('Should get diagnostics', () => {
 async function testDiagnostics(docUri: vscode.Uri, expectedDiagnostics: vscode.Diagnostic[]) {
 	await activate(docUri);
 
-	const actualDiagnostics = vscode.languages.getDiagnostics(docUri);
-
+	// Use this method first to ensure the extension is activated.
+	const actualDiagnostics = await runOnActivate(
+		() => vscode.languages.getDiagnostics(docUri),
+		(result) => result.length > 0
+	);
 	assert.equal(actualDiagnostics.length, expectedDiagnostics.length, "Count");
 
 	expectedDiagnostics.forEach((expectedDiagnostic, i) => {

client/src/test/foldingRanges.test.ts

@@ -1,6 +1,6 @@
 import * as vscode from 'vscode';
 import * as assert from 'assert';
-import { getDocUri, activate } from './helper';
+import { getDocUri, activate, runOnActivate } from './helper';
 
 suite('Should get folding ranges', () => {
 	test('formatting.class.template', async () => {
@@ -24,10 +24,16 @@ suite('Should get folding ranges', () => {
 
 async function testFoldingRanges(docUri: vscode.Uri, expectedFoldingRanges: vscode.FoldingRange[]) {
 	await activate(docUri);
-	const actualFoldingRanges = await vscode.commands.executeCommand<vscode.FoldingRange[]>(
+	const action = () => vscode.commands.executeCommand<vscode.FoldingRange[]>(
 		'vscode.executeFoldingRangeProvider',
 		docUri
 	)
+	
+	// Use this method first to ensure the extension is activated.
+	const actualFoldingRanges = await runOnActivate(
+		action,
+		(result) => Array.isArray(result) && result.length > 0
+	);
 
 	assert.equal(actualFoldingRanges.length ?? 0, expectedFoldingRanges.length, "Count");
 

client/src/test/formatting.test.ts

@@ -1,6 +1,6 @@
 import * as vscode from 'vscode';
 import * as assert from 'assert';
-import { getDocUri, activate } from './helper';
+import { getDocUri, activate, runOnActivate } from './helper';
 import { toRange } from './util';
 
 suite('Should get text edits', () => {
@@ -42,11 +42,18 @@ suite('Should get text edits', () => {
 
 async function testTextEdits(docUri: vscode.Uri, expectedTextEdits: vscode.TextEdit[]) {
 	await activate(docUri);
-	const actualEdits = await vscode.commands.executeCommand<vscode.TextEdit[]>(
+	await vscode.window.showTextDocument(docUri);
+	const action = () => vscode.commands.executeCommand<vscode.TextEdit[]>(
 		'vscode.executeFormatDocumentProvider',
 		docUri,
 		{ tabSize: 4, insertSpaces: true }
-	)
+	);
+
+	// Use this method first to ensure the extension is activated.
+	const actualEdits = await runOnActivate(
+		action,
+		(result) => Array.isArray(result) && result.length > 0
+	);
 
 	assert.equal(actualEdits.length ?? 0, expectedTextEdits.length, "Count");
 

client/src/test/helper.ts

@@ -10,6 +10,7 @@ export let doc: vscode.TextDocument;
 export let editor: vscode.TextEditor;
 export let documentEol: string;
 export let platformEol: string;
+const TIMEOUTMS = 5000;
 
 /**
  * Activates the vscode.lsp-sample extension
@@ -21,16 +22,31 @@ export async function activate(docUri: vscode.Uri) {
 	try {
 		doc = await vscode.workspace.openTextDocument(docUri);
 		editor = await vscode.window.showTextDocument(doc);
-		await sleep(500); // Wait for server activation
 	} catch (e) {
 		console.error(e);
 	}
 }
 
+export function getTimeout() {
+	return Date.now() + TIMEOUTMS;
+}
+
 async function sleep(ms: number) {
 	return new Promise(resolve => setTimeout(resolve, ms));
 }
 
+export async function runOnActivate<T>(action: () => T|Thenable<T>, test: (result: T) => boolean): Promise<T> {
+	const timeout = getTimeout();
+	while (Date.now() < timeout) {
+		const result = await action(); 
+		if (test(result)) {
+			return result;
+		}
+		await sleep(100);
+	}
+	throw new Error(`Timed out after ${TIMEOUTMS}`);
+}
+
 export const getDocPath = (p: string) => {
 	return path.resolve(__dirname, '../../../../test/fixtures', p);
 };