Forem: Kazi Naimul Hoque

Simplify RabbitMQ Integration in Node.js with @kazinaimul/rabbitmq

Kazi Naimul Hoque — Sat, 23 Dec 2023 04:58:50 +0000

Are you tired of navigating the complexities of RabbitMQ integration in your Node.js projects? Well, fret no more! I’m excited to introduce the @kazinaimul/rabbitmq package — a straightforward solution to streamline your RabbitMQ integration seamlessly.

Installation Made Easy

Let’s kick things off with a swift installation. Open your terminal and run:

yarn add @kazinaimul/rabbitmq

or

npm install @kazinaimul/rabbitmq

Getting Started: Establishing Connection

In your Express app’s app.js file, pave the way for RabbitMQ integration with this simple code snippet:

import { RabbitMQConnection } from '@kazinaimul/rabbitmq';
RabbitMQConnection.connect('RABBITMQ_CONNECTION_URL');

Swap out RABBITMQ_CONNECTION_URL with your RabbitMQ server connection URL, neatly formatted as _**amqp://username:password@localhost:5672**_.

Effortless Message Publishing

Publishing messages becomes a breeze with the creation of a Publisher class. Check out this snippet:

import { Publisher } from '@kazinaimul/rabbitmq';
export class PublishMessage extends Publisher {
 constructor() {
   const queueName = 'queue-name';
   super(queueName);
 }
async publish<MessageType>(message: MessageType): Promise<void> {
   try {
     const customOptions = {
     exchange: `Exchange_name`,
     routingKey: queue,
     delay: 0,
     exchangeType: "direct",
     headers: {},
     }; // Custom optional values, overwriting default options
     await this.rabbitMQClient.publish(this.queueName, message, customOptions);
   } catch (error) {
     console.error('Error publishing messages:', error);
   }
 }
}

By default the option for publish a message is followed which can be replaced:

const defaultOptions = { exchange:Exchange_${queue}, routingKey: queue, delay: 0, exchangeType: "direct", headers: {}, };

Seamless Message Consumption

Creating a Consumer class ensures smooth message consumption. Take a look:

import { Consumer } from '@kazinaimul/rabbitmq';
export class MyConsumer extends Consumer {
 constructor() {
   const queueName = 'queue-name';
   const options = {
     retry: true, // If true, messages will be queued again in case of an error (default is true)
     retry_count: 3, // Maximum retry count, beyond which the message will be moved to an error queue
     retry_delay: 0 // Delay in milliseconds for retries
   };
   super(queueName, options); // Options are an optional field
 }
async execute<T extends object>(message: T): Promise<void> {
 // Implement your own logic to handle the consumed message
 }
}

Register and Consume

Don’t forget to register your consumers in a file (let’s call it consumerRegister.ts):

// Import the consumer classes
import { MyConsumer } from './MyConsumer';
export const consumerRegister: any[] = [
  new MyConsumer()
  // Push all other Consumer classees here
];
In your application, consume messages effortlessly by iterating through the registered consumers:

import { consumerRegister } from './consumerRegister';
// Consume messages from registered consumers
for (const consumer of consumerRegister) {
 consumer.consume();
}

Replace ’queue-name’ with your chosen queue name.

Feel free to explore, contribute, and simplify your RabbitMQ integration. Happy coding! 🚀🐇

Check out the package on npm!

Boilerplate for Typescript-Express with sequelize ORM

Kazi Naimul Hoque — Tue, 08 Nov 2022 08:19:16 +0000

Boilerplate for Typescript-Express with sequelize ORM

A boilerplate for any enterprise rest api or service with Node.js -Typescript, Express and Sequelize ORM for mysql, postgresql or others.

By running this project you will get a production ready environment with all necessary supports for validation, unit testing, socket, redis and many more.This repo is the typescript version of my another boilerplate of Nodejs Express Mysql boilerplate

Manual Installation

Clone the repo:

git clone https://github.com/kazi-naimul/typescript-express-mysql-boilerplate
cd typescript-express-mysql-boilerplate

Install the dependencies:

yarn install

Set the environment variables:

cp .env.example .env

# open .env and modify the environment variables (if needed)

Features

ORM: Sequelize orm for object data modeling
Migration and Seed: DB migration and Seed using Sequelize-CLI
Authentication and authorization: using passport
Error handling: centralized error handling
Validation: request data validation using Joi
Logging: using winston
Testing: unittests using Mocha
Caching: Caching using Redis
Bidirectional Communication: using Scoket
Job scheduler: with Node-cron
Dependency management: with Yarn
Environment variables: using dotenv and cross-env
CORS: Cross-Origin Resource-Sharing enabled using cors
Docker support
Linting: with ESLint and Prettier

Commands

Running locally:

yarn dev

Running in production:

yarn start

Testing:

# run all tests
yarn test

Environment Variables

The environment variables can be found and modified in the .env file. They come with these default values:

#Server environment
NODE_ENV=development
#Port number
PORT=5000

#Db configuration
DB_HOST=db-host
DB_USER=db-user
DB_PASS=db-pass
DB_NAME=db-name


# JWT secret key
JWT_SECRET=your-jwt-secret-key
# Number of minutes after which an access token expires
JWT_ACCESS_EXPIRATION_MINUTES=5
# Number of days after which a refresh token expires
JWT_REFRESH_EXPIRATION_DAYS=30

#Log config
LOG_FOLDER=logs/
LOG_FILE=%DATE%-app-log.log
LOG_LEVEL=error

#Redis
REDIS_HOST=redis-host
REDIS_PORT=6379
REDIS_USE_PASSWORD=no
REDIS_PASSWORD=your-password

Project Structure

specs\
src\
 |--config\         # Environment variables and configuration related things
 |--controllers\    # Route controllers (controller layer)
 |--dao\            # Data Access Object for models
    |--contract\        # Contracts for all dao
    |--implementation   # Implementation of the contracts
 |--db\             # Migrations and Seed files
 |--models\         # Sequelize models (data layer)
 |--routes\         # Routes
 |--services\       # Business logic (service layer)
    |--contract\        # Contracts for all service
    |--implementation   # Implementation of the contracts
 |--helper\         # Helper classes and functions
 |--validations\    # Request data validation schemas
 |--app.js          # Express app
 |--cronJobs.ts     # Job Scheduler
 |--index.ts        # App entry point

Boilerplate for Node-Express with sequelize ORM

Kazi Naimul Hoque — Sun, 04 Sep 2022 07:12:39 +0000

https://github.com/kazi-naimul/node-express-mysql-boilerplate

A boilerplate for any enterprise rest api or service with Node.js, Express and Sequelize ORM for mysql, postgresql or others.

By running this project you will get a production ready environment with all necessary supports for validation, unit testing, socket, redis and many more.