@pingpolls/redisq 0.2.1 → 1.0.0

package/README.md

@@ -26,10 +26,10 @@ bun install @pingpolls/redisq
 ## Quick Start
 
 ```typescript
-import RedisQueue from '@pingpolls/redisq';
+import { RedisQ } from '@pingpolls/redisq';
 
 // Initialize the queue
-const queue = new RedisQueue({
+const queue = new RedisQ({
   host: '127.0.0.1',
   port: '6379',
   namespace: 'myapp'
@@ -73,9 +73,9 @@ Batch queues (suffix `:batch`) collect messages over a time period and process t
 Create a queue service in `src/lib/server/queue.ts`:
 
 ```typescript
-import RedisQueue from '@pingpolls/redisq';
+import { RedisQ } from '@pingpolls/redisq';
 
-export const queue = new RedisQueue({
+export const queue = new RedisQ({
   host: import.meta.env.REDIS_HOST || '127.0.0.1',
   port: import.meta.env.REDIS_PORT || '6379',
   namespace: 'sveltekit-app'
@@ -163,9 +163,9 @@ export async function load() {
 Create queue in `lib/queue.ts`:
 
 ```typescript
-import RedisQueue from '@pingpolls/redisq';
+import { RedisQ } from '@pingpolls/redisq';
 
-export const queue = new RedisQueue({
+export const queue = new RedisQ({
   host: process.env.REDIS_HOST!,
   port: process.env.REDIS_PORT!,
   namespace: 'nextjs-app'
@@ -217,10 +217,10 @@ export async function POST(request: Request) {
 Create queue plugin in `server/plugins/queue.ts`:
 
 ```typescript
-import RedisQueue from '@pingpolls/redisq';
+import { RedisQ } from '@pingpolls/redisq';
 
 export default defineNitroPlugin(async (nitroApp) => {
-  const queue = new RedisQueue({
+  const queue = new RedisQ({
     host: process.env.REDIS_HOST || '127.0.0.1',
     port: process.env.REDIS_PORT || '6379',
     namespace: 'nuxt-app'
@@ -260,11 +260,11 @@ export default defineEventHandler(async (event) => {
 
 ```typescript
 import { Hono } from 'hono';
-import RedisQueue from '@pingpolls/redisq';
+import { RedisQ } from '@pingpolls/redisq';
 
 const app = new Hono();
 
-const queue = new RedisQueue({
+const queue = new RedisQ({
   host: '127.0.0.1',
   port: '6379',
   namespace: 'hono-app'
@@ -329,7 +329,7 @@ export default app;
 ### Constructor
 
 ```typescript
-new RedisQueue(options: QueueOptions)
+new RedisQ(options: QueueOptions)
 ```
 
 **Options:**
@@ -586,11 +586,11 @@ REDIS_TLS=false
 
 ```typescript
 import { describe, test, expect } from 'bun:test';
-import RedisQueue from '@pingpolls/redisq';
+import { RedisQ } from '@pingpolls/redisq';
 
 describe('Queue Tests', () => {
   test('processes messages', async () => {
-    const queue = new RedisQueue({ host: '127.0.0.1', port: '6379' });
+    const queue = new RedisQ({ host: '127.0.0.1', port: '6379' });
     
     await queue.createQueue({ qname: 'test' });
     
@@ -621,16 +621,16 @@ Run the stress test to benchmark on your hardware:
 bun stress
 ```
 
-Individual Queue Performance:
-  - **Tiny messages (100B)**:   47181 msg/s (p50: 49.97ms)
-  - **Small messages (1KB)**:   33709 msg/s (p50: 69.05ms)
-  - **Medium messages (10KB)**:  4056 msg/s (p50: 261.32ms)
-  
-Overall:
-  - **Throughput**: ~28,315 messages/second
-  - **Latency (p50)**: 126.78 ms
-  - **Latency (p95)**: 299.27 ms
-  - **Latency (p99)**: 383.86 ms
+✅ Individual Queue Performance:
+  - **Tiny messages (100B)**:   49,302 msg/s (p50: 49.75ms)
+  - **Small messages (1KB)**:   35,061 msg/s (p50: 74.34ms)
+  - **Medium messages (10KB)**:  9,437 msg/s (p50: 213.58ms)
+
+💡 Overall (Averaged across all tests):
+  - **Throughput**: ~31,267 messages/second
+  - **Latency (p50)**: 112.56 ms
+  - **Latency (p95)**: 312.11 ms
+  - **Latency (p99)**: 676.23 ms
 
 Tested on Dockerized `redis:alpine` through WSL2 with 1 CPU and 1GB instance.
 

package/app.test.ts

@@ -1,5 +1,5 @@
 import { afterAll, describe, expect, test } from "bun:test";
-import RedisQueue from "./app";
+import { RedisQ } from "./app";
 
 const redisConfig = {
     host: process.env.REDIS_HOST || "127.0.0.1",
@@ -16,9 +16,9 @@ const workerConfig = {
  */
 const sleep = (ms: number) => new Promise((resolve) => setTimeout(resolve, ms));
 
-describe("RedisQueue Tests", () => {
+describe("RedisQ Tests", () => {
     test("1. Can send and receive single message", async () => {
-        const queue = new RedisQueue(redisConfig);
+        const queue = new RedisQ(redisConfig);
 
         await queue.createQueue({ qname: "test-basic" });
 
@@ -51,7 +51,7 @@ describe("RedisQueue Tests", () => {
     });
 
     test("2. Can send and receive delayed message", async () => {
-        const queue = new RedisQueue(redisConfig);
+        const queue = new RedisQ(redisConfig);
 
         await queue.createQueue({ qname: "test-delayed" });
 
@@ -97,7 +97,7 @@ describe("RedisQueue Tests", () => {
     });
 
     test("3. Can retry send and receive single message", async () => {
-        const queue = new RedisQueue(redisConfig);
+        const queue = new RedisQ(redisConfig);
 
         await queue.createQueue({
             maxBackoffSeconds: 1,
@@ -141,7 +141,7 @@ describe("RedisQueue Tests", () => {
     });
 
     test("4. Can retry send and receive delayed message", async () => {
-        const queue = new RedisQueue(redisConfig);
+        const queue = new RedisQ(redisConfig);
 
         await queue.createQueue({
             maxBackoffSeconds: 1,
@@ -198,7 +198,7 @@ describe("RedisQueue Tests", () => {
     });
 
     test("5. Can send and receive batched messages (multiple batches in same period)", async () => {
-        const queue = new RedisQueue(redisConfig);
+        const queue = new RedisQ(redisConfig);
 
         /**
          * Create batch queue with 3-second interval
@@ -328,7 +328,7 @@ describe("RedisQueue Tests", () => {
     });
 
     test("6. Can send and receive batched messages with selective retry", async () => {
-        const queue = new RedisQueue(redisConfig);
+        const queue = new RedisQ(redisConfig);
 
         /**
          * Create batch queue with 2-second interval and retry enabled
@@ -509,7 +509,7 @@ describe("RedisQueue Tests", () => {
     test("7. Can handle high volume and concurrency", async () => {
         const totalMessages = 10_000;
 
-        const queue = new RedisQueue(redisConfig);
+        const queue = new RedisQ(redisConfig);
 
         await queue.createQueue({ qname: "test-concurrency" });
 

package/app.ts

@@ -79,7 +79,7 @@ interface StoredBatchMeta {
     attempt: number;
 }
 
-export class RedisQueue {
+export class RedisQ {
     private redis: BunRedisClient;
     private redisUrl: string;
     private ns: string;
@@ -766,4 +766,4 @@ export class RedisQueue {
     }
 }
 
-export default RedisQueue;
+export default { RedisQ };

package/benchmark/stress-worker.ts

@@ -1,4 +1,5 @@
-import RedisQueue from "../app";
+import { RedisQ } from "../app";
+
 declare var self: Worker;
 
 interface WorkerMessage {
@@ -22,7 +23,7 @@ self.addEventListener("message", async (event: MessageEvent<WorkerMessage>) => {
             event.data.data;
 
         try {
-            const queue = new RedisQueue(redisConfig);
+            const queue = new RedisQ(redisConfig);
             const latencies: number[] = [];
             const CHUNK_SIZE = 1000;
 

package/benchmark/stress.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env bun
 
 import type { Worker } from "bun";
-import RedisQueue from "../app";
+import { RedisQ } from "../app";
 import mediumMsg from "./medium.txt";
 import smallMsg from "./small.txt";
 import tinyMsg from "./tiny.txt";
@@ -108,7 +108,7 @@ function printResults(testName: string, results: TestResults) {
 async function testRegularQueueParallel(
     config: StressTestConfig,
 ): Promise<TestResults> {
-    const queue = new RedisQueue({
+    const queue = new RedisQ({
         host: process.env.REDIS_HOST || "127.0.0.1",
         namespace: "stress-test",
         port: process.env.REDIS_PORT || "6379",

package/package.json

@@ -27,5 +27,5 @@
         "stress": "bun benchmark/stress.ts"
     },
     "type": "module",
-    "version": "0.2.1"
+    "version": "1.0.0"
 }

package/tsconfig.json

@@ -1,29 +1,29 @@
 {
-  "compilerOptions": {
-    // Environment setup & latest features
-    "lib": ["ESNext"],
-    "target": "ESNext",
-    "module": "Preserve",
-    "moduleDetection": "force",
-    "jsx": "react-jsx",
-    "allowJs": true,
+    "compilerOptions": {
+        "allowImportingTsExtensions": true,
+        "allowJs": true,
+        "jsx": "react-jsx",
+        // Environment setup & latest features
+        "lib": ["ESNext"],
+        "module": "Preserve",
+        "moduleDetection": "force",
 
-    // Bundler mode
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "verbatimModuleSyntax": true,
-    "noEmit": true,
+        // Bundler mode
+        "moduleResolution": "bundler",
+        "noEmit": true,
+        "noFallthroughCasesInSwitch": true,
+        "noImplicitOverride": true,
+        "noPropertyAccessFromIndexSignature": false,
+        "noUncheckedIndexedAccess": true,
 
-    // Best practices
-    "strict": true,
-    "skipLibCheck": true,
-    "noFallthroughCasesInSwitch": true,
-    "noUncheckedIndexedAccess": true,
-    "noImplicitOverride": true,
+        // Some stricter flags (disabled by default)
+        "noUnusedLocals": false,
+        "noUnusedParameters": false,
+        "skipLibCheck": true,
 
-    // Some stricter flags (disabled by default)
-    "noUnusedLocals": false,
-    "noUnusedParameters": false,
-    "noPropertyAccessFromIndexSignature": false
-  }
+        // Best practices
+        "strict": true,
+        "target": "ESNext",
+        "verbatimModuleSyntax": true
+    }
 }