Fix a double slash in url that causes history corruption (#332)

ming-codes · samselikoff · commit c3bcab04d6df · 2019-03-04T10:38:45.000-05:00
diff --git a/lib/deploy/plugin.js b/lib/deploy/plugin.js
@@ -155,12 +155,18 @@ module.exports = class AddonDocsDeployPlugin {
     let addonDocsRootURL = rootURL === '' ? '/' : `/${rootURL}/`;
     let contents = fs.readFileSync(indexPath, 'utf-8');
     let encodedVersion = encodeURIComponent(JSON.stringify(deployVersion));
-    let updated = contents.replace(/\/?ADDON_DOCS_ROOT_URL\/?/g, addonDocsRootURL)
-      .replace(/%22ADDON_DOCS_DEPLOY_VERSION%22/g, encodedVersion);
+    let updated = this._macroReplaceIndexContent(contents, addonDocsRootURL, encodedVersion);
 
     fs.writeFileSync(indexPath, updated);
   }
 
+  _macroReplaceIndexContent(contents, addonDocsRootURL, encodedVersion) {
+    return contents
+      .replace('%2FADDON_DOCS_ROOT_URL%2F', encodeURIComponent(addonDocsRootURL))
+      .replace(/\/?ADDON_DOCS_ROOT_URL\/?/g, addonDocsRootURL)
+      .replace(/%22ADDON_DOCS_DEPLOY_VERSION%22/g, encodedVersion);
+  }
+
   _currentDeployVersion() {
     let curpath = path.join('versions', this._getVersionPath());
     let name = this.userConfig.getVersionName();
diff --git a/tests-node/unit/deploy/plugin-test.js b/tests-node/unit/deploy/plugin-test.js
@@ -0,0 +1,51 @@
+'use strict';
+
+const QUnit = require('qunit');
+const AddonDocsDeployPlugin = require('../../../lib/deploy/plugin');
+
+const qModule = QUnit.module;
+const test = QUnit.test;
+
+qModule('`deploy` | plugin test', hooks => {
+  hooks.beforeEach(function() {
+    this.pluginInstance = new AddonDocsDeployPlugin();
+  });
+
+  test('_macroReplaceIndexContent', function(assert) {
+    const contents = `
+      <!DOCTYPE html>
+      <html>
+        <head>
+          <meta name="dummy/config/environment" content="%7B%22rootURL%22%3A%22%2FADDON_DOCS_ROOT_URL%2F%22%7D" />
+        </head>
+        <body>
+          <script src="/ADDON_DOCS_ROOT_URL/assets/vendor.js"></script>
+          <script src="/ADDON_DOCS_ROOT_URL/assets/dummy.js"></script>
+        </body>
+      </html>
+    `;
+    const encodedVersion = encodeURIComponent(JSON.stringify({
+      path: 'versions/master',
+      name: 'master',
+      sha: 'eef3',
+      tag: null,
+      key: 'master'
+    }));
+    const addonDocsRootURL = '/my-addon/versions/master/'
+    const actual = this.pluginInstance._macroReplaceIndexContent(contents, addonDocsRootURL, encodedVersion);
+    const expected = `
+      <!DOCTYPE html>
+      <html>
+        <head>
+          <meta name="dummy/config/environment" content="%7B%22rootURL%22%3A%22%2Fmy-addon%2Fversions%2Fmaster%2F%22%7D" />
+        </head>
+        <body>
+          <script src="/my-addon/versions/master/assets/vendor.js"></script>
+          <script src="/my-addon/versions/master/assets/dummy.js"></script>
+        </body>
+      </html>
+    `;
+
+    assert.equal(actual, expected);
+  });
+});
