From 7a5b34874353e786224dc96350f9b511ec86a850 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=BB=91?= <1395348685z@gmail.com>
Date: Fri, 9 Apr 2021 13:30:06 +0800
Subject: [PATCH] Make CONFIG more overridable & Fix quicklink

- Deprecate quicklink.ignores but not obsolete it
- Rename `load-config.js` in source/js/ to `config.js`
---
 _config.yml                        |  1 +
 layout/_layout.njk                 |  2 +-
 layout/_third-party/quicklink.njk  |  3 +-
 scripts/helpers/engine.js          |  4 +-
 source/js/config.js                | 60 ++++++++++++++++++++++++++++++
 source/js/load-config.js           | 43 ---------------------
 source/js/third-party/quicklink.js | 46 ++++++++++++++---------
 7 files changed, 95 insertions(+), 64 deletions(-)
 create mode 100644 source/js/config.js
 delete mode 100644 source/js/load-config.js

diff --git a/_config.yml b/_config.yml
index 8fa4fd21d..cf87e8be6 100644
--- a/_config.yml
+++ b/_config.yml
@@ -553,6 +553,7 @@ quicklink:
 
   # For more flexibility you can add some patterns (RegExp, Function, or Array) to ignores.
   # See: https://github.com/GoogleChromeLabs/quicklink#custom-ignore-patterns
+  # This option is deprecated. Use `CONFIG.quicklink.ignores` in your custom scripts instead.
   ignores:
 
 
diff --git a/layout/_layout.njk b/layout/_layout.njk
index d5df40ec8..b1475a209 100644
--- a/layout/_layout.njk
+++ b/layout/_layout.njk
@@ -4,7 +4,7 @@
   {{ partial('_partials/head/head.njk', {}, {cache: theme.cache.enable}) }}
   {%- include '_partials/head/head-unique.njk' -%}
   <title>{% block title %}{% endblock %}</title>
-  {{- next_js('load-config.js') }}
+  {{- next_js('config.js') }}
   {{- next_inject('head') }}
   {{ partial('_third-party/analytics/index.njk', {}, {cache: theme.cache.enable}) }}
   <noscript>
diff --git a/layout/_third-party/quicklink.njk b/layout/_third-party/quicklink.njk
index 5af0b9612..f97363f2d 100644
--- a/layout/_third-party/quicklink.njk
+++ b/layout/_third-party/quicklink.njk
@@ -1,6 +1,7 @@
 {%- if theme.quicklink.enable %}
+  <script src="{{ theme.vendors.quicklink }}"></script>
   {{ next_data('quicklink', page.quicklink, {
-    js: theme.vendors.quicklink
+    url: url | replace(r/index\.html$/, '')
   }) }}
   {{ next_js('third-party/quicklink.js') }}
 {%- endif %}
diff --git a/scripts/helpers/engine.js b/scripts/helpers/engine.js
index b18d728a3..aa51f3a57 100644
--- a/scripts/helpers/engine.js
+++ b/scripts/helpers/engine.js
@@ -32,8 +32,8 @@ hexo.extend.helper.register('next_js', function(file, pjax = false) {
 hexo.extend.helper.register('next_data', function(name, ...data) {
   const { escape_html } = this;
   const json = data.length === 1 ? data[0] : Object.assign({}, ...data);
-  return `<script id="next-config-${name}" type="application/json">${
-    escape_html(JSON.stringify(json) ?? '')
+  return `<script class="next-config" data-name="${name}" type="application/json">${
+    escape_html(JSON.stringify(json))
   }</script>`;
 });
 
diff --git a/source/js/config.js b/source/js/config.js
new file mode 100644
index 000000000..df894ae22
--- /dev/null
+++ b/source/js/config.js
@@ -0,0 +1,60 @@
+{
+  if (!window.NexT) window.NexT = {};
+
+  const className = 'next-config';
+
+  const staticConfig = {};
+  let variableConfig = {};
+
+  const parse = (text) => {
+    const jsonString = new DOMParser()
+      .parseFromString(text, 'text/html').documentElement
+      .textContent;
+    return JSON.parse(jsonString || '{}');
+  };
+
+  const update = (name) => {
+    const targetEle = document.querySelector(`.${className}[data-name="${name}"]`);
+    if (!targetEle) return;
+    const parsedConfig = parse(targetEle.text);
+    if (name === 'main') {
+      Object.assign(staticConfig, parsedConfig);
+    } else {
+      variableConfig[name] = parsedConfig;
+    }
+  };
+
+  update('main');
+
+  window.CONFIG = new Proxy({}, {
+    get(overrideConfig, name) {
+      let existing;
+      if (name in staticConfig) {
+        existing = staticConfig[name];
+      } else {
+        if (!(name in variableConfig)) update(name);
+        existing = variableConfig[name];
+      }
+
+      let override = overrideConfig[name];
+      if (override === undefined && typeof existing === 'object') {
+        override = {};
+        overrideConfig[name] = override;
+      }
+
+      if (typeof override === 'object') {
+        return new Proxy({...existing, ...override}, {
+          set(target, prop, value) {
+            override[prop] = value;
+            return true;
+          }
+        });
+      }
+      return existing;
+    }
+  });
+
+  document.addEventListener('pjax:success', () => {
+    variableConfig = {};
+  });
+}
diff --git a/source/js/load-config.js b/source/js/load-config.js
deleted file mode 100644
index 892936cd2..000000000
--- a/source/js/load-config.js
+++ /dev/null
@@ -1,43 +0,0 @@
-{
-  if (!window.NexT) window.NexT = {};
-
-  const prefix = 'next-config-';
-
-  const parse = (text) => {
-    const jsonString = new DOMParser().parseFromString(text, 'text/html').documentElement.textContent;
-    return JSON.parse(jsonString || '{}');
-  };
-
-  const staticConfig = {};
-  let variableConfig = {};
-
-  const update = (name) => {
-    const targetEle = document.getElementById(`${prefix}${name}`);
-    if (!targetEle) return;
-    const parsedConfig = parse(targetEle.text);
-    if (name === 'main') {
-      Object.assign(staticConfig, parsedConfig);
-    } else {
-      variableConfig[name] = parsedConfig;
-    }
-  };
-
-  update('main');
-
-  window.CONFIG = new Proxy({}, {
-    get(overrideConfig, propKey) {
-      if (propKey in overrideConfig) return overrideConfig[propKey];
-
-      if (propKey in staticConfig) {
-        return staticConfig[propKey];
-      }
-
-      if (!(propKey in variableConfig)) update(propKey);
-      return variableConfig[propKey];
-    }
-  });
-
-  document.addEventListener('pjax:success', () => {
-    variableConfig = {};
-  });
-}
diff --git a/source/js/third-party/quicklink.js b/source/js/third-party/quicklink.js
index ad7fda850..1eb81756b 100644
--- a/source/js/third-party/quicklink.js
+++ b/source/js/third-party/quicklink.js
@@ -1,29 +1,41 @@
-/* global NexT, CONFIG, quicklink */
+/* global CONFIG, quicklink */
 
 {
-  const quicklinkListen = () => {
-    quicklink.listen({
+  let resetFn = null;
+
+  const onRefresh = () => {
+    if (resetFn) resetFn();
+    if (!CONFIG.quicklink.enable) return;
+
+    let ignoresArr = CONFIG.quicklink.ignores || [];
+    if (typeof ignoresArr === 'string') {
+      try {
+        ignoresArr = JSON.parse(`[${ignoresArr}]`);
+      } catch {
+        // eslint-disable-next-line no-console
+        console.error('Setting regex and function in config file is deprecated. Try setting `CONFIG.quicklink.ignores` in any script code.');
+        // eslint-disable-next-line no-eval
+        ignoresArr = eval(`[${ignoresArr}]`);
+      }
+    } else if (!Array.isArray(ignoresArr)) {
+      ignoresArr = [ignoresArr];
+    }
+
+    resetFn = quicklink.listen({
       timeout : CONFIG.quicklink.timeout,
       priority: CONFIG.quicklink.priority,
       ignores : [
         uri => uri.includes('#'),
         uri => uri === CONFIG.quicklink.url,
-        // TODO: `quicklink.ignores` may includes functions that can not be parsed safely in JS runtime
-        ...JSON.parse(`[${CONFIG.quicklink.ignores}]`)
+        ...ignoresArr
       ]
     });
   };
 
-  document.addEventListener('page:loaded', () => {
-    if (!CONFIG.quicklink.enable) return;
-
-    NexT.utils.getScript(CONFIG.quicklink.js)
-      .then(() => {
-        if (CONFIG.quicklink.delay) {
-          window.addEventListener('load', quicklinkListen);
-        } else {
-          quicklinkListen();
-        }
-      });
-  });
+  if (CONFIG.quicklink.delay) {
+    window.addEventListener('load', onRefresh);
+    document.addEventListener('pjax:success', onRefresh);
+  } else {
+    document.addEventListener('page:loaded', onRefresh);
+  }
 }