Merge pull request #385 from icelam/issue-353-special-characters

icelam · web-flow · commit d7c4d79805e1 · 2022-07-24T17:52:04.000+08:00
fix: unable to match assets when filename contains special characters
diff --git a/__tests__/HtmlInlineScriptPlugin.test.ts b/__tests__/HtmlInlineScriptPlugin.test.ts
@@ -12,6 +12,7 @@ import inlineWebWorkerConfig from './cases/inline-web-worker/webpack.config';
 import ignoreScriptsConfig from './cases/ignore-scripts/webpack.config';
 import ignoreHtmlsConfig from './cases/ignore-htmls/webpack.config';
 import ignoreScriptsAndHtmlsConfig from './cases/ignore-scripts-and-htmls/webpack.config';
+import filenameWithSpecialCharactersConfig from './cases/filename-with-special-characters/webpack.config';
 
 describe('HtmlInlineScriptPlugin', () => {
   it('should build simple webpack config without error', async () => {
@@ -202,6 +203,38 @@ describe('HtmlInlineScriptPlugin', () => {
     await webpackPromise;
   });
 
+  it('should inline filename with spacial characters without error', async () => {
+    const webpackPromise = new Promise((resolve) => {
+      const compiler = webpack(filenameWithSpecialCharactersConfig);
+
+      compiler.run((error, stats) => {
+        expect(error).toBeNull();
+
+        const statsErrors = stats?.compilation.errors;
+        expect(statsErrors?.length).toBe(0);
+
+        const result = fs.readFileSync(
+          path.join(__dirname, 'cases/filename-with-special-characters/dist/index.html'),
+          'utf8',
+        );
+
+        const expected = fs.readFileSync(
+          path.join(__dirname, 'cases/filename-with-special-characters/expected/index.html'),
+          'utf8',
+        );
+        expect(result).toBe(expected);
+
+        const expectedFileList = fs.readdirSync(path.join(__dirname, 'cases/filename-with-special-characters/expected/'));
+        const generatedFileList = fs.readdirSync(path.join(__dirname, 'cases/filename-with-special-characters/dist/'));
+        expect(expectedFileList.sort()).toEqual(generatedFileList.sort());
+
+        resolve(true);
+      });
+    });
+
+    await webpackPromise;
+  });
+
   it('should respect plugin options on script matching pattern', async () => {
     const webpackPromise = new Promise((resolve) => {
       const compiler = webpack(ignoreScriptsConfig);
diff --git a/__tests__/cases/filename-with-special-characters/expected/index.html b/__tests__/cases/filename-with-special-characters/expected/index.html
@@ -0,0 +1 @@
+<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="language" content="English"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="viewport" content="minimum-scale=1,initial-scale=1,width=device-width,shrink-to-fit=no"/><title>webpack test</title><script defer="defer">console.log("Hello world");</script></head><body><p>This is minimal code to demonstrate webpack usage</p></body></html>
diff --git a/__tests__/cases/filename-with-special-characters/fixtures/index.html b/__tests__/cases/filename-with-special-characters/fixtures/index.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <meta name="language" content="English" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="minimum-scale=1, initial-scale=1, width=device-width, shrink-to-fit=no" />
+    <title>webpack test</title>
+  </head>
+  <body>
+    <p>This is minimal code to demonstrate webpack usage</p>
+  </body>
+</html>
diff --git a/__tests__/cases/filename-with-special-characters/fixtures/index.js b/__tests__/cases/filename-with-special-characters/fixtures/index.js
@@ -0,0 +1,2 @@
+// eslint-disable-next-line no-console
+console.log('Hello world');
diff --git a/__tests__/cases/filename-with-special-characters/webpack.config.ts b/__tests__/cases/filename-with-special-characters/webpack.config.ts
@@ -0,0 +1,21 @@
+import path from 'path';
+import type { Configuration } from 'webpack';
+import HtmlWebpackPlugin from 'html-webpack-plugin';
+import Self from '../../../dist';
+
+const config: Configuration = {
+  mode: 'production',
+  entry: path.join(__dirname, './fixtures/index.js'),
+  output: {
+    path: path.join(__dirname, './dist'),
+    filename: '[name]@production.js'
+  },
+  plugins: [
+    new HtmlWebpackPlugin({
+      template: path.resolve(__dirname, './fixtures/index.html')
+    }),
+    new Self()
+  ]
+};
+
+export default config;
diff --git a/src/HtmlInlineScriptPlugin.ts b/src/HtmlInlineScriptPlugin.ts
@@ -63,7 +63,8 @@ class HtmlInlineScriptPlugin implements WebpackPluginInstance {
       return tag;
     }
 
-    const scriptName = (tag.attributes.src as string).replace(publicPath, '');
+    // Decoded is needed for special characters in filename like '@' since they will be escaped
+    const scriptName = decodeURIComponent((tag.attributes.src as string).replace(publicPath, ''));
 
     if (!this.isFileNeedsToBeInlined(scriptName)) {
       return tag;

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<!doctype html><html lang="en"><head><meta charset="utf-8"/><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="language" content="English"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="viewport" content="minimum-scale=1,initial-scale=1,width=device-width,shrink-to-fit=no"/><title>webpack test</title><script defer="defer">console.log("Hello world");</script></head><body><p>This is minimal code to demonstrate webpack usage</p></body></html>`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+// eslint-disable-next-line no-console`
	`2`	`+console.log('Hello world');`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,8 @@ class HtmlInlineScriptPlugin implements WebpackPluginInstance {`
`63`	`63`	`return tag;`
`64`	`64`	`}`
`65`	`65`
`66`		`- const scriptName = (tag.attributes.src as string).replace(publicPath, '');`
	`66`	`+ // Decoded is needed for special characters in filename like '@' since they will be escaped`
	`67`	`+ const scriptName = decodeURIComponent((tag.attributes.src as string).replace(publicPath, ''));`
`67`	`68`
`68`	`69`	`if (!this.isFileNeedsToBeInlined(scriptName)) {`
`69`	`70`	`return tag;`