@pgflow/core 0.0.5-prealpha.2

package/supabase/tests/start_flow/creates_step_states_for_all_steps.test.sql

@@ -0,0 +1,25 @@
+begin;
+select plan(2);
+select pgflow_tests.reset_db();
+select pgflow_tests.setup_flow('sequential');
+select pgflow_tests.setup_flow('sequential_other');
+
+-- SETUP: Start a flow run
+select pgflow.start_flow('sequential', '"hello"'::jsonb);
+
+-- TEST: All step states from flow should be created
+select set_eq(
+  $$ SELECT step_slug
+       FROM pgflow.step_states WHERE flow_slug = 'sequential' $$,
+  array['first', 'second', 'last']::text [],
+  'All step states from flow should be created'
+);
+
+-- TEST: No steps from other flows should be created
+select is_empty(
+  $$ SELECT * FROM pgflow.step_states WHERE flow_slug <> 'sequential' $$,
+  'No steps from other flows should be created'
+);
+
+select finish();
+rollback;

package/supabase/tests/start_flow/creates_step_tasks_only_for_root_steps.test.sql

@@ -0,0 +1,54 @@
+begin;
+select plan(5);
+select pgflow_tests.reset_db();
+select pgflow_tests.setup_flow('two_roots');
+
+select pgflow.start_flow('two_roots', '"hello"'::jsonb);
+
+-- TEST: A step_task record should be created only for the root step
+select is(
+  (
+    select
+      array_agg(
+        step_slug
+        order by step_slug
+      )
+    from pgflow.step_tasks
+    where flow_slug = 'two_roots'
+  ),
+  array['root_a', 'root_b']::text [],
+  'A step_task record should be created for each root step'
+);
+
+-- TEST: Two messages should be in the queue, one per each root step
+select is(
+  (select count(*)::int from pgmq.q_two_roots),
+  2::int,
+  'Two messages should be in the queue, one per each root step'
+);
+
+-- TEST; Messages have appropriate flow slugs
+select is(
+  (select array_agg(message ->> 'flow_slug') from pgmq.q_two_roots),
+  array['two_roots', 'two_roots'],
+  'Messages have appropriate flow slugs'
+);
+
+-- TEST: Messages have appropriate step slugs
+select is(
+  (select array_agg(message ->> 'step_slug') from pgmq.q_two_roots),
+  array['root_a', 'root_b']::text [],
+  'Messages have appropriate step slugs'
+);
+
+select is(
+  (select array_agg(message ->> 'run_id') from pgmq.q_two_roots),
+  (
+    select array_agg(run_id::text) from pgflow.step_tasks
+    where flow_slug = 'two_roots'
+  ),
+  'Messages have appropriate run_ids'
+);
+
+select finish();
+rollback;

package/supabase/tests/start_flow/returns_run.test.sql

@@ -0,0 +1,24 @@
+begin;
+select plan(2);
+select pgflow_tests.reset_db();
+select pgflow_tests.setup_flow('sequential');
+select pgflow_tests.setup_flow('two_roots');
+
+-- TEST: start_flow() returns started step states
+select results_eq(
+  $$ SELECT flow_slug, status, input
+       FROM pgflow.start_flow('sequential', '"hello"'::jsonb) $$,
+  $$ VALUES ('sequential', 'started', '"hello"'::jsonb) $$,
+  'start_flow() should return a run'
+);
+
+-- TEST: start_flow() returns started step states
+select results_eq(
+  $$ SELECT flow_slug, status, input
+       FROM pgflow.start_flow('sequential', '"world"'::jsonb) $$,
+  $$ VALUES ('sequential', 'started', '"world"'::jsonb) $$,
+  'start_flow() should return a single run even for flow that have two root steps'
+);
+
+select finish();
+rollback;

package/supabase/tests/start_flow/sends_messages_on_the_queue.test.sql

@@ -0,0 +1,50 @@
+begin;
+select plan(2);
+select pgflow_tests.reset_db();
+select pgflow_tests.setup_flow('sequential');
+
+select pgflow.start_flow('sequential', '"hello"'::jsonb);
+
+-- TEST: A step_task record should be created only for the root step
+select is(
+  (
+    select
+      array_agg(
+        step_slug
+        order by step_slug
+      )
+    from pgflow.step_tasks
+    where flow_slug = 'sequential'
+  ),
+  array['first']::text [],
+  'A step_task record should be created only for the root step'
+);
+
+-- TEST: The message in the queue should contain the correct step info
+select is(
+  (
+    select q.message
+    from pgflow.step_tasks as st
+      inner join pgmq.q_sequential as q
+        on st.message_id = q.msg_id
+    where
+      st.flow_slug = 'sequential'
+      and st.step_slug = 'first'
+  ),
+  jsonb_build_object(
+    'flow_slug', 'sequential',
+    'run_id', (
+      select run_id
+      from pgflow.step_tasks
+      where
+        flow_slug = 'sequential'
+        and step_slug = 'first'
+    ),
+    'step_slug', 'first',
+    'task_index', 0
+  ),
+  'The message in the queue should contain the correct step info'
+);
+
+select finish();
+rollback;

package/supabase/tests/start_flow/starts_only_root_steps.test.sql

@@ -0,0 +1,21 @@
+begin;
+select plan(1);
+select pgflow_tests.reset_db();
+select pgflow_tests.setup_flow('sequential');
+
+-- SETUP: Start a flow run
+select pgflow.start_flow('sequential', '"hello"'::jsonb);
+
+-- TEST: Only root steps should be started
+--       (Root steps are steps with no dependencies)
+select results_eq(
+  $$ SELECT step_slug
+       FROM pgflow.step_states
+       WHERE flow_slug = 'sequential'
+       AND status = 'started' $$,
+  $$ VALUES ('first') $$,
+  'Only root steps should be started'
+);
+
+select finish();
+rollback;

package/supabase/tests/step_dsl_is_idempotent.test.sql

@@ -0,0 +1,34 @@
+begin;
+select plan(2);
+select pgflow_tests.reset_db();
+
+-- Create a simple flow first
+select pgflow.create_flow('test_flow');
+select pgflow.add_step('test_flow', 'step_one');
+select pgflow.add_step('test_flow', 'step_two', array['step_one']);
+select
+  pgflow.add_step('test_flow', 'step_three', array['step_one', 'step_two']);
+
+-- Run the same flow creation and step addition sequence again to verify those are idempotent
+select pgflow.create_flow('test_flow');
+select pgflow.add_step('test_flow', 'step_one');
+select pgflow.add_step('test_flow', 'step_two', array['step_one']);
+select
+  pgflow.add_step('test_flow', 'step_three', array['step_one', 'step_two']);
+
+-- Check the state after first sequence
+select results_eq(
+  $$ SELECT step_slug FROM pgflow.steps WHERE flow_slug = 'test_flow' ORDER BY step_slug $$,
+  array['step_one', 'step_three', 'step_two']::text [],
+  'No duplicated steps were created'
+);
+
+-- Verify the state hasn't changed
+select results_eq(
+  $$ SELECT DISTINCT flow_slug FROM pgflow.flows $$,
+  array['test_flow']::text [],
+  'No duplicated flows were created'
+);
+
+select * from finish();
+rollback;

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "../dsl"
+    },
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ]
+}

package/tsconfig.lib.json

@@ -0,0 +1,26 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "tsBuildInfoFile": "dist/tsconfig.lib.tsbuildinfo",
+    "emitDeclarationOnly": false,
+    "types": ["node", "vite/client"],
+    "allowImportingTsExtensions": true
+  },
+  "include": ["src/**/*.ts"],
+  "references": [{ "path": "../dsl/tsconfig.lib.json" }],
+  "exclude": [
+    "vite.config.ts",
+    "vite.config.mts",
+    "vitest.config.ts",
+    "vitest.config.mts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.test.tsx",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.js",
+    "src/**/*.spec.js",
+    "src/**/*.test.jsx",
+    "src/**/*.spec.jsx"
+  ]
+}

package/tsconfig.spec.json

@@ -0,0 +1,35 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "./out-tsc/vitest",
+    "types": [
+      "vitest/globals",
+      "vitest/importMeta",
+      "vite/client",
+      "node",
+      "vitest"
+    ],
+    "allowImportingTsExtensions": true
+  },
+  "include": [
+    "vite.config.ts",
+    "vite.config.mts",
+    "vitest.config.ts",
+    "vitest.config.mts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.test.tsx",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.js",
+    "src/**/*.spec.js",
+    "src/**/*.test.jsx",
+    "src/**/*.spec.jsx",
+    "src/**/*.d.ts",
+    "__tests__/**/*.ts"
+  ],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    }
+  ]
+}

package/vite.config.ts

@@ -0,0 +1,57 @@
+/// <reference types='vitest' />
+import { defineConfig } from 'vite';
+import dts from 'vite-plugin-dts';
+import * as path from 'path';
+import tsconfigPaths from 'vite-tsconfig-paths';
+
+export default defineConfig({
+  root: __dirname,
+  cacheDir: '../../node_modules/.vite/pkgs/core',
+  plugins: [
+    tsconfigPaths(),
+    dts({
+      entryRoot: 'src',
+      tsconfigPath: path.join(__dirname, 'tsconfig.lib.json'),
+    }),
+  ],
+  // Uncomment this if you are using workers.
+  // worker: {
+  //  plugins: [ nxViteTsPaths() ],
+  // },
+  // Configuration for building your library.
+  // See: https://vitejs.dev/guide/build.html#library-mode
+  build: {
+    outDir: './dist',
+    emptyOutDir: true,
+    reportCompressedSize: true,
+    commonjsOptions: {
+      transformMixedEsModules: true,
+    },
+    lib: {
+      // Could also be a dictionary or array of multiple entry points.
+      entry: 'src/index.ts',
+      name: 'core',
+      fileName: 'index',
+      // Change this to the formats you want to support.
+      // Don't forget to update your package.json as well.
+      formats: ['es'],
+    },
+    rollupOptions: {
+      // External packages that should not be bundled into your library.
+      external: [],
+    },
+  },
+  test: {
+    watch: false,
+    globals: true,
+    environment: 'node',
+    include: [
+      '{src,__tests__}/**/*.{test,spec,test-d,spec-d}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}',
+    ],
+    reporters: ['default'],
+    coverage: {
+      reportsDirectory: './test-output/vitest/coverage',
+      provider: 'v8',
+    },
+  },
+});