h2o2 - npm Package Compare versions

Comparing version 4.0.1 to 4.0.2

lib/index.js

@@ -50,3 +50,3 @@ // Load modules
 
-exports.register = function (server, options, next) {
+exports.register = function (server, pluginOptions, next) {
 
@@ -68,8 +68,8 @@ server.handler('proxy', internals.handler);
 
-internals.handler = function (route, options) {
+internals.handler = function (route, handlerOptions) {
 
-    Joi.assert(options, internals.schema, 'Invalid proxy handler options (' + route.path + ')');
+    Joi.assert(handlerOptions, internals.schema, 'Invalid proxy handler options (' + route.path + ')');
     Hoek.assert(!route.settings.payload || ((route.settings.payload.output === 'data' || route.settings.payload.output === 'stream') && !route.settings.payload.parse), 'Cannot proxy if payload is parsed or if output is not stream or data');
-    var settings = Hoek.applyToDefaultsWithShallow(internals.defaults, options, ['agent']);
-    settings.mapUri = options.mapUri || internals.mapUri(options.protocol, options.host, options.port, options.uri);
+    var settings = Hoek.applyToDefaultsWithShallow(internals.defaults, handlerOptions, ['agent']);
+    settings.mapUri = handlerOptions.mapUri || internals.mapUri(handlerOptions.protocol, handlerOptions.host, handlerOptions.port, handlerOptions.uri);
 
@@ -76,0 +76,0 @@ if (settings.ttl === 'upstream') {

package.json

 {
   "name": "h2o2",
   "description": "Proxy handler plugin for hapi.js",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "repository": "git://github.com/hapijs/h2o2",
@@ -21,3 +21,3 @@ "main": "lib/index.js",
     "joi": "6.x.x",
-    "wreck": "5.x.x"
+    "wreck": "6.x.x"
   },
@@ -24,0 +24,0 @@ "devDependencies": {

README.md

@@ -5,4 +5,138 @@ #h2o2
 
+[![NPM](https://nodei.co/npm/h2o2.png?downloads=true&stars=true)](https://nodei.co/npm/h2o2/)
+
 [![Build Status](https://secure.travis-ci.org/hapijs/h2o2.png)](http://travis-ci.org/hapijs/h2o2)
 
-Lead Maintainer - [Eran Hammer](https://github.com/hueniverse)
+Lead Maintainer - [Oscar A. Funes Martinez](https://github.com/osukaa)
+
+## Introduction
+
+**h2o2** is a hapi plugin that adds proxying functionality.
+
+## Manual loading
+
+There's the possibility of starting the server with the `minimal` property, which does not load the `h2o2` automatically. If you go with the minimal setup and want to add the `h2o2` module yourself, you could try this:
+
+```javascript
+var Hapi = require('hapi');
+var server = new Hapi.Server({ minimal: true });
+
+server.register({
+    register: require('h2o2')
+}, function (err) {
+
+    if (err) {
+        console.log('Failed to load h2o2');
+    }
+
+    server.start(function (err) {
+
+        console.log('Server started at: ' + server.info.uri);
+    });
+});
+```
+NOTE: h2o2 is included with and loaded by default in Hapi < 9.0.
+
+
+
+## Options
+
+The proxy handler object has the following properties:
+
+* `host` - upstream service host to proxy requests to. It will have the same path as the client request.
+* `port` - upstream service port.
+* `protocol` - protocol to use when making the request to the proxied host:
+    * 'http'
+    * 'https'
+* `uri` - absolute URI used insted of host, port, protocol, path, and query. Cannot be used with `host`, `port`, `protocol`, or `mapUri`.
+* `passThrough` - if set to `true`, it forwards the headers from the client to the upstream service, headers sent from the upstream service will also be forwarded to the client. Defaults to `false`.
+* `localStatePassThrough` - if set to`false`, any locally defined state is removed from incoming requests before being sent to the upstream service. This value can be overridden on a per state basis via the `server.state()``passThrough` option. Defaults to `false`
+* `acceptEncoding` - if set to `false`, does not pass-through the 'Accept-Encoding' HTTP header which is useful for the `onResponse` post-processing to avoid receiving an encoded response. Can only be used together with `passThrough`. Defaults to `true` (passing header).
+* `rejectUnauthorized` - sets the `rejectUnauthorized` property on the https [agent](http://nodejs.org/api/https.html#https_https_request_options_callback) making the request. This value is only used when the proxied server uses TLS/SSL. If set it will override the node.js `rejectUnauthorized` property. If `false` then ssl errors will be ignored. When `true` the server certificate is verified and an 500 response will be sent when verification fails. This shouldn't be used alongside the `agent` setting as the `agent` will be used instead. Defaults to the https agent default value of `true`.
+* `xforward` - if set to `true`, sets the 'X-Forwarded-For', 'X-Forwarded-Port', 'X-Forwarded-Proto' headers when making a request to the proxied upstream endpoint. Defaults to `false`.
+* `redirects` - the maximum number of HTTP redirections allowed to be followed automatically by the handler. Set to `false` or `0` to disable all redirections (the response will contain the redirection received from the upstream service). If redirections are enabled, no redirections (301, 302, 307, 308) will be passed along to the client, and reaching the maximum allowed redirections will return an error response. Defaults to `false`.
+* `timeout` - number of milliseconds before aborting the upstream request. Defaults to `180000` (3 minutes).
+* `mapUri` - a function used to map the request URI to the proxied URI. Cannot be used together with `host`, `port`, `protocol`, or `uri`. The function signature is `function(request, callback)` where:
+    * `request` - is the incoming [request object](http://hapijs.com/api#request-object).
+    * `callback` - is `function(err, uri, headers)` where:
+        * `err` - internal error condition.
+        * `uri` - the absolute proxy URI.
+        * `headers` - optional object where each key is an HTTP request header and the value is the header content.
+* `onResponse` - a custom function for processing the response from the upstream service before sending to the client. Useful for custom error handling of responses from the proxied endpoint or other payload manipulation. Function signature is `function(err, res, request, reply, settings, ttl)` where:
+    * `err` - internal or upstream error returned from attempting to contact the upstream proxy.
+    * `res` - the node response object received from the upstream service. `res` is a readable stream (use the [wreck](https://github.com/hapijs/wreck) module `read` method to easily convert it to a Buffer or string).
+    * `request` - is the incoming [request object](http://hapijs.com/api#request-object).
+    * `reply` - the [reply interface](http://hapijs.com/api#reply-interface) function.
+    * `settings` - the proxy handler configuration.
+    * `ttl` - the upstream TTL in milliseconds if `proxy.ttl` it set to `'upstream'` and the upstream response included a valid 'Cache-Control' header with 'max-age'.
+* `ttl` - if set to `'upstream'`, applies the upstream response caching policy to the response using the `response.ttl()` method (or passed as an argument to the `onResponse` method if provided).
+* `agent` - a node [http(s) agent](http://nodejs.org/api/http.html#http_class_http_agent) to be used for connections to upstream server.
+* `maxSockets` - sets the maximum number of sockets available per outgoing proxy host connection. `false` means use the **wreck** module default value (`Infinity`). Does not affect non-proxy outgoing client connections. Defaults to `Infinity`.
+
+## Usage
+
+As one of the handlers for hapi, it is used through the route configuration object.
+
+### Using the `host`, `port`, `protocol` options
+
+Setting these options will send the request to certain route to a specific upstream service with the same path as the original request. Cannot be used with `uri`, `mapUri`.
+
+```javascript
+server.route({
+    method: 'GET',
+    path: '/',
+    handler: {
+        proxy: {
+            host: '10.33.33.1',
+            port: '443',
+            protocol: 'https'
+        }
+    }
+});
+```
+
+### Using the `uri` option
+
+Setting this option will send the request to an absolute URI instead of the incoming host, port, protocol, path and query. Cannot be used with `host`, `port`, `protocol`, `mapUri`.
+
+```javascript
+server.route({
+    method: 'GET',
+    path: '/',
+    handler: {
+        proxy: {
+            uri: 'https://some.upstream.service.com/that/has?what=you&want=todo'
+        }
+    }
+});
+```
+
+### Using the `mapUri` and `onResponse` options
+
+Setting both options with custom functions will allow you to map the original request to an upstream service and to processing the response from the upstream service, before sending it to the client. Cannot be used together with `host`, `port`, `protocol`, or `uri`.
+
+```javascript
+server.route({
+    method: 'GET',
+    path: '/',
+    handler: {
+        proxy: {
+            mapUri: function (request, callback) {
+
+                console.log('doing some aditional stuff before redirecting');
+                callback(null, 'https://some.upstream.service.com/');
+            },
+            onResponse: function (err, res, request, reply, settings, ttl) {
+
+                console.log('receiving the response from the upstream.');
+                wreck.read(res, { json: true }, function (err, payload) {
+
+                    console.log('some payload manipulation if you want to.')
+                    reply(payload);
+                });
+            }
+        }
+    }
+});
+
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

84679

increased by9.75%

Number of lines in readme file

142

increased by1675%

Worsened metrics

Number of medium supply chain risk alerts

5

increased by25%

Dependency changes

• + Addedwreck@6.3.0(transitive)

• - Removedwreck@5.6.1(transitive)

• Updatedwreck@6.x.x