From 3d4a94dda3406ced22b3cb85cdc26a2df7aa3f55 Mon Sep 17 00:00:00 2001
From: Tyler Funk <tcfunk25@gmail.com>
Date: Thu, 07 Mar 2024 03:44:34 +0000
Subject: [PATCH] feat(analytics): Goatcounter support (#956)
---
quartz/plugins/emitters/componentResources.ts | 113 ++++++++++++++++++++++++++++++++++++++++++++++++--------
1 files changed, 96 insertions(+), 17 deletions(-)
diff --git a/quartz/plugins/emitters/componentResources.ts b/quartz/plugins/emitters/componentResources.ts
index accc261..7d1a01d 100644
--- a/quartz/plugins/emitters/componentResources.ts
+++ b/quartz/plugins/emitters/componentResources.ts
@@ -1,4 +1,4 @@
-import { FilePath, FullSlug } from "../../util/path"
+import { FilePath, FullSlug, joinSegments } from "../../util/path"
import { QuartzEmitterPlugin } from "../types"
// @ts-ignore
@@ -14,6 +14,7 @@
import { Features, transform } from "lightningcss"
import { transform as transpile } from "esbuild"
import { write } from "./helpers"
+import DepGraph from "../../depgraph"
type ComponentResources = {
css: string[]
@@ -119,21 +120,32 @@
} else if (cfg.analytics?.provider === "umami") {
componentResources.afterDOMLoaded.push(`
const umamiScript = document.createElement("script")
- umamiScript.src = cfg.analytics.host ?? "https://analytics.umami.is/script.js"
+ umamiScript.src = "${cfg.analytics.host ?? "https://analytics.umami.is"}/script.js"
umamiScript.setAttribute("data-website-id", "${cfg.analytics.websiteId}")
umamiScript.async = true
document.head.appendChild(umamiScript)
`)
+ } else if (cfg.analytics?.provider === "goatcounter") {
+ componentResources.afterDOMLoaded.push(`
+ const goatcounterScript = document.createElement("script")
+ goatcounterScript.src = "${cfg.analytics.scriptSrc ?? "https://gc.zgo.at/count.js"}"
+ goatcounterScript.async = true
+ goatcounterScript.setAttribute("data-goatcounter",
+ "https://${cfg.analytics.websiteId}.${cfg.analytics.host ?? "goatcounter.com"}/count")
+ document.head.appendChild(goatcounterScript)
+ `)
}
if (cfg.enableSPA) {
componentResources.afterDOMLoaded.push(spaRouterScript)
} else {
componentResources.afterDOMLoaded.push(`
- window.spaNavigate = (url, _) => window.location.assign(url)
- const event = new CustomEvent("nav", { detail: { url: document.body.dataset.slug } })
- document.dispatchEvent(event)`)
+ window.spaNavigate = (url, _) => window.location.assign(url)
+ window.addCleanup = () => {}
+ const event = new CustomEvent("nav", { detail: { url: document.body.dataset.slug } })
+ document.dispatchEvent(event)
+ `)
}
let wsUrl = `ws://localhost:${ctx.argv.wsPort}`
@@ -148,7 +160,8 @@
contentType: "inline",
script: `
const socket = new WebSocket('${wsUrl}')
- socket.addEventListener('message', () => document.location.reload())
+ // reload(true) ensures resources like images and scripts are fetched again in firefox
+ socket.addEventListener('message', () => document.location.reload(true))
`,
})
}
@@ -169,28 +182,93 @@
getQuartzComponents() {
return []
},
+ async getDependencyGraph(ctx, content, _resources) {
+ // This emitter adds static resources to the `resources` parameter. One
+ // important resource this emitter adds is the code to start a websocket
+ // connection and listen to rebuild messages, which triggers a page reload.
+ // The resources parameter with the reload logic is later used by the
+ // ContentPage emitter while creating the final html page. In order for
+ // the reload logic to be included, and so for partial rebuilds to work,
+ // we need to run this emitter for all markdown files.
+ const graph = new DepGraph<FilePath>()
+
+ for (const [_tree, file] of content) {
+ const sourcePath = file.data.filePath!
+ const slug = file.data.slug!
+ graph.addEdge(sourcePath, joinSegments(ctx.argv.output, slug + ".html") as FilePath)
+ }
+
+ return graph
+ },
async emit(ctx, _content, resources): Promise<FilePath[]> {
+ const promises: Promise<FilePath>[] = []
+ const cfg = ctx.cfg.configuration
// component specific scripts and styles
const componentResources = getComponentResources(ctx)
+ let googleFontsStyleSheet = ""
+ if (fontOrigin === "local") {
+ // let the user do it themselves in css
+ } else if (fontOrigin === "googleFonts") {
+ if (cfg.theme.cdnCaching) {
+ resources.css.push(googleFontHref(cfg.theme))
+ } else {
+ let match
+
+ const fontSourceRegex = /url\((https:\/\/fonts.gstatic.com\/s\/[^)]+\.(woff2|ttf))\)/g
+
+ googleFontsStyleSheet = await (
+ await fetch(googleFontHref(ctx.cfg.configuration.theme))
+ ).text()
+
+ while ((match = fontSourceRegex.exec(googleFontsStyleSheet)) !== null) {
+ // match[0] is the `url(path)`, match[1] is the `path`
+ const url = match[1]
+ // the static name of this file.
+ const [filename, ext] = url.split("/").pop()!.split(".")
+
+ googleFontsStyleSheet = googleFontsStyleSheet.replace(
+ url,
+ `/static/fonts/${filename}.ttf`,
+ )
+
+ promises.push(
+ fetch(url)
+ .then((res) => {
+ if (!res.ok) {
+ throw new Error(`Failed to fetch font`)
+ }
+ return res.arrayBuffer()
+ })
+ .then((buf) =>
+ write({
+ ctx,
+ slug: joinSegments("static", "fonts", filename) as FullSlug,
+ ext: `.${ext}`,
+ content: Buffer.from(buf),
+ }),
+ ),
+ )
+ }
+ }
+ }
+
// important that this goes *after* component scripts
// as the "nav" event gets triggered here and we should make sure
// that everyone else had the chance to register a listener for it
-
- if (fontOrigin === "googleFonts") {
- resources.css.push(googleFontHref(ctx.cfg.configuration.theme))
- } else if (fontOrigin === "local") {
- // let the user do it themselves in css
- }
-
addGlobalPageResources(ctx, resources, componentResources)
- const stylesheet = joinStyles(ctx.cfg.configuration.theme, ...componentResources.css, styles)
+ const stylesheet = joinStyles(
+ ctx.cfg.configuration.theme,
+ googleFontsStyleSheet,
+ ...componentResources.css,
+ styles,
+ )
const [prescript, postscript] = await Promise.all([
joinScripts(componentResources.beforeDOMLoaded),
joinScripts(componentResources.afterDOMLoaded),
])
- const fps = await Promise.all([
+ promises.push(
write({
ctx,
slug: "index" as FullSlug,
@@ -221,8 +299,9 @@
ext: ".js",
content: postscript,
}),
- ])
- return fps
+ )
+
+ return await Promise.all(promises)
},
}
}
--
Gitblit v1.10.0