amqp-suite 0.1.0 → 0.1.1

package/README.md

@@ -1,11 +1,11 @@
 # amqp-suite
 
-[![NPM version](https://img.shields.io/npm/v/amqp-suite)](https://www.npmjs.com/package/amqp-suite)
-[![NPM downloads](https://img.shields.io/npm/dw/amqp-suite.svg)](https://www.npmjs.com/package/amqp-suite)
+[![NPM version](https://img.shields.io/npm/v/amqp-suite?color=blue)](https://www.npmjs.com/package/amqp-suite)
 [![MIT license](https://img.shields.io/badge/License-MIT-bridhtgreen)](https://opensource.org/licenses/MIT)
+[![NPM downloads](https://img.shields.io/npm/dw/amqp-suite?color=bridhtgreen)](https://www.npmjs.com/package/amqp-suite)
 [![stars](https://img.shields.io/github/stars/iamcarlosdaniel/amqp-suite)](https://github.com/iamcarlosdaniel/amqp-suite)
 
-![](docs/assets/repository_banner.png)
+![](https://raw.githubusercontent.com/iamcarlosdaniel/amqp-suite/main/docs/assets/repository_banner.png)
 
 `amqp-suite` is a simple and efficient AMQP (Advanced Message Queuing Protocol) client wrapper for Node.js that handles connection management, message publishing, and consuming messages from queues with a topic exchange. This package abstracts complex connection handling and simplifies AMQP usage in applications by providing easy-to-use methods for connecting, publishing, consuming, and gracefully shutting down the connection.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "amqp-suite",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A simple wrapper for AMQP 0-9-1 messaging.",
   "license": "MIT",
   "author": {
@@ -8,6 +8,10 @@
     "email": "contact@iamcarlosdaniel.com",
     "url": "http://iamcarlosdaniel.com"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/iamcarlosdaniel/amqp-suite.git"
+  },
   "type": "module",
   "main": "src/index.js",
   "exports": {

package/src/{index.d.ts → amqp-client.d.ts}

@@ -1,4 +1,4 @@
-declare module "amqp-wrapper" {
+declare module "amqp-suite" {
   export class AmqpClient {
     constructor(amqpUrl: string, exchange: string);
     connect(retries?: number, delay?: number): Promise<void>;

package/src/amqp-client.js

@@ -23,6 +23,8 @@ class AmqpClient {
     this.channel = null;
     /** @type {boolean} State flag to prevent multiple simultaneous connection attempts. */
     this.isConnecting = false;
+    /** @type {boolean} State flag to indicate if the client is closing. */
+    this.isClosing = false;
   }
 
   /**
@@ -51,11 +53,14 @@ class AmqpClient {
       });
 
       this.connection.on("close", () => {
-        this.isConnecting = false;
         this.connection = null;
         this.channel = null;
-        console.warn(`AMQP connection lost. Retrying in ${delay}ms...`);
-        setTimeout(() => this.connect(), delay);
+
+        if (!this.isClosing) {
+          this.isConnecting = false;
+          console.warn(`AMQP connection lost. Retrying in ${delay}ms...`);
+          setTimeout(() => this.connect(), delay);
+        }
       });
 
       console.log("AMQP: Connection established successfully");
@@ -171,10 +176,12 @@ class AmqpClient {
    */
   async close() {
     try {
+      this.isClosing = true;
       await this.channel?.close();
       await this.connection?.close();
       console.log("AMQP: Connection closed cleanly.");
     } catch (err) {
+      this.isClosing = false;
       console.error("AMQP: Error during shutdown:", err);
     }
   }

package/src/index.js

@@ -1,3 +1,3 @@
-import { AmqpClient } from "./amqp-client";
+import { AmqpClient } from "./amqp-client.js";
 
 export { AmqpClient };

package/vitest.config.js

@@ -2,7 +2,7 @@ import { defineConfig } from "vitest/config";
 
 export default defineConfig({
   test: {
-    globals: true, // Permite usar 'describe', 'it', 'expect' sin importarlos
+    globals: true,
     environment: "node",
   },
 });

package/tests/amqp.test.js

@@ -1,172 +0,0 @@
-/**
- * @fileoverview Unit tests for the AMQP class using Vitest and amqplib mocks.
- */
-
-import { describe, it, expect, vi, beforeEach } from "vitest";
-import amqp from "amqplib";
-import { AmqpClient } from "amqp-suite";
-
-vi.mock("amqplib");
-
-/**
- * Test suite for AMQP integration and message handling.
- */
-describe("AMQP Class", () => {
-  /** @type {AmqpClient} */
-  let amqpInstance;
-
-  /** @type {string} */
-  const mockUrl = "amqp://localhost";
-
-  /** @type {string} */
-  const mockExchange = "test_exchange";
-
-  /**
-   * Mocked AMQP Channel object with Vitest spy functions.
-   * @type {Object}
-   */
-  const mockChannel = {
-    assertExchange: vi.fn().mockResolvedValue(undefined),
-    assertQueue: vi.fn().mockResolvedValue({}),
-    bindQueue: vi.fn().mockResolvedValue(undefined),
-    prefetch: vi.fn().mockResolvedValue(undefined),
-    publish: vi.fn().mockReturnValue(true),
-    consume: vi.fn().mockResolvedValue({ consumerTag: "abc" }),
-    ack: vi.fn(),
-    nack: vi.fn(),
-    close: vi.fn().mockResolvedValue(undefined),
-  };
-
-  /**
-   * Mocked AMQP Connection object.
-   * @type {Object}
-   */
-  const mockConnection = {
-    createChannel: vi.fn().mockResolvedValue(mockChannel),
-    on: vi.fn(),
-    close: vi.fn().mockResolvedValue(undefined),
-  };
-
-  /**
-   * Setup hook to reset mocks and re-initialize the AMQP instance before each test.
-   */
-  beforeEach(() => {
-    vi.clearAllMocks();
-    amqpInstance = new AmqpClient(mockUrl, mockExchange);
-    amqp.connect.mockResolvedValue(mockConnection);
-  });
-
-  /**
-   * Test case: Constructor property assignment.
-   */
-  it("should correctly initialize values in the constructor", () => {
-    expect(amqpInstance.amqpUrl).toBe(mockUrl);
-    expect(amqpInstance.exchange).toBe(mockExchange);
-  });
-
-  /**
-   * Test case: Connection workflow and exchange assertion.
-   */
-  it("should connect and create a channel successfully", async () => {
-    await amqpInstance.connect();
-
-    expect(amqp.connect).toHaveBeenCalledWith(mockUrl);
-    expect(mockConnection.createChannel).toHaveBeenCalled();
-    expect(mockChannel.assertExchange).toHaveBeenCalledWith(
-      mockExchange,
-      "topic",
-      { durable: true }
-    );
-    expect(amqpInstance.connection).not.toBeNull();
-  });
-
-  /**
-   * Test case: Message publishing logic and buffer conversion.
-   */
-  it("should publish a message correctly", async () => {
-    await amqpInstance.connect();
-    const routingKey = "user.created";
-    const message = { id: 1, name: "Test" };
-
-    await amqpInstance.publish(routingKey, message);
-
-    expect(mockChannel.publish).toHaveBeenCalledWith(
-      mockExchange,
-      routingKey,
-      expect.any(Buffer),
-      expect.objectContaining({ persistent: true })
-    );
-  });
-
-  /**
-   * Test case: Consumer setup and successful message processing.
-   */
-  it("should setup consumer and acknowledge messages on success", async () => {
-    await amqpInstance.connect();
-    const queueName = "test_queue";
-    const bindingKey = "test.key";
-    const mockPayload = { data: "hello world" };
-    const mockOnMessage = vi.fn().mockResolvedValue(undefined);
-
-    await amqpInstance.consume(
-      queueName,
-      mockOnMessage,
-      { prefetch: 5 },
-      bindingKey
-    );
-
-    expect(mockChannel.assertQueue).toHaveBeenCalledWith(
-      queueName,
-      expect.objectContaining({ durable: true })
-    );
-    expect(mockChannel.bindQueue).toHaveBeenCalledWith(
-      queueName,
-      mockExchange,
-      bindingKey
-    );
-    expect(mockChannel.prefetch).toHaveBeenCalledWith(5);
-
-    const consumerCallback = mockChannel.consume.mock.calls[0][1];
-    const fakeMsg = {
-      content: Buffer.from(JSON.stringify(mockPayload)),
-    };
-
-    await consumerCallback(fakeMsg);
-
-    expect(mockOnMessage).toHaveBeenCalledWith(mockPayload, fakeMsg);
-    expect(mockChannel.ack).toHaveBeenCalledWith(fakeMsg);
-  });
-
-  /**
-   * Test case: Consumer error handling (nack).
-   */
-  it("should nack messages if the processing fails", async () => {
-    await amqpInstance.connect();
-    const mockOnMessage = vi
-      .fn()
-      .mockRejectedValue(new Error("Processing failed"));
-
-    await amqpInstance.consume("error_queue", mockOnMessage);
-
-    const consumerCallback = mockChannel.consume.mock.calls[0][1];
-    const fakeMsg = {
-      content: Buffer.from(JSON.stringify({ some: "data" })),
-    };
-
-    await consumerCallback(fakeMsg);
-
-    expect(mockChannel.nack).toHaveBeenCalledWith(fakeMsg, false, false);
-    expect(mockChannel.ack).not.toHaveBeenCalled();
-  });
-
-  /**
-   * Test case: Graceful shutdown of channel and connection.
-   */
-  it("should close the connection cleanly", async () => {
-    await amqpInstance.connect();
-    await amqpInstance.close();
-
-    expect(mockChannel.close).toHaveBeenCalled();
-    expect(mockConnection.close).toHaveBeenCalled();
-  });
-});