consumer-pgmq 1.0.0 → 1.0.1

package/README.md

@@ -28,4 +28,191 @@ npm install consumer-pgmq
 yarn add consumer-pgmq
 ```
 
+## Options
+
+- queueName: The name of the queue. 
+- visibilityTime: The time in seconds that the message will be invisible to other consumers. PS: 
+    - Your handler must finish in this time or the message will be visible again to other consumers.
+    - Is used too to abort the message if the handler takes too long to finish. For example, if you set visibilityTime to 15 seconds and your handler didnt finish in 15 seconds the handler will be aborted and the message will be visible again to other consumers.
+- consumeType: The type of consume. Can be "read" or "pop"
+    - Read consume type is when the consumer gets the message and the message is not deleted from queue until the callback is executed with success. 
+    - Pop consume type is when the consumer gets the message and delete from queue in the moment get the message.
+- poolSize: The number of consumers. PS: this is the number of consumers that will be created to consume the messages and 
+if you use read consume type, the pool size is the number of messages will get at the same time.
+- timeMsWaitBeforeNextPolling: The time in milliseconds to wait before the next polling
+
+## Events
+
+- finish: When the message is consumed with success
+- abort-error: When the message is aborted
+- error: When an error occurs
+
+## Examples how to use
+
+- Consuming messages from Supabase queue
+```javascript
+import { config } from "dotenv"
+config()
+
+import Consumer from '../src/consumer';
+import { createClient, SupabaseClient } from '@supabase/supabase-js';
+import SupabaseQueueDriver from '../src/queueDriver/SupabaseQueueDriver';
+
+
+const supabase = createClient(
+    // @ts-ignore
+    process.env.SUPABASE_URL,
+    process.env.SUPABASE_ANON_KEY,
+    {
+        db: {
+            schema: 'pgmq_public'
+        }
+    }
+);
+
+const supabaseQueueDriver = new SupabaseQueueDriver(
+    supabase as unknown as SupabaseClient
+)
+
+
+import timersPromises from "node:timers/promises";
+
+async function start() {
+    for (let i = 0; i < 200; i++) {
+        await supabase.rpc("send", {
+            queue_name: "subscriptions",
+            message: { "message": `Message triggered at ${Date.now()}` }
+        });
+    }
+    console.log("Total messages sent: ", 200)
+
+    const consumer = new Consumer(
+        {
+            queueName: 'subscriptions',
+            visibilityTime: 15,
+            consumeType: "read",
+            poolSize: 4,
+            timeMsWaitBeforeNextPolling: 1000
+        },
+        async function (message: { [key: string]: any }, signal): Promise<void> {
+            try {
+                console.log(message)
+                const url = "https://jsonplaceholder.typicode.com/todos/1";
+                await timersPromises.setTimeout(100, null, { signal });
+                console.log("Fetching data...");
+                const response = await fetch(url, { signal });
+                const todo = await response.json();
+                console.log("Todo:", todo);
+            } catch (error: any) {
+                if (error.name === "AbortError") {
+                    console.log("Operation aborted");
+                } else {
+                    console.error("Error:", error);
+                }
+            }
+        },
+        supabaseQueueDriver
+    );
+
+    consumer.on('finish', (message: { [key: string]: any }) => {
+        console.log('Consumed message =>', message);
+    });
+
+    consumer.on("abort-error", (err) => {
+        console.log("Abort error =>", err)
+    })
+
+    consumer.on('error', (err: Error) => {
+        if (err.message.includes("TypeError: fetch failed")) {
+            console.log(err)
+            process.exit(1);
+        }
+        console.error('Error consuming message:', err.message);
+    });
+
+    consumer.start();
+
+}
+
+start()
+```
+
+- Consuming messages from Postgresql queue
+```javascript
+import { config } from "dotenv"
+config()
+
+import Consumer from '../src/consumer';
+import PostgresQueueDriver from '../src/queueDriver/PostgresQueueDriver';
+import timersPromises from "node:timers/promises";
+import knex from 'knex'
+
+async function start() {
+    const connection = knex({
+        client: 'pg',
+        connection: {
+            host: process.env.POSTGRES_HOST,
+            database: process.env.POSTGRES_DATABASE,
+            password: process.env.POSTGRES_PASSWORD,
+            port: Number(process.env.POSTGRES_PORT),
+            user: process.env.POSTGRES_USER,
+            ssl: false
+        }
+    });
+
+    const postgresQueueDriver = new PostgresQueueDriver(connection)
+
+    const consumer = new Consumer(
+        {
+            queueName: 'subscriptions',
+            visibilityTime: 15,
+            consumeType: "read",
+            poolSize: 4,
+            timeMsWaitBeforeNextPolling: 1000
+        },
+        async function (message: { [key: string]: any }, signal): Promise<void> {
+            try {
+                console.log(message)
+                const url = "https://jsonplaceholder.typicode.com/todos/1";
+                await timersPromises.setTimeout(100, null, { signal });
+                console.log("Fetching data...");
+                const response = await fetch(url, { signal });
+                const todo = await response.json();
+                console.log("Todo:", todo);
+            } catch (error: any) {
+                if (error.name === "AbortError") {
+                    console.log("Operation aborted");
+                } else {
+                    console.error("Error:", error);
+                }
+            }
+        },
+        postgresQueueDriver
+    );
+
+    consumer.on('finish', (message: { [key: string]: any }) => {
+        console.log('Consumed message =>', message);
+    });
+
+    consumer.on("abort-error", (err) => {
+        console.log("Abort error =>", err)
+    })
+
+    consumer.on('error', (err: Error) => {
+        if (err.message.includes("TypeError: fetch failed")) {
+            console.log(err)
+            process.exit(1);
+        }
+        console.error('Error consuming message:', err.message);
+    });
+
+    consumer.start();
+
+}
+
+start()
+```
+
+
+
 

package/examples/consumerPostgresDriver.ts

@@ -15,11 +15,11 @@ async function start() {
             password: process.env.POSTGRES_PASSWORD,
             port: Number(process.env.POSTGRES_PORT),
             user: process.env.POSTGRES_USER,
-            ssl: false
+            ssl: false,
         }
     });
 
-    const postgresQueueDriver = new PostgresQueueDriver(connection)
+    const postgresQueueDriver = new PostgresQueueDriver(connection, "pgmq")
 
     const consumer = new Consumer(
         {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "consumer-pgmq",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "The consumer of Supabase pgmq",
   "main": "dist/index.js",
   "type": "commonjs",

package/src/queueDriver/PostgresQueueDriver.ts

@@ -3,8 +3,10 @@ import { Message, QueueDriver } from "../type";
 
 class PostgresQueueDriver implements QueueDriver {
 
+
     constructor(
-        private connection: Knex
+        private connection: Knex,
+        private schema: string = "public"
     ) { }
 
     /**
@@ -17,7 +19,7 @@ class PostgresQueueDriver implements QueueDriver {
     async get(queueName: string, visibilityTime: number, totalMessages: number): Promise<{ data: Message[]; error: any; }> {
         try {
             const register = await this.connection.raw(`
-                SELECT * FROM pgmq.read(
+                SELECT * FROM ${this.schema}.read(
                     queue_name => ?,
                     vt         => ?,
                     qty        => ?
@@ -44,7 +46,7 @@ class PostgresQueueDriver implements QueueDriver {
     async pop(queueName: string): Promise<{ data: Message[]; error: any; }> {
         try {
             const register = await this.connection.raw(`
-                SELECT * FROM pgmq.pop(
+                SELECT * FROM ${this.schema}.pop(
                     queue_name => ?
                 );
                 `, [queueName]
@@ -70,7 +72,7 @@ class PostgresQueueDriver implements QueueDriver {
     async delete(queueName: string, messageID: number): Promise<{ error: any; }> {
         try {
             await this.connection.raw(`
-            SELECT * FROM pgmq.delete(
+            SELECT * FROM ${this.schema}.delete(
                 queue_name => ?,
                 msg_id     => ?
             );