hapi-heroku-helpers
v3.0.0
Published
hapi.js plugin which provides some basic functionality which can be useful when running a hapi.js site on Heroku.
Downloads
45
Readme
Hapi Heroku Helpers
hapi.js plugin which provides additional functionality which can be useful when running a hapi.js site on Heroku.
Note: Version 2 and above of this module requires Node 4 or above and Hapi 11 or above.
Heroku
The Heroku platform automatically routes HTTP requests sent to your app’s hostname(s) to your web dynos. Inbound requests are received by a load balancer that offers SSL termination. From there they are passed directly to a set of routers which routes the request to your application. Think of it as a reverse proxy.
HTTPS
If you want your site to have https
urls, that SSL termination happens on the edge of the heroku network, and the request is routed to your application using http
. By default this plugin allows you to have any http
request redirected automatically to a https
request (see redirectHttpToHttps
setting)
Client IP Address
Your hapi site will see the incoming HTTP request as coming from the IP address of the Heroku router and set this IP to request.info.remotePort. In the majority of cases you most likely are interested in the originating IP address and not the routers address. By default this plugin sets request.info.remoteAddress
to the value of the x-forwarded-for
header which Heroku sets to the originating IP address (see remoteAddressToClientIp
setting)
Client Port
Your hapi site will see the incoming HTTP request as coming from the PORT that hapi is running on inside the Heroku platform (which is rarely the port your site is running on - i.e. 80 or 443). In the majority of cases you most likely are interested in the port that the client is connecting on. By default this plugin sets request.info.remotePort
to the value of the x-forwarded-port
header which Heroku sets to the originating port (see remotePortToClientPort
setting)
Request ID
Your hapi site will generate an unique identifier for each incoming request. By default this plugin sets the request.id
to the value of the x-request-id
header which Heroku already generates for each incoming request (see mapRequestId
setting)
Options
The following options are available:
redirectHttpToHttps
: iftrue
and thex-forwarded-proto
header equalshttp
, will result in the request being redirected via a301
to thehttps://
version of the URL. Heroku sets thex-forwarded-proto
header to the originating protocol of the HTTP request (example: http). For example,http://localhost:3000/some-url
would redirect tohttps://localhost:3000/some-url
. Defaults totrue
.remoteAddressToClientIp
: iftrue
, will setrequest.info.remoteAddress
to the value of thex-forwarded-for
header if it exists and is non-empty. Heroku set thex-forwarded-for
header to the originating IP address of the client connecting to the Heroku router. Defaults totrue
.remotePortToClientPort
: iftrue
, will setrequest.info.remoteAddress
to the value of thex-forwarded-port
header if it exists and is non-empty. Heroku set thex-forwarded-port
header to the originating port of the HTTP request (example: 443). Defaults totrue
.mapRequestId
: iftrue
, will setrequest.id
to the value of thex-request-id
header if it exists and is non-empty. Heroku set thex-request-id
header to an unique identifier per request. This setting allows you to map any request logged by Heroku to a request received by your application. Defaults totrue
.
Usage
const Hapi = require('hapi');
const server = new Hapi.Server();
server.connection();
server.register(require('hapi-heroku-helpers'), function (err) {
// Assuming no err, start server
server.start(function () {
// ..
});
});
Example App
There is an example heroku hapi app which uses this plugin here: (https://github.com/briandela/hapi-heroku-helpers-example)
You can deploy it directly to your heroku account by clicking the button below: