feat: 2.0.1

feat: 2.0.1

Author: gabrielmendezsoares

.dockerignore

@@ -1,9 +1,9 @@
 dist
-docker-compose.yml.example
 node_modules
-storage.sql
-storage.sql.example
-README.md
 .env
 .env.example
 .gitignore
+docker-compose.yml.example
+README.md
+storage.sql
+storage.sql.example

.env.example

@@ -1,20 +1,40 @@
-NODE_ENV=""
+NODE_ENV=development
 
-PORT=""
+PORT=3892
 
-RATE_LIMIT_WINDOW_MS=""
-RATE_LIMIT_MAX_REQUESTS=""
+APPLICATION_TYPE=fence-tracker
 
-STORAGE_DATABASE_URL=""
+JWT_SECRET=jwt_secret
+JWT_EXPIRES_IN=1h
 
-APPLICATION_TYPE=""
+LOG_LEVEL=debug
 
-JWT_SECRET=""
-JWT_EXPIRES_IN=""
+ERROR_LOG_MAX_SIZE=20m
+ERROR_LOG_MAX_FILES=30d
+
+WARN_LOG_MAX_SIZE=15m
+WARN_LOG_MAX_FILES=14d
+
+INFO_LOG_MAX_SIZE=10m
+INFO_LOG_MAX_FILES=7d
+
+DEBUG_LOG_MAX_SIZE=5m
+DEBUG_LOG_MAX_FILES=3d
+
+EXCEPTION_LOG_MAX_SIZE=20m
+EXCEPTION_LOG_MAX_FILES=30d
+
+REJECTION_LOG_MAX_SIZE=20m
+REJECTION_LOG_MAX_FILES=30d
+
+RATE_LIMIT_WINDOW_MS=60000
+RATE_LIMIT_MAX_REQUESTS=100
+
+STORAGE_DATABASE_URI=mysql://root:root@127.0.0.1:3306/storage
+
+QUERY_GATEWAY_USERNAME=query_gateway_username
+QUERY_GATEWAY_PASSWORD=query_gateway_password
 
 CHAT_PRO_BEARER_TOKEN=""
 CHAT_PRO_INSTANCE_ID=""
 CHAT_PRO_NUMBER=""
-
-QUERY_GATEWAY_USERNAME=""
-QUERY_GATEWAY_PASSWORD=""

.gitignore

@@ -1,10 +1,20 @@
-cert.pem
 dist
-docker-compose.yml
+logs/.debug-audit.json*
+logs/.error-audit.json*
+logs/.exception-audit.json*
+logs/.info-audit.json*
+logs/.rejection-audit.json*
+logs/.warn-audit.json*
+logs/*.log*
 node_modules
-key.pem
-logs
-storage.sql
+ssl/*.ext*
+ssl/*.cnf*
+ssl/*.crt*
+ssl/*.csr*
+ssl/*.key*
+ssl/*.pem*
+ssl/*.srl*
 .env
-.log
-.pem
+docker-compose.yml
+package-lock.json
+storage.sql

Dockerfile

@@ -7,9 +7,9 @@ WORKDIR /app
 
 RUN chown -R nodeuser:nodejs /app
 
-COPY --chown=nodeuser:nodejs package*.json ./
 COPY --chown=nodeuser:nodejs prisma/ ./prisma/
 COPY --chown=nodeuser:nodejs scripts/ ./scripts/
+COPY --chown=nodeuser:nodejs package*.json ./
 
 USER nodeuser
 

README.md

@@ -1 +1,110 @@
-# fence-alert
+# 🚧 Fence Tracker
+
+## 📋 Overview
+
+Fence Tracker is a zone-based monitoring and alerting service that identifies when activity levels within specific geographic or logical zones exceed a configured threshold. It fetches data from a centralized Query Gateway, evaluates it against defined rules, and sends alerts when meaningful increases occur.
+
+To prevent redundant notifications, Fence Tracker persists the last triggered state for each zone in a MySQL database. When a new threshold multiple is crossed, it formats and dispatches a structured alert message via an external messaging system.
+
+### 🎯 Objectives
+
+- Fetch the latest fence activity data using a named query from the Query Gateway
+- Detect when the quantity per zone exceeds a defined threshold (e.g., 50)
+- Persist trigger states in a MySQL database using Prisma to track previously alerted values
+- Prevent duplicate alerts by only triggering when thresholds escalate beyond prior values
+- Generate structured alert messages containing relevant zone and account information
+- Send alerts to a configurable external messaging endpoint
+- Use Basic and Bearer authentication strategies for secure communication with the Query Gateway
+- Provide a scalable and maintainable alert pipeline for fence-based activity monitoring
+
+--- 
+
+## 📦 Quick Start
+
+### ⚠️ Prerequisites
+
+- [**Node.js**](https://nodejs.org/) ≥ `20.14.0` — _JavaScript runtime environment_
+- [**MySQL**](https://www.mysql.com/) ≥ `8.0` — _Relational database_
+- [**Query Gateway**](https://github.com/gabrielmendezsoares/query-gateway) ≥ `3.0.2` — _Configurable data query service_
+
+### ⚙️ Setup 
+
+```bash 
+# Clone & navigate
+git clone <repository-url> && cd fence-tracker
+
+# Configure environment
+cp .env.example .env  # Edit with your settings
+
+# Install dependencies (auto-runs database setup)
+npm install
+```
+
+> **💡 Database:** Import `storage.sql.example` before running `npm install`
+
+---
+
+## ⚡ Usage
+
+### 🛠️ Development
+
+```bash
+npm run start:development
+```
+
+### 🏗️ Production
+
+```bash
+npm run build && npm run start:production
+```
+
+---
+
+## 📚 Command Reference
+
+### 🧰 Core
+
+| Command | Description |
+| ------- | ----------- |
+| `npm run start:development` | _Start the application in development_ |
+| `npm run start:production` | _Start the application in production_ |
+| `npm run build` | _Build the application for production_ |
+| `npm run build:watch` | _Build the application with watch mode_ |
+| `npm run clean` | _Clean application build artifacts_ |
+
+### 🛢️ Database
+
+| Command | Description |
+| ------- | ----------- |
+| `npm run db:pull` | _Pull database schema into Prisma across all schemas_ |
+| `npm run db:push` | _Push Prisma schema to the database across all schemas_ |
+| `npm run db:generate` | _Generate Prisma Client for all schemas_ |
+| `npm run db:migrate:dev` | _Run development migrations across all schemas_ |
+| `npm run db:migrate:deploy` | _Deploy migrations to production across all schemas_ |
+| `npm run db:studio` | _Open Prisma Studio (GUI) across all schemas_ |
+| `npm run db:reset` | _Reset database (pull + generate) for all schemas_ |
+
+### 🐳 Docker
+
+| Command | Description |
+| ------- | ----------- |
+| `npm run docker:build:development` | _Build Docker image for development_ |
+| `npm run docker:build:production` | _Build Docker image for production_ |
+| `npm run docker:run:development` | _Run development Docker container_ |
+| `npm run docker:run:production` | _Run production Docker container_ |
+| `npm run docker:compose:up:development` | _Start Docker Compose in development_ |
+| `npm run docker:compose:up:production` | _Start Docker Compose in production_ |
+| `npm run docker:compose:up:build:development` | _Start & rebuild Docker Compose in development_ |
+| `npm run docker:compose:up:build:production` | _Start & rebuild Docker Compose in production_ |
+| `npm run docker:compose:down` | _Stop Docker Compose services_ |
+| `npm run docker:compose:logs` | _View Docker Compose logs_ |
+| `npm run docker:prune` | _Clean up unused Docker resources_ |
+
+### 🧪 Testing
+
+| Command | Description |
+| ------- | ----------- |
+| `npm test` | _Run all tests once_ |
+| `npm run test:watch` | _Run tests in watch mode_ |
+| `npm run test:coverage` | _Run tests and generate a coverage report_ |
+  

docker-compose.yml.example

@@ -8,7 +8,7 @@ x-common-variables: &common-variables
 services:
   main-development:
     <<: *common-variables
-    container_name: main-development-fence-alert
+    container_name: main-development-fence-tracker
     build:
       context: .
       dockerfile: Dockerfile
@@ -24,7 +24,7 @@ services:
 
   main-production:
     <<: *common-variables
-    container_name: main-production-fence-alert
+    container_name: main-production-fence-tracker
     build:
       context: .
       dockerfile: Dockerfile
@@ -37,7 +37,7 @@ services:
 
   db:
     <<: *common-variables
-    container_name: db-mysql-fence-alert
+    container_name: db-mysql-fence-tracker
     image: mysql:8.0
     ports:
       - "4406:3306"

expressium/controllers/getAuthentication.controller.ts

@@ -0,0 +1,43 @@
+import { Request, Response } from 'express';
+import { getAuthenticationService } from '../services/index.js';
+import { loggerUtil } from '../utils/index.js';
+
+/**
+ * ## getAuthentication
+ * 
+ * Controller for handling authentication requests.
+ *
+ * @description
+ * Delegates the authentication logic to the service layer, processes the response,
+ * and returns a JSON response with the appropriate HTTP status code.
+ *
+ * In case of an unhandled error, logs the error and returns a 500 Internal Server Error
+ * with a generic error message and suggestion.
+ *
+ * @param req - Express request object.
+ * @param res - Express response object.
+ *
+ * @returns
+ * Sends a JSON response with status code and authentication result.
+ */
+export const getAuthentication = async (
+  req: Request, 
+  res: Response
+): Promise<void> => {
+  try {
+    const { status, data } = await getAuthenticationService.getAuthentication(req);
+    
+    res.status(status).json(data);
+  } catch (error: unknown) {
+    loggerUtil.error(error instanceof Error ? error.message : String(error));
+
+    res
+      .status(500)
+      .json(
+        { 
+          message: 'The authentication process encountered a technical issue.',
+          suggestion: 'Please try again later or contact support if the issue persists.'
+        }
+      );
+  }
+};

expressium/controllers/index.ts

@@ -0,0 +1 @@
+export * as getAuthenticationController from './getAuthentication.controller.js';