feat(webpack): enable babel cache to make rebuild faster

web-infra-dev · Sep 27, 2022 · 0a524d1 · 0a524d1
1 parent d3795e8
commit 0a524d1
Show file tree

Hide file tree

Showing 5 changed files with 105 additions and 32 deletions.
diff --git a/.changeset/sour-lamps-appear.md b/.changeset/sour-lamps-appear.md
@@ -0,0 +1,5 @@
+---
+'@modern-js/webpack': patch
+---
+
+feat(webpack): enable babel cache to make rebuild faster
diff --git a/packages/cli/webpack/src/config/features/babel.ts b/packages/cli/webpack/src/config/features/babel.ts
@@ -81,6 +81,7 @@ export function applyScriptCondition({
 }
 
 export function applyBabelLoader({
+  chain,
   config,
   loaders,
   appContext,
@@ -90,13 +91,14 @@ export function applyBabelLoader({
   useTsLoader: boolean;
   babelPresetAppOptions?: Partial<BabelPresetAppOptions>;
 }) {
-  const { options, includes, excludes } = getBabelOptions(
-    appContext.metaName,
-    appContext.appDirectory,
+  const { options, includes, excludes } = getBabelOptions({
+    name: chain.get('name'),
+    chain: createBabelChain(),
     config,
-    createBabelChain(),
+    metaName: appContext.metaName,
+    appDirectory: appContext.appDirectory,
     babelPresetAppOptions,
-  );
+  });
 
   const rule = loaders
     .oneOf(CHAIN_ID.ONE_OF.JS)

diff --git a/packages/cli/webpack/src/utils/getBabelOptions.ts b/packages/cli/webpack/src/utils/getBabelOptions.ts
@@ -1,10 +1,12 @@
+import path from 'path';
 import { isProd, applyOptionsChain, isUseSSRBundle } from '@modern-js/utils';
 import {
   getBabelConfig,
   BabelChain,
   Options as BabelPresetAppOptions,
 } from '@modern-js/babel-preset-app';
 import type { NormalizedConfig, TransformOptions } from '@modern-js/core';
+import { CACHE_DIRECTORY } from './constants';
 
 export const getUseBuiltIns = (config: NormalizedConfig) => {
   const { polyfill } = config.output || {};
@@ -14,13 +16,57 @@ export const getUseBuiltIns = (config: NormalizedConfig) => {
   return polyfill;
 };
 
-export const getBabelOptions = (
-  metaName: string,
-  appDirectory: string,
-  config: NormalizedConfig,
-  chain: BabelChain,
-  babelPresetAppOptions?: Partial<BabelPresetAppOptions>,
-) => {
+function getCacheIdentifier(babelConfig: TransformOptions) {
+  let cacheIdentifier = process.env.NODE_ENV;
+
+  const packages = [
+    {
+      name: 'babel-loader',
+      version: require('../../compiled/babel-loader/package.json').version,
+    },
+    {
+      name: '@modern-js/babel-preset-app',
+      version:
+        require('../../package.json').dependencies[
+          '@modern-js/babel-preset-app'
+        ],
+    },
+  ];
+
+  for (const { name, version } of packages) {
+    cacheIdentifier += `:${name}@${version}`;
+  }
+
+  const pluginItems = [
+    ...(babelConfig.presets || []),
+    ...(babelConfig.plugins || []),
+  ];
+  pluginItems.forEach(pluginItem => {
+    if (Array.isArray(pluginItem)) {
+      cacheIdentifier += `:${pluginItem[0]}`;
+    } else {
+      cacheIdentifier += `:${pluginItem}`;
+    }
+  });
+
+  return cacheIdentifier;
+}
+
+export const getBabelOptions = ({
+  name,
+  chain,
+  config,
+  metaName,
+  appDirectory,
+  babelPresetAppOptions,
+}: {
+  name: string;
+  chain: BabelChain;
+  config: NormalizedConfig;
+  metaName: string;
+  appDirectory: string;
+  babelPresetAppOptions?: Partial<BabelPresetAppOptions>;
+}) => {
   const lodashOptions = applyOptionsChain(
     { id: ['lodash', 'ramda'] },
     config.tools?.lodash as any,
@@ -56,26 +102,42 @@ export const getBabelOptions = (
     },
   };
 
-  const babelOptions: TransformOptions = {
+  const babelConfig = getBabelConfig({
+    metaName,
+    appDirectory,
+    lodash: lodashOptions,
+    useLegacyDecorators: !config.output?.enableLatestDecorators,
+    useBuiltIns: getUseBuiltIns(config),
+    chain,
+    styledComponents: styledComponentsOptions,
+    userBabelConfig: config.tools?.babel,
+    userBabelConfigUtils: babelUtils,
+    ...babelPresetAppOptions,
+  });
+
+  const babelLoaderOptions: TransformOptions & {
+    cacheIdentifier?: string;
+    cacheDirectory?: string;
+    cacheCompression?: boolean;
+  } = {
     babelrc: false,
     configFile: false,
     compact: isProd(),
-    ...getBabelConfig({
-      metaName,
+    // enable babel loader cache because:
+    // 1. babel-loader cache can speed up the rebuild time (tested on large projects).
+    // 2. webpack cache get invalid in many cases, such as config changed, while babel cache is still valid.
+    cacheIdentifier: getCacheIdentifier(babelConfig),
+    cacheDirectory: path.resolve(
       appDirectory,
-      lodash: lodashOptions,
-      useLegacyDecorators: !config.output?.enableLatestDecorators,
-      useBuiltIns: getUseBuiltIns(config),
-      chain,
-      styledComponents: styledComponentsOptions,
-      userBabelConfig: config.tools?.babel,
-      userBabelConfigUtils: babelUtils,
-      ...babelPresetAppOptions,
-    }),
+      CACHE_DIRECTORY,
+      `babel/${name}`,
+    ),
+    cacheCompression: false,
+    ...babelConfig,
   };
 
   return {
-    options: babelOptions,
+    options: babelLoaderOptions,
     includes,
     excludes,
   };

diff --git a/packages/cli/webpack/tests/__snapshots__/utils.test.ts.snap b/packages/cli/webpack/tests/__snapshots__/utils.test.ts.snap
@@ -3,6 +3,9 @@
 exports[`getBabelOptions should return babel options as expected 1`] = `
 Object {
   "babelrc": false,
+  "cacheCompression": false,
+  "cacheDirectory": /.cache/babel/client,
+  "cacheIdentifier": /cli/babel-preset-base/compiled/babel-plugin-styled-components/index.js,
   "compact": false,
   "configFile": false,
   "plugins": Array [

diff --git a/packages/cli/webpack/tests/utils.test.ts b/packages/cli/webpack/tests/utils.test.ts
@@ -35,15 +35,16 @@ describe('mergeRegex', () => {
 
 describe('getBabelOptions', () => {
   it('should return babel options as expected', () => {
-    const { options: babelOptions } = getBabelOptions(
-      'metaName',
-      '/root',
-      {} as any,
-      createBabelChain(),
-      {
+    const { options: babelOptions } = getBabelOptions({
+      name: 'client',
+      metaName: 'metaName',
+      appDirectory: '/root',
+      config: {} as any,
+      chain: createBabelChain(),
+      babelPresetAppOptions: {
         target: 'client',
       },
-    );
+    });
 
     setPathSerializer();
     expect(babelOptions).toMatchSnapshot();