@cepseudo/adonis-audit-log 1.0.0

package/LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright (c) 2023
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,190 @@
+# @cepseudo/adonis-audit-log
+
+Simple audit logging package for AdonisJS 6.
+
+## Features
+
+- Custom audit logs for tracking user actions and business events
+- Automatic HTTP request logging via middleware
+- Error logging with exception handler integration
+- Configurable field sanitization for sensitive data
+- Retention settings for log cleanup
+
+## Installation
+
+```bash
+npm install @cepseudo/adonis-audit-log
+```
+
+## Configuration
+
+```bash
+node ace configure @cepseudo/adonis-audit-log
+```
+
+This will:
+
+1. Publish migrations to `database/migrations/`
+2. Publish config to `config/audit.ts`
+3. Register the provider in `adonisrc.ts`
+
+Then run the migrations:
+
+```bash
+node ace migration:run
+```
+
+## Configuration Options
+
+```typescript
+// config/audit.ts
+import { defineConfig } from '@cepseudo/adonis-audit-log'
+
+export default defineConfig({
+  enabled: true,
+
+  requestLog: {
+    enabled: true,
+    excludeRoutes: ['/health', '/metrics'],
+    excludeMethods: ['OPTIONS'],
+    logBody: false,
+    logQuery: true,
+    sanitizeFields: ['password', 'token', 'secret'],
+  },
+
+  errorLog: {
+    enabled: true,
+    excludeStatusCodes: [404],
+    includeStack: true,
+  },
+
+  auditLog: {
+    enabled: true,
+  },
+
+  retention: {
+    requestLogs: 30,
+    errorLogs: 90,
+    auditLogs: 365,
+  },
+})
+```
+
+## Usage
+
+### Custom Audit Logs
+
+```typescript
+import audit from '@cepseudo/adonis-audit-log/services/main'
+
+// Simple log
+await audit.log('user.login', { user_id: 1 })
+
+// With metadata
+await audit.log('submission.create', {
+  user_id: auth.user.id,
+  submission_id: submission.id,
+  project_acronym: submission.projectAcronym,
+})
+
+// Track changes
+await audit.logChange('user.update', {
+  userId: auth.user.id,
+  targetId: targetUser.id,
+  changes: {
+    email: { from: 'old@example.com', to: 'new@example.com' },
+  },
+})
+```
+
+### Request Logging (Middleware)
+
+Add the middleware to your router in `start/kernel.ts`:
+
+```typescript
+router.use([() => import('@cepseudo/adonis-audit-log/middleware/request_logger')])
+```
+
+### Error Logging (Exception Handler)
+
+Integrate with your exception handler in `app/exceptions/handler.ts`:
+
+```typescript
+import { AuditErrorLogger } from '@cepseudo/adonis-audit-log'
+
+export default class HttpExceptionHandler extends ExceptionHandler {
+  async report(error: unknown, ctx: HttpContext) {
+    await AuditErrorLogger.log(error, ctx)
+    return super.report(error, ctx)
+  }
+}
+```
+
+## Database Schema
+
+The package creates three tables:
+
+### audit_logs
+
+- `id` - Primary key
+- `action_type` - Event type (e.g., 'user.login', 'submission.create')
+- `metadata` - JSON object with additional data
+- `user_id` - Optional reference to users table
+- `created_at` - Timestamp
+
+### request_logs
+
+- `id` - Primary key
+- `method` - HTTP method
+- `url` - Request URL
+- `route_name` - Named route if available
+- `status_code` - HTTP response status
+- `response_time_ms` - Response time in milliseconds
+- `ip` - Client IP address
+- `user_agent` - Browser/client user agent
+- `user_id` - Optional reference to users table
+- `request_body` - Sanitized request body (optional)
+- `request_query` - Query parameters
+- `created_at` - Timestamp
+
+### error_logs
+
+- `id` - Primary key
+- `error_type` - Error class name
+- `message` - Error message
+- `stack` - Stack trace (optional)
+- `url` - URL where error occurred
+- `method` - HTTP method
+- `status_code` - HTTP status returned
+- `user_id` - Optional reference to users table
+- `context` - Additional context (params, query)
+- `created_at` - Timestamp
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Run tests
+npm run test
+
+# Run tests without linting
+npm run quick:test
+
+# Build
+npm run build
+
+# Type check
+npm run typecheck
+
+# Lint
+npm run lint
+
+# Format
+npm run format
+```
+
+## License
+
+MIT

package/build/configure.d.ts

@@ -0,0 +1,2 @@
+import ConfigureCommand from '@adonisjs/core/commands/configure';
+export declare function configure(command: ConfigureCommand): Promise<void>;

package/build/configure.js

@@ -0,0 +1,58 @@
+/*
+|--------------------------------------------------------------------------
+| Configure hook
+|--------------------------------------------------------------------------
+|
+| The configure hook is called when someone runs "node ace configure <package>"
+| command. It publishes migrations, config, and registers the provider.
+|
+*/
+import { stubsRoot } from './stubs/main.js';
+export async function configure(command) {
+    const codemods = await command.createCodemods();
+    // Publish config file
+    await codemods.makeUsingStub(stubsRoot, 'config.stub', {});
+    // Publish migrations
+    const now = new Date();
+    const timestamp = now
+        .toISOString()
+        .replace(/[-:]/g, '')
+        .replace('T', '_')
+        .replace(/\.\d{3}Z$/, '');
+    await codemods.makeUsingStub(stubsRoot, 'migrations/create_audit_logs_table.stub', {
+        migration: {
+            folder: 'database/migrations',
+            fileName: `${timestamp}_create_audit_logs_table.ts`,
+        },
+    });
+    // Add 1 second to timestamp for ordering
+    const timestamp2 = new Date(now.getTime() + 1000)
+        .toISOString()
+        .replace(/[-:]/g, '')
+        .replace('T', '_')
+        .replace(/\.\d{3}Z$/, '');
+    await codemods.makeUsingStub(stubsRoot, 'migrations/create_request_logs_table.stub', {
+        migration: {
+            folder: 'database/migrations',
+            fileName: `${timestamp2}_create_request_logs_table.ts`,
+        },
+    });
+    // Add 2 seconds to timestamp for ordering
+    const timestamp3 = new Date(now.getTime() + 2000)
+        .toISOString()
+        .replace(/[-:]/g, '')
+        .replace('T', '_')
+        .replace(/\.\d{3}Z$/, '');
+    await codemods.makeUsingStub(stubsRoot, 'migrations/create_error_logs_table.stub', {
+        migration: {
+            folder: 'database/migrations',
+            fileName: `${timestamp3}_create_error_logs_table.ts`,
+        },
+    });
+    // Register provider in adonisrc.ts
+    await codemods.updateRcFile((rcFile) => {
+        rcFile.addProvider('@cepseudo/adonis-audit-log/providers/audit_provider');
+    });
+    command.logger.success('Audit log package configured successfully!');
+    command.logger.info('Run "node ace migration:run" to create the audit tables.');
+}

package/build/index.d.ts

@@ -0,0 +1,9 @@
+export { configure } from './configure.js';
+export { defineConfig } from './src/types.js';
+export { AuditService } from './src/audit_service.js';
+export { RequestLogger } from './src/request_logger.js';
+export { ErrorLogger, AuditErrorLogger } from './src/error_logger.js';
+export { default as AuditLog } from './src/models/audit_log.js';
+export { default as RequestLog } from './src/models/request_log.js';
+export { default as ErrorLog } from './src/models/error_log.js';
+export type { AuditConfig, AuditLogEntry, RequestLogEntry, ErrorLogEntry } from './src/types.js';

package/build/index.js

@@ -0,0 +1,16 @@
+/*
+|--------------------------------------------------------------------------
+| Package entrypoint
+|--------------------------------------------------------------------------
+|
+| Export values from the package entrypoint.
+|
+*/
+export { configure } from './configure.js';
+export { defineConfig } from './src/types.js';
+export { AuditService } from './src/audit_service.js';
+export { RequestLogger } from './src/request_logger.js';
+export { ErrorLogger, AuditErrorLogger } from './src/error_logger.js';
+export { default as AuditLog } from './src/models/audit_log.js';
+export { default as RequestLog } from './src/models/request_log.js';
+export { default as ErrorLog } from './src/models/error_log.js';

package/build/middleware/request_logger.d.ts

@@ -0,0 +1,5 @@
+import type { HttpContext } from '@adonisjs/core/http';
+import type { NextFn } from '@adonisjs/core/types/http';
+export default class RequestLoggerMiddleware {
+    handle(ctx: HttpContext, next: NextFn): Promise<void>;
+}

package/build/middleware/request_logger.js

@@ -0,0 +1,36 @@
+/*
+|--------------------------------------------------------------------------
+| Request Logger Middleware
+|--------------------------------------------------------------------------
+|
+| This middleware logs HTTP requests automatically. Add it to your router
+| middleware stack in start/kernel.ts.
+|
+*/
+import app from '@adonisjs/core/services/app';
+import { RequestLogger } from '../src/request_logger.js';
+let requestLogger = null;
+export default class RequestLoggerMiddleware {
+    async handle(ctx, next) {
+        const startTime = performance.now();
+        // Execute the request
+        await next();
+        // Log the request after response (non-blocking)
+        try {
+            if (!requestLogger) {
+                const config = app.config.get('audit');
+                if (config) {
+                    requestLogger = new RequestLogger(config);
+                }
+            }
+            if (requestLogger) {
+                const responseTimeMs = Math.round(performance.now() - startTime);
+                // Use async version to not block the response
+                requestLogger.logAsync(ctx, responseTimeMs);
+            }
+        }
+        catch (error) {
+            console.error('[RequestLoggerMiddleware] Error:', error);
+        }
+    }
+}

package/build/providers/audit_provider.d.ts

@@ -0,0 +1,13 @@
+import type { ApplicationService } from '@adonisjs/core/types';
+import { AuditService } from '../src/audit_service.js';
+declare module '@adonisjs/core/types' {
+    interface ContainerBindings {
+        audit: AuditService;
+    }
+}
+export default class AuditProvider {
+    protected app: ApplicationService;
+    constructor(app: ApplicationService);
+    register(): void;
+    boot(): Promise<void>;
+}

package/build/providers/audit_provider.js

@@ -0,0 +1,52 @@
+/*
+|--------------------------------------------------------------------------
+| Audit Provider
+|--------------------------------------------------------------------------
+|
+| This provider registers the audit service in the container and initializes
+| the error logger.
+|
+*/
+import { AuditService } from '../src/audit_service.js';
+import { AuditErrorLogger } from '../src/error_logger.js';
+export default class AuditProvider {
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    register() {
+        this.app.container.singleton('audit', () => {
+            const config = this.app.config.get('audit', {
+                enabled: true,
+                requestLog: {
+                    enabled: true,
+                    excludeRoutes: [],
+                    excludeMethods: ['OPTIONS'],
+                    logBody: false,
+                    logQuery: true,
+                    sanitizeFields: ['password', 'token', 'secret'],
+                },
+                errorLog: {
+                    enabled: true,
+                    excludeStatusCodes: [404],
+                    includeStack: true,
+                },
+                auditLog: {
+                    enabled: true,
+                },
+                retention: {
+                    requestLogs: 30,
+                    errorLogs: 90,
+                    auditLogs: 365,
+                },
+            });
+            return new AuditService(config);
+        });
+    }
+    async boot() {
+        const config = this.app.config.get('audit');
+        if (config) {
+            AuditErrorLogger.init(config);
+        }
+    }
+}

package/build/services/main.d.ts

@@ -0,0 +1,3 @@
+import { AuditService } from '../src/audit_service.js';
+declare let audit: AuditService;
+export { audit as default };

package/build/services/main.js

@@ -0,0 +1,15 @@
+/*
+|--------------------------------------------------------------------------
+| Audit Service Singleton
+|--------------------------------------------------------------------------
+|
+| This file exports the audit service singleton that can be imported
+| anywhere in the application.
+|
+*/
+import app from '@adonisjs/core/services/app';
+let audit;
+await app.booted(async () => {
+    audit = await app.container.make('audit');
+});
+export { audit as default };

package/build/src/audit_service.d.ts

@@ -0,0 +1,43 @@
+import type { AuditConfig } from './types.js';
+import AuditLog from './models/audit_log.js';
+export declare class AuditService {
+    #private;
+    protected config: AuditConfig;
+    constructor(config: AuditConfig);
+    /**
+     * Check if logging is enabled
+     */
+    get isEnabled(): boolean;
+    /**
+     * Create an audit log entry (fire-and-forget, non-blocking)
+     */
+    logAsync(actionType: string, metadata?: Record<string, unknown>): void;
+    /**
+     * Create an audit log entry (blocking, returns the created log)
+     */
+    log(actionType: string, metadata?: Record<string, unknown>): Promise<AuditLog | null>;
+    /**
+     * Log with change tracking (fire-and-forget)
+     */
+    logChangeAsync(actionType: string, options: {
+        userId?: number | null;
+        targetId?: number | string;
+        changes: Record<string, {
+            from: unknown;
+            to: unknown;
+        }>;
+        extra?: Record<string, unknown>;
+    }): void;
+    /**
+     * Log with change tracking (blocking)
+     */
+    logChange(actionType: string, options: {
+        userId?: number | null;
+        targetId?: number | string;
+        changes: Record<string, {
+            from: unknown;
+            to: unknown;
+        }>;
+        extra?: Record<string, unknown>;
+    }): Promise<AuditLog | null>;
+}

package/build/src/audit_service.js

@@ -0,0 +1,76 @@
+/*
+|--------------------------------------------------------------------------
+| Audit Service
+|--------------------------------------------------------------------------
+|
+| Main service for creating custom audit logs. Provides a simple API
+| for logging user actions and business events.
+|
+*/
+import AuditLog from './models/audit_log.js';
+export class AuditService {
+    config;
+    constructor(config) {
+        this.config = config;
+    }
+    /**
+     * Check if logging is enabled
+     */
+    get isEnabled() {
+        return this.config.enabled && this.config.auditLog.enabled;
+    }
+    /**
+     * Create an audit log entry (fire-and-forget, non-blocking)
+     */
+    logAsync(actionType, metadata = {}) {
+        if (!this.isEnabled) {
+            return;
+        }
+        setImmediate(() => {
+            this.#createLog(actionType, metadata).catch((error) => {
+                console.error('[AuditService] Failed to log:', error);
+            });
+        });
+    }
+    /**
+     * Create an audit log entry (blocking, returns the created log)
+     */
+    async log(actionType, metadata = {}) {
+        if (!this.isEnabled) {
+            return null;
+        }
+        return this.#createLog(actionType, metadata);
+    }
+    /**
+     * Log with change tracking (fire-and-forget)
+     */
+    logChangeAsync(actionType, options) {
+        this.logAsync(actionType, {
+            user_id: options.userId,
+            target_id: options.targetId,
+            changes: options.changes,
+            ...options.extra,
+        });
+    }
+    /**
+     * Log with change tracking (blocking)
+     */
+    async logChange(actionType, options) {
+        return this.log(actionType, {
+            user_id: options.userId,
+            target_id: options.targetId,
+            changes: options.changes,
+            ...options.extra,
+        });
+    }
+    async #createLog(actionType, metadata) {
+        const userId = (metadata.user_id ?? metadata.userId ?? null);
+        // Create clean metadata without user_id fields
+        const cleanMetadata = Object.fromEntries(Object.entries(metadata).filter(([key]) => key !== 'user_id' && key !== 'userId'));
+        return AuditLog.create({
+            actionType,
+            metadata: cleanMetadata,
+            userId,
+        });
+    }
+}

package/build/src/error_logger.d.ts

@@ -0,0 +1,35 @@
+import type { HttpContext } from '@adonisjs/core/http';
+import type { AuditConfig } from './types.js';
+import ErrorLog from './models/error_log.js';
+export declare class ErrorLogger {
+    #private;
+    protected config: AuditConfig;
+    constructor(config: AuditConfig);
+    /**
+     * Check if the error should be logged
+     */
+    shouldLog(error: unknown, ctx?: HttpContext): boolean;
+    /**
+     * Log an error (fire-and-forget, non-blocking)
+     */
+    logAsync(error: unknown, ctx?: HttpContext): void;
+    /**
+     * Log an error (blocking, returns the created log)
+     */
+    log(error: unknown, ctx?: HttpContext): Promise<ErrorLog | null>;
+}
+/**
+ * Static helper for easy integration with exception handler
+ */
+export declare const AuditErrorLogger: {
+    instance: ErrorLogger | null;
+    init(config: AuditConfig): void;
+    /**
+     * Log error asynchronously (non-blocking)
+     */
+    logAsync(error: unknown, ctx?: HttpContext): void;
+    /**
+     * Log error and wait for result
+     */
+    log(error: unknown, ctx?: HttpContext): Promise<ErrorLog | null>;
+};

package/build/src/error_logger.js

@@ -0,0 +1,106 @@
+/*
+|--------------------------------------------------------------------------
+| Error Logger
+|--------------------------------------------------------------------------
+|
+| Logic for logging application errors. Designed to be integrated with
+| the AdonisJS exception handler.
+|
+*/
+import { getUserIdFromContext, getErrorStatusCode, isHttpError } from './types.js';
+import ErrorLog from './models/error_log.js';
+export class ErrorLogger {
+    config;
+    #excludedStatusCodes;
+    constructor(config) {
+        this.config = config;
+        // Pre-compute set for O(1) lookup
+        this.#excludedStatusCodes = new Set(config.errorLog.excludeStatusCodes);
+    }
+    /**
+     * Check if the error should be logged
+     */
+    shouldLog(error, ctx) {
+        if (!this.config.enabled || !this.config.errorLog.enabled) {
+            return false;
+        }
+        // Check if status code is excluded (O(1) lookup)
+        if (ctx) {
+            const statusCode = getErrorStatusCode(error) ?? ctx.response.getStatus();
+            if (this.#excludedStatusCodes.has(statusCode)) {
+                return false;
+            }
+        }
+        return true;
+    }
+    /**
+     * Log an error (fire-and-forget, non-blocking)
+     */
+    logAsync(error, ctx) {
+        if (!this.shouldLog(error, ctx)) {
+            return;
+        }
+        setImmediate(() => {
+            this.#createLog(error, ctx).catch((err) => {
+                console.error('[ErrorLogger] Failed to log error:', err);
+            });
+        });
+    }
+    /**
+     * Log an error (blocking, returns the created log)
+     */
+    async log(error, ctx) {
+        if (!this.shouldLog(error, ctx)) {
+            return null;
+        }
+        return this.#createLog(error, ctx);
+    }
+    async #createLog(error, ctx) {
+        const err = isHttpError(error) ? error : new Error(String(error));
+        const entry = {
+            errorType: err.constructor?.name ?? 'Error',
+            message: err.message,
+            stack: this.config.errorLog.includeStack ? (err.stack ?? null) : null,
+            url: ctx?.request.url(true) ?? null,
+            method: ctx?.request.method() ?? null,
+            statusCode: err.status ?? ctx?.response.getStatus() ?? 500,
+            userId: ctx ? getUserIdFromContext(ctx) : null,
+            context: ctx
+                ? {
+                    params: ctx.params,
+                    query: ctx.request.qs(),
+                }
+                : null,
+        };
+        return ErrorLog.create(entry);
+    }
+}
+/**
+ * Static helper for easy integration with exception handler
+ */
+export const AuditErrorLogger = {
+    instance: null,
+    init(config) {
+        this.instance = new ErrorLogger(config);
+    },
+    /**
+     * Log error asynchronously (non-blocking)
+     */
+    logAsync(error, ctx) {
+        if (!this.instance) {
+            console.warn('[AuditErrorLogger] Not initialized. Call AuditErrorLogger.init() first.');
+            return;
+        }
+        this.instance.logAsync(error, ctx);
+    },
+    /**
+     * Log error and wait for result
+     */
+    async log(error, ctx) {
+        if (!this.instance) {
+            console.warn('[AuditErrorLogger] Not initialized. Call AuditErrorLogger.init() first.');
+            return null;
+        }
+        return this.instance.log(error, ctx);
+    },
+};