Merge pull request #30 from ZachHaber/agent

lamweili · web-flow · commit 60e07f526683 · 2022-06-23T17:20:58.000+08:00
Add support for agent
diff --git a/README.md b/README.md
@@ -14,6 +14,7 @@ npm install log4js @log4js-node/logfaces-http
 - `timeout` - `integer` (optional, defaults to 5000ms) - the timeout for the HTTP request.
 - `configContext` - function (optional) returning a global context object accessible to all appenders. Properties from configContext added as `p_` values in the logFaces event.
 - `hostname` - `string` (optional) - used to add the hostname `h` property to the logFaces event.
+- `agent` - `http.Agent | https.Agent` (optional) - used to configure the requests being sent out if needed.
 
 This appender will also pick up Logger context values from the events, and add them as `p_` values in the logFaces event. See the example below for more details. Note that Logger context may override the same properties defined in `configContext`.
 
diff --git a/lib/index.js b/lib/index.js
@@ -32,13 +32,18 @@ function getErrorStack(logData) {
  *      "application": "LFS-TEST",        // name of the application (domain)
  *      "url": "http://lfs-server/logs",  // logFaces receiver servlet URL
  *   }
+ * @param {import('../types').LogFacesHTTPAppender} config
  */
 function logFacesAppender(config) {
   const sender = axios.create({
     baseURL: config.url,
     timeout: config.timeout || 5000,
     headers: { 'Content-Type': 'application/json' },
     withCredentials: true,
+    // The user should pass in the correct Agent type for their url
+    // since their url won't change after config this should be fine
+    httpAgent: config.agent,
+    httpsAgent: config.agent,
   });
 
   const { configContext } = config;
diff --git a/test/tap/index-test.js b/test/tap/index-test.js
@@ -1,5 +1,6 @@
 'use strict';
 
+const { Agent } = require('http');
 const { test } = require('tap');
 const sandbox = require('@log4js-node/sandboxed-module');
 const appender = require('../../lib');
@@ -65,10 +66,12 @@ test('logFaces appender', (batch) => {
   });
 
   batch.test('when using HTTP receivers', (t) => {
+    const agent = new Agent();
     const setup = setupLogging('myCategory', false, {
       application: 'LFS-HTTP',
       url: 'http://localhost/receivers/rx1',
       hostname: 'localhost',
+      agent,
     });
 
     t.test('axios should be configured', (assert) => {
@@ -81,6 +84,11 @@ test('logFaces appender', (batch) => {
       assert.same(setup.fakeAxios.config.headers, {
         'Content-Type': 'application/json',
       });
+      // For some reason with the sandboxed tests, the instanceof Agent doesn't exist.
+      assert.match(setup.fakeAxios.config, {
+        httpAgent: Object,
+        httpsAgent: Object,
+      });
       assert.end();
     });
 
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -1,3 +1,6 @@
+import type { Agent as httpAgent } from 'http';
+import type { Agent as httpsAgent } from 'https';
+
 export interface LogFacesHTTPAppender {
   type: '@log4js-node/logfaces-http';
   /** logFaces receiver servlet URL */
@@ -14,6 +17,10 @@ export interface LogFacesHTTPAppender {
   hostname?: string;
   /** The shared global config to include in your logs */
   configContext?: () => Record<string, string | number>;
+  /** An http.Agent or https.Agent to allow configuring behavior as needed.
+   * Make sure you use the correct type base on your url
+   */
+  agent?: httpAgent | httpsAgent;
 }
 
 // Add the LogFacesHTTPAppender to the list of appenders in log4js for better type support
