feat: ssr support externalWhitelist config (umijs#2733)

ycjcl868 · sorrycc · commit 14783acf18bb · 2019-07-01T10:48:21.000+08:00
diff --git a/docs/config/README.md b/docs/config/README.md
@@ -264,7 +264,10 @@ When enabled, `umi.server.js` file is also generated when the client static file
 
 ```js
 export default {
-  ssr: true,
+  ssr: {
+    // https://github.com/liady/webpack-node-externals#optionswhitelist-
+    externalWhitelist: [],
+  },
   // 需要开启
   manifest: {},
 };
diff --git a/docs/zh/config/README.md b/docs/zh/config/README.md
@@ -266,7 +266,10 @@ export default {
 
 ```js
 export default {
-  ssr: true,
+  ssr: {
+    // https://github.com/liady/webpack-node-externals#optionswhitelist-
+    externalWhitelist: [],
+  },
   // need enable
   manifest: {},
 };
diff --git a/packages/umi-build-dev/src/Service.test.js b/packages/umi-build-dev/src/Service.test.js
@@ -449,4 +449,31 @@ describe('Service', () => {
       chunkFilename: '[name].server.async.js',
     });
   });
+
+  it('runCommand ssr externalWhitelist', () => {
+    const service = new Service({
+      cwd: join(fixtures, 'plugin-ssr', 'externalWhitelist'),
+    });
+    const callback = jest.fn(() => {});
+    service.registerCommand(
+      'build',
+      {
+        webpack: {},
+      },
+      callback,
+    );
+    service.runCommand('build');
+
+    expect(service.config.ssr.externalWhitelist).toEqual(
+      expect.arrayContaining([/^@alipay\/bigfish(\/.*)?$/, 'antd-mobile']),
+    );
+    expect(service.webpackConfig).toBeTruthy();
+    expect(
+      pick(service.ssrWebpackConfig.output, ['libraryTarget', 'filename', 'chunkFilename']),
+    ).toEqual({
+      libraryTarget: 'commonjs2',
+      filename: '[name].server.js',
+      chunkFilename: '[name].server.async.js',
+    });
+  });
 });
diff --git a/packages/umi-build-dev/src/fixtures/Service/plugin-ssr/externalWhitelist/.umirc.js b/packages/umi-build-dev/src/fixtures/Service/plugin-ssr/externalWhitelist/.umirc.js
@@ -0,0 +1,6 @@
+export default {
+  ssr: {
+    externalWhitelist: [ /^@alipay\/bigfish(\/.*)?$/, 'antd-mobile' ]
+  },
+  manifest: {},
+}
diff --git a/packages/umi-build-dev/src/getWebpackConfig.js b/packages/umi-build-dev/src/getWebpackConfig.js
@@ -3,6 +3,8 @@ import assert from 'assert';
 import chalk from 'chalk';
 import nodeExternals from 'webpack-node-externals';
 
+const debug = require('debug')('umi-build-dev:getWebpackConfig');
+
 export default function(service, opts = {}) {
   const { ssr } = opts;
   const { config } = service;
@@ -45,8 +47,14 @@ export default function(service, opts = {}) {
         `WARNING: UmiJS SSR is still in beta, you can open issues or PRs in https://github.com/umijs/umi`,
       ),
     );
+    const externalWhitelist = [
+      /\.(css|less|sass|scss)$/,
+      /^umi(\/.*)?$/,
+      ...(ssr.externalWhitelist || []),
+    ];
+    debug(`externalWhitelist:`, externalWhitelist);
     webpackConfig.externals = nodeExternals({
-      whitelist: [/\.(css|less|sass|scss)$/, /^umi(\/.*)?$/],
+      externalWhitelist,
     });
     webpackConfig.output.libraryTarget = 'commonjs2';
     webpackConfig.output.filename = '[name].server.js';
diff --git a/packages/umi-types/config.d.ts b/packages/umi-types/config.d.ts
@@ -65,6 +65,11 @@ export interface IAFWebpackConfig {
   urlLoaderExcludes?: Condition[];
 }
 
+type WhitelistOption = string | RegExp;
+export interface IExportSSROpts {
+  externalWhitelist?: WhitelistOption[];
+}
+
 interface IConfig extends IAFWebpackConfig {
   // basic config
   // sorted by alphabet
@@ -87,7 +92,7 @@ interface IConfig extends IAFWebpackConfig {
   targets?: {
     [key: string]: number;
   };
-  ssr?: boolean | object;
+  ssr?: boolean | IExportSSROpts;
 }
 
 export default IConfig;
