@effectstream/db-emulator 0.100.0

package/README.md

@@ -0,0 +1,34 @@
+# @effectstream/db-emulator
+
+Database emulation utilities for Effectstream development and testing.
+
+## Purpose
+
+This package provides utilities for applying database migrations in test
+environments and during development. It was separated from `@effectstream/db` to break
+the circular dependency between `@effectstream/db` and `@effectstream/sm`.
+
+## Dependencies
+
+- `@effectstream/db` - Core database functionality
+- `@effectstream/sm` - State machine primitives (for built-in primitives map)
+
+## Usage
+
+```typescript
+import { getConnection } from "@effectstream/db";
+import { standAloneApplyMigrations } from "@effectstream/db-emulator";
+
+const db = await getConnection();
+await standAloneApplyMigrations(
+  db,
+  migrationTable,
+  localhostConfig,
+  userDefinedPrimitives, // optional
+);
+```
+
+## Note
+
+This is primarily a development/testing utility. Production applications
+typically use the migration system directly through `@effectstream/db`.

package/mod.ts

@@ -0,0 +1 @@
+export { standAloneApplyMigrations } from "./patch-emulator.ts";

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@effectstream/db-emulator",
+  "version": "0.100.0",
+  "license": "MIT",
+  "exports": {
+    ".": "./mod.ts"
+  },
+  "dependencies": {
+    "@pgtyped/runtime": "2.4.2",
+    "pg": "^8.14.0",
+    "effection": "^3.5.0"
+  }
+}

package/patch-emulator.ts

@@ -0,0 +1,88 @@
+import { run } from "effection";
+import { createDynamicTables } from "@effectstream/db";
+import type { Client } from "pg";
+import { applyMigrations } from "@effectstream/db/version";
+import type { SyncProtocolWithNetwork } from "@effectstream/config";
+import { builtInPrimitivesMap } from "@effectstream/sm";
+
+/**
+ * This is to generate the user/custom pgtyped files in compilation time
+ * MIGRATIONS environment variable is used to specify the path to the migrations folder.
+ * Every file in the migrations folder is executed in order.
+ * TODO: Implement how to manage the order of the migrations, e.g. 1.sql, 2.sql, 10.sql, etc.
+ */
+
+export async function standAloneApplyMigrations(
+  db: Client,
+  migrationTable: /*DBMigrations[]*/ any[],
+  localhostConfig: SyncProtocolWithNetwork,
+  userDefinedPrimitives?: Record<string, any>,
+) {
+  const l: SyncProtocolWithNetwork = localhostConfig as any;
+  const config = Object.entries(l.primitives).map(
+    ([key, value]: [string, any]) => {
+      const primitiveType = value.primitive.type;
+      const primitiveUniqueName = value.primitive.name;
+      const primitiveConfig = value.primitive;
+      const isBuiltInPrimitive = primitiveType in builtInPrimitivesMap;
+      const isUserDefinedPrimitive = userDefinedPrimitives &&
+        (primitiveType in userDefinedPrimitives);
+      const classConfig = {
+        ...primitiveConfig,
+        instanceName: primitiveUniqueName,
+      };
+      if (isBuiltInPrimitive) {
+        new builtInPrimitivesMap[
+          primitiveType as keyof typeof builtInPrimitivesMap
+        ](classConfig as any);
+      } else if (isUserDefinedPrimitive) {
+        new userDefinedPrimitives[
+          primitiveType as keyof typeof userDefinedPrimitives
+        ](classConfig);
+      } else {
+        console.error(
+          "userDefinedPrimitives",
+          userDefinedPrimitives,
+          primitiveType,
+        );
+        throw new Error(`Primitive ${primitiveType} not found`);
+      }
+
+      return {
+        config: {
+          primitives: [{
+            primitive: {
+              type: value.primitive.type,
+              name: value.primitive.name,
+            },
+          }],
+        },
+      };
+    },
+  );
+
+  await run(function* () {
+    return yield* createDynamicTables(
+      {
+        engine_current_version: "0.0.0",
+        engine_previous_version: "0.0.0",
+        app_previous_version: "0.0.0",
+        is_empty: true,
+      },
+      0,
+      db,
+      config as any,
+    );
+  });
+  const migrations = migrationTable;
+
+  for (const migration of migrations) {
+    await applyMigrations(
+      db,
+      0,
+      migration.name,
+      migration.sql,
+      false,
+    );
+  }
+}