fix: respect the output.publicPath option for the servecommand (#…

…2271)
webpack · Dec 30, 2020 · a3092ef · a3092ef
1 parent 0595603
commit a3092ef
Show file tree

Hide file tree

Showing 12 changed files with 302 additions and 32 deletions.
diff --git a/packages/serve/__tests__/__snapshots__/startDevServer.test.ts.snap b/packages/serve/__tests__/__snapshots__/startDevServer.test.ts.snap
@@ -4,6 +4,7 @@ exports[`startDevServer should set default port and host if not provided 1`] = `
 Object {
   "host": "localhost",
   "port": 8080,
+  "publicPath": "/",
 }
 `;
 
@@ -22,6 +23,7 @@ Object {
   "hot": true,
   "port": 9000,
   "progress": true,
+  "publicPath": "/",
 }
 `;
 
@@ -40,6 +42,7 @@ Object {
   "hot": true,
   "port": 9000,
   "progress": true,
+  "publicPath": "/",
 }
 `;
 
@@ -56,6 +59,7 @@ Object {
   "host": "localhost",
   "port": 9000,
   "progress": true,
+  "publicPath": "/",
 }
 `;
 
@@ -64,6 +68,7 @@ Object {
   "host": "localhost",
   "port": 9001,
   "progress": true,
+  "publicPath": "/",
 }
 `;
 

diff --git a/packages/serve/src/startDevServer.ts b/packages/serve/src/startDevServer.ts
@@ -11,10 +11,7 @@ import { devServerOptionsType } from './types';
  * @returns {Object[]} array of resulting servers
  */
 export default async function startDevServer(compiler, cliOptions, logger): Promise<object[]> {
-    let isDevServer4 = false,
-        devServerVersion,
-        Server,
-        findPort;
+    let devServerVersion, Server, findPort;
 
     try {
         // eslint-disable-next-line node/no-extraneous-require
@@ -28,24 +25,6 @@ export default async function startDevServer(compiler, cliOptions, logger): Prom
         process.exit(2);
     }
 
-    isDevServer4 = devServerVersion.startsWith('4');
-
-    const defaultOpts = {};
-    const devServerOptions = [];
-    const compilers = compiler.compilers || [compiler];
-
-    compilers.forEach((compiler) => {
-        if (compiler.options.devServer) {
-            devServerOptions.push(compiler.options.devServer);
-        }
-    });
-
-    if (devServerOptions.length === 0) {
-        devServerOptions.push(defaultOpts);
-    }
-
-    const servers = [];
-    const usedPorts: number[] = [];
     const mergeOptions = (cliOptions: devServerOptionsType, devServerOptions: devServerOptionsType): devServerOptionsType => {
         // CLI options should take precedence over devServer options,
         // and CLI options should have no default values included
@@ -60,35 +39,69 @@ export default async function startDevServer(compiler, cliOptions, logger): Prom
         return options;
     };
 
-    for (const devServerOpts of devServerOptions) {
-        const options = mergeOptions(cliOptions, devServerOpts);
+    const isMultiCompiler = Boolean(compiler.compilers);
+
+    let compilersWithDevServerOption;
+
+    if (isMultiCompiler) {
+        compilersWithDevServerOption = compiler.compilers.filter((compiler) => compiler.options.devServer);
+
+        // No compilers found with the `devServer` option, let's use first compiler
+        if (compilersWithDevServerOption.length === 0) {
+            compilersWithDevServerOption = [compiler.compilers[0]];
+        }
+    } else {
+        compilersWithDevServerOption = [compiler];
+    }
+
+    const isDevServer4 = devServerVersion.startsWith('4');
+    const usedPorts = [];
+    const devServersOptions = [];
+
+    for (const compilerWithDevServerOption of compilersWithDevServerOption) {
+        const options = mergeOptions(cliOptions, compilerWithDevServerOption.options.devServer || {});
 
         if (isDevServer4) {
             options.port = await findPort(options.port);
             options.client = options.client || {};
             options.client.port = options.client.port || options.port;
         } else {
+            if (!options.publicPath) {
+                options.publicPath =
+                    typeof compilerWithDevServerOption.options.output.publicPath === 'undefined' ||
+                    compilerWithDevServerOption.options.output.publicPath === 'auto'
+                        ? '/'
+                        : compilerWithDevServerOption.options.output.publicPath;
+            }
+
             options.host = options.host || 'localhost';
             options.port = options.port || 8080;
         }
 
         if (options.port) {
-            const portNum = +options.port;
+            const portNumber = Number(options.port);
 
-            if (usedPorts.find((port) => portNum === port)) {
+            if (usedPorts.find((port) => portNumber === port)) {
                 throw new Error(
                     'Unique ports must be specified for each devServer option in your webpack configuration. Alternatively, run only 1 devServer config using the --config-name flag to specify your desired config.',
                 );
             }
 
-            usedPorts.push(portNum);
+            usedPorts.push(portNumber);
         }
 
+        devServersOptions.push({ compiler, options });
+    }
+
+    const servers = [];
+
+    for (const devServerOptions of devServersOptions) {
+        const { compiler, options } = devServerOptions;
         const server = new Server(compiler, options);
 
-        server.listen(options.port, options.host, (err): void => {
-            if (err) {
-                throw err;
+        server.listen(options.port, options.host, (error): void => {
+            if (error) {
+                throw error;
             }
         });
 

diff --git a/packages/serve/src/types.ts b/packages/serve/src/types.ts
@@ -27,6 +27,7 @@ export type devServerOptionsType = {
     static?: boolean | string | object | (string | object)[];
     transportMode?: object | string;
     useLocalIp?: boolean;
+    publicPath?: undefined;
 };
 
 type devServerClientOptions = {

diff --git a/test/serve/basic/dev-server-output-public-path.config.js b/test/serve/basic/dev-server-output-public-path.config.js
@@ -0,0 +1,13 @@
+const WebpackCLITestPlugin = require('../../utils/webpack-cli-test-plugin');
+
+module.exports = {
+    mode: 'development',
+    devtool: false,
+    output: {
+        publicPath: '/my-public-path/',
+    },
+    devServer: {
+        publicPath: '/dev-server-my-public-path/',
+    },
+    plugins: [new WebpackCLITestPlugin(['mode', 'output'], false, 'hooks.compilation.taps')],
+};
diff --git a/test/serve/basic/multi-dev-server-output-public-path.config.js b/test/serve/basic/multi-dev-server-output-public-path.config.js
@@ -0,0 +1,26 @@
+const WebpackCLITestPlugin = require('../../utils/webpack-cli-test-plugin');
+
+module.exports = [
+    {
+        name: 'one',
+        mode: 'development',
+        devtool: false,
+        entry: './src/other.js',
+        output: {
+            filename: 'first-output/[name].js',
+        },
+    },
+    {
+        name: 'two',
+        mode: 'development',
+        devtool: false,
+        output: {
+            publicPath: '/my-public-path/',
+            filename: 'second-output/[name].js',
+        },
+        devServer: {
+            publicPath: '/dev-server-my-public-path/',
+        },
+        plugins: [new WebpackCLITestPlugin(['mode', 'output'], false, 'hooks.compilation.taps')],
+    },
+];
diff --git a/test/serve/basic/multi-dev-server.config.js b/test/serve/basic/multi-dev-server.config.js
@@ -0,0 +1,32 @@
+const getPort = require('get-port');
+
+const WebpackCLITestPlugin = require('../../utils/webpack-cli-test-plugin');
+
+module.exports = async () => [
+    {
+        name: 'one',
+        mode: 'development',
+        devtool: false,
+        output: {
+            filename: 'first-output/[name].js',
+        },
+        devServer: {
+            port: await getPort(),
+            publicPath: '/one-dev-server-my-public-path/',
+        },
+        plugins: [new WebpackCLITestPlugin(['mode', 'output'], false, 'hooks.compilation.taps')],
+    },
+    {
+        name: 'two',
+        mode: 'development',
+        devtool: false,
+        entry: './src/other.js',
+        output: {
+            filename: 'second-output/[name].js',
+        },
+        devServer: {
+            port: await getPort(),
+            publicPath: '/two-dev-server-my-public-path/',
+        },
+    },
+];
diff --git a/test/serve/basic/multi-output-public-path.config.js b/test/serve/basic/multi-output-public-path.config.js
@@ -0,0 +1,23 @@
+const WebpackCLITestPlugin = require('../../utils/webpack-cli-test-plugin');
+
+module.exports = [
+    {
+        name: 'one',
+        mode: 'development',
+        devtool: false,
+        output: {
+            publicPath: '/my-public-path/',
+            filename: 'first-output/[name].js',
+        },
+        plugins: [new WebpackCLITestPlugin(['mode', 'output'], false, 'hooks.compilation.taps')],
+    },
+    {
+        name: 'two',
+        mode: 'development',
+        devtool: false,
+        entry: './src/other.js',
+        output: {
+            filename: 'second-output/[name].js',
+        },
+    },
+];
diff --git a/test/serve/basic/multi.config.js b/test/serve/basic/multi.config.js
@@ -0,0 +1,25 @@
+const WebpackCLITestPlugin = require('../../utils/webpack-cli-test-plugin');
+
+module.exports = [
+    {
+        name: 'one',
+        mode: 'development',
+        devtool: false,
+        output: {
+            filename: 'first-output/[name].js',
+        },
+        devServer: {
+            publicPath: '/dev-server-my-public-path/',
+        },
+        plugins: [new WebpackCLITestPlugin(['mode', 'output'], false, 'hooks.compilation.taps')],
+    },
+    {
+        name: 'two',
+        mode: 'development',
+        devtool: false,
+        entry: './src/other.js',
+        output: {
+            filename: 'second-output/[name].js',
+        },
+    },
+];
diff --git a/test/serve/basic/multiple-dev-server.config.js b/test/serve/basic/multiple-dev-server.config.js
@@ -0,0 +1,29 @@
+const WebpackCLITestPlugin = require('../../utils/webpack-cli-test-plugin');
+
+module.exports = [
+    {
+        name: 'one',
+        mode: 'development',
+        devtool: false,
+        output: {
+            filename: 'first-output/[name].js',
+        },
+        devServer: {
+            publicPath: '/dev-server-my-public-path/',
+        },
+        plugins: [new WebpackCLITestPlugin(['mode', 'output'], false)],
+    },
+    {
+        name: 'two',
+        mode: 'development',
+        devtool: false,
+        entry: './src/other.js',
+        output: {
+            filename: 'first-output/[name].js',
+        },
+        devServer: {
+            publicPath: '/dev-server-my-public-path/',
+        },
+        plugins: [new WebpackCLITestPlugin(['mode', 'output'], false)],
+    },
+];
diff --git a/test/serve/basic/output-public-path.config.js b/test/serve/basic/output-public-path.config.js
@@ -0,0 +1,10 @@
+const WebpackCLITestPlugin = require('../../utils/webpack-cli-test-plugin');
+
+module.exports = {
+    mode: 'development',
+    devtool: false,
+    output: {
+        publicPath: '/my-public-path/',
+    },
+    plugins: [new WebpackCLITestPlugin(['mode', 'output'], false, 'hooks.compilation.taps')],
+};