Merge 12ba812 into 2d6741a

chimurai · Feb 27, 2022 · 2fdcbf5 · 2fdcbf5
2 parents 2d6741a + 12ba812
commit 2fdcbf5
Show file tree

Hide file tree

Showing 23 changed files with 572 additions and 886 deletions.
diff --git a/README.md b/README.md
diff --git a/examples/browser-sync/index.js b/examples/browser-sync/index.js
@@ -7,8 +7,9 @@ const { createProxyMiddleware } = require('../../dist'); // require('http-proxy-
 /**
  * Configure proxy middleware
  */
-const jsonPlaceholderProxy = createProxyMiddleware('/users', {
+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',
 });

diff --git a/examples/websocket/index.html b/examples/websocket/index.html
@@ -21,7 +21,7 @@
   <body>
     <h2>WebSocket demo</h2>
 
-    <p>Proxy <code>ws://localhost:3000</code> to <code>ws://echo.websocket.org</code></p>
+    <p>Proxy <code>ws://localhost:3000</code> to <code>ws://ws.ifelse.io</code></p>
 
     <fieldset id="configuration">
       <p>

diff --git a/examples/websocket/index.js b/examples/websocket/index.js
@@ -7,8 +7,8 @@ const { createProxyMiddleware } = require('../../dist'); // require('http-proxy-
 /**
  * Configure proxy middleware
  */
-const wsProxy = createProxyMiddleware('/', {
-  target: 'http://echo.websocket.org',
+const wsProxy = createProxyMiddleware({
+  target: 'http://ws.ifelse.io',
   // pathRewrite: {
   //  '^/websocket' : '/socket',        // rewrite path.
   //  '^/removepath' : ''               // remove path.

diff --git a/recipes/README.md b/recipes/README.md
@@ -12,15 +12,13 @@ http-proxy-middleware uses Nodejitsu's [http-proxy](https://github.com/nodejitsu
 const { createProxyMiddleware } = require('http-proxy-middleware');
 const winston = require('winston');
 
-/**
- * Context matching: decide which path(s) should be proxied. (wildcards supported)
- **/
-const context = '/api';
-
 /**
  * Proxy options
  */
 const options = {
+  // decide which path(s) should be proxied. (wildcards supported)
+  pathFilter: '/api',
+
   // hostname to the target server
   target: 'http://localhost:3000',
 
@@ -104,5 +102,5 @@ const options = {
 /**
  * Create the proxy middleware, so it can be used in a server.
  */
-const apiProxy = createProxyMiddleware(context, options);
+const apiProxy = createProxyMiddleware(options);
 ```
diff --git a/recipes/basic.md b/recipes/basic.md
@@ -5,10 +5,10 @@ This example will create a basic proxy middleware.
 ```javascript
 const { createProxyMiddleware } = require('http-proxy-middleware');
 
-const apiProxy = createProxyMiddleware('/api', { target: 'http://localhost:3000' });
-//                                    \____/  \________________________________/
-//                                      |                     |
-//                                    context              options
+const apiProxy = createProxyMiddleware({
+  pathFilter: '/api',
+  target: 'http://localhost:3000',
+});
 ```
 
 ## Alternative configuration

diff --git a/recipes/context-matching.md → recipes/pathFilter.md b/recipes/context-matching.md → recipes/pathFilter.md
@@ -1,12 +1,12 @@
-# Context matching
+# Path Filter
 
 Determine which requests should be proxied.
 
-Context matching is optional and is useful in cases where you are not able to use the regular [middleware mounting](http://expressjs.com/en/4x/api.html#app.use).
+`pathFilter` is optional and is useful in cases where you are not able to use the regular [middleware mounting](http://expressjs.com/en/4x/api.html#app.use).
 
-The [RFC 3986 `path`](https://tools.ietf.org/html/rfc3986#section-3.3) is used for context matching.
+The [RFC 3986 `path`](https://tools.ietf.org/html/rfc3986#section-3.3) is used for `pathFilter`.
 
-```
+```text
          foo://example.com:8042/over/there?name=ferret#nose
          \_/   \______________/\_________/ \_________/ \__/
           |           |            |            |        |
@@ -15,25 +15,22 @@ The [RFC 3986 `path`](https://tools.ietf.org/html/rfc3986#section-3.3) is used f
 
 `http-proxy-middleware` offers several ways to do this:
 
-<!-- MarkdownTOC autolink=true bracket=round -->
-
 - [Path](#path)
 - [Multi Path](#multi-path)
 - [Wildcard](#wildcard)
 - [Multi Wildcard](#multi-wildcard)
 - [Wildcard / Exclusion](#wildcard--exclusion)
 - [Custom filtering](#custom-filtering)
 
-<!-- /MarkdownTOC -->
-
 ## Path
 
 This will match paths starting with `/api`
 
 ```javascript
 const { createProxyMiddleware } = require('http-proxy-middleware');
 
-const apiProxy = createProxyMiddleware('/api', {
+const apiProxy = createProxyMiddleware({
+  pathFilter: '/api',
   target: 'http://localhost:3000',
 });
 
@@ -47,7 +44,10 @@ This will match paths starting with `/api` or `/rest`
 ```javascript
 const { createProxyMiddleware } = require('http-proxy-middleware');
 
-const apiProxy = createProxyMiddleware(['/api', '/rest'], { target: 'http://localhost:3000' });
+const apiProxy = createProxyMiddleware({
+  pathFilter: ['/api', '/rest'],
+  target: 'http://localhost:3000',
+});
 
 // `/api/foo/bar` -> `http://localhost:3000/api/foo/bar`
 // `/rest/lorum/ipsum` -> `http://localhost:3000/rest/lorum/ipsum`
@@ -60,7 +60,8 @@ This will match paths starting with `/api/` and should also end with `.json`
 ```javascript
 const { createProxyMiddleware } = require('http-proxy-middleware');
 
-const apiProxy = createProxyMiddleware('/api/**/*.json', {
+const apiProxy = createProxyMiddleware({
+  pathFilter: '/api/**/*.json',
   target: 'http://localhost:3000',
 });
 ```
@@ -72,26 +73,28 @@ Multiple wildcards can be used.
 ```javascript
 const { createProxyMiddleware } = require('http-proxy-middleware');
 
-const apiProxy = createProxyMiddleware(['/api/**/*.json', '/rest/**'], {
+const apiProxy = createProxyMiddleware({
+  pathFilter: ['/api/**/*.json', '/rest/**'],
   target: 'http://localhost:3000',
 });
 ```
 
 ## Wildcard / Exclusion
 
-This example will create a proxy with wildcard context matching.
+This example will create a proxy with globs.
 
 ```javascript
 const { createProxyMiddleware } = require('http-proxy-middleware');
 
-const apiProxy = createProxyMiddleware(['foo/*.js', '!bar.js'], {
+const apiProxy = createProxyMiddleware({
+  pathFilter: ['foo/*.js', '!bar.js'],
   target: 'http://localhost:3000',
 });
 ```
 
 ## Custom filtering
 
-Write your custom context matching function to have full control on the matching behavior.
+Write your custom `pathFilter` function to have full control on the matching behavior.
 The request `pathname` and `req` object are provided to determine which requests should be proxied or not.
 
 ```javascript
@@ -101,5 +104,8 @@ const filter = function (pathname, req) {
   return pathname.match('^/api') && req.method === 'GET';
 };
 
-const apiProxy = createProxyMiddleware(filter, { target: 'http://localhost:3000' });
+const apiProxy = createProxyMiddleware({
+  pathFilter: filter,
+  target: 'http://localhost:3000',
+});
 ```
diff --git a/recipes/shorthand.md b/recipes/shorthand.md
diff --git a/src/config-factory.ts b/src/config-factory.ts
diff --git a/src/configuration.ts b/src/configuration.ts
@@ -0,0 +1,23 @@
+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);
+  }
+}
diff --git a/src/errors.ts b/src/errors.ts
@@ -1,6 +1,6 @@
 export enum ERRORS {
   ERR_CONFIG_FACTORY_TARGET_MISSING = '[HPM] Missing "target" option. Example: {target: "http://www.example.org"}',
   ERR_CONTEXT_MATCHER_GENERIC = '[HPM] Invalid context. Expecting something like: "/api" or ["/api", "/ajax"]',
-  ERR_CONTEXT_MATCHER_INVALID_ARRAY = '[HPM] Invalid context. Expecting something like: ["/api", "/ajax"] or ["/api/**", "!**.html"]',
+  ERR_CONTEXT_MATCHER_INVALID_ARRAY = '[HPM] Invalid pathFilter. Expecting something like: ["/api", "/ajax"] or ["/api/**", "!**.html"]',
   ERR_PATH_REWRITER_CONFIG = '[HPM] Invalid pathRewrite config. Expecting object with pathRewrite config or a rewrite function',
 }