Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hapipal/underdog
HTTP/2 server-push for hapi
https://github.com/hapipal/underdog
Last synced: about 2 months ago
JSON representation
HTTP/2 server-push for hapi
- Host: GitHub
- URL: https://github.com/hapipal/underdog
- Owner: hapipal
- License: mit
- Created: 2016-08-29T04:29:23.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-04-12T03:48:47.000Z (over 3 years ago)
- Last Synced: 2024-07-14T00:23:20.115Z (2 months ago)
- Language: JavaScript
- Size: 63.5 KB
- Stars: 60
- Watchers: 5
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# underdog
HTTP/2 server-push for hapi
[](https://travis-ci.com/hapipal/underdog) [](https://coveralls.io/github/hapipal/underdog?branch=master)
Lead Maintainer - [Devin Ivy](https://github.com/devinivy)
## Installation
```sh
npm install underdog
```
## Usage
> See also the [API Reference](API.md)
>
> Underdog is intended for use with hapi v19+ and nodejs v12+ (see v4 for lower support).
>
> This module is currently under [ad hoc maintenance](https://github.com/hapipal/underdog/issues/17), which means it relies fully on community support.
Underdog brings [HTTP/2 server-push](http://httpwg.org/specs/rfc7540.html#PushResources) to hapi. The way it works is that you specify paths to resources that you'd like to push alongside a particular response. This is achieved with a call to the response toolkit decoration [`h.push()`](API.md#hpushresponse-path-headers). Before hapi responds to the original request, those push-requests will be made internally and their results will be streamed to the client as push-responses. Even pushed resources can specify additional resources to push. You can't make this stuff up!
### Example
```js
const Fs = require('fs');
const Http2 = require('http2');
const Hapi = require('@hapi/hapi');
const Underdog = require('underdog');
(async () => {
const listener = Http2.createSecureServer({
// See tests for a key/cert that you can use to try this out
key: Fs.readFileSync(`${__dirname}/localhost.key`),
cert: Fs.readFileSync(`${__dirname}/localhost.cert`)
});
const server = Hapi.server({
listener,
tls: true,
port: 3000
});
await server.register(Underdog);
server.route([
{
method: 'get',
path: '/',
handler: (request, h) => {
const response = h.response('');
h.push(response, 'push-me.js');
return response;
}
},
{
method: 'get',
path: '/push-me.js',
handler: (request) => {
return 'document.write(\'I was definitely pushed!\');';
},
// To demonstrate that it must have been pushed, not requested directly
config: { isInternal: true }
}
]);
await server.start();
console.log(`Check-out ${server.info.uri} in your favorite HTTP/2-supporting client`);
})();
```
### Compatibility
Underdog is compatible with nodejs's [`Http2Server`](https://nodejs.org/api/http2.html#http2_http2_createserver_options_onrequesthandler) and [`Http2SecureServer`](https://nodejs.org/api/http2.html#http2_http2_createsecureserver_options_onrequesthandler) under the [Compatibility API](https://nodejs.org/api/http2.html#http2_compatibility_api). Using any other HTTP server will simply disable server-push; [`h.push()`](API.md#hpushresponse-path-headers) will no-op and return `{ response, allowed: false }` and [`h.pushAllowed()`](API.md#hpushallowed) will return `false`.
## Extras
- The HTTP/2 spec ([here](http://httpwg.org/specs/rfc7540.html))
- For debugging HTTP/2 in Chrome, see `chrome://net-internals/#http2`
- Nodejs's HTTP/2 docs ([here](https://nodejs.org/api/http2.html))
- Shout-out to the original userland [spdy](https://github.com/indutny/node-spdy) and [http2](https://github.com/molnarg/node-http2) modules.