feat(compas-convert): get tests running, fix some issues while running the tests

packages/compas-convert/README.md

@@ -49,14 +49,28 @@ rm -rf ../compas-convert-test && npx compas-convert ../some-local-test-project .
 - [x] Pass: @compas/test to Vitest
 - [x] Pass: inline JSDoc blocks to inline types
 - Pass: Run TypeScript, ESLint and tests to find common errors
-  - [ ] Type of `AppErrror` in Compas should accept anything for 'cause' and 'info'.
+  - [x] Type of `AppErrror` in Compas should accept anything for 'cause' and 'info'.
     - `TS2345: Argument of type 'unknown' is not assignable to parameter of type 'Error | undefined'`
     - Used in all variants of `AppError` construction
   - [ ] Insert `assertIsAppError` in test files
     - On `TS18046: 'e' is of type 'unknown'`
     - AND `.key` or `.info` is accessed
     - Implement like `not-nil-checks-in-test-flows`
-  - [ ] Convert JSDOC `function(number, string): string` to `(number, string) => string`
+  - [x] ~Convert JSDOC `function(number, string): string` to `(number, string) => string`~
 - [x] Pass: query-builder types
   - Improve query-builder types by inferring the types based on the passed in builder.
-- [ ] Pass: build step. Fixup CI, Dockerfile, docs, etc
+
+Checklist:
+
+- [ ] Any TS errors we need to fix still?
+  - Start documenting common errors and their fixes below
+- [ ] Any ESLint rules we can fix?
+  - Start documenting common errors and their fixes below
+- [ ] Can we run the API, Queue, etc?
+- [ ] Does the docker build work?
+- [ ] Collect common knowledge:
+  - New QueryBuilder types
+  - TSX usage
+  - Vitest usage
+
+## Migration docs

packages/compas-convert/src/index.ts

@@ -6,6 +6,7 @@ import consola from "consola";
 import { createEmptyContext } from "./context.js";
 import type { GlobalPass, Pass } from "./pass.js";
 import { addCommonImports } from "./passes/add-common-imports.js";
+import { convertTestConfig } from "./passes/convert-test-config.js";
 import { convertTestFiles } from "./passes/convert-test-files.js";
 import { copyRename } from "./passes/copy-rename.js";
 import { finalizePendingImports } from "./passes/finalize-pending-imports.js";
@@ -56,6 +57,7 @@ const passes: Array<Pass> = [
 	fixTypesOfAllFunctions,
 	updateGenerateOptions,
 	convertTestFiles,
+	convertTestConfig,
 
 	transformModuleJsDoc,
 	transformExpressionJsDoc,

packages/compas-convert/src/passes/add-common-imports.ts

@@ -1,5 +1,5 @@
 import type { SourceFile } from "ts-morph";
-import { addNamedImportIfNotExists, resolveRelativeImport } from "../shared/import.js";
+import { addPendingImport, resolveRelativeImport } from "../shared/imports.js";
 import type { Context } from "./../context.js";
 import { CONVERT_UTIL, CONVERT_UTIL_PATH } from "./init-ts-morph.js";
 
@@ -15,49 +15,52 @@ export function addCommonImports(context: Context, sourceFile: SourceFile) {
 		return;
 	}
 
-	addNamedImportIfNotExists(
+	addPendingImport(
+		context,
 		sourceFile,
 		resolveRelativeImport(context, sourceFile, CONVERT_UTIL_PATH),
 		CONVERT_UTIL.any,
 		true,
 	);
-	addNamedImportIfNotExists(
+	addPendingImport(
+		context,
 		sourceFile,
 		resolveRelativeImport(context, sourceFile, CONVERT_UTIL_PATH),
 		CONVERT_UTIL.assertNotNil,
 		false,
 	);
 
-	addNamedImportIfNotExists(sourceFile, "@compas/stdlib", "InsightEvent", true);
-	addNamedImportIfNotExists(sourceFile, "@compas/stdlib", "Logger", true);
-	addNamedImportIfNotExists(sourceFile, "@compas/stdlib", "AppError", false);
-	addNamedImportIfNotExists(sourceFile, "@compas/stdlib", "Either", true);
-	addNamedImportIfNotExists(sourceFile, "@compas/stdlib", "EitherN", true);
+	addPendingImport(context, sourceFile, "@compas/stdlib", "InsightEvent", true);
+	addPendingImport(context, sourceFile, "@compas/stdlib", "Logger", true);
+	addPendingImport(context, sourceFile, "@compas/stdlib", "AppError", false);
+	addPendingImport(context, sourceFile, "@compas/stdlib", "Either", true);
+	addPendingImport(context, sourceFile, "@compas/stdlib", "EitherN", true);
 
-	addNamedImportIfNotExists(sourceFile, "@compas/code-gen", "Generator", false);
-	addNamedImportIfNotExists(sourceFile, "@compas/code-gen", "TypeCreator", false);
-	addNamedImportIfNotExists(sourceFile, "@compas/code-gen", "RouteCreator", true);
-	addNamedImportIfNotExists(sourceFile, "@compas/code-gen", "TypeBuilder", true);
-	addNamedImportIfNotExists(sourceFile, "@compas/code-gen", "TypeBuilderLike", true);
+	addPendingImport(context, sourceFile, "@compas/code-gen", "Generator", false);
+	addPendingImport(context, sourceFile, "@compas/code-gen", "TypeCreator", false);
+	addPendingImport(context, sourceFile, "@compas/code-gen", "RouteCreator", true);
+	addPendingImport(context, sourceFile, "@compas/code-gen", "TypeBuilder", true);
+	addPendingImport(context, sourceFile, "@compas/code-gen", "TypeBuilderLike", true);
 
-	addNamedImportIfNotExists(sourceFile, "@compas/server", "Application", true);
-	addNamedImportIfNotExists(sourceFile, "@compas/server", "Next", true);
-	addNamedImportIfNotExists(sourceFile, "@compas/server", "Middleware", true);
-	addNamedImportIfNotExists(sourceFile, "@compas/server", "Context", true);
-	addNamedImportIfNotExists(sourceFile, "@compas/server", "Context", true);
+	addPendingImport(context, sourceFile, "@compas/server", "Application", true);
+	addPendingImport(context, sourceFile, "@compas/server", "Next", true);
+	addPendingImport(context, sourceFile, "@compas/server", "Middleware", true);
+	addPendingImport(context, sourceFile, "@compas/server", "Context", true);
+	addPendingImport(context, sourceFile, "@compas/server", "Context", true);
 
-	addNamedImportIfNotExists(sourceFile, "@compas/store", "Postgres", true);
-	addNamedImportIfNotExists(sourceFile, "@compas/store", "S3Client", true);
-	addNamedImportIfNotExists(sourceFile, "@compas/store", "QueryPart", true);
-	addNamedImportIfNotExists(sourceFile, "@compas/store", "SessionStoreSettings", true);
-	addNamedImportIfNotExists(
+	addPendingImport(context, sourceFile, "@compas/store", "Postgres", true);
+	addPendingImport(context, sourceFile, "@compas/store", "S3Client", true);
+	addPendingImport(context, sourceFile, "@compas/store", "QueryPart", true);
+	addPendingImport(context, sourceFile, "@compas/store", "SessionStoreSettings", true);
+	addPendingImport(
+		context,
 		sourceFile,
 		"@compas/store",
 		"SessionTransportSettings",
 		true,
 	);
 
-	addNamedImportIfNotExists(sourceFile, "axios", "AxiosInstance", true);
-	addNamedImportIfNotExists(sourceFile, "axios", "AxiosRequestConfig", true);
-	addNamedImportIfNotExists(sourceFile, "axios", "AxiosError", true);
+	addPendingImport(context, sourceFile, "axios", "AxiosInstance", true);
+	addPendingImport(context, sourceFile, "axios", "AxiosRequestConfig", true);
+	addPendingImport(context, sourceFile, "axios", "AxiosError", true);
 }

packages/compas-convert/src/passes/convert-test-config.ts

@@ -0,0 +1,49 @@
+import path from "node:path";
+import type { Context } from "../context.js";
+import { getTypescriptProgram } from "./init-ts-morph.js";
+
+/**
+ * Apply .env loading in the test setup + rename methods
+ */
+export async function convertTestConfig(context: Context) {
+	const configFilePath = path.join(context.outputDirectory, "test/config.ts");
+
+	const program = getTypescriptProgram(context);
+	const configFile = program.getSourceFile(configFilePath);
+
+	if (configFile) {
+		configFile.replaceWithText(`
+import { readFileSync } from "node:fs";
+import { parseEnv } from "node:util";
+import { refreshEnvironmentCache, loggerSetGlobalDestination } from "@compas/stdlib";
+
+await setupTestEnvironment();
+
+${configFile
+	.getFullText()
+	.replace(
+		"export async function setup(): Promise<void> {",
+		`
+async function setupTestEnvironment(): Promise<void> {
+  // Compas-compat: Load default .env values.
+  Object.assign(process.env, parseEnv(readFileSync(".env", "utf-8")));
+  refreshEnvironmentCache();
+
+  // Compas-compat: use console.dir to only print error logs
+	loggerSetGlobalDestination({
+		write(msg) {
+			if (msg.includes(\`"level":"error"\`)) {
+				console.dir(msg, { colors: true, depth: null });
+			}
+		},
+	});
+`,
+	)
+	.replace(
+		`export async function teardown()`,
+		`async function teardownTestEnvironment()`,
+	)}
+  `);
+		await configFile.save();
+	}
+}

packages/compas-convert/src/passes/convert-test-files.ts

@@ -1,15 +1,14 @@
 import type { CallExpression, SourceFile } from "ts-morph";
 import { ts } from "ts-morph";
 import type { Context } from "../context.js";
-import { addNamedImportIfNotExists } from "../shared/import.js";
+import { addPendingImport } from "../shared/imports.js";
 import SyntaxKind = ts.SyntaxKind;
 
 /**
  * TODO:
  *  - Handle other usages of "t" like seedTestValuator  (not now)
  *  - Do something with: test("teardown", ...  (not now)
- *  - Handle newTestEvent(t) (not now)
- *
+ *  - Handle `seedXyz(t, ...args)`
  */
 
 enum TestCommand {
@@ -35,7 +34,11 @@ export function convertTestFiles(context: Context, sourceFile: SourceFile) {
 		return;
 	}
 
-	if (!filePath.includes("/src/") && !filePath.includes("/plugins/")) {
+	if (
+		!filePath.includes("/src/") &&
+		!filePath.includes("/plugins/") &&
+		!filePath.includes("/test/")
+	) {
 		return;
 	}
 
@@ -47,7 +50,11 @@ export function convertTestFiles(context: Context, sourceFile: SourceFile) {
 		?.remove();
 
 	// re-add import for newTestEvent
-	addNamedImportIfNotExists(sourceFile, "@compas/cli", "newTestEvent", false);
+	addPendingImport(context, sourceFile, "@compas/cli", "newTestEvent", false);
+	addPendingImport(context, sourceFile, "vitest", "expect", false);
+	addPendingImport(context, sourceFile, "vitest", "beforeAll", false);
+	addPendingImport(context, sourceFile, "vitest", "describe", false);
+	addPendingImport(context, sourceFile, "vitest", "test", false);
 
 	// go over each expression statement in file
 	for (const statement of sourceFile.getStatements()) {
@@ -91,9 +98,6 @@ function handleNestedTest(expression: CallExpression) {
 	if (testIsParent(expression)) {
 		// the test functions as grouping, so instead we use describe to define a separate suite
 		expression.getFirstChild()?.replaceWithText("describe");
-		addNamedImportIfNotExists(expression.getSourceFile(), "vitest", "describe", false);
-	} else {
-		addNamedImportIfNotExists(expression.getSourceFile(), "vitest", "test", false);
 	}
 
 	removeTestHandlerParameter(expression);
@@ -128,7 +132,7 @@ function handleNestedTest(expression: CallExpression) {
 				const expected = args[1]?.getText() ?? "true";
 				const message = args[2]?.getText() ?? "";
 				it.expression = it.expression.replaceWithText(
-					`expect(${actual}${message ? `, ${message}` : ""}).toStrictEqual(${expected})`,
+					`expect(${actual}${message ? `, ${message}` : ""}).toEqual(${expected})`,
 				) as CallExpression;
 				break;
 			}
@@ -167,15 +171,8 @@ function handleNestedTest(expression: CallExpression) {
 				if (testIsParent(it.expression)) {
 					// the test functions as grouping, so instead we use describe to define a separate suite
 					it.expression.getFirstChild()?.replaceWithText("describe");
-					addNamedImportIfNotExists(
-						expression.getSourceFile(),
-						"vitest",
-						"describe",
-						false,
-					);
 				} else {
 					it.expression.getFirstChild()?.replaceWithText("test");
-					addNamedImportIfNotExists(expression.getSourceFile(), "vitest", "test", false);
 				}
 
 				if (!testUsesContext(it)) {
@@ -187,29 +184,13 @@ function handleNestedTest(expression: CallExpression) {
 			}
 		}
 	}
-
-	if (
-		usage.find((it) =>
-			[
-				TestCommand.equal,
-				TestCommand.deepEqual,
-				TestCommand.notEqual,
-				TestCommand.ok,
-				TestCommand.notOk,
-				TestCommand.pass,
-				TestCommand.fail,
-			].includes(it.command),
-		)
-	) {
-		addNamedImportIfNotExists(expression.getSourceFile(), "vitest", "expect", false);
-	}
 }
 
 /**
  * Check if the expression only contains other tests
  */
 function testIsParent(expression: CallExpression): boolean {
-	return getDirectDescendants(expression).every((child) =>
+	return getDirectDescendants(expression).some((child) =>
 		child
 			?.getExpression()
 			.asKind(SyntaxKind.CallExpression)

packages/compas-convert/src/passes/generate-options.ts

@@ -107,9 +107,11 @@ export async function updateGenerateOptions(context: Context) {
 	// 5. Add a new command parser
 	generateCommandFile.addStatements(`
 import { newLogger, environment } from "@compas/stdlib";
+import { register } from "tsx/esm/api";
 
 // TODO(compas-convert): cleanup this;
 environment.NODE_ENV = "development";
+register();
 const opts = {
   logger: newLogger(),
   skipLint: true,

packages/compas-convert/src/passes/init-typescript-in-project.ts

@@ -15,13 +15,13 @@ export async function initTypescriptInProject(context: Context) {
 	packageJson.devDependencies["vitest"] = "2.0.5";
 	packageJson.devDependencies["@total-typescript/tsconfig"] = "1.0.4";
 	packageJson.devDependencies["@types/node"] = "latest";
-	packageJson.devDependencies["@compas/code-gen"] = "0.15.5";
+	packageJson.devDependencies["@compas/code-gen"] = "0.15.6";
 
 	packageJson.dependencies ??= {};
-	packageJson.dependencies["@compas/cli"] = "0.15.5";
-	packageJson.dependencies["@compas/server"] = "0.15.5";
-	packageJson.dependencies["@compas/stdlib"] = "0.15.5";
-	packageJson.dependencies["@compas/store"] = "0.15.5";
+	packageJson.dependencies["@compas/cli"] = "0.15.6";
+	packageJson.dependencies["@compas/server"] = "0.15.6";
+	packageJson.dependencies["@compas/stdlib"] = "0.15.6";
+	packageJson.dependencies["@compas/store"] = "0.15.6";
 
 	packageJson.scripts ??= {};
 	packageJson.scripts["build"] = `tsc -p ./tsconfig.json`;
@@ -49,10 +49,10 @@ export async function initTypescriptInProject(context: Context) {
 
 export default defineConfig({
   test: {
-  	globalSetup: "src/test/config.ts",
+    setupFiles: "./test/config.ts",
     expect: {
     	requireAssertions: true,
-    }
+    },
   },
 })`,
 	);