[7.x] Use brotli compression for some KP assets (#64367) (#65116)

package.json

@@ -144,6 +144,7 @@
     "@types/tar": "^4.0.3",
     "JSONStream": "1.3.5",
     "abortcontroller-polyfill": "^1.4.0",
+    "accept": "3.0.2",
     "angular": "^1.7.9",
     "angular-aria": "^1.7.9",
     "angular-elastic": "^2.5.1",
@@ -306,6 +307,7 @@
     "@percy/agent": "^0.26.0",
     "@testing-library/react": "^9.3.2",
     "@testing-library/react-hooks": "^3.2.1",
+    "@types/accept": "3.1.1",
     "@types/angular": "^1.6.56",
     "@types/angular-mocks": "^1.7.0",
     "@types/babel__core": "^7.1.2",

packages/kbn-optimizer/package.json

@@ -14,6 +14,7 @@
     "@kbn/babel-preset": "1.0.0",
     "@kbn/dev-utils": "1.0.0",
     "@kbn/ui-shared-deps": "1.0.0",
+    "@types/compression-webpack-plugin": "^2.0.1",
     "@types/estree": "^0.0.44",
     "@types/loader-utils": "^1.1.3",
     "@types/watchpack": "^1.1.5",
@@ -23,6 +24,7 @@
     "autoprefixer": "^9.7.4",
     "babel-loader": "^8.0.6",
     "clean-webpack-plugin": "^3.0.0",
+    "compression-webpack-plugin": "^3.1.0",
     "cpy": "^8.0.0",
     "css-loader": "^3.4.2",
     "del": "^5.1.0",

packages/kbn-optimizer/src/integration_tests/basic_optimization.test.ts

@@ -19,6 +19,7 @@
 
 import Path from 'path';
 import Fs from 'fs';
+import Zlib from 'zlib';
 import { inspect } from 'util';
 
 import cpy from 'cpy';
@@ -124,17 +125,12 @@ it('builds expected bundles, saves bundle counts to metadata', async () => {
   );
   assert('produce zero unexpected states', otherStates.length === 0, otherStates);
 
-  expect(
-    Fs.readFileSync(Path.resolve(MOCK_REPO_DIR, 'plugins/foo/target/public/foo.plugin.js'), 'utf8')
-  ).toMatchSnapshot('foo bundle');
-
-  expect(
-    Fs.readFileSync(Path.resolve(MOCK_REPO_DIR, 'plugins/foo/target/public/1.plugin.js'), 'utf8')
-  ).toMatchSnapshot('1 async bundle');
-
-  expect(
-    Fs.readFileSync(Path.resolve(MOCK_REPO_DIR, 'plugins/bar/target/public/bar.plugin.js'), 'utf8')
-  ).toMatchSnapshot('bar bundle');
+  expectFileMatchesSnapshotWithCompression('plugins/foo/target/public/foo.plugin.js', 'foo bundle');
+  expectFileMatchesSnapshotWithCompression(
+    'plugins/foo/target/public/1.plugin.js',
+    '1 async bundle'
+  );
+  expectFileMatchesSnapshotWithCompression('plugins/bar/target/public/bar.plugin.js', 'bar bundle');
 
   const foo = config.bundles.find(b => b.id === 'foo')!;
   expect(foo).toBeTruthy();
@@ -203,3 +199,24 @@ it('uses cache on second run and exist cleanly', async () => {
     ]
   `);
 });
+
+/**
+ * Verifies that the file matches the expected output and has matching compressed variants.
+ */
+const expectFileMatchesSnapshotWithCompression = (filePath: string, snapshotLabel: string) => {
+  const raw = Fs.readFileSync(Path.resolve(MOCK_REPO_DIR, filePath), 'utf8');
+  expect(raw).toMatchSnapshot(snapshotLabel);
+
+  // Verify the brotli variant matches
+  expect(
+    // @ts-ignore @types/node is missing the brotli functions
+    Zlib.brotliDecompressSync(
+      Fs.readFileSync(Path.resolve(MOCK_REPO_DIR, `${filePath}.br`))
+    ).toString()
+  ).toEqual(raw);
+
+  // Verify the gzip variant matches
+  expect(
+    Zlib.gunzipSync(Fs.readFileSync(Path.resolve(MOCK_REPO_DIR, `${filePath}.gz`))).toString()
+  ).toEqual(raw);
+};

packages/kbn-optimizer/src/worker/webpack.config.ts

@@ -28,6 +28,7 @@ import TerserPlugin from 'terser-webpack-plugin';
 import webpackMerge from 'webpack-merge';
 // @ts-ignore
 import { CleanWebpackPlugin } from 'clean-webpack-plugin';
+import CompressionPlugin from 'compression-webpack-plugin';
 import * as UiSharedDeps from '@kbn/ui-shared-deps';
 
 import { Bundle, WorkerConfig, parseDirPath, DisallowedSyntaxPlugin } from '../common';
@@ -315,6 +316,16 @@ export function getWebpackConfig(bundle: Bundle, worker: WorkerConfig) {
           IS_KIBANA_DISTRIBUTABLE: `"true"`,
         },
       }),
+      new CompressionPlugin({
+        algorithm: 'brotliCompress',
+        filename: '[path].br',
+        test: /\.(js|css)$/,
+      }),
+      new CompressionPlugin({
+        algorithm: 'gzip',
+        filename: '[path].gz',
+        test: /\.(js|css)$/,
+      }),
     ],
 
     optimization: {

packages/kbn-ui-shared-deps/package.json

@@ -14,6 +14,7 @@
     "@kbn/i18n": "1.0.0",
     "abortcontroller-polyfill": "^1.4.0",
     "angular": "^1.7.9",
+    "compression-webpack-plugin": "^3.1.0",
     "core-js": "^3.2.1",
     "custom-event-polyfill": "^0.3.0",
     "elasticsearch-browser": "^16.7.0",

packages/kbn-ui-shared-deps/webpack.config.js

@@ -20,6 +20,7 @@
 const Path = require('path');
 
 const MiniCssExtractPlugin = require('mini-css-extract-plugin');
+const CompressionPlugin = require('compression-webpack-plugin');
 const { REPO_ROOT } = require('@kbn/dev-utils');
 const webpack = require('webpack');
 
@@ -117,5 +118,15 @@ exports.getWebpackConfig = ({ dev = false } = {}) => ({
     new webpack.DefinePlugin({
       'process.env.NODE_ENV': dev ? '"development"' : '"production"',
     }),
+    new CompressionPlugin({
+      algorithm: 'brotliCompress',
+      filename: '[path].br',
+      test: /\.(js|css)$/,
+    }),
+    new CompressionPlugin({
+      algorithm: 'gzip',
+      filename: '[path].gz',
+      test: /\.(js|css)$/,
+    }),
   ],
 });

src/optimize/bundles_route/dynamic_asset_response.ts

@@ -21,6 +21,7 @@ import Fs from 'fs';
 import { resolve } from 'path';
 import { promisify } from 'util';
 
+import Accept from 'accept';
 import Boom from 'boom';
 import Hapi from 'hapi';
 
@@ -37,6 +38,41 @@ const asyncOpen = promisify(Fs.open);
 const asyncClose = promisify(Fs.close);
 const asyncFstat = promisify(Fs.fstat);
 
+async function tryToOpenFile(filePath: string) {
+  try {
+    return await asyncOpen(filePath, 'r');
+  } catch (e) {
+    if (e.code === 'ENOENT') {
+      return undefined;
+    } else {
+      throw e;
+    }
+  }
+}
+
+async function selectCompressedFile(acceptEncodingHeader: string | undefined, path: string) {
+  let fd: number | undefined;
+  let fileEncoding: 'gzip' | 'br' | undefined;
+
+  const supportedEncodings = Accept.encodings(acceptEncodingHeader, ['br', 'gzip']);
+
+  if (supportedEncodings[0] === 'br') {
+    fileEncoding = 'br';
+    fd = await tryToOpenFile(`${path}.br`);
+  }
+  if (!fd && supportedEncodings.includes('gzip')) {
+    fileEncoding = 'gzip';
+    fd = await tryToOpenFile(`${path}.gz`);
+  }
+  if (!fd) {
+    fileEncoding = undefined;
+    // Use raw open to trigger exception if it does not exist
+    fd = await asyncOpen(path, 'r');
+  }
+
+  return { fd, fileEncoding };
+}
+
 /**
  *  Create a Hapi response for the requested path. This is designed
  *  to replicate a subset of the features provided by Hapi's Inert
@@ -74,6 +110,7 @@ export async function createDynamicAssetResponse({
   isDist: boolean;
 }) {
   let fd: number | undefined;
+  let fileEncoding: 'gzip' | 'br' | undefined;
 
   try {
     const path = resolve(bundlesPath, request.params.path);
@@ -86,7 +123,7 @@ export async function createDynamicAssetResponse({
     // we use and manage a file descriptor mostly because
     // that's what Inert does, and since we are accessing
     // the file 2 or 3 times per request it seems logical
-    fd = await asyncOpen(path, 'r');
+    ({ fd, fileEncoding } = await selectCompressedFile(request.headers['accept-encoding'], path));
 
     const stat = await asyncFstat(fd);
     const hash = isDist ? undefined : await getFileHash(fileHashCache, path, stat, fd);
@@ -113,6 +150,12 @@ export async function createDynamicAssetResponse({
       response.header('cache-control', 'must-revalidate');
     }
 
+    // If we manually selected a compressed file, specify the encoding header.
+    // Otherwise, let Hapi automatically gzip the response.
+    if (fileEncoding) {
+      response.header('content-encoding', fileEncoding);
+    }
+
     return response;
   } catch (error) {
     if (fd) {

test/functional/apps/bundles/index.js

@@ -0,0 +1,73 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * These supertest-based tests live in the functional test suite because they depend on the optimizer bundles being built
+ * and served
+ */
+export default function({ getService }) {
+  const supertest = getService('supertest');
+
+  describe('bundle compression', function() {
+    this.tags('ciGroup12');
+
+    let buildNum;
+    before(async () => {
+      const resp = await supertest.get('/api/status').expect(200);
+      buildNum = resp.body.version.build_number;
+    });
+
+    it('returns gzip files when client only supports gzip', () =>
+      supertest
+        // We use the kbn-ui-shared-deps for these tests since they are always built with br compressed outputs,
+        // even in dev. Bundles built by @kbn/optimizer are only built with br compression in dist mode.
+        .get(`/${buildNum}/bundles/kbn-ui-shared-deps/kbn-ui-shared-deps.js`)
+        .set('Accept-Encoding', 'gzip')
+        .expect(200)
+        .expect('Content-Encoding', 'gzip'));
+
+    it('returns br files when client only supports br', () =>
+      supertest
+        .get(`/${buildNum}/bundles/kbn-ui-shared-deps/kbn-ui-shared-deps.js`)
+        .set('Accept-Encoding', 'br')
+        .expect(200)
+        .expect('Content-Encoding', 'br'));
+
+    it('returns br files when client only supports gzip and br', () =>
+      supertest
+        .get(`/${buildNum}/bundles/kbn-ui-shared-deps/kbn-ui-shared-deps.js`)
+        .set('Accept-Encoding', 'gzip, br')
+        .expect(200)
+        .expect('Content-Encoding', 'br'));
+
+    it('returns gzip files when client prefers gzip', () =>
+      supertest
+        .get(`/${buildNum}/bundles/kbn-ui-shared-deps/kbn-ui-shared-deps.js`)
+        .set('Accept-Encoding', 'gzip;q=1.0, br;q=0.5')
+        .expect(200)
+        .expect('Content-Encoding', 'gzip'));
+
+    it('returns gzip files when no brotli version exists', () =>
+      supertest
+        .get(`/${buildNum}/bundles/commons.style.css`) // legacy optimizer does not create brotli outputs
+        .set('Accept-Encoding', 'gzip, br')
+        .expect(200)
+        .expect('Content-Encoding', 'gzip'));
+  });
+}

test/functional/config.js

@@ -25,11 +25,12 @@ export default async function({ readConfigFile }) {
 
   return {
     testFiles: [
+      require.resolve('./apps/bundles'),
       require.resolve('./apps/console'),
-      require.resolve('./apps/getting_started'),
       require.resolve('./apps/context'),
       require.resolve('./apps/dashboard'),
       require.resolve('./apps/discover'),
+      require.resolve('./apps/getting_started'),
       require.resolve('./apps/home'),
       require.resolve('./apps/management'),
       require.resolve('./apps/saved_objects_management'),

test/functional/services/index.ts

@@ -51,6 +51,7 @@ import { ToastsProvider } from './toasts';
 import { PieChartProvider } from './visualizations';
 import { ListingTableProvider } from './listing_table';
 import { SavedQueryManagementComponentProvider } from './saved_query_management_component';
+import { KibanaSupertestProvider } from './supertest';
 
 export const services = {
   ...commonServiceProviders,
@@ -83,4 +84,5 @@ export const services = {
   toasts: ToastsProvider,
   savedQueryManagementComponent: SavedQueryManagementComponentProvider,
   elasticChart: ElasticChartProvider,
+  supertest: KibanaSupertestProvider,
 };

test/functional/services/supertest.ts

@@ -0,0 +1,29 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { FtrProviderContext } from 'test/functional/ftr_provider_context';
+import { format as formatUrl } from 'url';
+
+import supertestAsPromised from 'supertest-as-promised';
+
+export function KibanaSupertestProvider({ getService }: FtrProviderContext) {
+  const config = getService('config');
+  const kibanaServerUrl = formatUrl(config.get('servers.kibana'));
+  return supertestAsPromised(kibanaServerUrl);
+}

typings/accept.d.ts

@@ -0,0 +1,23 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+declare module 'accept' {
+  // @types/accept does not include the `preferences` argument so we override the type to include it
+  export function encodings(encodingHeader?: string, preferences?: string[]): string[];
+}

yarn.lock

@@ -3575,6 +3575,11 @@
   dependencies:
     "@turf/helpers" "6.x"
 
+"@types/accept@3.1.1":
+  version "3.1.1"
+  resolved "https://registry.yarnpkg.com/@types/accept/-/accept-3.1.1.tgz#74457f6afabd23181e32b6bafae238bda0ce0da7"
+  integrity sha512-pXwi0bKUriKuNUv7d1xwbxKTqyTIzmMr1StxcGARmiuTLQyjNo+YwDq0w8dzY8wQjPofdgs1hvQLTuJaGuSKiQ==
+
 "@types/angular-mocks@^1.7.0":
   version "1.7.0"
   resolved "https://registry.yarnpkg.com/@types/angular-mocks/-/angular-mocks-1.7.0.tgz#310d999a3c47c10ecd8eef466b5861df84799429"
@@ -3803,6 +3808,13 @@
   dependencies:
     "@types/color-convert" "*"
 
+"@types/compression-webpack-plugin@^2.0.1":
+  version "2.0.1"
+  resolved "https://registry.yarnpkg.com/@types/compression-webpack-plugin/-/compression-webpack-plugin-2.0.1.tgz#4db78c398c8e973077cc530014d6513f1c693951"
+  integrity sha512-40oKg2aByfUPShpYBkldYwOcO34yaqOIPdlUlR1+F3MFl2WfpqYq2LFKOcgjU70d1r1L8r99XHkxYdhkGajHSw==
+  dependencies:
+    "@types/webpack" "*"
+
 "@types/cookiejar@*":
   version "2.1.0"
   resolved "https://registry.yarnpkg.com/@types/cookiejar/-/cookiejar-2.1.0.tgz#4b7daf2c51696cfc70b942c11690528229d1a1ce"
@@ -5410,7 +5422,7 @@ abortcontroller-polyfill@^1.4.0:
   resolved "https://registry.yarnpkg.com/abortcontroller-polyfill/-/abortcontroller-polyfill-1.4.0.tgz#0d5eb58e522a461774af8086414f68e1dda7a6c4"
   integrity sha512-3ZFfCRfDzx3GFjO6RAkYx81lPGpUS20ISxux9gLxuKnqafNcFQo59+IoZqpO2WvQlyc287B62HDnDdNYRmlvWA==
 
-accept@3.x.x:
+accept@3.0.2, accept@3.x.x:
   version "3.0.2"
   resolved "https://registry.yarnpkg.com/accept/-/accept-3.0.2.tgz#83e41cec7e1149f3fd474880423873db6c6cc9ac"
   integrity sha512-bghLXFkCOsC1Y2TZ51etWfKDs6q249SAoHTZVfzWWdlZxoij+mgkj9AmUJWQpDY48TfnrTDIe43Xem4zdMe7mQ==
@@ -9435,6 +9447,18 @@ compressible@~2.0.16:
   dependencies:
     mime-db ">= 1.40.0 < 2"
 
+compression-webpack-plugin@^3.1.0:
+  version "3.1.0"
+  resolved "https://registry.yarnpkg.com/compression-webpack-plugin/-/compression-webpack-plugin-3.1.0.tgz#9f510172a7b5fae5aad3b670652e8bd7997aeeca"
+  integrity sha512-iqTHj3rADN4yHwXMBrQa/xrncex/uEQy8QHlaTKxGchT/hC0SdlJlmL/5eRqffmWq2ep0/Romw6Ld39JjTR/ug==
+  dependencies:
+    cacache "^13.0.1"
+    find-cache-dir "^3.0.0"
+    neo-async "^2.5.0"
+    schema-utils "^2.6.1"
+    serialize-javascript "^2.1.2"
+    webpack-sources "^1.0.1"
+
 compression@^1.7.4:
   version "1.7.4"
   resolved "https://registry.yarnpkg.com/compression/-/compression-1.7.4.tgz#95523eff170ca57c29a0ca41e6fe131f41e5bb8f"
@@ -31500,18 +31524,18 @@ webpack-merge@4.2.2, webpack-merge@^4.2.2:
   dependencies:
     lodash "^4.17.15"
 
-webpack-sources@^1.1.0:
-  version "1.3.0"
-  resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-1.3.0.tgz#2a28dcb9f1f45fe960d8f1493252b5ee6530fa85"
-  integrity sha512-OiVgSrbGu7NEnEvQJJgdSFPl2qWKkWq5lHMhgiToIiN9w34EBnjYzSYs+VbL5KoYiLNtFFa7BZIKxRED3I32pA==
+webpack-sources@^1.0.1, webpack-sources@^1.4.0, webpack-sources@^1.4.1, webpack-sources@^1.4.3:
+  version "1.4.3"
+  resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-1.4.3.tgz#eedd8ec0b928fbf1cbfe994e22d2d890f330a933"
+  integrity sha512-lgTS3Xhv1lCOKo7SA5TjKXMjpSM4sBjNV5+q2bqesbSPs5FjGmU6jjtBSkX9b4qW87vDIsCIlUPOEhbZrMdjeQ==
   dependencies:
     source-list-map "^2.0.0"
     source-map "~0.6.1"
 
-webpack-sources@^1.4.0, webpack-sources@^1.4.1, webpack-sources@^1.4.3:
-  version "1.4.3"
-  resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-1.4.3.tgz#eedd8ec0b928fbf1cbfe994e22d2d890f330a933"
-  integrity sha512-lgTS3Xhv1lCOKo7SA5TjKXMjpSM4sBjNV5+q2bqesbSPs5FjGmU6jjtBSkX9b4qW87vDIsCIlUPOEhbZrMdjeQ==
+webpack-sources@^1.1.0:
+  version "1.3.0"
+  resolved "https://registry.yarnpkg.com/webpack-sources/-/webpack-sources-1.3.0.tgz#2a28dcb9f1f45fe960d8f1493252b5ee6530fa85"
+  integrity sha512-OiVgSrbGu7NEnEvQJJgdSFPl2qWKkWq5lHMhgiToIiN9w34EBnjYzSYs+VbL5KoYiLNtFFa7BZIKxRED3I32pA==
   dependencies:
     source-list-map "^2.0.0"
     source-map "~0.6.1"