aboutsummaryrefslogtreecommitdiff
path: root/static/js/instantpage.ts
blob: b76cef8eb3c0202a82f49823f9f4509c40116bb0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/*
 * Instant Page Copyright (C) 2019-2023 Alexandre Dieulot
 * https://github.com/instantpage/instant.page/blob/master/LICENSE
 * Licence: MIT | https://mit-license.org/
*/

(function () {

  function fetch(url, method, callback) {
    const http = new XMLHttpRequest();
    http.onreadystatechange = function () {
      if (http.readyState === 4 && http.status === 200) {
        if (callback) callback(http);
      }
    };
    http.open(method, url);
    http.send();
    return http;
  }

  self.addEventListener("DOMContentLoaded", function () {
    const prefetches = new Set();
    const prefetchElement = document.createElement("link");

    const isSupported = prefetchElement.relList
      && prefetchElement.relList.supports
      && prefetchElement.relList.supports("prefetch")
      && window.IntersectionObserver
      && "isIntersecting" in IntersectionObserverEntry.prototype;

    const allowQueryString   = "instantAllowQueryString"   in document.body.dataset;
    const allowExternalLinks = "instantAllowExternalLinks" in document.body.dataset;
    const useWhitelist       = "instantWhitelist"          in document.body.dataset;
    const mousedownShortcut  = "instantMousedownShortcut"  in document.body.dataset;

    const DELAY_TO_NOT_BE_CONSIDERED_A_TOUCH_INITIATED_ACTION = 1111;

    let mouseoverTimer;
    let lastTouchTimestamp;
    let delayOnHover = 65;
    let useMousedown = false;
    let useMousedownOnly = false;
    let useViewport = false;

    if ("instantIntensity" in document.body.dataset) {
      const intensity = document.body.dataset.instantIntensity;

      if (intensity.substr(0, "mousedown".length) == "mousedown") {
        useMousedown = true;
        if (intensity == "mousedown-only") { useMousedownOnly = true; }
      } else if (intensity.substr(0, "viewport".length) == "viewport") {
        if (!(navigator.connection
            && (navigator.connection.saveData
            || (navigator.connection.effectiveType
            && navigator.connection.effectiveType.includes("2g"))))) {
          if (intensity == "viewport") {
            /*
              Biggest iPhone resolution (which we want): 414 × 896 = 370944
              Small 7" tablet resolution (which we don’t want): 600 × 1024 = 614400
              Note that the viewport (which we check here) is smaller than the resolution due to the UI’s chrome
            */
            if (document.documentElement.clientWidth * document.documentElement.clientHeight < 450000) { useViewport = true; }
          } else if (intensity == "viewport-all") {
            useViewport = true;
          }
        }
      } else {
        const milliseconds = parseInt(intensity);
        if (!isNaN(milliseconds)) { delayOnHover = milliseconds; }
      }
    }

    if (isSupported) {
      const eventListenersOptions = { capture: true, passive: true };

      if (!useMousedownOnly) { document.addEventListener( "touchstart", touchstartListener, eventListenersOptions,); }

      if (!useMousedown) {
        document.addEventListener( "mouseover", mouseoverListener, eventListenersOptions,);
      } else if (!mousedownShortcut) {
        document.addEventListener( "mousedown", mousedownListener, eventListenersOptions,);
      }

      if (mousedownShortcut) { document.addEventListener( "mousedown", mousedownShortcutListener, eventListenersOptions,); }

      if (useViewport) {
        let triggeringFunction;
        if (window.requestIdleCallback) {
          triggeringFunction = function (callback) { requestIdleCallback(callback, { timeout: 1500 }); }
        } else {
          triggeringFunction = function (callback) { callback(); }
        }

        triggeringFunction(function () {
          const intersectionObserver = new IntersectionObserver(
            function (entries) {
              entries.forEach(function (entry) {
                if (entry.isIntersecting) {
                  const linkElement = entry.target;
                  intersectionObserver.unobserve(linkElement);
                  preload(linkElement.href);
                }
              });
            },
          );

          document.querySelectorAll("a").forEach(function (linkElement) {
            if (isPreloadable(linkElement)) { intersectionObserver.observe(linkElement); }
          });
        });
      }
    }

    function touchstartListener(event) {
      /*
        Chrome on Android calls mouseover before touchcancel so `lastTouchTimestamp`
        must be assigned on touchstart to be measured on mouseover.
      */
      lastTouchTimestamp = performance.now();
      const linkElement = event.target.closest("a");
      if (!isPreloadable(linkElement)) { return; }
      preload(linkElement.href);
    }

    function mouseoverListener(event) {
      if (performance.now() - lastTouchTimestamp < DELAY_TO_NOT_BE_CONSIDERED_A_TOUCH_INITIATED_ACTION) { return; }

      const linkElement = event.target.closest("a");
      if (!isPreloadable(linkElement)) { return; }
      linkElement.addEventListener("mouseout", mouseoutListener, { passive: true });

      mouseoverTimer = setTimeout(function () {
        preload(linkElement.href);
        mouseoverTimer = undefined;
      }, delayOnHover);
    }

    function mousedownListener(event) {
      const linkElement = event.target.closest("a");
      if (!isPreloadable(linkElement)) { return; }
      preload(linkElement.href);
    }

    function mouseoutListener(event) {
      if (event.relatedTarget && event.target.closest("a") == event.relatedTarget.closest("a")) { return; }
      if (mouseoverTimer) { clearTimeout(mouseoverTimer); mouseoverTimer = undefined; }
    }

    function mousedownShortcutListener(event) {
      if (performance.now() - lastTouchTimestamp < DELAY_TO_NOT_BE_CONSIDERED_A_TOUCH_INITIATED_ACTION) { return; }

      const linkElement = event.target.closest("a");

      if (event.which > 1 || event.metaKey || event.ctrlKey) { return; }

      if (!linkElement) { return; }

      linkElement.addEventListener("click", function (event) {
        if (event.detail == 1337) { return; }
        event.preventDefault();
      }, { capture: true, passive: false, once: true });

      const customEvent = new MouseEvent("click", {
        view: window,
        bubbles: true,
        cancelable: false,
        detail: 1337,
      });

      linkElement.dispatchEvent(customEvent);
    }

    function isPreloadable(linkElement) {
      if (!linkElement || !linkElement.href) { return; }

      if (useWhitelist && !("instant" in linkElement.dataset)) { return; }

      if (!allowExternalLinks && linkElement.origin != location.origin && !("instant" in linkElement.dataset)) { return; }

      if (!["http:", "https:"].includes(linkElement.protocol)) { return; }

      if (linkElement.protocol == "http:" && location.protocol == "https:") { return; }

      if (!allowQueryString && linkElement.search && !("instant" in linkElement.dataset)) { return; }

      if (linkElement.hash && linkElement.pathname + linkElement.search == location.pathname + location.search) { return; }

      if ("noInstant" in linkElement.dataset) { return; }

      return true;
    }

    function preload(url) {
      if (prefetches.has(url)) { return; }
      const prefetcher = document.createElement("link");
      prefetcher.rel = "custom-prefetch";
      prefetcher.href = url;
      fetch(url, "GET", function () {
        document.head.appendChild(prefetcher);
        prefetches.add(url);
      });
    }
  });
})();