Fixing problems with windows slashes in our hacky "require" dumped code

Author: weaverryan

lib/config-generator.js

@@ -44,6 +44,7 @@ const sharedEntryTmpName = require('./utils/sharedEntryTmpName');
 const tmp = require('tmp');
 const fs = require('fs');
 const path = require('path');
+const stringEscaper = require('./utils/string-escaper');
 
 class ConfigGenerator {
     /**
@@ -131,8 +132,7 @@ class ConfigGenerator {
             const pathToRequire = path.resolve(this.webpackConfig.getContext(), this.webpackConfig.sharedCommonsEntryFile);
             fs.writeFileSync(
                 tmpFileObject.name,
-                // escape single quotes (x27) and backslashes
-                `require('${pathToRequire.replace(/\x27/g, '\\\x27').replace('/\\/g', '\\\\')}')`
+                `require('${stringEscaper(pathToRequire)}')`
             );
 
             entry[sharedEntryTmpName] = tmpFileObject.name;

lib/utils/string-escaper.js

@@ -0,0 +1,24 @@
+/*
+ * This file is part of the Symfony Webpack Encore package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+'use strict';
+
+/**
+ * Function that escapes a string so it can be written into a
+ * file surrounded by single quotes.
+ *
+ * This is imperfect - is used to escape a filename (so, mostly,
+ * it needs to escape the Window path slashes).
+ *
+ * @param {string} str
+ * @return {string}
+ */
+module.exports = function stringEscaper(str) {
+    return str.replace(/\\/g, '\\\\').replace(/\x27/g, '\\\x27');
+};

test/utils/string-escaper.js

@@ -0,0 +1,38 @@
+/*
+ * This file is part of the Symfony Webpack Encore package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+'use strict';
+
+const expect = require('chai').expect;
+const stringEscaper = require('../../lib/utils/string-escaper');
+
+function expectEvaledStringToEqual(str, expectedStr) {
+    // put the string in quotes & eval it: should match original
+    expect(eval(`'${str}'`)).to.equal(expectedStr);
+}
+
+describe('string-escaper', () => {
+    it('escapes filenames with quotes', () => {
+        // eslint-disable-next-line quotes
+        const filename = "/foo/bar's/stuff";
+
+        const escapedFilename = stringEscaper(filename);
+        console.log(escapedFilename);
+        expectEvaledStringToEqual(escapedFilename, filename);
+    });
+
+    it('escapes Windows filenames', () => {
+        // eslint-disable-next-line quotes
+        const filename = `C:\\path\\to\\file`;
+        console.log(filename);
+
+        const escapedFilename = stringEscaper(filename);
+        expectEvaledStringToEqual(escapedFilename, filename);
+    });
+});