From 9576701d8532b9697df62c96d7c8676afd985b2d Mon Sep 17 00:00:00 2001
From: Andrew G. Dunn <andrew@dunn.dev>
Date: Mon, 02 Mar 2026 16:31:53 +0000
Subject: [PATCH] fix: await micromorph() to prevent race condition with nav event handlers (#2323)
---
quartz/components/scripts/spa.inline.ts | 99 +++++++++++++++++++++++++++++++++++++++----------
1 files changed, 79 insertions(+), 20 deletions(-)
diff --git a/quartz/components/scripts/spa.inline.ts b/quartz/components/scripts/spa.inline.ts
index d91ca78..465e793 100644
--- a/quartz/components/scripts/spa.inline.ts
+++ b/quartz/components/scripts/spa.inline.ts
@@ -1,9 +1,9 @@
import micromorph from "micromorph"
-import { FullSlug, RelativeURL, getFullSlug } from "../../util/path"
+import { FullSlug, RelativeURL, getFullSlug, normalizeRelativeURLs } from "../../util/path"
+import { fetchCanonical } from "./util"
// adapted from `micromorph`
// https://github.com/natemoo-re/micromorph
-
const NODE_TYPE_ELEMENT = 1
let announcer = document.createElement("route-announcer")
const isElement = (target: EventTarget | null): target is Element =>
@@ -18,8 +18,15 @@
return false
}
+const isSamePage = (url: URL): boolean => {
+ const sameOrigin = url.origin === window.location.origin
+ const samePath = url.pathname === window.location.pathname
+ return sameOrigin && samePath
+}
+
const getOpts = ({ target }: Event): { url: URL; scroll?: boolean } | undefined => {
if (!isElement(target)) return
+ if (target.attributes.getNamedItem("target")?.value === "_blank") return
const a = target.closest("a")
if (!a) return
if ("routerIgnore" in a.dataset) return
@@ -33,18 +40,54 @@
document.dispatchEvent(event)
}
+const cleanupFns: Set<(...args: any[]) => void> = new Set()
+window.addCleanup = (fn) => cleanupFns.add(fn)
+
+function startLoading() {
+ const loadingBar = document.createElement("div")
+ loadingBar.className = "navigation-progress"
+ loadingBar.style.width = "0"
+ if (!document.body.contains(loadingBar)) {
+ document.body.appendChild(loadingBar)
+ }
+
+ setTimeout(() => {
+ loadingBar.style.width = "80%"
+ }, 100)
+}
+
+let isNavigating = false
let p: DOMParser
-async function navigate(url: URL, isBack: boolean = false) {
+async function _navigate(url: URL, isBack: boolean = false) {
+ isNavigating = true
+ startLoading()
p = p || new DOMParser()
- const contents = await fetch(`${url}`)
- .then((res) => res.text())
+ const contents = await fetchCanonical(url)
+ .then((res) => {
+ const contentType = res.headers.get("content-type")
+ if (contentType?.startsWith("text/html")) {
+ return res.text()
+ } else {
+ window.location.assign(url)
+ }
+ })
.catch(() => {
window.location.assign(url)
})
if (!contents) return
+ // notify about to nav
+ const event: CustomEventMap["prenav"] = new CustomEvent("prenav", { detail: {} })
+ document.dispatchEvent(event)
+
+ // cleanup old
+ cleanupFns.forEach((fn) => fn())
+ cleanupFns.clear()
+
const html = p.parseFromString(contents, "text/html")
+ normalizeRelativeURLs(html, url)
+
let title = html.querySelector("title")?.textContent
if (title) {
document.title = title
@@ -59,22 +102,22 @@
html.body.appendChild(announcer)
// morph body
- micromorph(document.body, html.body)
+ await micromorph(document.body, html.body)
// scroll into place and add history
if (!isBack) {
if (url.hash) {
- const el = document.getElementById(url.hash.substring(1))
+ const el = document.getElementById(decodeURIComponent(url.hash.substring(1)))
el?.scrollIntoView()
} else {
window.scrollTo({ top: 0 })
}
}
- // now, patch head
- const elementsToRemove = document.head.querySelectorAll(":not([spa-preserve])")
+ // now, patch head, re-executing scripts
+ const elementsToRemove = document.head.querySelectorAll(":not([data-persist])")
elementsToRemove.forEach((el) => el.remove())
- const elementsToAdd = html.head.querySelectorAll(":not([spa-preserve])")
+ const elementsToAdd = html.head.querySelectorAll(":not([data-persist])")
elementsToAdd.forEach((el) => document.head.appendChild(el))
// delay setting the url until now
@@ -82,33 +125,48 @@
if (!isBack) {
history.pushState({}, "", url)
}
+
notifyNav(getFullSlug(window))
delete announcer.dataset.persist
}
+async function navigate(url: URL, isBack: boolean = false) {
+ if (isNavigating) return
+ isNavigating = true
+ try {
+ await _navigate(url, isBack)
+ } catch (e) {
+ console.error(e)
+ window.location.assign(url)
+ } finally {
+ isNavigating = false
+ }
+}
+
window.spaNavigate = navigate
function createRouter() {
if (typeof window !== "undefined") {
window.addEventListener("click", async (event) => {
const { url } = getOpts(event) ?? {}
- if (!url) return
+ // dont hijack behaviour, just let browser act normally
+ if (!url || event.ctrlKey || event.metaKey) return
event.preventDefault()
- try {
- navigate(url, false)
- } catch (e) {
- window.location.assign(url)
+
+ if (isSamePage(url) && url.hash) {
+ const el = document.getElementById(decodeURIComponent(url.hash.substring(1)))
+ el?.scrollIntoView()
+ history.pushState({}, "", url)
+ return
}
+
+ navigate(url, false)
})
window.addEventListener("popstate", (event) => {
const { url } = getOpts(event) ?? {}
if (window.location.hash && window.location.pathname === url?.pathname) return
- try {
- navigate(new URL(window.location.toString()), true)
- } catch (e) {
- window.location.reload()
- }
+ navigate(new URL(window.location.toString()), true)
return
})
}
@@ -139,6 +197,7 @@
style:
"position: absolute; left: 0; top: 0; clip: rect(0 0 0 0); clip-path: inset(50%); overflow: hidden; white-space: nowrap; width: 1px; height: 1px",
}
+
customElements.define(
"route-announcer",
class RouteAnnouncer extends HTMLElement {
--
Gitblit v1.10.0