Switch to Brotli from Gzip

lib/benchmark-minifiers.ts

@@ -70,12 +70,12 @@ export async function benchmarkMinifiers(
 					const [firstRun] = runs;
 					const raw = {
 						minifiedSize: firstRun.minifiedSize,
-						minzippedSize: firstRun.minzippedSize,
+						brotliMinifiedSize: firstRun.brotliMinifiedSize,
 						averageTime,
 					};
 					const formatted = {
 						minifiedSize: byteSize(raw.minifiedSize).toString(),
-						minzippedSize: byteSize(raw.minzippedSize).toString(),
+						brotliMinifiedSize: byteSize(raw.brotliMinifiedSize).toString(),
 						averageTime: formatMs(raw.averageTime),
 					};
 

lib/get-artifacts/index.ts

@@ -3,7 +3,7 @@ import path from 'path';
 import assert from 'assert';
 import { readPackageUp } from 'read-pkg-up';
 import type { Artifact, ArtifactMeta } from '../types';
-import { getSize, getGzipSize } from '../utils/get-size';
+import { getSize, getBrotliSize } from '../utils/get-size';
 
 const readPublicPackageUp = async (cwd: string) => {
 	let packageFound = await readPackageUp({ cwd });
@@ -36,7 +36,7 @@ export const defineArtifact = async (artifactMeta: ArtifactMeta): Promise<Artifa
 		testPath: '',
 		artifactCode,
 		size: getSize(artifactCode),
-		gzipSize: getGzipSize(artifactCode),
+		brotliSize: getBrotliSize(artifactCode),
 	};
 };
 

lib/types.ts

@@ -14,14 +14,14 @@ export type Artifact = {
 	fullModulePath: string;
 	artifactCode: Buffer;
 	size: number;
-	gzipSize: number;
+	brotliSize: number;
 	testPath: string;
 }
 
 // Result for a minifier benchmark given a file
 export type BenchmarkData = {
 	minifiedSize: number;
-	minzippedSize: number;
+	brotliMinifiedSize: number;
 	time: number;
 };
 
@@ -37,7 +37,7 @@ export type BenchmarkResult = BenchmarkResultSuccess | BenchmarkResultFailed;
 
 export type AverageBenchmarkData<format = number> = {
 	minifiedSize: format;
-	minzippedSize: format;
+	brotliMinifiedSize: format;
 	averageTime: format;
 };
 

lib/utils/get-size.ts

@@ -4,6 +4,8 @@ export const getSize = (
 	code: string | Buffer,
 ) => Buffer.byteLength(code, 'utf8');
 
-export const getGzipSize = (
+export const getBrotliSize = (
 	code: string | Buffer,
-) => zlib.gzipSync(code, { level: zlib.constants.Z_BEST_COMPRESSION }).length;
+) => zlib.brotliCompressSync(code, {
+	[zlib.constants.BROTLI_PARAM_QUALITY]: zlib.constants.BROTLI_MAX_QUALITY,
+}).length;

readme.md

@@ -26,15 +26,15 @@ _Benchmarks last updated on <!-- lastUpdated:start -->Jan 13, 2022<!-- lastUpdat
 - Benchmarks are gathered on every PR via [GitHub Actions](https://github.com/privatenumber/minification-benchmarks/actions/workflows/benchmark.yml) (verifiable minified artifacts are uploaded on each run)
 
 ## ⏱ Metrics
-Minifiers are ranked by smallest minzipped size.
+Minifiers are ranked by smallest minifed Brotli size.
 
 #### Minified size
 
 Size of the minified output.
 
-#### Minzipped size
+#### Minified and Brotli size
 
-Size of the minified output with [Gzip compression](https://en.wikipedia.org/wiki/Gzip).
+Size of the minified output with [Brotli compression](https://en.wikipedia.org/wiki/Brotli).
 
 For minifiers, this measures how compressable the output is.
 

scripts/benchmark/index.ts

@@ -2,7 +2,7 @@ import fs from 'fs/promises';
 import assert from 'assert';
 import path from 'path';
 import { cli } from 'cleye';
-import { getSize, getGzipSize } from '../../lib/utils/get-size';
+import { getSize, getBrotliSize } from '../../lib/utils/get-size';
 import type { BenchmarkData } from '../../lib/types';
 import { getMinifier } from './get-minifier';
 import { unpreserveComment } from './unpreserve-comments';
@@ -80,7 +80,7 @@ import { runTest } from './run-test';
 
 	console.log(JSON.stringify({
 		minifiedSize: success && getSize(minifiedCode),
-		minzippedSize: success && getGzipSize(minifiedCode),
+		brotliMinifiedSize: success && getBrotliSize(minifiedCode),
 		time: success && (hrtime[0] * 1000) + (hrtime[1] / 1e6),
 	} as BenchmarkData));
 

scripts/update-benchmarks-readme/update-readme.ts

@@ -47,16 +47,16 @@ function getBenchmarkTable(
 ) {
 	const successfulMinifiers = minifierResults.filter(minifier => !('error' in minifier)) as MinifierResultSuccess[];
 	const bestMinified = minBy(successfulMinifiers, 'data.raw.minifiedSize');
-	const bestMinzipped = minBy(successfulMinifiers, 'data.raw.minzippedSize');
+	const bestBrotliMinified = minBy(successfulMinifiers, 'data.raw.brotliMinifiedSize');
 	const bestSpeed = minBy(successfulMinifiers, 'data.raw.averageTime');
 
 	return [
-		['Minifier', 'Minified size', 'Minzipped size', 'Time'].map(mdu.strong),
+		['Minifier', 'Minified size', 'Brotli size', 'Time'].map(mdu.strong),
 		...minifierResults
 			.sort(
 				(a, b) => (
-					('error' in a ? PositiveInfinity : a.data.raw.minzippedSize)
-					- ('error' in b ? PositiveInfinity : b.data.raw.minzippedSize)
+					('error' in a ? PositiveInfinity : a.data.raw.brotliMinifiedSize)
+					- ('error' in b ? PositiveInfinity : b.data.raw.brotliMinifiedSize)
 				),
 			)
 			.map((minifier) => {
@@ -79,9 +79,9 @@ function getBenchmarkTable(
 						minifier === bestMinified,
 					),
 					displayColumn(
-						minifier.data.formatted.minzippedSize,
-						percent(artifact.gzipSize, minifier.data.raw.minzippedSize),
-						minifier === bestMinzipped,
+						minifier.data.formatted.brotliMinifiedSize,
+						percent(artifact.brotliSize, minifier.data.raw.brotliMinifiedSize),
+						minifier === bestBrotliMinified,
 					),
 					displayColumn(
 						minifier.data.formatted.averageTime,
@@ -98,23 +98,22 @@ export function getBenchmarkDataTables(
 ) {
 	return artifactMinifierBenchmarks.map(
 		({ artifact, benchmarkResults }) => outdent`
-			${
-				markdownTable([
-					['Artifact', 'Original size', 'Gzip size'],
-					[
-						`${mdu.link(
-							`${artifact.packageName} v${artifact.packageVersion}`,
-							`https://www.npmjs.com/package/${artifact.packageName}/v/${artifact.packageVersion}`,
-						)} (${mdu.link('Source', `https://unpkg.com/${artifact.packageName}@${artifact.packageVersion}${artifact.modulePath}`)})`,
-						mdu.c(byteSize(artifact.size).toString()),
-						mdu.c(byteSize(artifact.gzipSize).toString()),
-						'',
-					],
+			${markdownTable([
+			['Artifact', 'Original size', 'Brotli size'],
+			[
+				`${mdu.link(
+					`${artifact.packageName} v${artifact.packageVersion}`,
+					`https://www.npmjs.com/package/${artifact.packageName}/v/${artifact.packageVersion}`,
+				)} (${mdu.link('Source', `https://unpkg.com/${artifact.packageName}@${artifact.packageVersion}${artifact.modulePath}`)})`,
+				mdu.c(byteSize(artifact.size).toString()),
+				mdu.c(byteSize(artifact.brotliSize).toString()),
+				'',
+			],
 
-					...getBenchmarkTable(artifact, benchmarkResults),
-				], {
-					align: ['l', 'r', 'r', 'r'],
-				})
+			...getBenchmarkTable(artifact, benchmarkResults),
+		], {
+			align: ['l', 'r', 'r', 'r'],
+		})
 			}
 		`,
 	).join('\n----\n');