Merge pull request #57 from SSlinky/dev

Bug fixes and enhancements

Author: SSlinky

.github/workflows/node.js.yml

@@ -36,7 +36,7 @@ jobs:
         npm run antlr4ngPre
         npm run antlr4ngFmt
         mv ./server/src/antlr/out/server/src/antlr/* ./server/src/antlr/out
-    - run: npm run compile
+    - run: npm run build
     - run: xvfb-run -a npm test
       if: runner.os == 'Linux'
     - run: npm test

.vscode/launch.json

@@ -11,7 +11,6 @@
 				"--extensionDevelopmentPath=${workspaceRoot}",
 				"${workspaceFolder}/sample"
 			],
-			"outFiles": ["${workspaceRoot}/client/out/**/*.js"],
 			"preLaunchTask": {
 				"type": "npm",
 				"script": "compile"
@@ -23,7 +22,6 @@
 			"name": "Attach to Server",
 			"port": 6009,
 			"restart": true,
-			"outFiles": ["${workspaceRoot}/server/out/**/*.js"]
 		},
 		{
 			"name": "Language Server E2E Test",
@@ -32,10 +30,10 @@
 			"runtimeExecutable": "${execPath}",
 			"args": [
 				"--extensionDevelopmentPath=${workspaceRoot}",
-				"--extensionTestsPath=${workspaceRoot}/client/out/test/index",
-				"${workspaceRoot}/client/testFixture"
+				"--extensionTestsPath=${workspaceRoot}/dist/client/out/test/index",
+				"${workspaceRoot}/test/fixtures"
 			],
-			"outFiles": ["${workspaceRoot}/client/out/test/**/*.js"]
+			"outFiles": ["${workspaceRoot}/dist/client/out/test/**/*.js"]
 		},
 		{
 			"name": "Debug ANTLR4 grammar",

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);
 };

esbuild.js

@@ -3,6 +3,7 @@ const esbuild = require('esbuild');
 
 const production = process.argv.includes('--production');
 const watch = process.argv.includes('--watch');
+const test = process.argv.includes('--test');
 
 /**
  * @type {import('esbuild').Plugin}
@@ -77,11 +78,11 @@ async function buildTests() {
 }
 
 async function main() {
-  const buildTasks = [
-    buildClient(),
-    buildServer(),
-    buildTests()
-  ]
+  const buildTasks = test ? [] : [
+      buildClient(),
+      buildServer(),
+    ];
+  buildTasks.push(buildTests());
   const buildContexts = await Promise.all(buildTasks);
 
   if (watch) {

package-lock.json

@@ -6,7 +6,7 @@
 	"icon": "images/vba-lsp-icon.png",
 	"author": "SSlinky",
 	"license": "MIT",
-	"version": "1.5.6",
+	"version": "1.5.7",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/SSlinky/VBA-LanguageServer"
@@ -179,7 +179,8 @@
 	},
 	"scripts": {
 		"vscode:prepublish": "npm run package",
-		"compile": "npm run check-types && node esbuild.js",
+		"build": "npm run check-types && node esbuild.js",
+		"build-test": "node esbuild.js --test",
 		"check-types": "tsc --noEmit",
 		"watch": "npm-run-all -p watch:*",
 		"watch:esbuild": "node esbuild.js --watch",
@@ -188,7 +189,7 @@
 		"lint": "eslint ./client/src ./server/src --ext .ts,.tsx",
 		"postinstall": "cd client && npm install && cd ../server && npm install && cd ..",
 		"textMate": "npx js-yaml client/syntaxes/vba.tmLanguage.yaml > client/syntaxes/vba.tmLanguage.json && npm run tmSnapTest",
-		"antlr": "npm run antlr4ngPre && npm run antlr4ng && npm run antlr4ngFmt && npm run compile",
+		"antlr": "npm run antlr4ngPre && npm run antlr4ng && npm run antlr4ngFmt && npm run build",
 		"antlr4ng": "antlr4ng -Dlanguage=TypeScript -visitor -Xlog ./server/src/antlr/vba.g4 -o ./server/src/antlr/out/",
 		"antlr4ngPre": "antlr4ng -Dlanguage=TypeScript -visitor ./server/src/antlr/vbapre.g4 -o ./server/src/antlr/out/",
 		"antlr4ngFmt": "antlr4ng -Dlanguage=TypeScript -visitor ./server/src/antlr/vbafmt.g4 -o ./server/src/antlr/out/",
@@ -198,7 +199,7 @@
 		"tmUnitTest": "vscode-tmgrammar-test ./test/textmate/**/*.vba",
 		"tmSnapTest": "vscode-tmgrammar-snap ./test/textmate/snapshot/*.??s",
 		"tmSnapUpdate": "vscode-tmgrammar-snap --updateSnapshot ./test/textmate/snapshot/*.??s",
-		"vsctest": "vscode-test"
+		"vsctest": "npm run build-test && vscode-test"
 	},
 	"dependencies": {
 		"antlr4ng": "^3.0.16",

package.json

@@ -1,3 +1,3 @@
-$ENV:CODE_TESTS_PATH="$(Get-Location)\client\out\test"
-$ENV:CODE_TESTS_WORKSPACE="$(Get-Location)\client\testFixture"
-Invoke-Expression "node $(Get-Location)\client\out\test\runTest.js"
+$ENV:CODE_TESTS_PATH="$(Get-Location)\dist\client\out\test"
+$ENV:CODE_TESTS_WORKSPACE="$(Get-Location)\test\fixtures"
+Invoke-Expression "node $(Get-Location)\dist\client\out\test\runTest.js"