vela 0.21.0 → 0.23.0

package/dist/testing.d.ts

@@ -0,0 +1,21 @@
+import type { TestProject } from 'vitest/node';
+/** What a server-test run talks to; `inject('vela')` in a test or setup file. */
+export interface TestServers {
+    /** The throwaway PocketBase, migrated and loaded with seeds and fixtures. */
+    pocketbaseUrl: string;
+    /** The app, served by Vite in test mode with its pages stubbed out. */
+    appUrl: string;
+    /** The superuser the harness created in the throwaway database. */
+    superuser: {
+        email: string;
+        password: string;
+    };
+    /** The run's data directory: PocketBase's, uploads, the CMS database. */
+    dataDir: string;
+}
+declare module 'vitest' {
+    interface ProvidedContext {
+        vela: TestServers;
+    }
+}
+export default function setup(project: TestProject): Promise<() => Promise<void>>;

package/dist/testing.js

@@ -0,0 +1,43 @@
+// src/testing.ts
+import { spawn } from "node:child_process";
+import path from "node:path";
+import process from "node:process";
+import { fileURLToPath } from "node:url";
+import dotenv from "dotenv";
+async function setup(project) {
+  const root = project.config.root;
+  dotenv.config({ path: path.join(root, ".env"), quiet: true });
+  const bin = fileURLToPath(new URL("./bin.js", import.meta.url));
+  const child = spawn(process.execPath, [bin, "test:harness"], {
+    cwd: root,
+    // `test.env` from the config reaches the app too, not only the workers,
+    // so a suite's settings live in one place.
+    env: { ...process.env, ...project.config.env },
+    stdio: ["ignore", "inherit", "inherit", "ipc"]
+  });
+  const exited = new Promise((resolve) => {
+    child.once("exit", (code) => resolve(code));
+  });
+  const ready = await new Promise((resolve, reject) => {
+    child.on("message", (message) => {
+      if (message.type === "ready") resolve(message);
+      else reject(new Error(message.message));
+    });
+    void exited.then(
+      (code) => reject(new Error(`vela test:harness exited with code ${code} before its servers were up`))
+    );
+  });
+  Object.assign(process.env, ready.env);
+  project.provide("vela", ready.servers);
+  return async () => {
+    if (child.exitCode !== null) return;
+    child.send("stop");
+    const timer = setTimeout(() => child.kill(), 5e3);
+    await exited;
+    clearTimeout(timer);
+  };
+}
+export {
+  setup as default
+};
+//# sourceMappingURL=testing.js.map

package/dist/testing.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../src/testing.ts"],
+  "sourcesContent": ["/**\n * Vitest support for vela projects.\n *\n * The default export is a vitest global setup: it starts the servers the\n * server tests need (a throwaway PocketBase with the app's hooks, seeds and\n * fixtures, and the app under Vite in test mode) before the first test file\n * runs, and stops them after the last. A project names it in\n * `vitest.config.ts`:\n *\n * ```ts\n * test: { globalSetup: ['vela/testing'] }\n * ```\n *\n * The servers run in a child process (`vela test:harness`), so vitest, bare\n * or through `vela test:server`, in watch mode or from an editor, boots the\n * same thing. Tests reach the servers through `inject('vela')`, and through\n * the environment `vela test:server` always set: `POCKETBASE_URL`,\n * `POCKETBASE_SUPERUSER_EMAIL`, `POCKETBASE_SUPERUSER_PASSWORD`,\n * `VELA_DATA_DIR`, `VITE_TEST_URL` and `TEST=true`.\n */\nimport { spawn } from 'node:child_process';\nimport path from 'node:path';\nimport process from 'node:process';\nimport { fileURLToPath } from 'node:url';\nimport dotenv from 'dotenv';\nimport type { TestProject } from 'vitest/node';\n\n/** What a server-test run talks to; `inject('vela')` in a test or setup file. */\nexport interface TestServers {\n\t/** The throwaway PocketBase, migrated and loaded with seeds and fixtures. */\n\tpocketbaseUrl: string;\n\t/** The app, served by Vite in test mode with its pages stubbed out. */\n\tappUrl: string;\n\t/** The superuser the harness created in the throwaway database. */\n\tsuperuser: { email: string; password: string };\n\t/** The run's data directory: PocketBase's, uploads, the CMS database. */\n\tdataDir: string;\n}\n\ndeclare module 'vitest' {\n\tinterface ProvidedContext {\n\t\tvela: TestServers;\n\t}\n}\n\ntype HarnessMessage =\n\t| { type: 'ready'; servers: TestServers; env: Record<string, string> }\n\t| { type: 'error'; message: string };\n\nexport default async function setup(project: TestProject): Promise<() => Promise<void>> {\n\tconst root = project.config.root;\n\t// The project's `.env`, as every vela command loads it: the app reads it\n\t// through Vite either way, and a test that signs a request with the same\n\t// secret must see the same value. Nothing already set is replaced, and the\n\t// harness's own variables are assigned over it below.\n\tdotenv.config({ path: path.join(root, '.env'), quiet: true });\n\n\t// This package's own bin, so the harness is the vela the project installed,\n\t// whatever is on the PATH.\n\tconst bin = fileURLToPath(new URL('./bin.js', import.meta.url));\n\tconst child = spawn(process.execPath, [bin, 'test:harness'], {\n\t\tcwd: root,\n\t\t// `test.env` from the config reaches the app too, not only the workers,\n\t\t// so a suite's settings live in one place.\n\t\tenv: { ...process.env, ...project.config.env },\n\t\tstdio: ['ignore', 'inherit', 'inherit', 'ipc']\n\t});\n\tconst exited = new Promise<number | null>((resolve) => {\n\t\tchild.once('exit', (code) => resolve(code));\n\t});\n\n\tconst ready = await new Promise<Extract<HarnessMessage, { type: 'ready' }>>((resolve, reject) => {\n\t\tchild.on('message', (message: HarnessMessage) => {\n\t\t\tif (message.type === 'ready') resolve(message);\n\t\t\telse reject(new Error(message.message));\n\t\t});\n\t\tvoid exited.then((code) =>\n\t\t\treject(new Error(`vela test:harness exited with code ${code} before its servers were up`))\n\t\t);\n\t});\n\n\t// Workers start after this returns and inherit the environment, so the\n\t// setup file and the tests see the same variables `vela test:server` set.\n\tObject.assign(process.env, ready.env);\n\tproject.provide('vela', ready.servers);\n\n\treturn async () => {\n\t\tif (child.exitCode !== null) return;\n\t\tchild.send('stop');\n\t\tconst timer = setTimeout(() => child.kill(), 5_000);\n\t\tawait exited;\n\t\tclearTimeout(timer);\n\t};\n}\n"],
+  "mappings": ";AAoBA,SAAS,aAAa;AACtB,OAAO,UAAU;AACjB,OAAO,aAAa;AACpB,SAAS,qBAAqB;AAC9B,OAAO,YAAY;AAyBnB,eAAO,MAA6B,SAAoD;AACvF,QAAM,OAAO,QAAQ,OAAO;AAK5B,SAAO,OAAO,EAAE,MAAM,KAAK,KAAK,MAAM,MAAM,GAAG,OAAO,KAAK,CAAC;AAI5D,QAAM,MAAM,cAAc,IAAI,IAAI,YAAY,YAAY,GAAG,CAAC;AAC9D,QAAM,QAAQ,MAAM,QAAQ,UAAU,CAAC,KAAK,cAAc,GAAG;AAAA,IAC5D,KAAK;AAAA;AAAA;AAAA,IAGL,KAAK,EAAE,GAAG,QAAQ,KAAK,GAAG,QAAQ,OAAO,IAAI;AAAA,IAC7C,OAAO,CAAC,UAAU,WAAW,WAAW,KAAK;AAAA,EAC9C,CAAC;AACD,QAAM,SAAS,IAAI,QAAuB,CAAC,YAAY;AACtD,UAAM,KAAK,QAAQ,CAAC,SAAS,QAAQ,IAAI,CAAC;AAAA,EAC3C,CAAC;AAED,QAAM,QAAQ,MAAM,IAAI,QAAoD,CAAC,SAAS,WAAW;AAChG,UAAM,GAAG,WAAW,CAAC,YAA4B;AAChD,UAAI,QAAQ,SAAS,QAAS,SAAQ,OAAO;AAAA,UACxC,QAAO,IAAI,MAAM,QAAQ,OAAO,CAAC;AAAA,IACvC,CAAC;AACD,SAAK,OAAO;AAAA,MAAK,CAAC,SACjB,OAAO,IAAI,MAAM,sCAAsC,IAAI,6BAA6B,CAAC;AAAA,IAC1F;AAAA,EACD,CAAC;AAID,SAAO,OAAO,QAAQ,KAAK,MAAM,GAAG;AACpC,UAAQ,QAAQ,QAAQ,MAAM,OAAO;AAErC,SAAO,YAAY;AAClB,QAAI,MAAM,aAAa,KAAM;AAC7B,UAAM,KAAK,MAAM;AACjB,UAAM,QAAQ,WAAW,MAAM,MAAM,KAAK,GAAG,GAAK;AAClD,UAAM;AACN,iBAAa,KAAK;AAAA,EACnB;AACD;",
+  "names": []
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "vela",
-	"version": "0.21.0",
+	"version": "0.23.0",
 	"type": "module",
 	"description": "A CLI for creating and updating SvelteKit projects",
 	"license": "MIT",
@@ -16,12 +16,19 @@
 		"vela": "./dist/bin.js",
 		"velastack": "./dist/bin.js"
 	},
+	"exports": {
+		"./testing": {
+			"types": "./dist/testing.d.ts",
+			"default": "./dist/testing.js"
+		},
+		"./package.json": "./package.json"
+	},
 	"files": [
 		"dist",
 		"templates"
 	],
 	"scripts": {
-		"build": "node --experimental-strip-types scripts/build.ts",
+		"build": "node --experimental-strip-types scripts/build.ts && tsc -p tsconfig.testing.json",
 		"dev": "node --experimental-strip-types scripts/build.ts --watch",
 		"clean": "rm -rf dist",
 		"lint": "npm run lint:ts && npm run lint:format && npm run lint:sh",
@@ -37,7 +44,7 @@
 	"dependencies": {
 		"@clack/prompts": "^1.7.0",
 		"@faker-js/faker": "^10.6.0",
-		"@velastack/patterns": "^0.10.0",
+		"@velastack/patterns": "^0.11.0",
 		"@velastack/pocketbase-codegen": "^0.1.0",
 		"@velastack/schema": "^0.3.0",
 		"@velastack/schema-ui": "^0.3.1",
@@ -45,6 +52,7 @@
 		"commander": "^15.0.0",
 		"cross-spawn": "^7.0.6",
 		"dedent": "^1.7.2",
+		"devalue": "^5.9.4",
 		"dotenv": "^18.0.1",
 		"fetch-cookie": "^3.2.0",
 		"json-schema-faker": "^0.6.3",
@@ -53,7 +61,7 @@
 		"picocolors": "^1.1.1",
 		"pocketbase": "^0.28.0",
 		"pocketbase-server": "^0.40.6-beta.5",
-		"stripe": "^22.6.2",
+		"stripe": "^23.0.1",
 		"sv": "~1.1.1",
 		"svelte": "^5.56.10",
 		"tar": "^7.5.22",

package/templates/minimal/_gitignore

@@ -30,3 +30,6 @@ vite.config.ts.timestamp-*
 
 # Backups
 /backups
+
+# Throwaway databases of server-test runs (vela/testing)
+test-data/

package/templates/minimal/package.template.json

@@ -16,6 +16,8 @@
 		"check:watch": "svelte-kit sync && vela sync && svelte-check --tsconfig ./tsconfig.json --watch",
 		"lint": "prettier --check .",
 		"format": "prettier --write .",
+		"test": "vitest run",
+		"test:unit": "vitest run --project unit",
 		"test:server": "vela test:server"
 	},
 	"devDependencies": {

package/templates/minimal/test/setup.ts

@@ -1,10 +1,19 @@
-import { beforeEach, afterEach, beforeAll } from 'vitest';
+import { beforeEach, afterEach, beforeAll, inject } from 'vitest';
 import supertest, { type Agent } from 'supertest';
 import PocketBase from 'pocketbase-sveltekit';
 import type { TestContext } from '@velastack/pocketbase/testing';
+import type {} from 'vela/testing';
 
-const admin = new PocketBase(process.env.POCKETBASE_URL!) as App.Locals['admin'];
-const pb = new PocketBase(process.env.POCKETBASE_URL!) as App.Locals['pb'];
+// The servers `vela/testing` started: a throwaway PocketBase and the app.
+const servers = inject('vela');
+if (!servers) {
+	throw new Error(
+		'Server tests need the servers `vela/testing` starts. Add `globalSetup: [\'vela/testing\']` to the test config in vitest.config.ts.'
+	);
+}
+
+const admin = new PocketBase(servers.pocketbaseUrl) as App.Locals['admin'];
+const pb = new PocketBase(servers.pocketbaseUrl) as App.Locals['pb'];
 
 const testUserPassword = 'password';
 
@@ -25,15 +34,12 @@ beforeAll(async () => {
 	await admin
 		// @ts-ignore
 		.collection('_superusers')
-		.authWithPassword(
-			process.env.POCKETBASE_SUPERUSER_EMAIL!,
-			process.env.POCKETBASE_SUPERUSER_PASSWORD!
-		);
+		.authWithPassword(servers.superuser.email, servers.superuser.password);
 });
 
 beforeEach(async (context: TestContext) => {
-	context.request = supertest(process.env.VITE_TEST_URL!);
-	context.agent = supertest.agent(process.env.VITE_TEST_URL!) as TestContext['agent'];
+	context.request = supertest(servers.appUrl);
+	context.agent = supertest.agent(servers.appUrl) as TestContext['agent'];
 	context.admin = admin;
 	context.pb = pb;
 	const email = `test-${Math.random().toString(36).slice(2)}@example.com`;

package/templates/minimal/vitest.config.ts

@@ -1,4 +1,4 @@
-import { defineConfig, mergeConfig } from 'vitest/config';
+import { configDefaults, defineConfig, mergeConfig } from 'vitest/config';
 import viteConfig from './vite.config.ts';
 
 export default mergeConfig(
@@ -8,11 +8,48 @@ export default mergeConfig(
 			expect: {
 				requireAssertions: true
 			},
-			name: 'server',
 			environment: 'node',
-			include: ['src/**/*.{test,spec}.{js,ts}'],
-			exclude: ['src/**/*.svelte.{test,spec}.{js,ts}'],
-			setupFiles: ['test/setup.ts']
+			passWithNoTests: true,
+			// Server tests reach the app over HTTP and import nothing from it, so
+			// watch mode cannot see which tests an edit affects. Rerun them all.
+			forceRerunTriggers: [
+				'**/package.json/**',
+				'**/{vitest,vite}.config.*/**',
+				'src/routes/**',
+				'src/lib/server/**',
+				'src/hooks.server.ts',
+				'data/hooks/**'
+			],
+			projects: [
+				{
+					extends: true,
+					test: {
+						// `server.test.ts` next to a route, `<name>.server.test.ts` elsewhere:
+						// tests that run against the app and its database.
+						name: 'server',
+						include: ['src/**/*server.{test,spec}.{js,ts}'],
+						// Starts a throwaway PocketBase and the app before the first test
+						// file, and stops them after the last. Every way of running vitest
+						// gets the same servers: `vela test:server`, `vitest`, `vitest --watch`,
+						// an editor's test runner.
+						globalSetup: ['vela/testing'],
+						setupFiles: ['test/setup.ts']
+					}
+				},
+				{
+					extends: true,
+					test: {
+						// Every other test: pure functions, no servers, no setup file.
+						name: 'unit',
+						include: ['src/**/*.{test,spec}.{js,ts}'],
+						exclude: [
+							...configDefaults.exclude,
+							'src/**/*server.{test,spec}.{js,ts}',
+							'src/**/*.svelte.{test,spec}.{js,ts}'
+						]
+					}
+				}
+			]
 		}
 	})
 );