@better-auth/test-utils 1.5.0-beta.9

package/dist/test-adapter.d.mts

@@ -0,0 +1,75 @@
+import { createTestSuite } from "./create-test-suite.mjs";
+import { DBAdapter } from "@better-auth/core/db/adapter";
+import { Awaitable, BetterAuthOptions } from "@better-auth/core";
+
+//#region src/adapter/test-adapter.d.ts
+type Logger = {
+  info: (...args: any[]) => void;
+  success: (...args: any[]) => void;
+  warn: (...args: any[]) => void;
+  error: (...args: any[]) => void;
+  debug: (...args: any[]) => void;
+};
+declare const testAdapter: ({
+  adapter: getAdapter,
+  runMigrations,
+  overrideBetterAuthOptions,
+  additionalCleanups,
+  tests,
+  prefixTests,
+  onFinish,
+  customIdGenerator,
+  transformIdOutput
+}: {
+  /**
+   * A function that will return the adapter instance to test with.
+   *
+   * @example
+   * ```ts
+   * testAdapter({
+   *   adapter: (options) => drizzleAdapter(drizzle(db), {
+   *     schema: generateSchema(options),
+   *   }),
+   * })
+   */
+  adapter: (options: BetterAuthOptions) => Awaitable<(options: BetterAuthOptions) => DBAdapter<BetterAuthOptions>>;
+  /**
+   * A function that will run the database migrations.
+   */
+  runMigrations: (betterAuthOptions: BetterAuthOptions) => Promise<void> | void;
+  /**
+   * Any potential better-auth options overrides.
+   */
+  overrideBetterAuthOptions?: (betterAuthOptions: BetterAuthOptions) => BetterAuthOptions;
+  /**
+   * By default we will cleanup all tables automatically,
+   * but if you have additional cleanup logic, you can pass it here.
+   *
+   * Such as deleting a DB file that could had been created.
+   */
+  additionalCleanups?: () => Promise<void> | void;
+  /**
+   * A test suite to run.
+   */
+  tests: ReturnType<ReturnType<typeof createTestSuite>>[];
+  /**
+   * A prefix to add to the test suite name.
+   */
+  prefixTests?: string;
+  /**
+   * Upon finish of the tests, this function will be called.
+   */
+  onFinish?: () => Promise<void> | void;
+  /**
+   * Custom ID generator function to be used by the helper functions. (such as `insertRandom`)
+   */
+  customIdGenerator?: () => any;
+  /**
+   * A function that will transform the ID output.
+   */
+  transformIdOutput?: (id: any) => any;
+}) => Promise<{
+  execute: () => void;
+}>;
+//#endregion
+export { Logger, testAdapter };

package/dist/test-adapter.mjs

@@ -0,0 +1,162 @@
+import { deepmerge, initGetModelName } from "@better-auth/core/db/adapter";
+import { TTY_COLORS } from "@better-auth/core/env";
+import { afterAll, beforeAll, describe } from "vitest";
+import { getAuthTables } from "better-auth/db";
+
+//#region src/adapter/test-adapter.ts
+const testAdapter = async ({ adapter: getAdapter, runMigrations, overrideBetterAuthOptions, additionalCleanups, tests, prefixTests, onFinish, customIdGenerator, transformIdOutput }) => {
+	const defaultBAOptions = {};
+	let betterAuthOptions = {
+		...defaultBAOptions,
+		...overrideBetterAuthOptions?.(defaultBAOptions) || {}
+	};
+	let adapter = (await getAdapter(betterAuthOptions))(betterAuthOptions);
+	const adapterName = adapter.options?.adapterConfig.adapterName;
+	const adapterId = adapter.options?.adapterConfig.adapterId || adapter.id;
+	const adapterDisplayName = adapterName || adapterId;
+	const refreshAdapter = async (betterAuthOptions$1) => {
+		adapter = (await getAdapter(betterAuthOptions$1))(betterAuthOptions$1);
+	};
+	/**
+	* A helper function to log to the console.
+	*/
+	const log = {
+		info: (...args) => console.log(`${TTY_COLORS.fg.blue}INFO   ${TTY_COLORS.reset} [${adapterDisplayName}]`, ...args),
+		success: (...args) => console.log(`${TTY_COLORS.fg.green}SUCCESS${TTY_COLORS.reset} [${adapterDisplayName}]`, ...args),
+		warn: (...args) => console.log(`${TTY_COLORS.fg.yellow}WARN   ${TTY_COLORS.reset} [${adapterDisplayName}]`, ...args),
+		error: (...args) => console.log(`${TTY_COLORS.fg.red}ERROR  ${TTY_COLORS.reset} [${adapterDisplayName}]`, ...args),
+		debug: (...args) => console.log(`${TTY_COLORS.fg.magenta}DEBUG  ${TTY_COLORS.reset} [${adapterDisplayName}]`, ...args)
+	};
+	/**
+	* Cleanup function to remove all rows from the database.
+	*/
+	const cleanup = async () => {
+		const start = performance.now();
+		await refreshAdapter(betterAuthOptions);
+		const getAllModels = getAuthTables(betterAuthOptions);
+		for (const model of Object.keys(getAllModels)) {
+			const getModelName = initGetModelName({
+				usePlural: adapter.options?.adapterConfig?.usePlural,
+				schema: getAllModels
+			});
+			try {
+				const modelName = getModelName(model);
+				await adapter.deleteMany({
+					model: modelName,
+					where: []
+				});
+			} catch (error) {
+				const msg = `Error while cleaning up all rows from ${model}`;
+				log.error(msg, error);
+				throw new Error(msg, { cause: error });
+			}
+		}
+		try {
+			await additionalCleanups?.();
+		} catch (error) {
+			const msg = `Error while running additional cleanups`;
+			log.error(msg, error);
+			throw new Error(msg, { cause: error });
+		}
+		await refreshAdapter(betterAuthOptions);
+		log.success(`${TTY_COLORS.bright}CLEAN-UP${TTY_COLORS.reset} completed successfully (${(performance.now() - start).toFixed(3)}ms)`);
+	};
+	/**
+	* A function that will run the database migrations.
+	*/
+	const migrate = async () => {
+		const start = performance.now();
+		try {
+			await runMigrations(betterAuthOptions);
+		} catch (error) {
+			const msg = `Error while running migrations`;
+			log.error(msg, error);
+			throw new Error(msg, { cause: error });
+		}
+		log.success(`${TTY_COLORS.bright}MIGRATIONS${TTY_COLORS.reset} completed successfully (${(performance.now() - start).toFixed(3)}ms)`);
+	};
+	return { execute: () => {
+		describe(adapterDisplayName, async () => {
+			const allSuiteStats = [];
+			beforeAll(async () => {
+				await migrate();
+			}, 6e4);
+			afterAll(async () => {
+				await cleanup();
+				if (allSuiteStats.length > 0) {
+					const totalMigrations = allSuiteStats.reduce((sum, stats) => sum + stats.migrationCount, 0);
+					const totalMigrationTime = allSuiteStats.reduce((sum, stats) => sum + stats.totalMigrationTime, 0);
+					const totalTests = allSuiteStats.reduce((sum, stats) => sum + stats.testCount, 0);
+					const totalDuration = allSuiteStats.reduce((sum, stats) => sum + stats.suiteDuration, 0);
+					const separator = `${"─".repeat(80)}`;
+					console.log(`\n${TTY_COLORS.fg.cyan}${separator}`);
+					console.log(`${TTY_COLORS.fg.cyan}${TTY_COLORS.bright}TEST SUITE STATISTICS SUMMARY${TTY_COLORS.reset}`);
+					console.log(`${TTY_COLORS.fg.cyan}${separator}${TTY_COLORS.reset}\n`);
+					for (const stats of allSuiteStats) {
+						const avgMigrationTime$1 = stats.migrationCount > 0 ? (stats.totalMigrationTime / stats.migrationCount).toFixed(2) : "0.00";
+						console.log(`${TTY_COLORS.fg.magenta}${stats.suiteName}${TTY_COLORS.reset}:`);
+						console.log(`  Tests: ${TTY_COLORS.fg.green}${stats.testCount}${TTY_COLORS.reset}`);
+						console.log(`  Migrations: ${TTY_COLORS.fg.yellow}${stats.migrationCount}${TTY_COLORS.reset} (avg: ${avgMigrationTime$1}ms)`);
+						console.log(`  Total Migration Time: ${TTY_COLORS.fg.yellow}${stats.totalMigrationTime.toFixed(2)}ms${TTY_COLORS.reset}`);
+						console.log(`  Suite Duration: ${TTY_COLORS.fg.blue}${stats.suiteDuration.toFixed(2)}ms${TTY_COLORS.reset}`);
+						if (stats.groupingStats) {
+							const { totalGroups: totalGroups$1, averageTestsPerGroup, largestGroupSize, smallestGroupSize, groupsWithMultipleTests } = stats.groupingStats;
+							console.log(`  Test Groups: ${TTY_COLORS.fg.cyan}${totalGroups$1}${TTY_COLORS.reset}`);
+							if (totalGroups$1 > 0) {
+								console.log(`    Avg Tests/Group: ${TTY_COLORS.fg.cyan}${averageTestsPerGroup.toFixed(2)}${TTY_COLORS.reset}`);
+								console.log(`    Largest Group: ${TTY_COLORS.fg.cyan}${largestGroupSize}${TTY_COLORS.reset}`);
+								console.log(`    Smallest Group: ${TTY_COLORS.fg.cyan}${smallestGroupSize}${TTY_COLORS.reset}`);
+								console.log(`    Groups w/ Multiple Tests: ${TTY_COLORS.fg.cyan}${groupsWithMultipleTests}${TTY_COLORS.reset}`);
+							}
+						}
+						console.log("");
+					}
+					const avgMigrationTime = totalMigrations > 0 ? (totalMigrationTime / totalMigrations).toFixed(2) : "0.00";
+					const totalGroups = allSuiteStats.reduce((sum, stats) => sum + (stats.groupingStats?.totalGroups || 0), 0);
+					const totalGroupsWithMultipleTests = allSuiteStats.reduce((sum, stats) => sum + (stats.groupingStats?.groupsWithMultipleTests || 0), 0);
+					const totalTestsInGroups = allSuiteStats.reduce((sum, stats) => sum + (stats.groupingStats?.totalTestsInGroups || 0), 0);
+					const avgTestsPerGroup = totalGroups > 0 ? totalTestsInGroups / totalGroups : 0;
+					console.log(`${TTY_COLORS.fg.cyan}${separator}`);
+					console.log(`${TTY_COLORS.fg.cyan}${TTY_COLORS.bright}TOTALS${TTY_COLORS.reset}`);
+					console.log(`  Total Tests: ${TTY_COLORS.fg.green}${totalTests}${TTY_COLORS.reset}`);
+					console.log(`  Total Migrations: ${TTY_COLORS.fg.yellow}${totalMigrations}${TTY_COLORS.reset} (avg: ${avgMigrationTime}ms)`);
+					console.log(`  Total Migration Time: ${TTY_COLORS.fg.yellow}${totalMigrationTime.toFixed(2)}ms${TTY_COLORS.reset}`);
+					console.log(`  Total Duration: ${TTY_COLORS.fg.blue}${totalDuration.toFixed(2)}ms${TTY_COLORS.reset}`);
+					if (totalGroups > 0) {
+						console.log(`  Total Test Groups: ${TTY_COLORS.fg.cyan}${totalGroups}${TTY_COLORS.reset}`);
+						console.log(`    Avg Tests/Group: ${TTY_COLORS.fg.cyan}${avgTestsPerGroup.toFixed(2)}${TTY_COLORS.reset}`);
+						console.log(`    Groups w/ Multiple Tests: ${TTY_COLORS.fg.cyan}${totalGroupsWithMultipleTests}${TTY_COLORS.reset}`);
+					}
+					console.log(`${TTY_COLORS.fg.cyan}${separator}${TTY_COLORS.reset}\n`);
+				}
+				await onFinish?.();
+			}, 6e4);
+			for (const testSuite of tests) await testSuite({
+				adapter: async () => {
+					await refreshAdapter(betterAuthOptions);
+					return adapter;
+				},
+				adapterDisplayName,
+				log,
+				getBetterAuthOptions: () => betterAuthOptions,
+				modifyBetterAuthOptions: async (options) => {
+					const newOptions = deepmerge(defaultBAOptions, options);
+					betterAuthOptions = deepmerge(newOptions, overrideBetterAuthOptions?.(newOptions) || {});
+					await refreshAdapter(betterAuthOptions);
+					return betterAuthOptions;
+				},
+				cleanup,
+				prefixTests,
+				runMigrations: migrate,
+				onTestFinish: async (stats) => {
+					allSuiteStats.push(stats);
+				},
+				customIdGenerator,
+				transformIdOutput
+			});
+		});
+	} };
+};
+
+//#endregion
+export { testAdapter };

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@better-auth/test-utils",
+  "version": "1.5.0-beta.9",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/better-auth/better-auth.git"
+  },
+  "exports": {
+    "./adapter": {
+      "dev-source": "./src/adapter.ts",
+      "default": "./dist/adapter.mjs",
+      "types": "./dist/adapter.d.mts"
+    }
+  },
+  "devDependencies": {
+    "tsdown": "^0.19.0",
+    "vitest": "^4.0.17",
+    "@better-auth/core": "1.5.0-beta.9",
+    "better-auth": "1.5.0-beta.9"
+  },
+  "peerDependencies": {
+    "vitest": "^4.0.17",
+    "@better-auth/core": "1.5.0-beta.9",
+    "better-auth": "1.5.0-beta.9"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch"
+  }
+}