@icd-iot-aicf/nestjs-logger 4.0.8 → 4.0.10

package/migration/log-snapshot-v3.e2e-spec.ts

@@ -0,0 +1,364 @@
+/**
+ * Log Snapshot — v3 Baseline Capture Script
+ *
+ * ╔══════════════════════════════════════════════════════════════════╗
+ * ║  COPY THIS FILE INTO YOUR PROJECT'S test/ FOLDER BEFORE         ║
+ * ║  UPGRADING TO v4, THEN RUN:                                      ║
+ * ║                                                                  ║
+ * ║    npx jest --testPathPatterns=log-snapshot --updateSnapshot     ║
+ * ║                                                                  ║
+ * ║  This saves a baseline snapshot of your v3 log format.           ║
+ * ║  After upgrading to v4, run the same file from the v4 package    ║
+ * ║  (test/log-snapshot.e2e-spec.ts) to compare what changed.        ║
+ * ╚══════════════════════════════════════════════════════════════════╝
+ *
+ * REQUIREMENTS (add to your project if missing):
+ *   npm install --save-dev @nestjs/testing supertest
+ *
+ * ADD THIS JEST CONFIG to your jest-e2e.json (or equivalent):
+ *   "transformIgnorePatterns": ["node_modules/(?!(uuid)/)"]
+ */
+
+import { Test, TestingModule } from '@nestjs/testing';
+import {
+  Controller,
+  Get,
+  INestApplication,
+  MiddlewareConsumer,
+  Module,
+  NestModule,
+} from '@nestjs/common';
+import request from 'supertest';
+
+// ── v3 imports (these names change in v4 — do NOT update before snapshotting) ──
+import {
+  AppLogConfigModule,
+  LoggerModule,
+  HTTPLogsMiddleware, // renamed to HttpLogsMiddleware in v4
+  FORMAT_TYPE,
+  CustomLoggerService,
+  RecordName,
+  HttpAction,
+  DBAction,
+  LogicAction,
+  ExceptionAction,
+} from '@icd-iot-aicf/nestjs-logger';
+
+// ── Normalisation ──────────────────────────────────────────────────────────────
+
+const DYNAMIC_FIELDS = new Set([
+  'timestamp',
+  'systemTimestamp',
+  'reqTimestamp',
+  'resTimestamp',
+  'transactionId',
+  'sessionId',
+  'tid',
+  'subSessionId',
+  'serviceStartTime',
+  'serviceEndTime',
+  'serviceTime',
+  'usageTime',
+  'startTime',
+  'endTime',
+  'processTime',
+  'instance',
+  'containerId',
+  'message',
+]);
+
+function normalizeLog(log: any): any {
+  if (typeof log !== 'object' || log === null) return log;
+  if (Array.isArray(log)) return log.map(normalizeLog);
+
+  const result: Record<string, any> = {};
+  for (const [key, value] of Object.entries(log)) {
+    if (DYNAMIC_FIELDS.has(key)) {
+      result[key] = '[NORMALIZED]';
+    } else if (typeof value === 'string') {
+      result[key] = normalizeString(value);
+    } else {
+      result[key] = normalizeLog(value);
+    }
+  }
+  return result;
+}
+
+function normalizeString(value: string): string {
+  try {
+    const parsed = JSON.parse(value);
+    if (typeof parsed === 'object' && parsed !== null) {
+      return JSON.stringify(normalizeLog(parsed));
+    }
+  } catch {
+    /* not JSON */
+  }
+
+  return value
+    .replace(/\b(\d{1,3}\.){3}\d{1,3}:\d+\b/g, '[HOST]')
+    .replace(/\blocalhost:\d+\b/g, '[HOST]')
+    .replace(
+      /[a-z0-9_-]+_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/gi,
+      '[AUTO-TXN]',
+    );
+}
+
+function captureSnapshot(calls: jest.MockContext<any, any[]>['calls']) {
+  return {
+    count: calls.length,
+    logs: calls.map(([arg]) => normalizeLog(arg)),
+  };
+}
+
+// ── Shared test controller ─────────────────────────────────────────────────────
+
+@Controller('snapshot')
+class SnapshotController {
+  @Get('success')
+  @RecordName('SuccessEndpoint')
+  success() {
+    return { resultCode: '20000', resultDescription: 'SUCCESS', httpCode: 200 };
+  }
+
+  @Get('not-found')
+  @RecordName('NotFoundEndpoint')
+  notFound() {
+    return {
+      resultCode: '40400',
+      resultDescription: 'DATA_NOT_FOUND',
+      httpCode: 404,
+    };
+  }
+
+  @Get('no-headers')
+  noHeaders() {
+    return { ok: true };
+  }
+}
+
+const waitForFinish = (ms = 80) => new Promise((r) => setTimeout(r, ms));
+
+// ─────────────────────────────────────────────────────────────────────────────
+// IMPORTANT: describe() and it() names below MUST match the v4 snapshot file
+//            exactly — Jest uses these names as snapshot keys for comparison.
+// ─────────────────────────────────────────────────────────────────────────────
+
+describe('Log Snapshot — AICF format', () => {
+  let app: INestApplication;
+  let logSpy: jest.SpyInstance;
+
+  beforeAll(async () => {
+    @Module({
+      imports: [
+        AppLogConfigModule.forRoot({
+          appName: 'snapshot-app',
+          componentName: 'snapshot-comp',
+          format: FORMAT_TYPE.AICF,
+        }),
+        LoggerModule,
+      ],
+      controllers: [SnapshotController],
+    })
+    class AicfSnapshotModule implements NestModule {
+      configure(consumer: MiddlewareConsumer) {
+        // v3 name — this is what changes in v4 (HttpLogsMiddleware)
+        consumer.apply(HTTPLogsMiddleware).forRoutes('*');
+      }
+    }
+
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AicfSnapshotModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.init();
+
+    logSpy = jest.spyOn(app.get(CustomLoggerService), 'log');
+  });
+
+  afterAll(async () => await app.close());
+  beforeEach(() => logSpy.mockClear());
+
+  it('GET /snapshot/success — log count + structure', async () => {
+    await request(app.getHttpServer())
+      .get('/snapshot/success')
+      .set('x-ais-orderref', 'SNAP-AICF-001');
+    await waitForFinish();
+    const snapshot = captureSnapshot(logSpy.mock.calls);
+    expect(snapshot.count).toMatchSnapshot('log count');
+    expect(snapshot.logs).toMatchSnapshot('log structure');
+  });
+
+  it('GET /snapshot/not-found — log count + structure', async () => {
+    await request(app.getHttpServer())
+      .get('/snapshot/not-found')
+      .set('x-ais-orderref', 'SNAP-AICF-002');
+    await waitForFinish();
+    const snapshot = captureSnapshot(logSpy.mock.calls);
+    expect(snapshot.count).toMatchSnapshot('log count');
+    expect(snapshot.logs).toMatchSnapshot('log structure');
+  });
+
+  it('GET /snapshot/no-headers — log count + structure (missing correlation headers)', async () => {
+    await request(app.getHttpServer()).get('/snapshot/no-headers');
+    await waitForFinish();
+    const snapshot = captureSnapshot(logSpy.mock.calls);
+    expect(snapshot.count).toMatchSnapshot('log count');
+    expect(snapshot.logs).toMatchSnapshot('log structure');
+  });
+
+  it('HttpAction.GET — DTO field structure', () => {
+    const dto = HttpAction.GET({
+      requestObject: {
+        url: '/api/users/1',
+        headers: { 'x-ais-orderref': 'SNAP-ACT-001' },
+        queryString: {},
+        routeParameters: {},
+        payload: {},
+      },
+      responseObject: { httpStatusCode: 200, headers: {}, payload: { id: 1 } },
+    });
+    expect(normalizeLog(dto)).toMatchSnapshot();
+  });
+
+  it('HttpAction.POST — DTO field structure', () => {
+    const dto = HttpAction.POST({
+      requestObject: {
+        url: '/api/users',
+        headers: {},
+        queryString: {},
+        routeParameters: {},
+        payload: { name: 'test-user' },
+      },
+      responseObject: { httpStatusCode: 201, headers: {}, payload: { id: 99 } },
+    });
+    expect(normalizeLog(dto)).toMatchSnapshot();
+  });
+
+  it('DBAction.READ — DTO field structure', () => {
+    const dto = DBAction.READ({
+      requestObject: { method: 'findOne', payload: { id: 1 } },
+      responseObject: {
+        httpStatusCode: 200,
+        headers: {},
+        payload: { name: 'item' },
+      },
+    });
+    expect(normalizeLog(dto)).toMatchSnapshot();
+  });
+
+  it('DBAction.CREATE — DTO field structure', () => {
+    const dto = DBAction.CREATE({
+      requestObject: { method: 'insertOne', payload: { name: 'new-item' } },
+    });
+    expect(normalizeLog(dto)).toMatchSnapshot();
+  });
+
+  it('LogicAction.FUNCTION — DTO field structure', () => {
+    const dto = LogicAction.FUNCTION({ message: 'Processing data' });
+    expect(normalizeLog(dto)).toMatchSnapshot();
+  });
+
+  it('LogicAction.CHECKPOINT — DTO field structure', () => {
+    const dto = LogicAction.CHECKPOINT({ message: 'Step completed' });
+    expect(normalizeLog(dto)).toMatchSnapshot();
+  });
+
+  it('ExceptionAction.LOG — DTO field structure', () => {
+    const dto = ExceptionAction.LOG({ message: 'Unexpected error occurred' });
+    expect(normalizeLog(dto)).toMatchSnapshot();
+  });
+});
+
+describe('Log Snapshot — Cloudron format', () => {
+  let app: INestApplication;
+  let logSpy: jest.SpyInstance;
+
+  beforeAll(async () => {
+    @Module({
+      imports: [
+        AppLogConfigModule.forRoot({
+          appName: 'snapshot-app',
+          componentName: 'snapshot-comp',
+          format: FORMAT_TYPE.CLOUDRON,
+        }),
+        LoggerModule,
+      ],
+      controllers: [SnapshotController],
+    })
+    class CloudronSnapshotModule implements NestModule {
+      configure(consumer: MiddlewareConsumer) {
+        consumer.apply(HTTPLogsMiddleware).forRoutes('*');
+      }
+    }
+
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [CloudronSnapshotModule],
+    }).compile();
+
+    app = moduleFixture.createNestApplication();
+    await app.init();
+
+    logSpy = jest.spyOn(app.get(CustomLoggerService), 'log');
+  });
+
+  afterAll(async () => await app.close());
+  beforeEach(() => logSpy.mockClear());
+
+  it('GET /snapshot/success — log count + structure', async () => {
+    await request(app.getHttpServer())
+      .get('/snapshot/success')
+      .set('x-ais-orderref', 'SNAP-CLDRON-001');
+    await waitForFinish();
+    const snapshot = captureSnapshot(logSpy.mock.calls);
+    expect(snapshot.count).toMatchSnapshot('log count');
+    expect(snapshot.logs).toMatchSnapshot('log structure');
+  });
+
+  it('GET /snapshot/not-found — log count + structure', async () => {
+    await request(app.getHttpServer())
+      .get('/snapshot/not-found')
+      .set('x-ais-orderref', 'SNAP-CLDRON-002');
+    await waitForFinish();
+    const snapshot = captureSnapshot(logSpy.mock.calls);
+    expect(snapshot.count).toMatchSnapshot('log count');
+    expect(snapshot.logs).toMatchSnapshot('log structure');
+  });
+
+  it('GET /snapshot/no-headers — log count + structure (missing correlation headers)', async () => {
+    await request(app.getHttpServer()).get('/snapshot/no-headers');
+    await waitForFinish();
+    const snapshot = captureSnapshot(logSpy.mock.calls);
+    expect(snapshot.count).toMatchSnapshot('log count');
+    expect(snapshot.logs).toMatchSnapshot('log structure');
+  });
+
+  it('HttpAction.GET — DTO field structure', () => {
+    const dto = HttpAction.GET({
+      requestObject: {
+        url: '/api/resource/1',
+        headers: { 'x-ais-orderref': 'SNAP-C-ACT-001' },
+        queryString: {},
+        routeParameters: {},
+        payload: {},
+      },
+      responseObject: { httpStatusCode: 200, headers: {}, payload: {} },
+    });
+    expect(normalizeLog(dto)).toMatchSnapshot();
+  });
+
+  it('DBAction.UPDATE — DTO field structure', () => {
+    const dto = DBAction.UPDATE({
+      requestObject: {
+        method: 'updateOne',
+        payload: { id: 1, name: 'updated' },
+      },
+    });
+    expect(normalizeLog(dto)).toMatchSnapshot();
+  });
+
+  it('LogicAction.FUNCTION — DTO field structure', () => {
+    const dto = LogicAction.FUNCTION({ message: 'Processing' });
+    expect(normalizeLog(dto)).toMatchSnapshot();
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@icd-iot-aicf/nestjs-logger",
-  "version": "4.0.8",
+  "version": "4.0.10",
   "description": "",
   "author": "",
   "private": false,