Notification Service

A Node.js service that handles push notifications using RabbitMQ as a message broker. Currently supports iOS push notifications via Apple Push Notification service (APNs).

Notification Methods

This service provides two distinct ways to send notifications:

1. Direct RabbitMQ Integration: Connect directly to the RabbitMQ message broker to send notifications (see Message Format below)
2. HTTP API: Use the REST API endpoints to send notifications and manage device tokens. (see API Documentation).

• Comes with an optional Portal for broadcasting to all users.

Note: Device token management (registration, updates, deletion) is only available through the HTTP API.

Prerequisites

• Docker and Docker Compose
• Apple Developer Account credentials for iOS push notifications

Setup

1. Clone the repository

2. Create a .env file in the root directory with the following configuration:

RABBITMQ_QUEUE_NAME = "test_queue"

APN_TEAM_ID = "YOUR_TEAM_ID"
APN_KEY_ID = "YOUR_KEY_ID"
APN_KEY_PATH = "./IOS/AuthKey_YOUR_KEY_ID.p8"
APN_TOPIC = "your.app.bundle.id"

APN_TEST_DEVICE_TOKEN = "YOUR_DEVICE_TOKEN"

CREATE_MANAGEMENT_PORTAL = true

4. Place your APNs authentication key (.p8 file) in the IOS directory

Running the Service

1. Start RabbitMQ and notfication service using Docker Compose:

docker-compose up -d

How It Works

The service:

1. Connects to RabbitMQ on startup
2. Listens for notification messages on the configured queue
3. Processes messages and sends push notifications to iOS devices

Message Format

Send JSON messages to RabbitMQ in the following format:

{
  "title": "Notification Title",
  "body": "Notification Body",
  "tokens": ["device_token_1", "device_token_2"]
}

Development

The project structure:

• src/index.ts - Main application entry point
• RabbitMQ/RabbitMQ.ts - RabbitMQ connection handling
• Notification.ts - Notification processing and sending logic

Testing

Run tests using Jest:

npm test

RabbitMQ Management

Access the RabbitMQ management interface at:

• URL: http://localhost:15672
• Username: guest
• Password: guest

License

ISC