@pepys/testing 0.2.0 → 0.3.1

package/README.md

@@ -25,6 +25,32 @@ bun add -d @pepys/testing
 
 Set the compiler options from the [kit's README](../kit/README.md#configuration).
 
+Then test a query on rows written for the test:
+
+```ts
+import { expect, test } from 'bun:test';
+import type { EntityID } from '@pepys/kit';
+import { createTestStore } from '@pepys/testing';
+import { toTagged } from '@zgeoff/std';
+import { shelfBookConsumer, shelfPlugin, shelfTitleQuery } from './shelf-plugin.ts';
+
+test('it answers a query from rows written for the test', async () => {
+  await using store = await createTestStore({ plugins: [shelfPlugin] });
+
+  await store.writeRows(shelfBookConsumer, 'shelf_book', [
+    { id: toTagged<EntityID>('shelf:book:atlas'), title: 'The Coral Atlas' },
+  ]);
+
+  expect(await store.query(shelfTitleQuery, { id: 'shelf:book:atlas' })).toStrictEqual({
+    title: 'The Coral Atlas',
+  });
+});
+```
+
+```sh
+bun test
+```
+
 ## Features
 
 - `createTestStore`: apply facts or write rows, then run a query, read rows and read links.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pepys/testing",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Test a pepys plug-in on Bun: an in-memory store that runs its consumers and queries",
   "license": "MIT",
   "repository": {
@@ -19,9 +19,9 @@
     "access": "public"
   },
   "dependencies": {
-    "@pepys/ingest": "0.2.0",
-    "@pepys/kit": "0.2.0",
-    "@pepys/kysely-turso": "0.2.0",
+    "@pepys/ingest": "0.3.1",
+    "@pepys/kit": "0.3.1",
+    "@pepys/kysely-turso": "0.3.1",
     "@tursodatabase/database": "0.8.3",
     "kysely": "0.29.8",
     "tiny-invariant": "1.3.3",

package/src/fact-index/collect-scope-facts.ts

@@ -1,4 +1,4 @@
-import type { FactEnvelope } from '@pepys/kit';
+import type { EntityID, FactEnvelope } from '@pepys/kit';
 import { compareCodePoints } from '../utils/compare-code-points.ts';
 import type { FactIndex } from './types.ts';
 
@@ -6,7 +6,7 @@ import type { FactIndex } from './types.ts';
 // ID, sorted by time, then stream, then sequence number.
 export function collectScopeFacts(
   index: FactIndex,
-  scope: string,
+  scope: EntityID,
   streams: readonly string[],
 ): FactEnvelope<unknown>[] {
   return [...index.firstCopies.values()]

package/src/fact-index/types.ts

@@ -1,4 +1,4 @@
-import type { FactEnvelope } from '@pepys/kit';
+import type { FactEnvelope, FactID } from '@pepys/kit';
 
 // One record of the test store's log: a fact in its stream, at its sequence number.
 export interface LoggedFact {
@@ -11,5 +11,5 @@ export interface LoggedFact {
 // fact ID, and a module reads synchronously, so the test store keeps the index out of the database.
 export interface FactIndex {
   log: readonly LoggedFact[];
-  firstCopies: ReadonlyMap<string, LoggedFact>;
+  firstCopies: ReadonlyMap<FactID, LoggedFact>;
 }

package/src/links/remove-link.ts

@@ -1,16 +1,26 @@
+import { isEntityID } from '@pepys/kit';
 import type { StoreDatabase } from '../store-database/types.ts';
 import type { WireLink } from '../utils/types.ts';
 
+// No check runs on an unlink, and a stored link always joins two entity IDs, so an end that is no
+// entity ID matches no link.
 export async function removeLink(
   db: StoreDatabase,
   origin: string,
   link: Pick<WireLink, 'type' | 'from' | 'to'>,
 ): Promise<void> {
+  const from = link.from;
+  const to = link.to;
+
+  if (!isEntityID(from) || !isEntityID(to)) {
+    return;
+  }
+
   await db
     .deleteFrom('link')
     .where('origin', '=', origin)
     .where('type', '=', link.type)
-    .where('from_id', '=', link.from)
-    .where('to_id', '=', link.to)
+    .where('from_id', '=', from)
+    .where('to_id', '=', to)
     .execute();
 }

package/src/links/write-link.ts

@@ -1,20 +1,28 @@
+import { isEntityID } from '@pepys/kit';
+import type { EntityID } from '@pepys/kit';
+import invariant from 'tiny-invariant';
 import type { StoreDatabase } from '../store-database/types.ts';
 import type { WireLink } from '../utils/types.ts';
 
 // Writes the link of `origin`, the consumer's name, with the scope that owns it, or null in fact
-// mode.
+// mode. The link has passed the link check.
 export async function writeLink(
   db: StoreDatabase,
   origin: string,
-  scope: string | null,
+  scope: EntityID | null,
   link: WireLink,
 ): Promise<void> {
+  const from = link.from;
+  const to = link.to;
+
+  invariant(isEntityID(from) && isEntityID(to), 'a checked link joins two entity IDs');
+
   await db
     .replaceInto('link')
     .values({
       type: link.type,
-      from_id: link.from,
-      to_id: link.to,
+      from_id: from,
+      to_id: to,
       scope,
       origin,
       confidence: link.confidence,

package/src/scope-replace/pick-scope-changes.ts

@@ -1,4 +1,4 @@
-import type { Result } from '@pepys/kit';
+import type { EntityID, Result } from '@pepys/kit';
 import { compareCodePoints } from '../utils/compare-code-points.ts';
 import type { ApplyFailure, ChangeEntry, WireLink } from '../utils/types.ts';
 import { buildLinkKey } from './build-link-key.ts';
@@ -10,7 +10,7 @@ import type { KeyedRow, ScopeChanges, ScopeResult, ScopeState } from './types.ts
 // entries come as rows written, links written, rows deleted, links deleted, each in key order.
 export function pickScopeChanges(
   consumer: string,
-  scope: string,
+  scope: EntityID,
   result: ScopeResult,
   state: ScopeState,
 ): Result<ScopeChanges, ApplyFailure> {
@@ -89,7 +89,7 @@ function compareKeys(left: readonly string[], right: readonly string[]): number
 
 function findConflict(
   consumer: string,
-  scope: string,
+  scope: EntityID,
   result: ScopeResult,
   state: ScopeState,
 ): ApplyFailure | undefined {

package/src/scope-replace/read-scope-state.ts

@@ -1,4 +1,4 @@
-import type { ConsumerDeclaration } from '@pepys/kit';
+import type { ConsumerDeclaration, EntityID } from '@pepys/kit';
 import { readLinkRows } from '../links/read-link-rows.ts';
 import { readTableRows } from '../rows/read-table-rows.ts';
 import type { StoreDatabase } from '../store-database/types.ts';
@@ -10,7 +10,7 @@ import type { ScopeResult, ScopeState, StoredLink } from './types.ts';
 export async function readScopeState(
   db: StoreDatabase,
   consumer: ConsumerDeclaration,
-  scope: string,
+  scope: EntityID,
   result: ScopeResult,
 ): Promise<ScopeState> {
   const owned = await db

package/src/scope-replace/replace-scope.ts

@@ -1,4 +1,4 @@
-import type { ConsumerDeclaration } from '@pepys/kit';
+import type { ConsumerDeclaration, EntityID } from '@pepys/kit';
 import { parseOperations } from '../operations/parse-operations.ts';
 import type { StoreDatabase } from '../store-database/types.ts';
 import { ApplyError } from '../utils/apply-error.ts';
@@ -13,7 +13,7 @@ import { writeScopeChanges } from './write-scope-changes.ts';
 export async function replaceScope(
   db: StoreDatabase,
   consumer: ConsumerDeclaration,
-  scope: string,
+  scope: EntityID,
   output: string,
 ): Promise<readonly ChangeEntry[]> {
   const operations = parseOperations(consumer, output);

package/src/scope-replace/types.ts

@@ -1,3 +1,4 @@
+import type { EntityID } from '@pepys/kit';
 import type { ChangeEntry, Row, WireLink } from '../utils/types.ts';
 
 export interface KeyedRow {
@@ -13,7 +14,7 @@ export interface ScopeResult {
 }
 
 export interface StoredLink {
-  scope: string | null;
+  scope: EntityID | null;
   link: WireLink;
 }
 
@@ -21,7 +22,7 @@ export interface StoredLink {
 // `buildRowID`, links by the JSON text of their key.
 export interface ScopeState {
   // the scope of each row that a scope owns
-  rowOwners: ReadonlyMap<string, string>;
+  rowOwners: ReadonlyMap<string, EntityID>;
 
   // the stored row of each key that the result names or that the scope owns
   storedRows: ReadonlyMap<string, Row>;

package/src/scope-replace/write-scope-changes.ts

@@ -1,4 +1,4 @@
-import type { ConsumerDeclaration } from '@pepys/kit';
+import type { ConsumerDeclaration, EntityID } from '@pepys/kit';
 import { removeLink } from '../links/remove-link.ts';
 import { writeLink } from '../links/write-link.ts';
 import { removeRow } from '../rows/remove-row.ts';
@@ -9,7 +9,7 @@ import type { ScopeChanges } from './types.ts';
 export async function writeScopeChanges(
   db: StoreDatabase,
   consumer: ConsumerDeclaration,
-  scope: string,
+  scope: EntityID,
   changes: ScopeChanges,
 ): Promise<void> {
   for (const row of changes.writtenRows) {

package/src/store-database/types.ts

@@ -1,4 +1,4 @@
-import type { LinkRow, SharedViews } from '@pepys/kit';
+import type { EntityID, LinkRow, SharedViews } from '@pepys/kit';
 import type { Kysely } from 'kysely';
 
 // The tables that the test store keeps beside the consumers' own. The host keeps `link` and
@@ -6,7 +6,7 @@ import type { Kysely } from 'kysely';
 // consumer's name.
 export interface StoreTables extends SharedViews {
   link: LinkRow;
-  scope_row: { consumer: string; table_name: string; key: string; scope: string };
+  scope_row: { consumer: string; table_name: string; key: string; scope: EntityID };
 }
 
 export type StoreDatabase = Kysely<StoreTables>;

package/src/test-store/run-consumers.ts

@@ -1,5 +1,5 @@
 import { parseEntityID } from '@pepys/kit';
-import type { ConsumerDeclaration } from '@pepys/kit';
+import type { ConsumerDeclaration, FactID } from '@pepys/kit';
 import invariant from 'tiny-invariant';
 import { buildReadFunctions } from '../consumer-entries/build-read-functions.ts';
 import { runEntry } from '../consumer-entries/run-entry.ts';
@@ -14,7 +14,7 @@ import { ApplyError } from '../utils/apply-error.ts';
 import { compareCodePoints } from '../utils/compare-code-points.ts';
 
 // The fact IDs each fact-mode consumer has applied, by consumer name.
-export type AppliedFactIDs = ReadonlyMap<string, ReadonlySet<string>>;
+export type AppliedFactIDs = ReadonlyMap<string, ReadonlySet<FactID>>;
 
 interface ConsumerRun {
   index: FactIndex;
@@ -57,8 +57,8 @@ async function runFactConsumer(
   db: StoreDatabase,
   consumer: ConsumerDeclaration,
   facts: readonly LoggedFact[],
-  applied: ReadonlySet<string>,
-): Promise<ReadonlySet<string>> {
+  applied: ReadonlySet<FactID>,
+): Promise<ReadonlySet<FactID>> {
   const seen = new Set(applied);
 
   for (const record of facts) {

package/src/utils/types.ts

@@ -1,4 +1,4 @@
-import type { LinkProblem } from '@pepys/kit';
+import type { EntityID, LinkProblem } from '@pepys/kit';
 
 // Why the test store refused an apply. The kinds from `bad-operation` on are the host's refusals
 // of a module's output, which the scope replace case file names.
@@ -18,10 +18,10 @@ export type ApplyFailure =
   | {
       kind: 'scope-conflict';
       consumer: string;
-      scope: string;
+      scope: EntityID;
       table: string;
       key: string;
-      owner: string | null;
+      owner: EntityID | null;
     };
 
 // A row as the module writes it and as the test store reads it back: booleans as booleans and a