[tests] Configure both database servers in one place

PostgreSQL and SQL Server were configured two different ways, and
neither in one place: the PostgreSQL URL was written out five times in
the harness, and SQL Server read four environment variables.

Both now come from `provide` in vitest.config.ts. A project's provide
merges over the root's rather than replacing it, so the '-servers'
projects keep the databases while overriding their own flag. The harness
reads them, and the five repeated URLs collapse to one constant.

The documentation examples had their own copies again, eight of them.
Rather than have them recite credentials a reader might paste into their
own code, they keep spelling out a plain local database, and the doc
tests rewrite that pattern to whatever this run is configured against -
adding, for SQL Server, the login that PostgreSQL does not need. So the
mssql examples now read like the PostgreSQL ones instead of reaching
into process.env, and TINYBASE_MSSQL is gone entirely.

Checked by pointing the config at ports nothing listens on: both the
harness and the documentation examples fail, which is what proves they
are reading it rather than a default of their own.

Author: jamesgpearce

site/guides/20_releases.md

@@ -70,7 +70,7 @@ import {connect} from 'mssql';
 import {createStore} from 'tinybase';
 import {createMsSqlPersister} from 'tinybase/persisters/persister-mssql';
 
-const msSqlPool = await connect(process.env.TINYBASE_MSSQL);
+const msSqlPool = await connect('Server=localhost,1433;Database=tinybase');
 const msSqlStore = createStore().setTables({pets: {fido: {species: 'dog'}}});
 const msSqlPersister = await createMsSqlPersister(
   msSqlStore,

src/@types/persisters/persister-mssql/docs.js

@@ -32,9 +32,9 @@
  *
  * This module currently supports the JSON serialization mode only.
  *
- * The examples in this documentation connect with the `TINYBASE_MSSQL`
- * environment variable, which should be set to a connection string for a
- * scratch database.
+ * The examples below connect to a local `tinybase` database. A real
+ * connection string also carries the login, or the authentication type that
+ * stands in for one on Azure.
  * @see Database Persistence guide
  * @packageDocumentation
  * @module persister-mssql
@@ -69,7 +69,7 @@
    * import {createStore} from 'tinybase';
    * import {createMsSqlPersister} from 'tinybase/persisters/persister-mssql';
    *
-   * const pool = await connect(process.env.TINYBASE_MSSQL);
+   * const pool = await connect('Server=localhost,1433;Database=tinybase');
    * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
    * const persister = await createMsSqlPersister(store, pool, 'my_tinybase');
    *
@@ -134,7 +134,7 @@
  * import {createStore} from 'tinybase';
  * import {createMsSqlPersister} from 'tinybase/persisters/persister-mssql';
  *
- * const pool = await connect(process.env.TINYBASE_MSSQL);
+ * const pool = await connect('Server=localhost,1433;Database=tinybase');
  * const store = createStore().setTables({pets: {fido: {species: 'dog'}}});
  * const persister = await createMsSqlPersister(store, pool, 'my_tinybase');
  *

test/unit/common/other.ts

@@ -15,26 +15,23 @@ export const withServers: boolean = isBun
   : (vitest as {inject?: (key: 'servers') => boolean}).inject?.('servers') ==
     true;
 
-// The local SQL Server these tests expect, given the same treatment as the
-// PostgreSQL URL in databases.ts. PostgreSQL can use trust authentication and
-// so needs no password; SQL Server cannot, so one is spelled out here. It is
-// the password of a throwaway container holding nothing but test data, never
-// a real instance:
-//
-//   docker run -d --name tinybase-mssql -p 1433:1433 \
-//     -e ACCEPT_EULA=Y -e MSSQL_PID=Developer \
-//     -e MSSQL_SA_PASSWORD='TinyBase!Passw0rd' \
-//     mcr.microsoft.com/mssql/server:2022-latest
-//
-// Point any part of it somewhere else with the matching variable.
-export const MSSQL_SERVER = process.env.TINYBASE_MSSQL_SERVER ?? 'localhost';
-export const MSSQL_PORT = Number(process.env.TINYBASE_MSSQL_PORT ?? 1433);
-export const MSSQL_USER = process.env.TINYBASE_MSSQL_USER ?? 'sa';
-export const MSSQL_PASSWORD =
-  process.env.TINYBASE_MSSQL_PASSWORD ?? 'TinyBase!Passw0rd';
-export const MSSQL_CONNECTION_STRING =
-  `Server=${MSSQL_SERVER},${MSSQL_PORT};Database=tinybase;` +
-  `User Id=${MSSQL_USER};Password=${MSSQL_PASSWORD};` +
+// The two database servers, configured once in vitest.config.ts. Bun aliases
+// 'vitest' to 'bun:test', which has no inject, but it runs no database variant
+// and no server-backed example, so these go unused there.
+const injected = (vitest as {inject?: (key: string) => any}).inject;
+
+export const POSTGRES_URL: string = injected?.('postgres');
+
+export const MSSQL_CONFIG: {
+  server: string;
+  port: number;
+  user: string;
+  password: string;
+} = injected?.('mssql');
+
+export const getMsSqlConnectionString = (database: string): string =>
+  `Server=${MSSQL_CONFIG.server},${MSSQL_CONFIG.port};Database=${database};` +
+  `User Id=${MSSQL_CONFIG.user};Password=${MSSQL_CONFIG.password};` +
   `Encrypt=false;TrustServerCertificate=true`;
 
 export const AsyncFunction = Object.getPrototypeOf(

test/unit/documentation.test.ts

@@ -67,10 +67,11 @@ import {AutomergeTestNetworkAdapter as BroadcastChannelNetworkAdapter} from './c
 import {getTimeFunctions} from './common/mergeable.ts';
 import {
   AsyncFunction,
+  getMsSqlConnectionString,
   importBunSqlite,
   isBun,
-  MSSQL_CONNECTION_STRING,
   pause,
+  POSTGRES_URL,
   suppressWarnings,
   withServers,
 } from './common/other.ts';
@@ -333,8 +334,21 @@ const transformSolidJsx = (source: string, loader: 'jsx' | 'tsx'): string =>
     {presets: [['solid', {delegateEvents: false}]]},
   )?.code ?? '';
 
+// The examples spell out a plain local database, which is what a reader should
+// see, so they say nothing about credentials. Point them at whatever this run
+// is configured against, which for SQL Server means adding the login that
+// PostgreSQL does not need. Bun has no inject and runs none of these.
+const replaceDatabaseUrls = (source: string): string =>
+  POSTGRES_URL == undefined
+    ? source
+    : source
+        .replace(/postgres:\/\/localhost:5432/g, POSTGRES_URL)
+        .replace(/Server=localhost,1433;Database=(\w+)/g, (_, database) =>
+          getMsSqlConnectionString(database),
+        );
+
 const prepareRunnableCode = (source: string, replaceImports: boolean): string =>
-  (replaceImports ? replaceRunnableImports(source) : source)
+  replaceDatabaseUrls(replaceImports ? replaceRunnableImports(source) : source)
     .replace(
       /console\.log\((.+?)\.innerHTML\);$/gm,
       '_actual.push(getHtml($1));',
@@ -770,11 +784,6 @@ ${body
   expect(problem).toBeUndefined();
 };
 
-// The mssql examples deliberately read their connection string from the
-// environment rather than spelling out credentials a reader might copy. Point
-// it at the local instance when nothing else has, so the suite needs no setup.
-process.env.TINYBASE_MSSQL ??= MSSQL_CONNECTION_STRING;
-
 describe('Documentation tests', () => {
   beforeAll(async () => {
     if (isBun) {

test/unit/persisters/common/databases.ts

@@ -35,10 +35,8 @@ import {createSqliteWasmPersister} from 'tinybase/persisters/persister-sqlite-wa
 import tmp from 'tmp';
 import {afterAll, expect} from 'vitest';
 import {
-  MSSQL_PASSWORD,
-  MSSQL_PORT,
-  MSSQL_SERVER,
-  MSSQL_USER,
+  MSSQL_CONFIG,
+  POSTGRES_URL,
   importBunSqlite,
   isBun,
   noop,
@@ -68,7 +66,7 @@ export type SqlClientsAndName = [Sql, ReservedSql, string];
 export type PgClientsAndName = [Pool, PoolClient, Mutex, string];
 export type MsSqlPoolsAndName = [ConnectionPool, ConnectionPool, Mutex, string];
 
-const PG_ADMIN_URL = 'postgres://localhost:5432/postgres';
+const PG_ADMIN_URL = POSTGRES_URL + '/postgres';
 const PG_OPTIONS = '-c client_min_messages=warning';
 
 const pgAdmin = async (sql: string) => {
@@ -80,13 +78,9 @@ const pgAdmin = async (sql: string) => {
   await adminPool.end();
 };
 
-// As with the PostgreSQL URL above, this is the local instance the tests
-// expect; see the constants in other.ts for what it is and how to override it.
+// Both servers are configured in vitest.config.ts; see `provide` there.
 const getMsSqlConfig = (database: string) => ({
-  server: MSSQL_SERVER,
-  port: MSSQL_PORT,
-  user: MSSQL_USER,
-  password: MSSQL_PASSWORD,
+  ...MSSQL_CONFIG,
   database,
   pool: {max: 20},
   options: {encrypt: false, trustServerCertificate: true},
@@ -464,12 +458,12 @@ export const NODE_POSTGRESQL_VARIANTS: Variants = {
       const existingName = sqlClientsAndName?.[2];
       const name = existingName ?? 'tinybase_' + getUniqueId();
       if (!existingName) {
-        const adminSql = postgres('postgres://localhost:5432/postgres');
+        const adminSql = postgres(PG_ADMIN_URL);
         await adminSql`CREATE DATABASE ${adminSql(name)}`;
         await adminSql.end({timeout: 0.1});
       }
 
-      const sql = postgres('postgres://localhost:5432/' + name, {
+      const sql = postgres(POSTGRES_URL + '/' + name, {
         connection: {client_min_messages: 'warning'},
       });
       const cmdSql = await sql.reserve();
@@ -496,7 +490,7 @@ export const NODE_POSTGRESQL_VARIANTS: Variants = {
       cmdSql.release();
       await sql.end({timeout: 0.1});
 
-      const adminSql = postgres('postgres://localhost:5432/postgres', {
+      const adminSql = postgres(PG_ADMIN_URL, {
         connection: {client_min_messages: 'warning'},
       });
       await adminSql`DROP DATABASE IF EXISTS ${adminSql(name)} WITH (FORCE)`;
@@ -516,7 +510,7 @@ export const NODE_POSTGRESQL_VARIANTS: Variants = {
       }
 
       const pool = new Pool({
-        connectionString: 'postgres://localhost:5432/' + name,
+        connectionString: POSTGRES_URL + '/' + name,
         options: PG_OPTIONS,
         max: 20,
       });

vitest.config.ts

@@ -33,10 +33,35 @@ export default defineConfig({
       reporter: ['text-summary', 'json-summary', 'html'],
     },
 
-    // Which half of the database work a project runs. The '-servers' projects
-    // below override this; everything else leaves those variants and
-    // documentation examples alone, so the suite needs no database server.
-    provide: {servers: false},
+    provide: {
+      // Which half of the database work a project runs. The '-servers'
+      // projects below override this; everything else leaves those variants
+      // and documentation examples alone, so the suite needs no database
+      // server. A project's provide merges over these, rather than replacing
+      // them, so the two databases below reach every project.
+      servers: false,
+
+      // The two database servers the suite expects, in the one place they are
+      // configured. The tests read them from here, and the documentation
+      // examples - which spell out a plain local database, as a reader should
+      // see - are rewritten to match before they run.
+      //
+      // PostgreSQL uses trust authentication and so needs no password. SQL
+      // Server cannot, so a password is here; it belongs to a throwaway
+      // container holding nothing but test data, never a real instance:
+      //
+      //   docker run -d --name tinybase-mssql -p 1433:1433 \
+      //     -e ACCEPT_EULA=Y -e MSSQL_PID=Developer \
+      //     -e MSSQL_SA_PASSWORD='TinyBase!Passw0rd' \
+      //     mcr.microsoft.com/mssql/server:2022-latest
+      postgres: 'postgres://localhost:5432',
+      mssql: {
+        server: 'localhost',
+        port: 1433,
+        user: 'sa',
+        password: 'TinyBase!Passw0rd',
+      },
+    },
 
     onUnhandledError: ({message}) =>
       message !== 'Invariant: worker WS endpoint not found',