Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fastify/fastify-early-hints
Draft plugin of the HTTP 103 implementation
https://github.com/fastify/fastify-early-hints
fastify fastify-plugin nodejs
Last synced: 3 months ago
JSON representation
Draft plugin of the HTTP 103 implementation
- Host: GitHub
- URL: https://github.com/fastify/fastify-early-hints
- Owner: fastify
- License: mit
- Archived: true
- Created: 2020-11-12T20:44:45.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-06-03T20:02:36.000Z (7 months ago)
- Last Synced: 2024-09-19T04:08:06.115Z (3 months ago)
- Topics: fastify, fastify-plugin, nodejs
- Language: JavaScript
- Homepage:
- Size: 134 KB
- Stars: 22
- Watchers: 12
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @fastify/early-hints
[](http://standardjs.com/)
Draft proposal of plugin handling the HTTP 103 code.
Based on : https://github.com/fastify/fastify/issues/2683
## Install
```shell
npm i @fastify/early-hints
```
## Options
You can pass the following options during the plugin registration:
```js
await fastify.register(import('@fastify/early-hints'), {
warn: true // default: false
})
```
- `warn` : indicates if the plugin should log warnings if invalid values are supplied as early hints
## Usage
### Reply.writeEarlyHints
This method is used to write early hints with any header you need. It accepts
either `object` or `Array` of headers and return `Promise`.
```javascript
const Fastify = require("fastify");
const eh = require("@fastify/early-hints");
const fastify = Fastify({ logger: true });
fastify.register(eh);
fastify.get("/", async (request, reply) => {
// object
await reply.writeEarlyHints({
'Content-Security-Policy': 'style-src: self;',
Link: ['; rel=preload; as=style', '; rel=preload; as=script']
})
// array
await reply.writeEarlyHints([
{ name: 'Content-Security-Policy', value: 'style-src: self;' },
{ name: 'Link', value: '; rel=preload; as=style' },
{ name: 'Link', value: '; rel=preload; as=script' },
])
return { hello: "world" };
});
const start = async () => {
try {
await fastify.listen({ port: 3000 });
fastify.log.info(`server listening on ${fastify.server.address().port}`);
} catch (err) {
fastify.log.error(err);
process.exit(1);
}
};
start();
```
Result
```shell
$ curl -D - http://localhost:3000
HTTP/1.1 103 Early Hints
Content-Security-Policy: style-src: self;
Link: ; rel=preload; as=style
Link: ; rel=preload; as=script
HTTP/1.1 103 Early Hints
Content-Security-Policy: style-src: self;
Link: ; rel=preload; as=style
Link: ; rel=preload; as=script
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
content-length: 17
Date: Thu, 12 Nov 2020 22:45:54 GMT
Connection: keep-alive
{"hello":"world"}
```
### Reply.writeEarlyHintsLinks
This method used to write only the `Link` header. It accepts an `Array` and
return `Promise`.
```javascript
const Fastify = require("fastify");
const eh = require("@fastify/early-hints");
const fastify = Fastify({ logger: true });
fastify.register(eh);
fastify.get("/", async (request, reply) => {
await reply.writeEarlyHintsLinks([
"Link: ; rel=preload; as=style",
"Link: ; rel=preload; as=script",
])
await reply.writeEarlyHintsLinks([
{ href: "//example.com", rel: "preload", as: "style" },
{ href: "//example.com", rel: "preload", as: "style", cors: true },
{ href: "//example.com", rel: "preconnect" },
{ href: "//example2.com", rel: "preconnect", cors: true },
{ href: "//example3.com", rel: "preconnect", cors: "use-credentials" },
])
return { hello: "world" };
});
const start = async () => {
try {
await fastify.listen({ port: 3000 });
fastify.log.info(`server listening on ${fastify.server.address().port}`);
} catch (err) {
fastify.log.error(err);
process.exit(1);
}
};
start();
```
Result
```shell
$ curl -D - http://localhost:3000
HTTP/1.1 103 Early Hints
Link: ; rel=preload; as=style
Link: ; rel=preload; as=script
HTTP/1.1 103 Early Hints
Link: ; rel=preload; as=style
Link: ; rel=preload; as=script
Link: /example.com>; rel=preload; as=style
Link: /example.com>; rel=preload; as=style; crossorigin
Link: /example.com>; rel=preconnect
Link: /example2.com>; rel=preconnect; crossorigin
Link: /example3.com>; rel=preconnect; crossorigin=use-credentials
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
content-length: 17
Date: Thu, 12 Nov 2020 22:45:54 GMT
Connection: keep-alive
{"hello":"world"}
```
## Browser Limitation
Currently (2022-09-29), only Chrome 103 is supporting `103 Early Hints` and
Chrome will ignore `103 Early Hints` in the following situations.
- Early Hints sent on subresource requests
- Early Hints sent on iframe navigation
- Early Hints sent on HTTP/1.1 or earlier
- Second and following Early Hints
Read more on
## References
-
-
## License
Licensed under [MIT](./LICENSE).