Create unique branch for each app e2e test run

Author: CarsonF

src/common/and-call.ts

@@ -0,0 +1,19 @@
+import { FnLike } from '@seedcompany/common';
+import { isPromise } from 'node:util/types';
+import { ConditionalKeys } from 'type-fest';
+
+export const andCall = <
+  T,
+  K extends ConditionalKeys<T, FnLike>,
+  X extends T[K] & FnLike,
+>(
+  thing: T,
+  methodName: K,
+  add: X,
+) => {
+  const orig = (thing[methodName] as FnLike).bind(thing);
+  (thing[methodName] as FnLike) = () => {
+    const res = orig();
+    return isPromise(res) ? res.then((x) => add(x)) : add(res);
+  };
+};

src/common/index.ts

@@ -1,5 +1,6 @@
 export { Many, many, maybeMany, JsonSet, ArrayItem } from '@seedcompany/common';
 
+export * from './and-call';
 export * from './temporal';
 export * from './calculated.decorator';
 export * from './context.type';

test/utility/create-app.ts

@@ -1,13 +1,15 @@
 import { faker } from '@faker-js/faker';
 import { INestApplication } from '@nestjs/common';
 import { Test } from '@nestjs/testing';
+import { andCall } from '~/common';
 import { AppModule } from '../../src/app.module';
 import { LogLevel } from '../../src/core/logger';
 import { LevelMatcher } from '../../src/core/logger/level-matcher';
 import {
   createGraphqlClient,
   GraphQLTestClient,
 } from './create-graphql-client';
+import { ephemeralEdgeDB } from './edgedb-setup';
 
 // Patch faker email to be more unique
 const origEmail = faker.internet.email.bind(faker.internet);
@@ -19,16 +21,29 @@ export interface TestApp extends INestApplication {
 }
 
 export const createTestApp = async () => {
-  const moduleFixture = await Test.createTestingModule({
-    imports: [AppModule],
-  })
-    .overrideProvider(LevelMatcher)
-    .useValue(new LevelMatcher([], LogLevel.ERROR))
-    .compile();
+  const db = await ephemeralEdgeDB();
 
-  const app = moduleFixture.createNestApplication<TestApp>();
-  await app.init();
-  app.graphql = await createGraphqlClient(app);
+  try {
+    const moduleFixture = await Test.createTestingModule({
+      imports: [AppModule],
+    })
+      .overrideProvider(LevelMatcher)
+      .useValue(new LevelMatcher([], LogLevel.ERROR))
+      .overrideProvider('EDGEDB_CONNECT')
+      .useValue(db?.options)
+      .compile();
 
-  return app;
+    const app = moduleFixture.createNestApplication<TestApp>();
+    await app.init();
+    app.graphql = await createGraphqlClient(app);
+
+    andCall(app, 'close', async () => {
+      await db?.cleanup();
+    });
+
+    return app;
+  } catch (e) {
+    await db?.cleanup();
+    throw e;
+  }
 };

test/utility/edgedb-setup.ts

@@ -0,0 +1,47 @@
+import { Client, ConnectOptions, createClient } from 'edgedb';
+import { DateTime } from 'luxon';
+
+export const ephemeralEdgeDB = async () => {
+  if (process.env.DATABASE !== 'edgedb') {
+    return undefined;
+  }
+
+  const db = createClient();
+
+  await dropStale(db);
+
+  const branch = `test_${Date.now()}`;
+
+  await db.execute(`create schema branch ${branch} from main`);
+
+  const cleanup = async () => {
+    await db.execute(`drop branch ${branch}`);
+    await db.close();
+  };
+
+  const options: ConnectOptions = { branch };
+
+  return { options, cleanup };
+};
+
+async function dropStale(db: Client) {
+  const branches = await db.query<string>('select sys::Database.name');
+
+  const stale = branches.flatMap((name) => {
+    if (!name.startsWith('test_')) {
+      return [];
+    }
+    const ts = Number(name.slice(5));
+    if (isNaN(ts)) {
+      return [];
+    }
+    const createdAt = DateTime.fromMillis(ts);
+    return createdAt.diffNow().as('hours') > 4 ? name : [];
+  });
+  if (stale.length === 0) {
+    return;
+  }
+  await db.execute('drop branch array_unpack(<array<string>>$branches)', {
+    branches: stale,
+  });
+}