rl-core-api 0.3.0 → 0.5.0

package/dist/features/audit/presentation/audit.interceptor.d.ts

@@ -1,8 +1,12 @@
 import { CallHandler, ExecutionContext, NestInterceptor } from "@nestjs/common";
+import { Reflector } from "@nestjs/core";
 import { Observable } from "rxjs";
+import { EnvService } from "../../../core/config/env.service";
 import { AuditService } from "../domain/audit.service";
 export declare class AuditInterceptor implements NestInterceptor {
     private readonly audit;
-    constructor(audit: AuditService);
+    private readonly env;
+    private readonly reflector;
+    constructor(audit: AuditService, env: EnvService, reflector: Reflector);
     intercept(context: ExecutionContext, next: CallHandler): Observable<unknown>;
 }

package/dist/features/audit/presentation/audit.interceptor.js

@@ -12,15 +12,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuditInterceptor = void 0;
 const node_crypto_1 = require("node:crypto");
 const common_1 = require("@nestjs/common");
+const core_1 = require("@nestjs/core");
 const rxjs_1 = require("rxjs");
+const env_service_1 = require("../../../core/config/env.service");
 const auditContext_1 = require("../../../core/context/auditContext");
+const requestLog_context_1 = require("../../../core/context/requestLog.context");
 const ip_util_1 = require("../../../core/utils/ip.util");
 const audit_service_1 = require("../domain/audit.service");
-const classifyError_util_1 = require("../domain/classifyError.util");
+const requestOutcome_enum_1 = require("../domain/enums/requestOutcome.enum");
+const auditable_decorator_1 = require("./decorators/auditable.decorator");
 const REQUEST_ID_HEADER = "x-request-id";
 let AuditInterceptor = class AuditInterceptor {
-    constructor(audit) {
+    constructor(audit, env, reflector) {
         this.audit = audit;
+        this.env = env;
+        this.reflector = reflector;
     }
     intercept(context, next) {
         const req = context.switchToHttp().getRequest();
@@ -32,41 +38,58 @@ let AuditInterceptor = class AuditInterceptor {
         const requestId = req.headers[REQUEST_ID_HEADER] || (0, node_crypto_1.randomUUID)();
         res.setHeader("X-Request-Id", requestId);
         req.requestId = requestId;
+        const auditable = this.reflector.getAllAndOverride(auditable_decorator_1.AUDITABLE_KEY, [context.getHandler(), context.getClass()]);
+        const action = auditable
+            ? (auditable.action ?? `${method} ${req.path}`)
+            : null;
+        const logContext = { action, startedAt: start, userId: user?.id ?? null };
+        (0, requestLog_context_1.setRequestLogContext)(req, logContext);
         res.once("finish", () => {
-            void this.audit.recordChange({
-                userId: user?.id ?? null,
-                action: `${method} ${req.path}`,
+            const durationMs = Date.now() - start;
+            if (res.statusCode >= 400) {
+                return;
+            }
+            const slow = durationMs >= this.env.get("AUDIT_SLOW_REQUEST_MS");
+            if (!action && !slow) {
+                return;
+            }
+            if (action && !slow && !auditable.allowSystem && !logContext.userId) {
+                return;
+            }
+            void this.audit.recordRequest({
+                outcome: requestOutcome_enum_1.RequestOutcome.SUCCESS,
+                action,
                 method,
                 path: req.path,
-                ipAddress,
+                route: (0, requestLog_context_1.routePathOf)(req),
                 statusCode: res.statusCode,
+                durationMs,
+                userId: logContext.userId,
+                ipHash: (0, ip_util_1.hashIp)(ipAddress, this.env.auditIpSalt()) ?? null,
+                userAgent: req.headers["user-agent"]?.slice(0, 255) ?? null,
+                requestId,
+            });
+        });
+        res.once("close", () => {
+            if (res.writableFinished) {
+                return;
+            }
+            void this.audit.recordRequest({
+                outcome: requestOutcome_enum_1.RequestOutcome.ABORTED,
+                action,
+                method,
+                path: req.path,
+                route: (0, requestLog_context_1.routePathOf)(req),
                 durationMs: Date.now() - start,
+                userId: logContext.userId,
+                ipHash: (0, ip_util_1.hashIp)(ipAddress, this.env.auditIpSalt()) ?? null,
+                userAgent: req.headers["user-agent"]?.slice(0, 255) ?? null,
                 requestId,
             });
         });
         return new rxjs_1.Observable((subscriber) => {
             auditContext_1.auditContext.run({ userId: user?.id ?? null, ipAddress, requestId }, () => {
-                next
-                    .handle()
-                    .pipe((0, rxjs_1.tap)({
-                    error: (err) => {
-                        const status = err?.status ?? 500;
-                        if (status >= 400) {
-                            void this.audit.recordError({
-                                statusCode: status,
-                                type: (0, classifyError_util_1.classifyError)(err, status),
-                                message: err?.message ?? "Erro desconhecido",
-                                stack: err?.stack ?? null,
-                                method,
-                                path: req.path,
-                                userId: user?.id ?? null,
-                                ipAddress,
-                                requestId,
-                            });
-                        }
-                    },
-                }))
-                    .subscribe(subscriber);
+                next.handle().subscribe(subscriber);
             });
         });
     }
@@ -74,5 +97,7 @@ let AuditInterceptor = class AuditInterceptor {
 exports.AuditInterceptor = AuditInterceptor;
 exports.AuditInterceptor = AuditInterceptor = __decorate([
     (0, common_1.Injectable)(),
-    __metadata("design:paramtypes", [audit_service_1.AuditService])
+    __metadata("design:paramtypes", [audit_service_1.AuditService,
+        env_service_1.EnvService,
+        core_1.Reflector])
 ], AuditInterceptor);

package/dist/features/audit/presentation/decorators/auditable.decorator.d.ts

@@ -0,0 +1,10 @@
+import { CustomDecorator } from "@nestjs/common";
+export declare const AUDITABLE_KEY = "auditable";
+export interface AuditableOptions {
+    allowSystem?: boolean;
+}
+export interface AuditableMetadata {
+    action: string | null;
+    allowSystem: boolean;
+}
+export declare const Auditable: (action?: string, options?: AuditableOptions) => CustomDecorator<string>;

package/dist/features/audit/presentation/decorators/auditable.decorator.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Auditable = exports.AUDITABLE_KEY = void 0;
+const common_1 = require("@nestjs/common");
+exports.AUDITABLE_KEY = "auditable";
+const Auditable = (action, options) => (0, common_1.SetMetadata)(exports.AUDITABLE_KEY, {
+    action: action ?? null,
+    allowSystem: options?.allowSystem ?? false,
+});
+exports.Auditable = Auditable;

package/dist/features/audit/presentation/filters/audit.filters.d.ts

@@ -1,4 +1,3 @@
 import { FilterCatalog } from "../../../../core/query/filterField.interface";
-export declare const AUDIT_CHANGES_FILTER_CATALOG: FilterCatalog;
-export declare const ERROR_LOGS_FILTER_CATALOG: FilterCatalog;
+export declare const REQUEST_LOGS_FILTER_CATALOG: FilterCatalog;
 export declare const AUDIT_DATA_CHANGES_FILTER_CATALOG: FilterCatalog;

package/dist/features/audit/presentation/filters/audit.filters.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AUDIT_DATA_CHANGES_FILTER_CATALOG = exports.ERROR_LOGS_FILTER_CATALOG = exports.AUDIT_CHANGES_FILTER_CATALOG = void 0;
+exports.AUDIT_DATA_CHANGES_FILTER_CATALOG = exports.REQUEST_LOGS_FILTER_CATALOG = void 0;
 const filterFieldType_enum_1 = require("../../../../core/query/filterFieldType.enum");
+const errorType_enum_1 = require("../../domain/enums/errorType.enum");
+const requestOutcome_enum_1 = require("../../domain/enums/requestOutcome.enum");
 const auditDataChange_schema_1 = require("../../infra/schema/auditDataChange.schema");
-const errorLog_schema_1 = require("../../infra/schema/errorLog.schema");
 const TRACKED_ENTITIES = [
     "User",
     "Role",
@@ -14,7 +15,35 @@ const TRACKED_ENTITIES = [
     "Scope",
 ];
 const optionsFromValues = (values) => values.map((value) => ({ value, label: value }));
-exports.AUDIT_CHANGES_FILTER_CATALOG = [
+const optionsFromEnum = (labels) => Object.entries(labels).map(([value, label]) => ({ value, label }));
+const REQUEST_OUTCOME_LABELS = {
+    [requestOutcome_enum_1.RequestOutcome.SUCCESS]: "Sucesso",
+    [requestOutcome_enum_1.RequestOutcome.ERROR]: "Erro",
+    [requestOutcome_enum_1.RequestOutcome.ABORTED]: "Abortada",
+};
+const ERROR_TYPE_LABELS = {
+    [errorType_enum_1.ErrorType.VALIDATION]: "Validação",
+    [errorType_enum_1.ErrorType.AUTH]: "Autenticação",
+    [errorType_enum_1.ErrorType.NOT_FOUND]: "Não encontrado",
+    [errorType_enum_1.ErrorType.RATE_LIMIT]: "Limite de requisições",
+    [errorType_enum_1.ErrorType.DATABASE]: "Banco de dados",
+    [errorType_enum_1.ErrorType.INTEGRATION]: "Integração",
+    [errorType_enum_1.ErrorType.INTERNAL]: "Interno",
+};
+const AUDIT_DATA_ACTION_LABELS = {
+    [auditDataChange_schema_1.AuditDataAction.CREATE]: "Criação",
+    [auditDataChange_schema_1.AuditDataAction.UPDATE]: "Alteração",
+    [auditDataChange_schema_1.AuditDataAction.DELETE]: "Exclusão",
+};
+exports.REQUEST_LOGS_FILTER_CATALOG = [
+    {
+        field: "outcome",
+        column: "outcome",
+        label: "Desfecho",
+        type: filterFieldType_enum_1.FilterFieldType.Enum,
+        options: optionsFromEnum(REQUEST_OUTCOME_LABELS),
+        sortable: true,
+    },
     {
         field: "action",
         column: "action",
@@ -27,29 +56,28 @@ exports.AUDIT_CHANGES_FILTER_CATALOG = [
         column: "method",
         label: "Método",
         type: filterFieldType_enum_1.FilterFieldType.Enum,
-        options: optionsFromValues([
-            "GET",
-            "POST",
-            "PATCH",
-            "PUT",
-            "DELETE",
-        ]),
+        options: optionsFromValues(["GET", "POST", "PATCH", "PUT", "DELETE"]),
         sortable: true,
     },
     {
-        field: "path",
-        column: "path",
+        field: "route",
+        column: "route",
         label: "Rota",
         type: filterFieldType_enum_1.FilterFieldType.Text,
         sortable: true,
     },
+    {
+        field: "path",
+        column: "path",
+        label: "Caminho",
+        type: filterFieldType_enum_1.FilterFieldType.Text,
+    },
     {
         field: "statusCode",
         column: "statusCode",
         label: "Status HTTP",
         type: filterFieldType_enum_1.FilterFieldType.Number,
         sortable: true,
-        filterable: false,
     },
     {
         field: "durationMs",
@@ -57,49 +85,24 @@ exports.AUDIT_CHANGES_FILTER_CATALOG = [
         label: "Duração (ms)",
         type: filterFieldType_enum_1.FilterFieldType.Number,
         sortable: true,
-        filterable: false,
-    },
-    {
-        field: "userId",
-        column: "userId",
-        label: "Usuário",
-        type: filterFieldType_enum_1.FilterFieldType.Uuid,
     },
-];
-exports.ERROR_LOGS_FILTER_CATALOG = [
     {
-        field: "type",
-        column: "type",
-        label: "Tipo",
+        field: "errorType",
+        column: "errorType",
+        label: "Tipo do erro",
         type: filterFieldType_enum_1.FilterFieldType.Enum,
-        options: optionsFromValues(Object.values(errorLog_schema_1.ErrorType)),
-        sortable: true,
-    },
-    {
-        field: "statusCode",
-        column: "statusCode",
-        label: "Status HTTP",
-        type: filterFieldType_enum_1.FilterFieldType.Number,
-        sortable: true,
-        filterable: false,
+        options: optionsFromEnum(ERROR_TYPE_LABELS),
     },
     {
-        field: "message",
-        column: "message",
-        label: "Mensagem",
+        field: "errorCode",
+        column: "errorCode",
+        label: "Código do erro",
         type: filterFieldType_enum_1.FilterFieldType.Text,
     },
     {
-        field: "method",
-        column: "method",
-        label: "Método",
-        type: filterFieldType_enum_1.FilterFieldType.Enum,
-        options: optionsFromValues(["GET", "POST", "PATCH", "PUT", "DELETE"]),
-    },
-    {
-        field: "path",
-        column: "path",
-        label: "Rota",
+        field: "errorMessage",
+        column: "errorMessage",
+        label: "Mensagem",
         type: filterFieldType_enum_1.FilterFieldType.Text,
     },
     {
@@ -108,6 +111,19 @@ exports.ERROR_LOGS_FILTER_CATALOG = [
         label: "Usuário",
         type: filterFieldType_enum_1.FilterFieldType.Uuid,
     },
+    {
+        field: "requestId",
+        column: "requestId",
+        label: "ID da requisição",
+        type: filterFieldType_enum_1.FilterFieldType.Uuid,
+    },
+    {
+        field: "createdAt",
+        column: "createdAt",
+        label: "Data",
+        type: filterFieldType_enum_1.FilterFieldType.DateTime,
+        sortable: true,
+    },
 ];
 exports.AUDIT_DATA_CHANGES_FILTER_CATALOG = [
     {
@@ -129,7 +145,7 @@ exports.AUDIT_DATA_CHANGES_FILTER_CATALOG = [
         column: "action",
         label: "Ação",
         type: filterFieldType_enum_1.FilterFieldType.Enum,
-        options: optionsFromValues(Object.values(auditDataChange_schema_1.AuditDataAction)),
+        options: optionsFromEnum(AUDIT_DATA_ACTION_LABELS),
         sortable: true,
     },
     {

package/dist/features/audit/presentation/httpError.listener.d.ts

@@ -0,0 +1,8 @@
+import { HttpErrorEvent } from "../../../core/events/appEvent.enum";
+import { AuditService } from "../domain/audit.service";
+export declare class HttpErrorListener {
+    private readonly audit;
+    private readonly logger;
+    constructor(audit: AuditService);
+    onHttpError(event: HttpErrorEvent): Promise<void>;
+}

package/dist/features/audit/presentation/httpError.listener.js

@@ -0,0 +1,61 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var HttpErrorListener_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpErrorListener = void 0;
+const common_1 = require("@nestjs/common");
+const event_emitter_1 = require("@nestjs/event-emitter");
+const appEvent_enum_1 = require("../../../core/events/appEvent.enum");
+const audit_service_1 = require("../domain/audit.service");
+const classifyError_util_1 = require("../domain/classifyError.util");
+const requestOutcome_enum_1 = require("../domain/enums/requestOutcome.enum");
+const TEXT_MAX_LENGTH = 255;
+let HttpErrorListener = HttpErrorListener_1 = class HttpErrorListener {
+    constructor(audit) {
+        this.audit = audit;
+        this.logger = new common_1.Logger(HttpErrorListener_1.name);
+    }
+    async onHttpError(event) {
+        try {
+            await this.audit.recordRequest({
+                outcome: requestOutcome_enum_1.RequestOutcome.ERROR,
+                action: event.action ?? null,
+                method: event.method,
+                path: event.path,
+                route: event.route,
+                statusCode: event.statusCode,
+                durationMs: event.durationMs ?? null,
+                userId: event.userId,
+                ipHash: event.ipHash,
+                userAgent: event.userAgent?.slice(0, TEXT_MAX_LENGTH) ?? null,
+                requestId: event.requestId,
+                errorType: (0, classifyError_util_1.classifyError)({ name: event.errorName }, event.statusCode),
+                errorCode: event.errorCode,
+                errorMessage: (event.message || "Erro desconhecido").slice(0, TEXT_MAX_LENGTH),
+                errorStack: event.statusCode >= 500 ? (event.stack ?? null) : null,
+            });
+        }
+        catch (err) {
+            this.logger.warn(`Falha ao registrar RequestLog: ${err.message}`);
+        }
+    }
+};
+exports.HttpErrorListener = HttpErrorListener;
+__decorate([
+    (0, event_emitter_1.OnEvent)(appEvent_enum_1.AppEvent.HTTP_ERROR),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], HttpErrorListener.prototype, "onHttpError", null);
+exports.HttpErrorListener = HttpErrorListener = HttpErrorListener_1 = __decorate([
+    (0, common_1.Injectable)(),
+    __metadata("design:paramtypes", [audit_service_1.AuditService])
+], HttpErrorListener);

package/dist/features/audit/presentation/index.d.ts

@@ -1,2 +1,5 @@
 export * from "./audit.controller";
 export * from "./audit.interceptor";
+export * from "./decorators/auditable.decorator";
+export * from "./httpError.listener";
+export * from "./userRolesChanged.listener";

package/dist/features/audit/presentation/index.js

@@ -16,3 +16,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./audit.controller"), exports);
 __exportStar(require("./audit.interceptor"), exports);
+__exportStar(require("./decorators/auditable.decorator"), exports);
+__exportStar(require("./httpError.listener"), exports);
+__exportStar(require("./userRolesChanged.listener"), exports);

package/dist/features/audit/presentation/responses/auditDataChange.response.js

@@ -45,7 +45,7 @@ __decorate([
 ], AuditDataChangeResponse.prototype, "entityId", void 0);
 __decorate([
     (0, swagger_1.ApiProperty)({ enum: auditDataChange_schema_1.AuditDataAction, enumName: "AuditDataAction" }),
-    __metadata("design:type", String)
+    __metadata("design:type", Number)
 ], AuditDataChangeResponse.prototype, "action", void 0);
 __decorate([
     (0, swagger_1.ApiProperty)({ type: Object, required: false, nullable: true }),

package/dist/features/audit/presentation/responses/log.response.d.ts

@@ -1,20 +1,25 @@
 import { PaginationMetaResponse } from "../../../../core/utils/paginationMeta.response";
-import { ErrorType } from "../../infra/schema/errorLog.schema";
+import { ErrorType } from "../../domain/enums/errorType.enum";
+import { RequestOutcome } from "../../domain/enums/requestOutcome.enum";
 import { AuditUserRefResponse } from "./auditDataChange.response";
 export declare class RequestLogResponse {
     id: string;
-    action: string;
-    entity?: string | null;
-    entityId?: string | null;
+    outcome: RequestOutcome;
+    action?: string | null;
     method?: string | null;
     path?: string | null;
+    route?: string | null;
     statusCode?: number | null;
     durationMs?: number | null;
-    ipAddress?: string | null;
-    requestId?: string | null;
-    metadata?: Record<string, unknown> | null;
     userId?: string | null;
     user?: AuditUserRefResponse | null;
+    ipHash?: string | null;
+    userAgent?: string | null;
+    requestId?: string | null;
+    errorType?: ErrorType | null;
+    errorCode?: string | null;
+    errorMessage?: string | null;
+    errorStack?: string | null;
     createdAt: Date;
     updatedAt: Date;
     deletedAt?: Date | null;
@@ -23,23 +28,3 @@ export declare class PaginatedRequestLogsResponse {
     items: RequestLogResponse[];
     meta: PaginationMetaResponse;
 }
-export declare class ErrorLogResponse {
-    id: string;
-    type: ErrorType;
-    statusCode?: number | null;
-    message: string;
-    stack?: string | null;
-    method?: string | null;
-    path?: string | null;
-    ipAddress?: string | null;
-    requestId?: string | null;
-    userId?: string | null;
-    user?: AuditUserRefResponse | null;
-    createdAt: Date;
-    updatedAt: Date;
-    deletedAt?: Date | null;
-}
-export declare class PaginatedErrorLogsResponse {
-    items: ErrorLogResponse[];
-    meta: PaginationMetaResponse;
-}