@ogcio/fastify-logging-wrapper 4.0.0

package/__tests__/logging-wrapper.test.ts

@@ -0,0 +1,168 @@
+import { Level } from "pino";
+import { getLoggerConfiguration } from "../src/logging-wrapper.js";
+import { buildLogger } from "./helpers/build-logger.js";
+import { hostname } from "os";
+import { REDACTED_VALUE } from "../src/logging-wrapper-entities.js";
+import assert from "node:assert";
+import { test } from "node:test";
+
+const getRandomFieldValue = () => Math.random().toString(36).slice(2);
+
+const toRedactFields = {
+  input_value: {
+    request: {
+      "x-api-key": "non redacted because not under headers",
+      headers: {
+        "x-amz-security-token": getRandomFieldValue(),
+        "x-api-key": getRandomFieldValue(),
+        authorization: getRandomFieldValue(),
+        cookie: getRandomFieldValue(),
+        "set-cookie": getRandomFieldValue(),
+        "proxy-authorization": getRandomFieldValue(),
+        non_to_redact: "non_redacted_value",
+      },
+    },
+    response: {
+      headers: {
+        "x-amz-security-token": getRandomFieldValue(),
+        "x-api-key": getRandomFieldValue(),
+        authorization: getRandomFieldValue(),
+        cookie: getRandomFieldValue(),
+        "set-cookie": getRandomFieldValue(),
+        "proxy-authorization": getRandomFieldValue(),
+        non_to_redact: "non_redacted_value",
+      },
+    },
+  },
+  expected_output: {
+    request: {
+      "x-api-key": "non redacted because not under headers",
+      headers: {
+        "x-amz-security-token": REDACTED_VALUE,
+        "x-api-key": REDACTED_VALUE,
+        authorization: REDACTED_VALUE,
+        cookie: REDACTED_VALUE,
+        "set-cookie": REDACTED_VALUE,
+        "proxy-authorization": REDACTED_VALUE,
+        non_to_redact: "non_redacted_value",
+      },
+    },
+    response: {
+      headers: {
+        "x-amz-security-token": REDACTED_VALUE,
+        "x-api-key": REDACTED_VALUE,
+        authorization: REDACTED_VALUE,
+        cookie: REDACTED_VALUE,
+        "set-cookie": REDACTED_VALUE,
+        "proxy-authorization": REDACTED_VALUE,
+        non_to_redact: "non_redacted_value",
+      },
+    },
+  },
+};
+
+const methodsDataProvider = [
+  {
+    method: "trace",
+    expected: {
+      level: 10,
+      level_name: "TRACE",
+    },
+  },
+  {
+    method: "debug",
+    expected: {
+      level: 20,
+      level_name: "DEBUG",
+    },
+  },
+  {
+    method: "info",
+    expected: {
+      level: 30,
+      level_name: "INFO",
+    },
+  },
+  {
+    method: "warn",
+    expected: {
+      level: 40,
+      level_name: "WARN",
+    },
+  },
+  {
+    method: "error",
+    expected: {
+      level: 50,
+      level_name: "ERROR",
+    },
+  },
+  {
+    method: "fatal",
+    expected: {
+      level: 60,
+      level_name: "FATAL",
+    },
+  },
+];
+
+test("Basic format is the expected one", async (t) => {
+  const { logger, loggedRecordsMethod } = buildLogger({
+    ...getLoggerConfiguration("debug"),
+  });
+  logger.debug("test message");
+  logger.info("another message");
+
+  const loggedRecords = loggedRecordsMethod();
+  assert.strictEqual(loggedRecords.length, 2);
+
+  const parsed = JSON.parse(loggedRecords[0]);
+  assert.strictEqual(typeof parsed.timestamp, "number");
+  assert.ok(
+    parsed.timestamp > Date.now() - 2000,
+    "the timestamp must be newer than 2 seconds ago",
+  );
+  delete parsed.timestamp;
+  assert.deepStrictEqual(parsed, {
+    level: 20,
+    level_name: "DEBUG",
+    hostname: hostname(),
+    message: "test message",
+  });
+});
+
+test("Fields are redacted as expected", async (t) => {
+  const { logger, loggedRecordsMethod } = buildLogger({
+    ...getLoggerConfiguration(),
+  });
+  logger.warn(toRedactFields.input_value);
+
+  const loggedRecords = loggedRecordsMethod();
+  const parsed = JSON.parse(loggedRecords[0]);
+  delete parsed.hostname;
+  delete parsed.level;
+  delete parsed.level_name;
+  delete parsed.timestamp;
+
+  assert.deepStrictEqual(parsed, toRedactFields.expected_output);
+});
+
+methodsDataProvider.forEach((methodDataProvider) =>
+  test(`Methods are writing correct levels - ${methodDataProvider.method}`, async (t) => {
+    const { logger, loggedRecordsMethod } = buildLogger({
+      ...getLoggerConfiguration("trace"),
+    });
+
+    logger[methodDataProvider.method]("test");
+
+    const loggedRecords = loggedRecordsMethod();
+    assert.strictEqual(loggedRecords.length, 1);
+    const parsed = JSON.parse(loggedRecords[0]);
+
+    assert.strictEqual(parsed.level, methodDataProvider.expected.level);
+    assert.strictEqual(
+      parsed.level_name,
+      methodDataProvider.expected.level_name,
+    );
+  }),
+);

package/dist/fastify-logging-wrapper.d.ts

@@ -0,0 +1,5 @@
+import { FastifyServerOptions, FastifyInstance } from "fastify";
+import { DestinationStream } from "pino";
+export declare const initializeLoggingHooks: (server: FastifyInstance) => void;
+export declare const getLoggingConfiguration: (loggerDestination?: DestinationStream) => FastifyServerOptions;
+//# sourceMappingURL=fastify-logging-wrapper.d.ts.map

package/dist/fastify-logging-wrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fastify-logging-wrapper.d.ts","sourceRoot":"","sources":["../src/fastify-logging-wrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAchE,OAAO,EAAQ,iBAAiB,EAAE,MAAM,MAAM,CAAC;AAK/C,eAAO,MAAM,sBAAsB,WAAY,eAAe,KAAG,IA6BhE,CAAC;AAEF,eAAO,MAAM,uBAAuB,uBACd,iBAAiB,KACpC,oBAMD,CAAC"}

package/dist/fastify-logging-wrapper.js

@@ -0,0 +1,34 @@
+import hyperid from "hyperid";
+import { LogMessages, REQUEST_ID_LOG_LABEL, } from "./logging-wrapper-entities.js";
+import { getLoggerConfiguration, getLoggingContextError, getPartialLoggingContextError, parseFullLoggingRequest, resetLoggingContext, setLoggingContext, } from "./logging-wrapper.js";
+import { pino } from "pino";
+import { REQUEST_ID_HEADER } from "@ogcio/shared-errors";
+const hyperidInstance = hyperid({ fixedLength: true, urlSafe: true });
+export const initializeLoggingHooks = (server) => {
+    server.addHook("preHandler", (request, _reply, done) => {
+        setLoggingContext({ request });
+        request.log.info({ request: parseFullLoggingRequest(request) }, LogMessages.NewRequest);
+        done();
+    });
+    server.addHook("onResponse", (_req, reply, done) => {
+        setLoggingContext({ response: reply });
+        reply.log.info(LogMessages.Response);
+        // Include error in API Track if exists
+        reply.log.info({ error: getPartialLoggingContextError() }, LogMessages.ApiTrack);
+        resetLoggingContext();
+        done();
+    });
+    server.addHook("onError", (request, _reply, error, done) => {
+        setLoggingContext({ error });
+        request.log.error({ error: getLoggingContextError() }, LogMessages.Error);
+        done();
+    });
+};
+export const getLoggingConfiguration = (loggerDestination) => ({
+    logger: pino(getLoggerConfiguration(), loggerDestination),
+    disableRequestLogging: true,
+    genReqId: () => hyperidInstance(),
+    requestIdLogLabel: REQUEST_ID_LOG_LABEL,
+    requestIdHeader: REQUEST_ID_HEADER,
+});
+//# sourceMappingURL=fastify-logging-wrapper.js.map

package/dist/fastify-logging-wrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fastify-logging-wrapper.js","sourceRoot":"","sources":["../src/fastify-logging-wrapper.ts"],"names":[],"mappings":"AACA,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EACL,WAAW,EACX,oBAAoB,GACrB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,sBAAsB,EACtB,sBAAsB,EACtB,6BAA6B,EAC7B,uBAAuB,EACvB,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EAAE,IAAI,EAAqB,MAAM,MAAM,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AAEzD,MAAM,eAAe,GAAG,OAAO,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;AAEtE,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,MAAuB,EAAQ,EAAE;IACtE,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE;QACrD,iBAAiB,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QAC/B,OAAO,CAAC,GAAG,CAAC,IAAI,CACd,EAAE,OAAO,EAAE,uBAAuB,CAAC,OAAO,CAAC,EAAE,EAC7C,WAAW,CAAC,UAAU,CACvB,CAAC;QACF,IAAI,EAAE,CAAC;IACT,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QACjD,iBAAiB,CAAC,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;QACvC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;QACrC,uCAAuC;QACvC,KAAK,CAAC,GAAG,CAAC,IAAI,CACZ,EAAE,KAAK,EAAE,6BAA6B,EAAE,EAAE,EAC1C,WAAW,CAAC,QAAQ,CACrB,CAAC;QACF,mBAAmB,EAAE,CAAC;QACtB,IAAI,EAAE,CAAC;IACT,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;QACzD,iBAAiB,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;QAE7B,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,sBAAsB,EAAE,EAAE,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;QAE1E,IAAI,EAAE,CAAC;IACT,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,iBAAqC,EACf,EAAE,CAAC,CAAC;IAC1B,MAAM,EAAE,IAAI,CAAC,sBAAsB,EAAE,EAAE,iBAAiB,CAAC;IACzD,qBAAqB,EAAE,IAAI;IAC3B,QAAQ,EAAE,GAAG,EAAE,CAAC,eAAe,EAAE;IACjC,iBAAiB,EAAE,oBAAoB;IACvC,eAAe,EAAE,iBAAiB;CACnC,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { getLoggingConfiguration, initializeLoggingHooks, } from "./fastify-logging-wrapper.js";
+export { toLoggingError, LogMessages, LoggingError, } from "./logging-wrapper-entities.js";
+export { getLoggingContextError, setLoggingContext } from "./logging-wrapper.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,cAAc,EACd,WAAW,EACX,YAAY,GACb,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+export { getLoggingConfiguration, initializeLoggingHooks, } from "./fastify-logging-wrapper.js";
+export { toLoggingError, LogMessages, } from "./logging-wrapper-entities.js";
+export { getLoggingContextError, setLoggingContext } from "./logging-wrapper.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,uBAAuB,EACvB,sBAAsB,GACvB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EACL,cAAc,EACd,WAAW,GAEZ,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/logging-wrapper-entities.d.ts

@@ -0,0 +1,55 @@
+import { FastifyError } from "fastify";
+import { HttpError } from "@fastify/sensible";
+export interface LoggingRequest {
+    scheme: string;
+    method: string;
+    path: string | undefined;
+    hostname: string;
+    query_params: unknown;
+    [key: string]: unknown;
+}
+export interface FullLoggingRequest extends LoggingRequest {
+    headers: unknown;
+    user_agent: string | undefined;
+    client_ip: string;
+}
+export interface LoggingResponse {
+    headers: unknown;
+    status_code: number;
+    [key: string]: unknown;
+}
+export interface LoggingError {
+    class: LogErrorClasses;
+    message: string;
+    trace?: string;
+    parent?: {
+        name: string;
+        message: string;
+        stack?: string;
+    };
+    [key: string]: unknown;
+}
+export interface LoggingContext {
+    request?: LoggingRequest;
+    response?: LoggingResponse;
+    error?: LoggingError;
+}
+export declare enum LogMessages {
+    NewRequest = "NEW_REQUEST",
+    Response = "RESPONSE",
+    Error = "ERROR",
+    ApiTrack = "API_TRACK"
+}
+export declare enum LogErrorClasses {
+    ServerError = "SERVER_ERROR",
+    ValidationError = "VALIDATION_ERROR",
+    RequestError = "REQUEST_ERROR",
+    GatewayError = "GATEWAY_ERROR",
+    UnknownError = "UNKNOWN_ERROR"
+}
+export declare const REDACTED_VALUE = "[redacted]";
+export declare const REDACTED_PATHS: string[];
+export declare const MESSAGE_KEY = "message";
+export declare const REQUEST_ID_LOG_LABEL = "request_id";
+export declare const toLoggingError: (error: HttpError | FastifyError) => LoggingError;
+//# sourceMappingURL=logging-wrapper-entities.d.ts.map

package/dist/logging-wrapper-entities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging-wrapper-entities.d.ts","sourceRoot":"","sources":["../src/logging-wrapper-entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAIvC,OAAO,EAAE,SAAS,EAAC,MAAM,mBAAmB,CAAC;AAG7C,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,OAAO,CAAC;IACtB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,eAAe,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC3D,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,KAAK,CAAC,EAAE,YAAY,CAAC;CACtB;AAED,oBAAY,WAAW;IACrB,UAAU,gBAAgB;IAC1B,QAAQ,aAAa;IACrB,KAAK,UAAU;IACf,QAAQ,cAAc;CACvB;AAED,oBAAY,eAAe;IACzB,WAAW,iBAAiB;IAC5B,eAAe,qBAAqB;IACpC,YAAY,kBAAkB;IAC9B,YAAY,kBAAkB;IAC9B,YAAY,kBAAkB;CAC/B;AAED,eAAO,MAAM,cAAc,eAAe,CAAC;AAE3C,eAAO,MAAM,cAAc,UAO1B,CAAC;AAEF,eAAO,MAAM,WAAW,YAAY,CAAC;AAErC,eAAO,MAAM,oBAAoB,eAAe,CAAC;AAIjD,eAAO,MAAM,cAAc,UAClB,SAAS,GAAG,YAAY,KAC9B,YAyBF,CAAC"}

package/dist/logging-wrapper-entities.js

@@ -0,0 +1,72 @@
+import { parseErrorForLogging, } from "@ogcio/shared-errors";
+import { isHttpError } from "http-errors";
+export var LogMessages;
+(function (LogMessages) {
+    LogMessages["NewRequest"] = "NEW_REQUEST";
+    LogMessages["Response"] = "RESPONSE";
+    LogMessages["Error"] = "ERROR";
+    LogMessages["ApiTrack"] = "API_TRACK";
+})(LogMessages || (LogMessages = {}));
+export var LogErrorClasses;
+(function (LogErrorClasses) {
+    LogErrorClasses["ServerError"] = "SERVER_ERROR";
+    LogErrorClasses["ValidationError"] = "VALIDATION_ERROR";
+    LogErrorClasses["RequestError"] = "REQUEST_ERROR";
+    LogErrorClasses["GatewayError"] = "GATEWAY_ERROR";
+    LogErrorClasses["UnknownError"] = "UNKNOWN_ERROR";
+})(LogErrorClasses || (LogErrorClasses = {}));
+export const REDACTED_VALUE = "[redacted]";
+export const REDACTED_PATHS = [
+    '*.headers["x-amz-security-token"]',
+    '*.headers["x-api-key"]',
+    '*.headers["authorization"]',
+    '*.headers["cookie"]',
+    '*.headers["set-cookie"]',
+    '*.headers["proxy-authorization"]',
+];
+export const MESSAGE_KEY = "message";
+export const REQUEST_ID_LOG_LABEL = "request_id";
+const UNHANDLED_EXCEPTION_CODE = "UNHANDLED_EXCEPTION";
+export const toLoggingError = (error) => {
+    const output = {
+        class: parseErrorClass(error),
+        message: error.message,
+        trace: error.stack,
+    };
+    if (isHttpError(error)) {
+        const parentInput = error.parentError ?? error.parent;
+        const parent = parentInput
+            ? { parent: parseErrorForLogging(parentInput) }
+            : {};
+        return {
+            ...output,
+            code: error.name,
+            process: error.errorProcess,
+            ...parent,
+        };
+    }
+    return {
+        ...output,
+        code: error.code ?? UNHANDLED_EXCEPTION_CODE,
+    };
+};
+const parseErrorClass = (error) => {
+    if (!error.statusCode) {
+        return LogErrorClasses.UnknownError;
+    }
+    const statusCode = Number(error.statusCode);
+    if (statusCode === 502) {
+        return LogErrorClasses.GatewayError;
+    }
+    if (statusCode >= 500) {
+        return LogErrorClasses.ServerError;
+    }
+    if (statusCode === 422) {
+        return LogErrorClasses.ValidationError;
+    }
+    if (statusCode >= 400) {
+        return LogErrorClasses.RequestError;
+    }
+    return LogErrorClasses.UnknownError;
+};
+//# sourceMappingURL=logging-wrapper-entities.js.map

package/dist/logging-wrapper-entities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging-wrapper-entities.js","sourceRoot":"","sources":["../src/logging-wrapper-entities.ts"],"names":[],"mappings":"AACA,OAAO,EACL,oBAAoB,GACrB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,WAAW,EAAC,MAAM,aAAa,CAAC;AAqCxC,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,yCAA0B,CAAA;IAC1B,oCAAqB,CAAA;IACrB,8BAAe,CAAA;IACf,qCAAsB,CAAA;AACxB,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAED,MAAM,CAAN,IAAY,eAMX;AAND,WAAY,eAAe;IACzB,+CAA4B,CAAA;IAC5B,uDAAoC,CAAA;IACpC,iDAA8B,CAAA;IAC9B,iDAA8B,CAAA;IAC9B,iDAA8B,CAAA;AAChC,CAAC,EANW,eAAe,KAAf,eAAe,QAM1B;AAED,MAAM,CAAC,MAAM,cAAc,GAAG,YAAY,CAAC;AAE3C,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,mCAAmC;IACnC,wBAAwB;IACxB,4BAA4B;IAC5B,qBAAqB;IACrB,yBAAyB;IACzB,kCAAkC;CACnC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,SAAS,CAAC;AAErC,MAAM,CAAC,MAAM,oBAAoB,GAAG,YAAY,CAAC;AAEjD,MAAM,wBAAwB,GAAG,qBAAqB,CAAC;AAEvD,MAAM,CAAC,MAAM,cAAc,GAAG,CAC5B,KAA+B,EACjB,EAAE;IAChB,MAAM,MAAM,GAAG;QACb,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC;QAC7B,OAAO,EAAE,KAAK,CAAC,OAAO;QACtB,KAAK,EAAE,KAAK,CAAC,KAAK;KACnB,CAAC;IAEF,IAAI,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,KAAK,CAAC,MAAM,CAAC;QACtD,MAAM,MAAM,GAAG,WAAW;YACxB,CAAC,CAAC,EAAE,MAAM,EAAE,oBAAoB,CAAC,WAAW,CAAC,EAAE;YAC/C,CAAC,CAAC,EAAE,CAAC;QAEP,OAAO;YACL,GAAG,MAAM;YACT,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,OAAO,EAAE,KAAK,CAAC,YAAY;YAC3B,GAAG,MAAM;SACV,CAAC;IACJ,CAAC;IAED,OAAO;QACL,GAAG,MAAM;QACT,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,wBAAwB;KAC7C,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CACtB,KAA+B,EACd,EAAE;IACnB,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;QACtB,OAAO,eAAe,CAAC,YAAY,CAAC;IACtC,CAAC;IAED,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAE5C,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;QACvB,OAAO,eAAe,CAAC,YAAY,CAAC;IACtC,CAAC;IAED,IAAI,UAAU,IAAI,GAAG,EAAE,CAAC;QACtB,OAAO,eAAe,CAAC,WAAW,CAAC;IACrC,CAAC;IAED,IAAI,UAAU,KAAK,GAAG,EAAE,CAAC;QACvB,OAAO,eAAe,CAAC,eAAe,CAAC;IACzC,CAAC;IAED,IAAI,UAAU,IAAI,GAAG,EAAE,CAAC;QACtB,OAAO,eAAe,CAAC,YAAY,CAAC;IACtC,CAAC;IAED,OAAO,eAAe,CAAC,YAAY,CAAC;AACtC,CAAC,CAAC"}

package/dist/logging-wrapper.d.ts

@@ -0,0 +1,20 @@
+import { FastifyRequest, FastifyReply, FastifyError } from "fastify";
+import { LoggingContext, FullLoggingRequest, LoggingError } from "./logging-wrapper-entities.js";
+import { LogLevel, PinoLoggerOptions } from "fastify/types/logger.js";
+import { HttpError } from "@fastify/sensible";
+type INPUT_ERROR_TYPES = FastifyError | HttpError;
+export declare const getLoggingContext: (params: {
+    includeError: boolean;
+}) => LoggingContext;
+export declare const setLoggingContext: (params: {
+    request?: FastifyRequest;
+    response?: FastifyReply;
+    error?: INPUT_ERROR_TYPES;
+}) => void;
+export declare const resetLoggingContext: () => void;
+export declare const getLoggingContextError: () => LoggingError | undefined;
+export declare const getPartialLoggingContextError: () => Omit<LoggingError, "trace"> | undefined;
+export declare const parseFullLoggingRequest: (req: FastifyRequest) => FullLoggingRequest;
+export declare const getLoggerConfiguration: (minimumLevel?: LogLevel) => PinoLoggerOptions;
+export {};
+//# sourceMappingURL=logging-wrapper.d.ts.map

package/dist/logging-wrapper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging-wrapper.d.ts","sourceRoot":"","sources":["../src/logging-wrapper.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAErE,OAAO,EACL,cAAc,EAEd,kBAAkB,EAElB,YAAY,EAKb,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAI9C,KAAK,iBAAiB,GAAG,YAAY,GAAG,SAAS,CAAC;AAElD,eAAO,MAAM,iBAAiB,WAAY;IACxC,YAAY,EAAE,OAAO,CAAC;CACvB,KAAG,cAGyC,CAAC;AAE9C,eAAO,MAAM,iBAAiB,WAAY;IACxC,OAAO,CAAC,EAAE,cAAc,CAAC;IACzB,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,KAAK,CAAC,EAAE,iBAAiB,CAAC;CAC3B,KAAG,IAUH,CAAC;AAEF,eAAO,MAAM,mBAAmB,QAAO,IAItC,CAAC;AAEF,eAAO,MAAM,sBAAsB,QAAO,YAAY,GAAG,SACR,CAAC;AAElD,eAAO,MAAM,6BAA6B,QACtC,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC,GAC3B,SAGF,CAAC;AAaH,eAAO,MAAM,uBAAuB,QAC7B,cAAc,KAClB,kBAKD,CAAC;AAOH,eAAO,MAAM,sBAAsB,kBACnB,QAAQ,KACrB,iBAmBD,CAAC"}

package/dist/logging-wrapper.js

@@ -0,0 +1,66 @@
+import { hostname } from "os";
+import { REDACTED_VALUE, REDACTED_PATHS, MESSAGE_KEY, toLoggingError, } from "./logging-wrapper-entities.js";
+const loggingContext = {};
+export const getLoggingContext = (params) => params.includeError
+    ? loggingContext
+    : { ...loggingContext, error: undefined };
+export const setLoggingContext = (params) => {
+    if (params.request !== undefined) {
+        loggingContext.request = parseLoggingRequest(params.request);
+    }
+    if (params.response !== undefined) {
+        loggingContext.response = parseLoggingResponse(params.response);
+    }
+    if (params.error !== undefined) {
+        loggingContext.error = toLoggingError(params.error);
+    }
+};
+export const resetLoggingContext = () => {
+    loggingContext.request = undefined;
+    loggingContext.response = undefined;
+    loggingContext.error = undefined;
+};
+export const getLoggingContextError = () => getLoggingContext({ includeError: true }).error;
+export const getPartialLoggingContextError = () => ({
+    ...(getLoggingContext({ includeError: true }).error ?? {}),
+    trace: undefined,
+});
+const getPathWithoutParams = (req) => req.routeOptions?.url ?? req.url.split("?")[0];
+const parseLoggingRequest = (req) => ({
+    scheme: req.protocol,
+    method: req.method,
+    path: getPathWithoutParams(req),
+    hostname: req.hostname,
+    query_params: req.query,
+});
+export const parseFullLoggingRequest = (req) => ({
+    ...parseLoggingRequest(req),
+    headers: req.headers,
+    client_ip: req.ip,
+    user_agent: req.headers["user-agent"] ?? undefined,
+});
+const parseLoggingResponse = (res) => ({
+    status_code: res.statusCode,
+    headers: res.getHeaders(),
+});
+export const getLoggerConfiguration = (minimumLevel = "debug") => ({
+    base: { hostname: hostname() },
+    messageKey: MESSAGE_KEY,
+    mixin: () => ({
+        timestamp: Date.now(),
+        ...getLoggingContext({ includeError: false }),
+    }),
+    redact: {
+        paths: REDACTED_PATHS,
+        censor: REDACTED_VALUE,
+    },
+    timestamp: false,
+    formatters: {
+        level: (name, levelVal) => ({
+            level: levelVal,
+            level_name: name.toUpperCase(),
+        }),
+    },
+    level: minimumLevel,
+});
+//# sourceMappingURL=logging-wrapper.js.map

package/dist/logging-wrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging-wrapper.js","sourceRoot":"","sources":["../src/logging-wrapper.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAC9B,OAAO,EAML,cAAc,EACd,cAAc,EACd,WAAW,EACX,cAAc,GACf,MAAM,+BAA+B,CAAC;AAIvC,MAAM,cAAc,GAAmB,EAAE,CAAC;AAI1C,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,MAEjC,EAAkB,EAAE,CACnB,MAAM,CAAC,YAAY;IACjB,CAAC,CAAC,cAAc;IAChB,CAAC,CAAC,EAAE,GAAG,cAAc,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;AAE9C,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,MAIjC,EAAQ,EAAE;IACT,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QACjC,cAAc,CAAC,OAAO,GAAG,mBAAmB,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC/D,CAAC;IACD,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;QAClC,cAAc,CAAC,QAAQ,GAAG,oBAAoB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAClE,CAAC;IACD,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC/B,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IACtD,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAS,EAAE;IAC5C,cAAc,CAAC,OAAO,GAAG,SAAS,CAAC;IACnC,cAAc,CAAC,QAAQ,GAAG,SAAS,CAAC;IACpC,cAAc,CAAC,KAAK,GAAG,SAAS,CAAC;AACnC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sBAAsB,GAAG,GAA6B,EAAE,CACnE,iBAAiB,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC;AAElD,MAAM,CAAC,MAAM,6BAA6B,GAAG,GAE/B,EAAE,CAAC,CAAC;IAChB,GAAG,CAAC,iBAAiB,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;IAC1D,KAAK,EAAE,SAAS;CACjB,CAAC,CAAC;AAEH,MAAM,oBAAoB,GAAG,CAAC,GAAmB,EAAU,EAAE,CAC3D,GAAG,CAAC,YAAY,EAAE,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAEjD,MAAM,mBAAmB,GAAG,CAAC,GAAmB,EAAkB,EAAE,CAAC,CAAC;IACpE,MAAM,EAAE,GAAG,CAAC,QAAQ;IACpB,MAAM,EAAE,GAAG,CAAC,MAAM;IAClB,IAAI,EAAE,oBAAoB,CAAC,GAAG,CAAC;IAC/B,QAAQ,EAAE,GAAG,CAAC,QAAQ;IACtB,YAAY,EAAE,GAAG,CAAC,KAAK;CACxB,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,GAAmB,EACC,EAAE,CAAC,CAAC;IACxB,GAAG,mBAAmB,CAAC,GAAG,CAAC;IAC3B,OAAO,EAAE,GAAG,CAAC,OAAO;IACpB,SAAS,EAAE,GAAG,CAAC,EAAE;IACjB,UAAU,EAAE,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,SAAS;CACnD,CAAC,CAAC;AAEH,MAAM,oBAAoB,GAAG,CAAC,GAAiB,EAAmB,EAAE,CAAC,CAAC;IACpE,WAAW,EAAE,GAAG,CAAC,UAAU;IAC3B,OAAO,EAAE,GAAG,CAAC,UAAU,EAAE;CAC1B,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,eAAyB,OAAO,EACb,EAAE,CAAC,CAAC;IACvB,IAAI,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE;IAC9B,UAAU,EAAE,WAAW;IACvB,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;QACZ,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;QACrB,GAAG,iBAAiB,CAAC,EAAE,YAAY,EAAE,KAAK,EAAE,CAAC;KAC9C,CAAC;IACF,MAAM,EAAE;QACN,KAAK,EAAE,cAAc;QACrB,MAAM,EAAE,cAAc;KACvB;IACD,SAAS,EAAE,KAAK;IAChB,UAAU,EAAE;QACV,KAAK,EAAE,CAAC,IAAY,EAAE,QAAgB,EAAE,EAAE,CAAC,CAAC;YAC1C,KAAK,EAAE,QAAQ;YACf,UAAU,EAAE,IAAI,CAAC,WAAW,EAAE;SAC/B,CAAC;KACH;IACD,KAAK,EAAE,YAAY;CACpB,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,32 @@
+{
+    "name": "@ogcio/fastify-logging-wrapper",
+    "version": "4.0.0",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "type": "module",
+    "scripts": {
+        "build": "rm -rf dist tsconfig.prod.tsbuildinfo tsconfig.tsbuildinfo && tsc -p tsconfig.prod.json",
+        "test": "tap --jobs=1 --allow-incomplete-coverage __tests__/**/*.test.ts"
+    },
+    "keywords": [],
+    "author": {
+        "name": "Samuele Salvatico",
+        "email": "samuele.salvatico@nearform.com"
+    },
+    "license": "ISC",
+    "description": "Enable standardized log entries for each request in fastify",
+    "dependencies": {
+        "@fastify/error": "^4.0.0",
+        "@fastify/sensible": "^5.6.0",
+        "fastify": "^4.28.1",
+        "hyperid": "^3.3.0"
+    },
+    "devDependencies": {
+        "@types/http-errors": "^2.0.4"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/ogcio/shared-node-utils.git",
+        "directory": "packages/fastify-logging-wrapper"
+    }
+}

package/src/fastify-logging-wrapper.ts

@@ -0,0 +1,59 @@
+import { FastifyServerOptions, FastifyInstance } from "fastify";
+import hyperid from "hyperid";
+import {
+  LogMessages,
+  REQUEST_ID_LOG_LABEL,
+} from "./logging-wrapper-entities.js";
+import {
+  getLoggerConfiguration,
+  getLoggingContextError,
+  getPartialLoggingContextError,
+  parseFullLoggingRequest,
+  resetLoggingContext,
+  setLoggingContext,
+} from "./logging-wrapper.js";
+import { pino, DestinationStream } from "pino";
+import { REQUEST_ID_HEADER } from "@ogcio/shared-errors";
+
+const hyperidInstance = hyperid({ fixedLength: true, urlSafe: true });
+
+export const initializeLoggingHooks = (server: FastifyInstance): void => {
+  server.addHook("preHandler", (request, _reply, done) => {
+    setLoggingContext({ request });
+    request.log.info(
+      { request: parseFullLoggingRequest(request) },
+      LogMessages.NewRequest,
+    );
+    done();
+  });
+
+  server.addHook("onResponse", (_req, reply, done) => {
+    setLoggingContext({ response: reply });
+    reply.log.info(LogMessages.Response);
+    // Include error in API Track if exists
+    reply.log.info(
+      { error: getPartialLoggingContextError() },
+      LogMessages.ApiTrack,
+    );
+    resetLoggingContext();
+    done();
+  });
+
+  server.addHook("onError", (request, _reply, error, done) => {
+    setLoggingContext({ error });
+
+    request.log.error({ error: getLoggingContextError() }, LogMessages.Error);
+
+    done();
+  });
+};
+
+export const getLoggingConfiguration = (
+  loggerDestination?: DestinationStream,
+): FastifyServerOptions => ({
+  logger: pino(getLoggerConfiguration(), loggerDestination),
+  disableRequestLogging: true,
+  genReqId: () => hyperidInstance(),
+  requestIdLogLabel: REQUEST_ID_LOG_LABEL,
+  requestIdHeader: REQUEST_ID_HEADER,
+});

package/src/index.ts

@@ -0,0 +1,11 @@
+export {
+  getLoggingConfiguration,
+  initializeLoggingHooks,
+} from "./fastify-logging-wrapper.js";
+export {
+  toLoggingError,
+  LogMessages,
+  LoggingError,
+} from "./logging-wrapper-entities.js";
+
+export { getLoggingContextError, setLoggingContext } from "./logging-wrapper.js";