@rf-logger/logger-axios 0.0.9

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { LoggerPlugin } from "@rf-logger/logger";
+declare const plugin: LoggerPlugin;
+export default plugin;

package/dist/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_interceptor_1 = require("./interceptors/axios.interceptor");
+const plugin = {
+    registerInterceptors: (logger) => {
+        (0, axios_interceptor_1.registerAxiosInterceptor)(logger);
+    },
+};
+exports.default = plugin;

package/dist/interceptors/axios.interceptor.d.ts

@@ -0,0 +1,4 @@
+import type { AxiosInstance } from "axios";
+import { Logger } from "winston";
+export declare const enhanceAxiosInstance: (axios: AxiosInstance, logger: Logger) => void;
+export declare const registerAxiosInterceptor: (logger: Logger) => void;

package/dist/interceptors/axios.interceptor.js

@@ -0,0 +1,101 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerAxiosInterceptor = exports.enhanceAxiosInstance = void 0;
+const axios_1 = __importDefault(require("axios"));
+const axios_better_stacktrace_1 = __importDefault(require("axios-better-stacktrace"));
+const AxiosLogger = __importStar(require("axios-logger"));
+/**
+ * Wrap axios-logger "error" interceptor to customize the output.
+ */
+const wrappedErrorLogger = (logger) => (error) => __awaiter(void 0, void 0, void 0, function* () {
+    return AxiosLogger.errorLogger(error, {
+        logger: (message) => {
+            var _a;
+            const statusCode = (_a = error.response) === null || _a === void 0 ? void 0 : _a.status;
+            const request = error.request;
+            const response = error.response;
+            // To prevent cluttering the logs with the whole
+            // request and response objects, we omit them.
+            error.request = undefined;
+            error.response = undefined;
+            logger.log(
+            // In case of a 400 HTTP error, we only log it as a debug
+            // In case of a 500 HTTP error, we log it as a real error
+            statusCode && statusCode < 500 ? "debug" : "error", 
+            // We add the error directly in the message for easy reading
+            message, {
+                channel: "axios",
+                error,
+            });
+            // We add back the request and response so that they can be used in catch clauses
+            error.request = request;
+            error.response = response;
+        },
+        // For axios errors, we want to log the whole server response headers + data
+        headers: true,
+        data: true,
+    });
+});
+const axiosLogRequestResponse = (axios, logger) => {
+    axios.interceptors.request.use(AxiosLogger.requestLogger, wrappedErrorLogger(logger));
+    axios.interceptors.response.use(AxiosLogger.responseLogger, wrappedErrorLogger(logger));
+};
+const enhanceAxiosInstance = (axios, logger) => {
+    (0, axios_better_stacktrace_1.default)(axios);
+    axiosLogRequestResponse(axios, logger);
+};
+exports.enhanceAxiosInstance = enhanceAxiosInstance;
+const enhanceAxiosModule = (axios, logger) => {
+    (0, exports.enhanceAxiosInstance)(axios, logger);
+    axios.create = ((originalCreate) => {
+        return (config) => {
+            const instance = originalCreate.apply(this, [config]);
+            (0, exports.enhanceAxiosInstance)(instance, logger);
+            return instance;
+        };
+    })(axios.create);
+};
+const registerAxiosInterceptor = (logger) => {
+    AxiosLogger.setGlobalConfig({
+        logger: (message) => logger.http(message, { channel: "axios" }),
+        data: false,
+        params: true, // whether to include query parameters in logs
+    });
+    enhanceAxiosModule(axios_1.default, logger);
+};
+exports.registerAxiosInterceptor = registerAxiosInterceptor;

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@rf-logger/logger-axios",
+  "files": [
+    "dist/**"
+  ],
+  "main": "dist/index.js",
+  "peerDependencies": {
+    "axios": "^0.27.2",
+    "winston": "^3.8.2",
+    "@rf-logger/logger": "0.0.9"
+  },
+  "dependencies": {
+    "axios-better-stacktrace": "^2.1.3",
+    "axios-logger": "^2.6.1"
+  },
+  "devDependencies": {
+    "axios": "0.27.2",
+    "axios-mock-adapter": "1.21.1"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "version": "0.0.9",
+  "scripts": {
+    "test": "jest",
+    "version": "pnpm version --no-git-tag-version"
+  }
+}