Rename + readme example (#3)

* Rename + readme example

* Reduce performance requirements

* Fix ci pnpm cache

* Init changeset

* Add ci/cd

* Fix cd

* rename

* Fix cicd

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.changeset/good-seahorses-wave.md

@@ -0,0 +1,5 @@
+---
+'pg-task': patch
+---
+
+Add initial version

.github/workflows/ci.yml

@@ -0,0 +1,57 @@
+name: integration
+
+on:
+  workflow_call:
+  pull_request:
+    branches:
+      - "main"
+    paths-ignore:
+      - 'docs/**'
+      - 'example/**'
+      - '**/*.md'
+
+jobs:
+  # Label of the container job
+  test:
+    # Containers must run in Linux based operating systems
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x, 20.x]
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        id: setup-node
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 8
+
+      # See https://github.com/actions/setup-node/issues/641#issuecomment-1358859686
+      - name: pnpm cache path
+        id: pnpm-cache-path
+        run: |
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+      - name: pnpm cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.pnpm-cache-path.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-${{ steps.setup-node.outputs.node-version }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ steps.setup-node.outputs.node-version }}-pnpm-store-
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+      - name: typecheck
+        run: pnpm run typecheck
+      - name: test
+        run: pnpm run test
+      - name: ✅ Upload coverage to Codecov
+        uses: codecov/codecov-action@v3

.github/workflows/cicd.yml

@@ -0,0 +1,55 @@
+name: cicd
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+jobs:
+  test:
+    uses: ./.github/workflows/ci.yml
+  release:
+    name: Release
+    needs: test
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      contents: write
+      packages: write
+      pull-requests: write
+      issues: read
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        id: setup-node
+        with:
+          node-version: 20.x
+      - name: Install pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 8
+          # See https://github.com/actions/setup-node/issues/641#issuecomment-1358859686
+      - name: pnpm cache path
+        id: pnpm-cache-path
+        run: |
+          echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
+
+      - name: pnpm cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.pnpm-cache-path.outputs.STORE_PATH }}
+          key: ${{ runner.os }}-${{ steps.setup-node.outputs.node-version }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ steps.setup-node.outputs.node-version }}-pnpm-store-
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Create Release Pull Request
+        uses: changesets/action@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,3 +1,50 @@
 # pg-task
 
 A SQS like solution build on top of Postgres and NodeJS.
+
+## Usage
+
+```
+npm install pg-task
+```
+
+```typescript
+import { createManager, executeQuery, createPlans, createTaskQueueFactory } from 'pg-task';
+import { Pool } from 'pg';
+
+const pool = new Pool({});
+
+const manager = createManager({
+  pgClient: pool,
+  schema,
+});
+await manager.start();
+
+// Register a worker for `worker-queue` task queue
+const workerId = await manager.work<MyTask>({
+  queue: 'worker-queue',
+  async handler(data) {
+    await Promise.resolve();
+  },
+});
+
+// enqueue tasks
+const plans = createPlans(schema);
+const taskFactory = createTaskQueueFactory('worker-queue');
+await executeQuery(
+  pool,
+  plans.enqueueTasks(
+    taskFactory([
+      {
+        data: { somepayload: 'test' },
+      },
+      {
+        data: { somepayload: 'test' },
+      },
+    ])
+  )
+);
+
+// On application shutdown
+await manager.stop();
+```

src/index.ts

@@ -10,4 +10,12 @@ export {
   type TaskResult,
   type TaskResultState,
 } from './task';
+export {
+  executeQuery,
+  type Pool,
+  type ClientFromPool,
+  type QueryClient,
+  type TypedQuery,
+  type QueryResultRow,
+} from './utils/sql';
 export default createManager;

src/maintaince.ts

@@ -57,7 +57,7 @@ export const createMaintainceWorker = async (pool: Pool, schema: string, options
         // complete this task, and reschedule it in future
         await transactionExecutor(plans.resolveTasks([{ task_id: id, result: data, state: TaskResultStates.success }]));
         await transactionExecutor(
-          plans.createTasks(
+          plans.enqueueTasks(
             taskFactory([
               {
                 data: null,
@@ -73,7 +73,7 @@ export const createMaintainceWorker = async (pool: Pool, schema: string, options
 
   // ensure we try to create the maintaince tasks always
   await executor(
-    plans.createTasks(
+    plans.enqueueTasks(
       taskFactory([
         {
           data: null,

src/manager.spec.ts

@@ -73,7 +73,7 @@ describe('pg worker', () => {
 
     await executeQuery(
       pool,
-      plans.createTasks([
+      plans.enqueueTasks([
         {
           data: { nosmoke: true },
           expireInSeconds: 1,
@@ -94,6 +94,6 @@ describe('pg worker', () => {
     await manager.stop();
 
     // we should not have any pending tasks left
-    await expect(executeQuery(pool, plans.getAndStartTasks(queue, 100))).resolves.toHaveLength(0);
+    await expect(executeQuery(pool, plans.popTasks(queue, 100))).resolves.toHaveLength(0);
   });
 });