feat: add brotli to supported compression 🗜️

bricss · bricss · commit fbe22de2bcc5 · 2024-05-19T12:17:40.000+02:00
diff --git a/API.md b/API.md
@@ -110,6 +110,13 @@ Default value: '1024'.
 Sets the minimum response payload size in bytes that is required for content encoding compression.
 If the payload size is under the limit, no compression is performed.
 
+##### <a name="server.options.compression.priority" /> `server.options.compression.priority`
+
+Default value: `null`.
+
+Sets the priority for content encoding compression algorithms in descending order,
+e.g.: `['br', 'gzip', 'deflate']`.
+
 #### <a name="server.options.debug" /> `server.options.debug`
 
 Default value: `{ request: ['implementation'] }`.
diff --git a/lib/compression.js b/lib/compression.js
@@ -8,21 +8,23 @@ const Hoek = require('@hapi/hoek');
 
 
 const internals = {
-    common: ['gzip, deflate', 'deflate, gzip', 'gzip', 'deflate', 'gzip, deflate, br']
+    common: ['gzip, deflate', 'deflate, gzip', 'gzip', 'deflate', 'br', 'gzip, deflate, br']
 };
 
 
 exports = module.exports = internals.Compression = class {
 
     decoders = {
+        br: (options) => Zlib.createBrotliDecompress(options),
         gzip: (options) => Zlib.createGunzip(options),
         deflate: (options) => Zlib.createInflate(options)
     };
 
-    encodings = ['identity', 'gzip', 'deflate'];
+    encodings = ['identity', 'gzip', 'deflate', 'br'];
 
     encoders = {
         identity: null,
+        br: (options) => Zlib.createBrotliCompress(options),
         gzip: (options) => Zlib.createGzip(options),
         deflate: (options) => Zlib.createDeflate(options)
     };
@@ -116,4 +118,10 @@ exports = module.exports = internals.Compression = class {
         Hoek.assert(encoder !== undefined, `Unknown encoding ${encoding}`);
         return encoder(request.route.settings.compression[encoding]);
     }
+
+    setPriority(priority) {
+
+        this.encodings = [...new Set([...priority, ...this.encodings])];
+        this._updateCommons();
+    }
 };
diff --git a/lib/config.js b/lib/config.js
@@ -241,7 +241,8 @@ internals.server = Validate.object({
     autoListen: Validate.boolean(),
     cache: Validate.allow(null),                                 // Validated elsewhere
     compression: Validate.object({
-        minBytes: Validate.number().min(1).integer().default(1024)
+        minBytes: Validate.number().min(1).integer().default(1024),
+        priority: Validate.array().items(Validate.string().valid('gzip', 'deflate', 'br')).default(null)
     })
         .allow(false)
         .default(),
diff --git a/lib/core.js b/lib/core.js
@@ -127,6 +127,10 @@ exports = module.exports = internals.Core = class {
         this._debug();
         this._initializeCache();
 
+        if (this.settings.compression.priority) {
+            this.compression.setPriority(this.settings.compression.priority);
+        }
+
         if (this.settings.routes.validate.validator) {
             this.validator = Validation.validator(this.settings.routes.validate.validator);
         }
diff --git a/lib/types/server/encoders.d.ts b/lib/types/server/encoders.d.ts
@@ -1,4 +1,4 @@
-import { createDeflate, createGunzip, createGzip, createInflate } from 'zlib';
+import { createBrotliCompress, createBrotliDecompress, createDeflate, createGunzip, createGzip, createInflate } from 'zlib';
 
 /**
  * Available [content encoders](https://github.com/hapijs/hapi/blob/master/API.md#-serverencoderencoding-encoder).
@@ -7,6 +7,7 @@ export interface ContentEncoders {
 
     deflate: typeof createDeflate;
     gzip: typeof createGzip;
+    br: typeof createBrotliCompress;
 }
 
 /**
@@ -16,4 +17,5 @@ export interface ContentDecoders {
 
     deflate: typeof createInflate;
     gzip: typeof createGunzip;
+    br: typeof createBrotliDecompress;
 }
diff --git a/lib/types/server/options.d.ts b/lib/types/server/options.d.ts
@@ -10,6 +10,7 @@ import { SameSitePolicy } from './state';
 
 export interface ServerOptionsCompression {
     minBytes: number;
+    priority: string[];
 }
 
 /**
diff --git a/test/payload.js b/test/payload.js
@@ -407,6 +407,30 @@ describe('Payload', () => {
         expect(res.result).to.equal(message);
     });
 
+    it('handles br payload', async () => {
+
+        const message = { 'msg': 'This message is going to be brotlied.' };
+        const server = Hapi.server();
+        server.route({ method: 'POST', path: '/', handler: (request) => request.payload });
+
+        const compressed = await new Promise((resolve) => Zlib.brotliCompress(JSON.stringify(message), (ignore, result) => resolve(result)));
+
+        const request = {
+            method: 'POST',
+            url: '/',
+            headers: {
+                'content-type': 'application/json',
+                'content-encoding': 'br',
+                'content-length': compressed.length
+            },
+            payload: compressed
+        };
+
+        const res = await server.inject(request);
+        expect(res.result).to.exist();
+        expect(res.result).to.equal(message);
+    });
+
     it('handles custom compression', async () => {
 
         const message = { 'msg': 'This message is going to be gzipped.' };
diff --git a/test/transmit.js b/test/transmit.js
@@ -677,6 +677,19 @@ describe('transmission', () => {
             expect(res3.headers['last-modified']).to.equal(res2.headers['last-modified']);
         });
 
+        it('returns a brotlied file in the response when the request accepts br', async () => {
+
+            const server = Hapi.server({ compression: { minBytes: 1 }, routes: { files: { relativeTo: __dirname } } });
+            await server.register(Inert);
+            server.route({ method: 'GET', path: '/file', handler: (request, h) => h.file(__dirname + '/../package.json') });
+
+            const res = await server.inject({ url: '/file', headers: { 'accept-encoding': 'br' } });
+            expect(res.headers['content-type']).to.equal('application/json; charset=utf-8');
+            expect(res.headers['content-encoding']).to.equal('br');
+            expect(res.headers['content-length']).to.not.exist();
+            expect(res.payload).to.exist();
+        });
+
         it('returns a gzipped file in the response when the request accepts gzip', async () => {
 
             const server = Hapi.server({ compression: { minBytes: 1 }, routes: { files: { relativeTo: __dirname } } });
@@ -729,6 +742,16 @@ describe('transmission', () => {
             expect(res.payload).to.exist();
         });
 
+        it('returns a brotlied stream response without a content-length header when accept-encoding is br', async () => {
+
+            const server = Hapi.server({ compression: { minBytes: 1 } });
+            server.route({ method: 'GET', path: '/stream', handler: () => new internals.TimerStream() });
+
+            const res = await server.inject({ url: '/stream', headers: { 'Content-Type': 'application/json', 'accept-encoding': 'br' } });
+            expect(res.statusCode).to.equal(200);
+            expect(res.headers['content-length']).to.not.exist();
+        });
+
         it('returns a gzipped stream response without a content-length header when accept-encoding is gzip', async () => {
 
             const server = Hapi.server({ compression: { minBytes: 1 } });
@@ -749,6 +772,37 @@ describe('transmission', () => {
             expect(res.headers['content-length']).to.not.exist();
         });
 
+        it('returns a br response on a post request when accept-encoding: br is requested', async () => {
+
+            const data = '{"test":"true"}';
+
+            const server = Hapi.server({ compression: { minBytes: 1 } });
+            server.route({ method: 'POST', path: '/', handler: (request) => request.payload });
+            await server.start();
+
+            const uri = 'http://localhost:' + server.info.port;
+            const brotlied = await internals.compress('brotliCompress', Buffer.from(data));
+
+            const { payload } = await Wreck.post(uri, { headers: { 'accept-encoding': 'br' }, payload: data });
+            expect(payload.toString()).to.equal(brotlied.toString());
+            await server.stop();
+        });
+
+        it('returns a br response on a get request when accept-encoding: br is requested', async () => {
+
+            const data = '{"test":"true"}';
+
+            const server = Hapi.server({ compression: { minBytes: 1 } });
+            server.route({ method: 'GET', path: '/', handler: () => data });
+            await server.start();
+
+            const uri = 'http://localhost:' + server.info.port;
+            const brotlied = await internals.compress('brotliCompress', Buffer.from(data));
+            const { payload } = await Wreck.get(uri, { headers: { 'accept-encoding': 'br' } });
+            expect(payload.toString()).to.equal(brotlied.toString());
+            await server.stop();
+        });
+
         it('returns a gzip response on a post request when accept-encoding: gzip is requested', async () => {
 
             const data = '{"test":"true"}';
@@ -891,6 +945,35 @@ describe('transmission', () => {
             await server.stop();
         });
 
+
+        it('returns a br response on a post request when accept-encoding: gzip;q=1, deflate;q=0.5, br;q=1 is requested', async () => {
+
+            const data = '{"test":"true"}';
+            const server = Hapi.server({ compression: { minBytes: 1, priority: ['br'] } });
+            server.route({ method: 'POST', path: '/', handler: (request) => request.payload });
+            await server.start();
+
+            const uri = 'http://localhost:' + server.info.port;
+            const brotlied = await internals.compress('brotliCompress', Buffer.from(data));
+            const { payload } = await Wreck.post(uri, { headers: { 'accept-encoding': 'gzip;q=1, deflate;q=0.5, br;q=1' }, payload: data });
+            expect(payload.toString()).to.equal(brotlied.toString());
+            await server.stop();
+        });
+
+        it('returns a br response on a get request when accept-encoding: gzip;q=1, deflate;q=0.5, br;q=1 is requested', async () => {
+
+            const data = '{"test":"true"}';
+            const server = Hapi.server({ compression: { minBytes: 1, priority: ['br'] } });
+            server.route({ method: 'GET', path: '/', handler: () => data });
+            await server.start();
+
+            const uri = 'http://localhost:' + server.info.port;
+            const brotlied = await internals.compress('brotliCompress', Buffer.from(data));
+            const { payload } = await Wreck.get(uri, { headers: { 'accept-encoding': 'gzip;q=1, deflate;q=0.5, br;q=1' } });
+            expect(payload.toString()).to.equal(brotlied.toString());
+            await server.stop();
+        });
+
         it('returns a gzip response on a post request when accept-encoding: deflate, gzip is requested', async () => {
 
             const data = '{"test":"true"}';
@@ -919,6 +1002,35 @@ describe('transmission', () => {
             await server.stop();
         });
 
+
+        it('returns a br response on a post request when accept-encoding: gzip, deflate, br is requested', async () => {
+
+            const data = '{"test":"true"}';
+            const server = Hapi.server({ compression: { minBytes: 1, priority: ['br'] } });
+            server.route({ method: 'POST', path: '/', handler: (request) => request.payload });
+            await server.start();
+
+            const uri = 'http://localhost:' + server.info.port;
+            const brotlied = await internals.compress('brotliCompress', Buffer.from(data));
+            const { payload } = await Wreck.post(uri, { headers: { 'accept-encoding': 'gzip, deflate, br' }, payload: data });
+            expect(payload.toString()).to.equal(brotlied.toString());
+            await server.stop();
+        });
+
+        it('returns a br response on a get request when accept-encoding: gzip, deflate, br is requested', async () => {
+
+            const data = '{"test":"true"}';
+            const server = Hapi.server({ compression: { minBytes: 1, priority: ['br'] } });
+            server.route({ method: 'GET', path: '/', handler: () => data });
+            await server.start();
+
+            const uri = 'http://localhost:' + server.info.port;
+            const brotlied = await internals.compress('brotliCompress', Buffer.from(data));
+            const { payload } = await Wreck.get(uri, { headers: { 'accept-encoding': 'gzip, deflate, br' } });
+            expect(payload.toString()).to.equal(brotlied.toString());
+            await server.stop();
+        });
+
         it('boom object reused does not affect encoding header.', async () => {
 
             const error = Boom.badRequest();

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { createDeflate, createGunzip, createGzip, createInflate } from 'zlib';`
	`1`	`+import { createBrotliCompress, createBrotliDecompress, createDeflate, createGunzip, createGzip, createInflate } from 'zlib';`
`2`	`2`
`3`	`3`	`/**`
`4`	`4`	`* Available [content encoders](https://github.com/hapijs/hapi/blob/master/API.md#-serverencoderencoding-encoder).`
`@@ -7,6 +7,7 @@ export interface ContentEncoders {`
`7`	`7`
`8`	`8`	`deflate: typeof createDeflate;`
`9`	`9`	`gzip: typeof createGzip;`
	`10`	`+ br: typeof createBrotliCompress;`
`10`	`11`	`}`
`11`	`12`
`12`	`13`	`/**`
`@@ -16,4 +17,5 @@ export interface ContentDecoders {`
`16`	`17`
`17`	`18`	`deflate: typeof createInflate;`
`18`	`19`	`gzip: typeof createGunzip;`
	`20`	`+ br: typeof createBrotliDecompress;`
`19`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ import { SameSitePolicy } from './state';`
`10`	`10`
`11`	`11`	`export interface ServerOptionsCompression {`
`12`	`12`	`minBytes: number;`
	`13`	`+ priority: string[];`
`13`	`14`	`}`
`14`	`15`
`15`	`16`	`/**`