Move webpack manifest out from index chunk

Enables index chunk hash to become independent of children
chunk hashes. The manifest is inlined with every server
rendered route in production mode.

Author: dhruvparmar372

config/values.js

@@ -134,6 +134,10 @@ const values = {
   // containing details of all output files for a bundle?
   bundleAssetsFileName: 'assets.json',
 
+  // What should we name the manifest generated by chunk-manifest-webpack-plugin
+  // containing mappings for chunk ids and names?
+  bundleManifestFileName: 'manifest.json',
+
   // node_modules are not included in any bundles that target "node" as a
   // runtime (e.g.. the server bundle) as including them often breaks builds
   // due to thinks like require statements containing expressions..

internal/webpack/configFactory.js

@@ -5,6 +5,7 @@ import nodeExternals from 'webpack-node-externals';
 import path from 'path';
 import webpack from 'webpack';
 import WebpackMd5Hash from 'webpack-md5-hash';
+import ChunkManifestWebpackPlugin from 'chunk-manifest-webpack-plugin';
 
 import { happyPackPlugin } from '../utils';
 import { ifElse } from '../../shared/utils/logic';
@@ -219,6 +220,17 @@ export default function webpackConfigFactory(buildOptions) {
       // even though 1 or 2 may have only changed.
       ifClient(() => new WebpackMd5Hash()),
 
+      // Since chunk-manifest-webpack-plugin doesn't work with webpack-dev-server
+      // https://github.com/soundcloud/chunk-manifest-webpack-plugin/issues/26
+      // we generate manifest only in production mode.
+      // Also this optimisation is to prevent better long term caching of
+      // index chunk which can be compromised in development mode.
+      ifProdClient(() => new ChunkManifestWebpackPlugin({
+        filename: config('bundleManifestFileName'),
+        manifestVariable: 'webpackManifest',
+        inlineManifest: false,
+      })),
+
       // These are process.env flags that you can use in your code in order to
       // have advanced control over what is included/excluded in your bundles.
       // For example you may only want certain parts of your code to be

package.json

@@ -96,6 +96,7 @@
     "babel-preset-stage-3": "6.24.1",
     "babel-template": "6.25.0",
     "chokidar": "1.7.0",
+    "chunk-manifest-webpack-plugin": "^1.1.0",
     "css-loader": "0.28.4",
     "enzyme": "2.9.1",
     "enzyme-to-json": "1.5.1",

server/middleware/reactApplication/ServerHTML.js

@@ -13,7 +13,10 @@ import serialize from 'serialize-javascript';
 import config from '../../../config';
 import ifElse from '../../../shared/utils/logic/ifElse';
 import removeNil from '../../../shared/utils/arrays/removeNil';
-import getClientBundleEntryAssets from './getClientBundleEntryAssets';
+import {
+  getClientBundleEntryAssets,
+  getClientWebpackManifest,
+} from './getClientBundleEntryAssets';
 
 import ClientConfig from '../../../config/components/ClientConfig';
 import HTML from '../../../shared/components/HTML';
@@ -27,6 +30,11 @@ function KeyedComponent({ children }) {
 // Resolve the assets (js/css) for the client bundle's entry chunk.
 const clientEntryAssets = getClientBundleEntryAssets();
 
+// Resolve the webpack manifest. Useful only in production mode.
+const clientWebpackManifest = process.env.BUILD_FLAG_IS_DEV === 'false' ?
+  getClientWebpackManifest() : {};
+
+
 function stylesheetTag(stylesheetFilePath) {
   return (
     <link href={stylesheetFilePath} media="screen, projection" rel="stylesheet" type="text/css" />
@@ -47,13 +55,18 @@ function ServerHTML(props) {
     <script nonce={nonce} type="text/javascript" dangerouslySetInnerHTML={{ __html: body }} />
   );
 
+  const webpackManifestScript = `
+    window.webpackManifest = ${JSON.stringify(clientWebpackManifest)};
+  `;
+
   const headerElements = removeNil([
     ...ifElse(helmet)(() => helmet.title.toComponent(), []),
     ...ifElse(helmet)(() => helmet.base.toComponent(), []),
     ...ifElse(helmet)(() => helmet.meta.toComponent(), []),
     ...ifElse(helmet)(() => helmet.link.toComponent(), []),
     ifElse(clientEntryAssets && clientEntryAssets.css)(() => stylesheetTag(clientEntryAssets.css)),
     ...ifElse(helmet)(() => helmet.style.toComponent(), []),
+    ifElse(process.env.BUILD_FLAG_IS_DEV === 'false')(() => inlineScript(webpackManifestScript)),
   ]);
 
   const bodyElements = removeNil([

server/middleware/reactApplication/getClientBundleEntryAssets.js

@@ -7,7 +7,21 @@ import { resolve as pathResolve } from 'path';
 import appRootDir from 'app-root-dir';
 import config from '../../../config';
 
-let resultCache;
+function getJSONFromFile(fileName) {
+  const filePath = pathResolve(
+    appRootDir.get(),
+    config('bundles.client.outputPath'),
+    `./${fileName}`,
+  );
+
+  if (!fs.existsSync(filePath)) {
+    throw new Error(
+      `We could not find the "${filePath}" file. Please ensure that the client bundle has been built.`,
+    );
+  }
+
+  return JSON.parse(fs.readFileSync(filePath, 'utf8'));
+}
 
 /**
  * Retrieves the js/css for the named chunks that belong to our client bundle.
@@ -22,31 +36,33 @@ let resultCache;
  *     to the render logic.  Having this method allows us to easily fetch
  *     the respective assets simply by using a chunk name. :)
  */
-export default function getClientBundleEntryAssets() {
+export function getClientBundleEntryAssets() {
+  let resultCache;
+
   // Return the assets json cache if it exists.
   // In development mode we always read the assets json file from disk to avoid
   // any cases where an older version gets cached.
   if (process.env.BUILD_FLAG_IS_DEV === 'false' && resultCache) {
     return resultCache;
   }
 
-  const assetsFilePath = pathResolve(
-    appRootDir.get(),
-    config('bundles.client.outputPath'),
-    `./${config('bundleAssetsFileName')}`,
-  );
+  const clientBundleAssetsJSON = getJSONFromFile(config('bundleAssetsFileName'));
 
-  if (!fs.existsSync(assetsFilePath)) {
-    throw new Error(
-      `We could not find the "${assetsFilePath}" file, which contains a list of the assets of the client bundle.  Please ensure that the client bundle has been built.`,
-    );
+  if (typeof clientBundleAssetsJSON.index === 'undefined') {
+    throw new Error('No asset data found for expected "index" entry chunk of client bundle.');
   }
 
-  const readAssetsJSONFile = () => JSON.parse(fs.readFileSync(assetsFilePath, 'utf8'));
-  const assetsJSONCache = readAssetsJSONFile();
-  if (typeof assetsJSONCache.index === 'undefined') {
-    throw new Error('No asset data found for expected "index" entry chunk of client bundle.');
+  resultCache = clientBundleAssetsJSON.index;
+  return resultCache;
+}
+
+export function getClientWebpackManifest() {
+  let resultCache;
+
+  if (resultCache) {
+    return resultCache;
   }
-  resultCache = assetsJSONCache.index;
+
+  resultCache = getJSONFromFile(config('bundleManifestFileName'));
   return resultCache;
 }

yarn.lock

@@ -1252,6 +1252,12 @@ chokidar@1.7.0, chokidar@^1.4.3, chokidar@^1.6.1:
   optionalDependencies:
     fsevents "^1.0.0"
 
+chunk-manifest-webpack-plugin@^1.1.0:
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/chunk-manifest-webpack-plugin/-/chunk-manifest-webpack-plugin-1.1.0.tgz#21e73e5d31ed09e15f610e41385a276224d39af2"
+  dependencies:
+    webpack-core "^0.6.9"
+
 ci-info@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/ci-info/-/ci-info-1.0.0.tgz#dc5285f2b4e251821683681c381c3388f46ec534"
@@ -5722,7 +5728,7 @@ sort-keys@^1.0.0:
   dependencies:
     is-plain-obj "^1.0.0"
 
-source-list-map@^0.1.7:
+source-list-map@^0.1.7, source-list-map@~0.1.7:
   version "0.1.8"
   resolved "https://registry.yarnpkg.com/source-list-map/-/source-list-map-0.1.8.tgz#c550b2ab5427f6b3f21f5afead88c4f5587b2106"
 
@@ -5744,7 +5750,7 @@ source-map@0.5.6, source-map@0.5.x, source-map@^0.5.0, source-map@^0.5.3, source
   version "0.5.6"
   resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.5.6.tgz#75ce38f52bf0733c5a7f0c118d81334a2bb5f412"
 
-source-map@^0.4.4:
+source-map@^0.4.4, source-map@~0.4.1:
   version "0.4.4"
   resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.4.4.tgz#eba4f5da9c0dc999de68032d8b4f76173652036b"
   dependencies:
@@ -6261,6 +6267,13 @@ webpack-bundle-analyzer@2.8.2:
     opener "^1.4.3"
     ws "^2.3.1"
 
+webpack-core@^0.6.9:
+  version "0.6.9"
+  resolved "https://registry.yarnpkg.com/webpack-core/-/webpack-core-0.6.9.tgz#fc571588c8558da77be9efb6debdc5a3b172bdc2"
+  dependencies:
+    source-list-map "~0.1.7"
+    source-map "~0.4.1"
+
 webpack-dev-middleware@1.11.0:
   version "1.11.0"
   resolved "https://registry.yarnpkg.com/webpack-dev-middleware/-/webpack-dev-middleware-1.11.0.tgz#09691d0973a30ad1f82ac73a12e2087f0a4754f9"