refactor(logger): replace logLevel and logProvider with logger option [BREAKING CHANGE]

Author: chimurai

README.md

@@ -73,8 +73,7 @@ _All_ `http-proxy` [options](https://github.com/nodejitsu/node-http-proxy#option
   - [`pathRewrite` (object/function)](#pathrewrite-objectfunction)
   - [`router` (object/function)](#router-objectfunction)
   - [`plugins` (Array)](#plugins-array)
-  - [`logLevel` (string)](#loglevel-string)
-  - [`logProvider` (function)](#logprovider-function)
+  - [`logger` (Object)](#logger-object)
 - [`http-proxy` events](#http-proxy-events)
 - [`http-proxy` options](#http-proxy-options)
 - [WebSocket](#websocket)
@@ -287,38 +286,16 @@ const config = {
 };
 ```
 
-### `logLevel` (string)
+### `logger` (Object)
 
-Default: `'info'`
+Configure a logger to output information from http-proxy-middleware: ie. `console`, `winston`, `pino`, `bunyan`, `log4js`, etc...
 
-Values: ['debug', 'info', 'warn', 'error', 'silent'].
-
-### `logProvider` (function)
-
-Modify or replace log provider. Default: `console`.
-
-```javascript
-// simple replace
-function logProvider(provider) {
-  // replace the default console log provider.
-  return require('winston');
-}
-```
+See also logger recipes ([recipes/logger.md](https://github.com/chimurai/http-proxy-middleware/blob/master/recipes/logger.md)) for more details.
 
 ```javascript
-// verbose replacement
-function logProvider(provider) {
-  const logger = new (require('winston').Logger)();
-
-  const myCustomProvider = {
-    log: logger.log,
-    debug: logger.debug,
-    info: logger.info,
-    warn: logger.warn,
-    error: logger.error,
-  };
-  return myCustomProvider;
-}
+createProxyMiddleware({
+  logger: console,
+});
 ```
 
 ## `http-proxy` events

cspell.json

@@ -28,6 +28,7 @@
     "nextjs",
     "Nodejitsu",
     "ntlm",
+    "pino",
     "proxied",
     "proxying",
     "rawbody",

examples/browser-sync/index.js

@@ -11,7 +11,7 @@ const jsonPlaceholderProxy = createProxyMiddleware({
   target: 'http://jsonplaceholder.typicode.com',
   pathFilter: '/users',
   changeOrigin: true, // for vhosted sites, changes host header to match to target's host
-  logLevel: 'debug',
+  logger: console,
 });
 
 /**

examples/express/index.js

@@ -11,6 +11,7 @@ const jsonPlaceholderProxy = createProxyMiddleware({
   target: 'http://jsonplaceholder.typicode.com/users',
   changeOrigin: true, // for vhosted sites, changes host header to match to target's host
   logLevel: 'debug',
+  logger: console,
 });
 
 const app = express();

examples/response-interceptor/index.js

@@ -64,7 +64,7 @@ const jsonPlaceholderProxy = createProxyMiddleware({
       return JSON.stringify(favoriteFoods);
     }),
   },
-  logLevel: 'debug',
+  logger: console,
 });
 
 const app = express();

examples/websocket/index.js

@@ -15,7 +15,7 @@ const wsProxy = createProxyMiddleware({
   // },
   changeOrigin: true, // for vhosted sites, changes host header to match to target's host
   ws: true, // enable websocket proxy
-  logLevel: 'debug',
+  logger: console,
 });
 
 const app = express();

recipes/logLevel.md

@@ -1,41 +1,5 @@
-# Log Level
+# [BREAKING CHANGE]
 
-Control the amount of logging of http-proxy-middleware.
+This functionality is removed in v3.
 
-Possible values:
-
-- `debug`
-- `info`
-- `warn` (default)
-- `error`
-- `silent`
-
-## Level: debug
-
-Log everything.
-
-```javascript
-const { createProxyMiddleware } = require('http-proxy-middleware');
-
-const options = {
-  target: 'http://localhost:3000',
-  logLevel: 'debug',
-};
-
-const apiProxy = createProxyMiddleware(options);
-```
-
-## Level: silent
-
-Suppress all logging.
-
-```javascript
-const { createProxyMiddleware } = require('http-proxy-middleware');
-
-const options = {
-  target: 'http://localhost:3000',
-  logLevel: 'silent',
-};
-
-const apiProxy = createProxyMiddleware(options);
-```
+See [logger.md](logger.md) for logging in v3.

recipes/logProvider.md

@@ -1,76 +1,5 @@
-# Log Provider
+# [BREAKING CHANGE]
 
-Configure your own logger with the `logProvider` option.
+This functionality is removed in v3.
 
-In this example [winston](https://www.npmjs.com/package/winston) is configured to do the actual logging.
-
-```javascript
-const winston = require('winston');
-const { createProxyMiddleware } = require('http-proxy-middleware');
-
-const options = {
-  target: 'http://localhost:3000',
-  logProvider: function (provider) {
-    return winston;
-  },
-};
-
-const apiProxy = createProxyMiddleware(options);
-```
-
-## Winston
-
-Configure your own logger with the `logProvider` option.
-
-In this example [winston](https://www.npmjs.com/package/winston) is configured to do the actual logging. Map the logging api if needed.
-
-```javascript
-const winston = require('winston');
-const { createProxyMiddleware } = require('http-proxy-middleware');
-
-const logProvider = function (provider) {
-  return {
-    log: winston.log,
-    debug: winston.debug,
-    info: winston.info,
-    warn: winston.warn,
-    error: winston.error,
-  };
-};
-
-const options = {
-  target: 'http://localhost:3000',
-  logProvider: logProvider,
-};
-
-const apiProxy = createProxyMiddleware(options);
-```
-
-# Winston Multi Transport
-
-Configure your own logger with the `logProvider` option.
-
-In this example [winston](https://www.npmjs.com/package/winston) is configured to do the actual logging.
-
-```javascript
-const winston = require('winston');
-const { createProxyMiddleware } = require('http-proxy-middleware');
-
-const logProvider = function (provider) {
-  const logger = new winston.Logger({
-    transports: [
-      new winston.transports.Console(),
-      new winston.transports.File({ filename: 'some-file.log' }),
-    ],
-  });
-
-  return logger;
-};
-
-const options = {
-  target: 'http://localhost:3000',
-  logProvider: logProvider,
-};
-
-const apiProxy = createProxyMiddleware(options);
-```
+See [logger.md](logger.md) for logging in v3.

recipes/logger.md

@@ -0,0 +1,87 @@
+# Logger
+
+Configure a logger to output information from http-proxy-middleware: ie. `console`, `winston`, `pino`, `bunyan`, `log4js`, etc...
+
+## `console`
+
+```javascript
+const { createProxyMiddleware } = require('http-proxy-middleware');
+
+const proxy = createProxyMiddleware({
+  target: 'http://localhost:3000',
+  logger: console,
+});
+```
+
+## `winston`
+
+<https://github.com/winstonjs/winston> ![GitHub Repo stars](https://img.shields.io/github/stars/winstonjs/winston?style=social) ![winston downloads](https://img.shields.io/npm/dm/winston)
+
+```javascript
+const { createProxyMiddleware } = require('http-proxy-middleware');
+const winston = require('winston');
+const { format, transports } = require('winston');
+
+// Enable interpolation in log messages
+// https://github.com/winstonjs/winston#string-interpolation
+const logger = winston.createLogger({
+  format: format.combine(format.splat(), format.simple()),
+  transports: [new transports.Console()],
+});
+
+const proxy = createProxyMiddleware({
+  target: 'http://localhost:3000',
+  logger,
+});
+```
+
+## `pino`
+
+<https://github.com/pinojs/pino> ![GitHub Repo stars](https://img.shields.io/github/stars/pinojs/pino?style=social) ![winston downloads](https://img.shields.io/npm/dm/pino)
+
+```javascript
+const { createProxyMiddleware } = require('http-proxy-middleware');
+const pino = require('pino');
+
+const logger = pino();
+
+const proxy = createProxyMiddleware({
+  target: 'http://localhost:3000',
+  logger,
+});
+```
+
+## `log4js`
+
+<https://github.com/log4js-node/log4js-node> ![GitHub Repo stars](https://img.shields.io/github/stars/log4js-node/log4js-node?style=social) ![winston downloads](https://img.shields.io/npm/dm/log4js)
+
+```javascript
+const { createProxyMiddleware } = require('http-proxy-middleware');
+const log4js = require('log4js');
+
+const logger = log4js.getLogger();
+logger.level = 'debug';
+
+const proxy = createProxyMiddleware({
+  target: 'http://localhost:3000',
+  logger,
+});
+```
+
+## `bunyan`
+
+<https://github.com/trentm/node-bunyan> ![GitHub Repo stars](https://img.shields.io/github/stars/trentm/node-bunyan?style=social) ![winston downloads](https://img.shields.io/npm/dm/bunyan)
+
+```javascript
+const { createProxyMiddleware } = require('http-proxy-middleware');
+const bunyan = require('bunyan');
+
+const logger = bunyan.createLogger({
+  name: 'my-app',
+});
+
+const proxy = createProxyMiddleware({
+  target: 'http://localhost:3000',
+  logger,
+});
+```

src/configuration.ts

@@ -1,23 +1,8 @@
 import { ERRORS } from './errors';
-import { getInstance } from './logger';
 import { Options } from './types';
 
-const logger = getInstance();
-
 export function verifyConfig(options: Options): void {
-  configureLogger(options);
-
   if (!options.target && !options.router) {
     throw new Error(ERRORS.ERR_CONFIG_FACTORY_TARGET_MISSING);
   }
 }
-
-function configureLogger(options: Options): void {
-  if (options.logLevel) {
-    logger.setLevel(options.logLevel);
-  }
-
-  if (options.logProvider) {
-    logger.setProvider(options.logProvider);
-  }
-}

src/http-proxy-middleware.ts

@@ -1,5 +1,5 @@
 import type * as https from 'https';
-import type { Request, RequestHandler, Options, Filter } from './types';
+import type { Request, RequestHandler, Options, Filter, Logger } from './types';
 import * as httpProxy from 'http-proxy';
 import { verifyConfig } from './configuration';
 import { matchPathFilter } from './path-filter';
@@ -14,7 +14,7 @@ import {
 } from './plugins/default';
 
 export class HttpProxyMiddleware {
-  private logger: Partial<Console>;
+  private logger: Logger;
   private wsInternalSubscribed = false;
   private serverOnCloseSubscribed = false;
   private proxyOptions: Options;
@@ -28,7 +28,7 @@ export class HttpProxyMiddleware {
 
     // create proxy
     this.proxy = httpProxy.createProxyServer({});
-    this.logger.log(`[HPM] Proxy created: ${options.pathFilter ?? '/'}  -> ${options.target}`);
+    this.logger.info(`[HPM] Proxy created: %O`, options.target);
 
     this.registerPlugins(this.proxy, this.proxyOptions);
 
@@ -68,7 +68,7 @@ export class HttpProxyMiddleware {
 
     if (server && !this.serverOnCloseSubscribed) {
       server.on('close', () => {
-        this.logger.log('[HPM] server close signal received: closing proxy server');
+        this.logger.info('[HPM] server close signal received: closing proxy server');
         this.proxy.close();
       });
       this.serverOnCloseSubscribed = true;
@@ -104,7 +104,7 @@ export class HttpProxyMiddleware {
     if (this.shouldProxy(this.proxyOptions.pathFilter, req)) {
       const activeProxyOptions = await this.prepareProxyRequest(req);
       this.proxy.ws(req, socket, head, activeProxyOptions);
-      this.logger.log('[HPM] Upgrading to WebSocket');
+      this.logger.info('[HPM] Upgrading to WebSocket');
     }
   };
 
@@ -143,7 +143,7 @@ export class HttpProxyMiddleware {
       newTarget = await Router.getTarget(req, options);
 
       if (newTarget) {
-        this.logger.log('[HPM] Router new target: %s -> "%s"', options.target, newTarget);
+        this.logger.info('[HPM] Router new target: %s -> "%s"', options.target, newTarget);
         options.target = newTarget;
       }
     }
@@ -157,7 +157,7 @@ export class HttpProxyMiddleware {
       if (typeof path === 'string') {
         req.url = path;
       } else {
-        this.logger.log('[HPM] pathRewrite: No rewritten path found. (%s)', req.url);
+        this.logger.info('[HPM] pathRewrite: No rewritten path found. (%s)', req.url);
       }
     }
   };