Tests: run against compiled source rather than transpiling on the fly

package.json

@@ -19,10 +19,9 @@
     "webpack-server": "grunt server",
     "webpack-build": "npm run webpack-browser && npm run webpack-module && npm run webpack-server",
     "lint": "balena-lint -t tsconfig.dev.json -e js -e ts src build typings Gruntfile.ts && npx tsc --project tsconfig.dev.json --noEmit",
-    "test": "npm run lint && npm run build && npm run webpack-build && npm run test:compose && npm run test:generated-types",
-    "test:compose": "trap 'docker compose -f docker-compose.npm-test.yml down ; echo Stopped ; exit 0' INT; docker compose -f docker-compose.npm-test.yml up -d && sleep 2 && DATABASE_URL=postgres://docker:docker@localhost:5431/postgres PINEJS_WEBRESOURCE_MAXFILESIZE=1000000000 S3_ENDPOINT=http://localhost:43680 S3_ACCESS_KEY=USERNAME S3_SECRET_KEY=PASSWORD S3_STORAGE_ADAPTER_BUCKET=balena-pine-web-resources S3_REGION=us-east-1 PINEJS_QUEUE_CONCURRENCY=1 TZ=UTC npm run mocha",
+    "test": "npm run build && npm run lint && npm run webpack-build && npm run test:compose && npm run test:generated-types",
+    "test:compose": "trap 'docker compose -f docker-compose.npm-test.yml down ; echo Stopped ; exit 0' INT; docker compose -f docker-compose.npm-test.yml up -d && sleep 2 && DATABASE_URL=postgres://docker:docker@localhost:5431/postgres PINEJS_WEBRESOURCE_MAXFILESIZE=1000000000 S3_ENDPOINT=http://localhost:43680 S3_ACCESS_KEY=USERNAME S3_SECRET_KEY=PASSWORD S3_STORAGE_ADAPTER_BUCKET=balena-pine-web-resources S3_REGION=us-east-1 PINEJS_QUEUE_CONCURRENCY=1 TZ=UTC npx mocha",
     "test:generated-types": "npm run generate-types && git diff --exit-code ./src/sbvr-api/user.ts ./src/migrator/migrations.ts ./src/sbvr-api/dev.ts",
-    "mocha": "TS_NODE_FILES=true mocha",
     "lint-fix": "balena-lint -t tsconfig.dev.json -e js -e ts --fix src test build typings Gruntfile.ts",
     "generate-types": "node ./bin/sbvr-compiler.js generate-types ./src/sbvr-api/user.sbvr ./src/sbvr-api/user.ts && node ./bin/sbvr-compiler.js generate-types ./src/migrator/migrations.sbvr ./src/migrator/migrations.ts && node ./bin/sbvr-compiler.js generate-types ./src/sbvr-api/dev.sbvr ./src/sbvr-api/dev.ts && node ./bin/sbvr-compiler.js generate-types ./src/tasks/tasks.sbvr ./src/tasks/tasks.ts && balena-lint -t tsconfig.dev.json --fix ./src/sbvr-api/user.ts ./src/migrator/migrations.ts ./src/sbvr-api/dev.ts"
   },
@@ -69,6 +68,7 @@
   },
   "devDependencies": {
     "@balena/lint": "^8.2.8",
+    "@balena/pinejs": "file:./",
     "@faker-js/faker": "^9.3.0",
     "@types/busboy": "^1.5.4",
     "@types/chai": "^4.3.20",

src/sbvr-api/express-extension.ts

@@ -1,10 +1,9 @@
 // Augment express.js with pinejs-specific attributes via declaration merging.
+import type { User as PineUser } from './sbvr-utils';
 
 declare global {
 	// eslint-disable-next-line @typescript-eslint/no-namespace
 	namespace Express {
-		type PineUser = import('./sbvr-utils').User;
-
 		// Augment Express.User to include the props of our PineUser.
 		// eslint-disable-next-line @typescript-eslint/no-empty-interface
 		interface User extends PineUser {}

test/03-async-migrator.test.ts

@@ -2,9 +2,9 @@ import supertest from 'supertest';
 import type { ChildProcess } from 'child_process';
 import { assert, expect } from 'chai';
 import { setTimeout } from 'timers';
-import { dbModule } from '../src/server-glue/module';
+import type { Migrator } from '@balena/pinejs';
+import { dbModule } from '@balena/pinejs';
 import { testInit, testDeInit, testLocalServer } from './lib/test-init';
-import type { MigrationStatus } from '../src/migrator/utils';
 
 const fixturesBasePath = __dirname + '/fixtures/03-async-migrator/';
 
@@ -88,7 +88,9 @@ const waitForAllDataMigrated = async function (
 	return [result, allResults];
 };
 
-const getMigrationStatus = async function (): Promise<MigrationStatus[]> {
+const getMigrationStatus = async function (): Promise<
+	Migrator.MigrationStatus[]
+> {
 	const res = await supertest(testLocalServer).get(
 		'/migrations/migration_status',
 	);
@@ -142,7 +144,7 @@ describe('03 Async Migrations', function () {
 				.that.has.ownProperty('d')
 				.to.be.an('array');
 
-			res.body.d.map(async (migration: MigrationStatus) => {
+			res.body.d.map(async (migration: Migrator.MigrationStatus) => {
 				await supertest(testLocalServer)
 					.patch(`/migrations/migration_status('${migration.migration_key}')`)
 					.send({
@@ -153,7 +155,7 @@ describe('03 Async Migrations', function () {
 		});
 
 		it('should run one async migrator', async function () {
-			let result: MigrationStatus[] = [];
+			let result: Migrator.MigrationStatus[] = [];
 			// active wait until 1 row has been migrated
 			while (result.length === 0 || result[0]?.migrated_row_count < 1) {
 				result = await getMigrationStatus();
@@ -165,7 +167,7 @@ describe('03 Async Migrations', function () {
 
 		it('should complete / catch up data in one async migrator', async function () {
 			// active wait to check if migrations have catched up
-			let result: MigrationStatus[] = [];
+			let result: Migrator.MigrationStatus[] = [];
 			await waitForAllDataMigrated('device');
 			// active wait as updating migration status after migrations have done takes some time.
 			// dont want to wait for an artificial magic time delay.
@@ -177,7 +179,7 @@ describe('03 Async Migrations', function () {
 		});
 
 		it('should migrate future data change after first catch up', async function () {
-			let result: MigrationStatus[] = [];
+			let result: Migrator.MigrationStatus[] = [];
 
 			const startTime = Date.now().valueOf();
 			// first catch up is precondition from above test case.
@@ -218,7 +220,7 @@ describe('03 Async Migrations', function () {
 			pineFirstInstace = await testInit({ configPath, deleteDb: false });
 
 			await delay(200); // wait for one to have happened
-			let result: MigrationStatus[] = await getMigrationStatus();
+			let result: Migrator.MigrationStatus[] = await getMigrationStatus();
 			for (const row of result) {
 				expect(row.run_count).to.be.equal(0);
 			}
@@ -239,7 +241,7 @@ describe('03 Async Migrations', function () {
 			pineFirstInstace = await testInit({ configPath, deleteDb: false });
 
 			await delay(200); // wait for one to have happened
-			const result: MigrationStatus[] = await getMigrationStatus();
+			const result: Migrator.MigrationStatus[] = await getMigrationStatus();
 			for (const row of result) {
 				expect(row.run_count).to.be.greaterThan(0);
 			}
@@ -307,7 +309,7 @@ describe('03 Async Migrations', function () {
 		});
 
 		it('should start 2 migrations competitive', async function () {
-			let result: MigrationStatus[] = [];
+			let result: Migrator.MigrationStatus[] = [];
 			// active wait until 1 row has been migrated
 			while (
 				result.length < 2 ||
@@ -325,7 +327,7 @@ describe('03 Async Migrations', function () {
 		});
 
 		it('should complete / catch up all data in 2 migrations competitive', async function () {
-			let result: MigrationStatus[] = [];
+			let result: Migrator.MigrationStatus[] = [];
 			// active wait to check if migrations have catched up
 			await waitForAllDataMigrated('device');
 			await waitForAllDataMigrated('deviceb');
@@ -347,7 +349,7 @@ describe('03 Async Migrations', function () {
 		});
 
 		it('should migrate future data change after first catch up in 2 migrators', async function () {
-			let result: MigrationStatus[] = [];
+			let result: Migrator.MigrationStatus[] = [];
 			while (
 				result.length < 2 ||
 				result[0]?.is_backing_off === false ||
@@ -401,7 +403,7 @@ describe('03 Async Migrations', function () {
 			// It's meant to be a wait until we can 'surely' assume that the async migrations
 			// would have run at least one iteration. Still a magic number is undesired as it's error prone
 			await delay(2000); // wait for some migrations to have happened
-			let result: MigrationStatus[] = [];
+			let result: Migrator.MigrationStatus[] = [];
 
 			result = await getMigrationStatus();
 			expect(result).to.be.empty;
@@ -436,7 +438,7 @@ describe('03 Async Migrations', function () {
 		});
 
 		it('should report error in error count', async function () {
-			let rows: MigrationStatus[] = [];
+			let rows: Migrator.MigrationStatus[] = [];
 			// active wait until 1 row has been migrated
 			const errorMigrationKeys = ['0002', '0003'];
 			while (rows.length < 2 || !rows[0]?.error_count || !rows[1]?.run_count) {
@@ -455,7 +457,7 @@ describe('03 Async Migrations', function () {
 		});
 
 		it('should switch to backoff when exceeding error threshold and give error message', async function () {
-			let rows: MigrationStatus[] = [];
+			let rows: Migrator.MigrationStatus[] = [];
 			// active wait until 1 row has been migrated
 			const errorMigrationKeys = ['0002', '0003'];
 			while (
@@ -479,7 +481,7 @@ describe('03 Async Migrations', function () {
 		});
 
 		it('should remain in backoff when exceeding error threshold and give error message', async function () {
-			let rows: MigrationStatus[] = [];
+			let rows: Migrator.MigrationStatus[] = [];
 			// active wait until 1 row has been migrated
 			const errorMigrationKeys = ['0002', '0003'];
 			while (
@@ -504,7 +506,7 @@ describe('03 Async Migrations', function () {
 		});
 
 		it('should recover from error backoff when no migration error occurs and rows get migrated', async function () {
-			let rows: MigrationStatus[] = [];
+			let rows: Migrator.MigrationStatus[] = [];
 			// active wait until 1 row has been migrated
 			const errorMigrationKeys = ['0002'];
 			while (rows.length === 0 || rows[0]?.error_count <= 5) {
@@ -580,7 +582,7 @@ describe('03 Async Migrations', function () {
 		});
 
 		it('should complete / catch up massive data in one async migrator', async function () {
-			let rows: MigrationStatus[] = [];
+			let rows: Migrator.MigrationStatus[] = [];
 
 			const res = await supertest(testLocalServer)
 				.get('/example/device/$count')

test/07-permissions.test.ts

@@ -2,8 +2,8 @@ import supertest from 'supertest';
 import { expect } from 'chai';
 const configPath = __dirname + '/fixtures/07-permissions/config.js';
 import { testInit, testDeInit, testLocalServer } from './lib/test-init';
-import { sbvrUtils, permissions } from '../src/server-glue/module';
-import type UserModel from '../src/sbvr-api/user';
+import { sbvrUtils, permissions } from '@balena/pinejs';
+import type UserModel from '@balena/pinejs/out/sbvr-api/user';
 
 describe('07 permissions tests', function () {
 	let pineServer: Awaited<ReturnType<typeof testInit>>;

test/08-tasks.test.ts

@@ -4,8 +4,8 @@ import { randomUUID } from 'node:crypto';
 import { setTimeout } from 'node:timers/promises';
 import { PineTest } from 'pinejs-client-supertest';
 import { testInit, testDeInit, testLocalServer } from './lib/test-init';
-import { tasks as tasksEnv } from '../src/config-loader/env';
-import type Model from '../src/tasks/tasks';
+import { env } from '@balena/pinejs';
+import type Model from '@balena/pinejs/out/tasks/tasks';
 import * as cronParser from 'cron-parser';
 import { PINE_TEST_SIGNALS } from './lib/common';
 
@@ -17,7 +17,7 @@ export async function waitFor(checkFn: () => Promise<boolean>): Promise<void> {
 	const maxCount = 10;
 	for (let i = 1; i <= maxCount; i++) {
 		console.log(`Waiting (${i}/${maxCount})...`);
-		await setTimeout(tasksEnv.queueIntervalMS);
+		await setTimeout(env.tasks.queueIntervalMS);
 		if (await checkFn()) {
 			return;
 		}
@@ -229,8 +229,8 @@ describe('08 task tests', function () {
 			expect(created).to.be.lessThan(started);
 
 			// Calculate the earliest and latest start times based on queue interval
-			const earliest = scheduled - tasksEnv.queueIntervalMS;
-			const latest = scheduled + tasksEnv.queueIntervalMS;
+			const earliest = scheduled - env.tasks.queueIntervalMS;
+			const latest = scheduled + env.tasks.queueIntervalMS;
 
 			// Check if the start time was within the expected range
 			expect(started)
@@ -423,7 +423,7 @@ describe('08 task tests', function () {
 			});
 
 			// Await more than the queue interval to ensure the task is not picked up
-			await setTimeout(2 * tasksEnv.queueIntervalMS);
+			await setTimeout(2 * env.tasks.queueIntervalMS);
 
 			await expectTask(pineTest, task.id, {
 				status: 'queued',

test/fixtures/00-basic/config.ts

@@ -1,4 +1,4 @@
-import type { ConfigLoader } from '../../../src/server-glue/module';
+import type { ConfigLoader } from '@balena/pinejs';
 
 const apiRoot = 'example';
 const modelName = 'example';

test/fixtures/01-constrain/config.ts

@@ -1,4 +1,4 @@
-import type { ConfigLoader } from '../../../src/server-glue/module';
+import type { ConfigLoader } from '@balena/pinejs';
 
 const apiRoot = 'university';
 const modelName = 'university';

test/fixtures/02-sync-migrator/00-execute-model.ts

@@ -1,4 +1,4 @@
-import type { ConfigLoader } from '../../../src/server-glue/module';
+import type { ConfigLoader } from '@balena/pinejs';
 
 const apiRoot = 'example';
 const modelName = 'example';

test/fixtures/02-sync-migrator/01-migrations.ts

@@ -1,4 +1,4 @@
-import type { ConfigLoader } from '../../../src/server-glue/module';
+import type { ConfigLoader } from '@balena/pinejs';
 
 const apiRoot = 'example';
 const modelName = 'example';

test/fixtures/02-sync-migrator/01-migrations/0002-test-migrations.sync.ts

@@ -1,4 +1,4 @@
-import type { Migrator } from '../../../../src/server-glue/module';
+import type { Migrator } from '@balena/pinejs';
 
 const migration: Migrator.MigrationFn = async (tx) => {
 	const staticSql = `\

test/fixtures/02-sync-migrator/02-migrations-error.ts

@@ -1,4 +1,4 @@
-import type { ConfigLoader } from '../../../src/server-glue/module';
+import type { ConfigLoader } from '@balena/pinejs';
 
 const apiRoot = 'example';
 const modelName = 'example';

test/fixtures/02-sync-migrator/02-migrations-error/0002-test-migrations.sync.ts

@@ -1,4 +1,4 @@
-import type { Migrator } from '../../../../src/server-glue/module';
+import type { Migrator } from '@balena/pinejs';
 
 const migration: Migrator.MigrationFn = async (tx) => {
 	const staticSql = `\

test/fixtures/02-sync-migrator/03-exclusive-category.ts

@@ -1,4 +1,4 @@
-import type { ConfigLoader } from '../../../src/server-glue/module';
+import type { ConfigLoader } from '@balena/pinejs';
 
 const apiRoot = 'example';
 const modelName = 'example';

test/fixtures/02-sync-migrator/04-new-model-with-init.ts

@@ -1,4 +1,4 @@
-import type { ConfigLoader } from '../../../src/server-glue/module';
+import type { ConfigLoader } from '@balena/pinejs';
 
 const apiRoot = 'example';
 const modelName = 'example';
@@ -13,12 +13,12 @@ export default {
 			migrations: {
 				'0001': `
 					INSERT INTO "device" ("id", "name", "note", "type")
-					VALUES (2, 'no run', 'shouldNotRun', 'empty')			
+					VALUES (2, 'no run', 'shouldNotRun', 'empty')
 				`,
 			},
 			initSql: `
 				INSERT INTO "device" ("id", "name", "note", "type")
-				VALUES (1, 'initName', 'shouldBeInit', 'init')			
+				VALUES (1, 'initName', 'shouldBeInit', 'init')
 			`,
 		},
 	],

test/fixtures/03-async-migrator/00-execute-model.ts

@@ -1,4 +1,4 @@
-import type { ConfigLoader } from '../../../src/server-glue/module';
+import type { ConfigLoader } from '@balena/pinejs';
 
 const apiRoot = 'example';
 const modelName = 'example';

test/fixtures/03-async-migrator/01-migrations.ts

@@ -1,4 +1,4 @@
-import type { ConfigLoader } from '../../../src/server-glue/module';
+import type { ConfigLoader } from '@balena/pinejs';
 
 const apiRoot = 'example';
 const modelName = 'example';

test/fixtures/03-async-migrator/01-migrations/migrations/0002-test-migrations.async.ts

@@ -1,6 +1,6 @@
-import type { AsyncMigration } from '../../../../../src/migrator/utils';
+import type { Migrator } from '@balena/pinejs';
 
-const migration: AsyncMigration = {
+const migration: Migrator.AsyncMigration = {
 	asyncFn: async (tx, options) => {
 		const staticSql = `\
 		UPDATE "device"

test/fixtures/03-async-migrator/01-migrations/migrations/0003-finalized-test-migration.async.ts

@@ -1,6 +1,6 @@
-import type { AsyncMigration } from '../../../../../src/migrator/utils';
+import type { Migrator } from '@balena/pinejs';
 
-const migration: AsyncMigration = {
+const migration: Migrator.AsyncMigration = {
 	asyncFn: async (tx) => {
 		const staticSql = `\
 		SELECT 1;`;

test/fixtures/03-async-migrator/02-parallel-migrations.ts

@@ -1,4 +1,4 @@
-import type { ConfigLoader } from '../../../src/server-glue/module';
+import type { ConfigLoader } from '@balena/pinejs';
 
 const apiRoot = 'example';
 const modelName = 'example';

test/fixtures/03-async-migrator/02-parallel-migrations/migrations/0001-migrate-testa.async.ts

@@ -1,6 +1,6 @@
-import type { AsyncMigration } from '../../../../../src/migrator/utils';
+import type { Migrator } from '@balena/pinejs';
 
-const migration: AsyncMigration = {
+const migration: Migrator.AsyncMigration = {
 	asyncFn: async (tx, options) => {
 		const staticSql = `\
 		UPDATE "device"

test/fixtures/03-async-migrator/02-parallel-migrations/migrations/0002-migrate-testb.async.ts

@@ -1,6 +1,6 @@
-import type { AsyncMigration } from '../../../../../src/migrator/utils';
+import type { Migrator } from '@balena/pinejs';
 
-const migration: AsyncMigration = {
+const migration: Migrator.AsyncMigration = {
 	asyncFn: async (tx, options) => {
 		const staticSql = `\
 		UPDATE "deviceb"

test/fixtures/03-async-migrator/03-finalize-async.ts

@@ -1,4 +1,4 @@
-import type { ConfigLoader } from '../../../src/server-glue/module';
+import type { ConfigLoader } from '@balena/pinejs';
 
 const apiRoot = 'example';
 const modelName = 'example';

test/fixtures/03-async-migrator/03-finalize-async/migrations/m0001-data-copy.async.ts

@@ -1,6 +1,6 @@
-import type { AsyncMigration } from '../../../../../src/migrator/utils';
+import type { Migrator } from '@balena/pinejs';
 
-const migration: AsyncMigration = {
+const migration: Migrator.AsyncMigration = {
 	asyncFn: async (tx, options) => {
 		const staticSql = `\
 		UPDATE "device"

test/fixtures/03-async-migrator/03-finalize-async/migrations/m0002-data-copy.async.ts

@@ -1,6 +1,6 @@
-import type { AsyncMigration } from '../../../../../src/migrator/utils';
+import type { Migrator } from '@balena/pinejs';
 
-const migration: AsyncMigration = {
+const migration: Migrator.AsyncMigration = {
 	asyncSql: `\
 	UPDATE "deviceb"
 	SET "note" = "deviceb"."name"

test/fixtures/03-async-migrator/04-migration-errors.ts

@@ -1,4 +1,4 @@
-import type { ConfigLoader } from '../../../src/server-glue/module';
+import type { ConfigLoader } from '@balena/pinejs';
 
 const apiRoot = 'example';
 const modelName = 'example';