From e10de3febffd3e3b7eaa3aed611aea03153e6a82 Mon Sep 17 00:00:00 2001
From: Jacky Zhao <j.zhao2k19@gmail.com>
Date: Tue, 22 Aug 2023 00:01:18 +0000
Subject: [PATCH] fix: server-handler crash from filename (closes #386)
---
quartz/bootstrap-cli.mjs | 118 ++++++++++++++++++++++++++++++++++++++++++++++++----------
1 files changed, 97 insertions(+), 21 deletions(-)
diff --git a/quartz/bootstrap-cli.mjs b/quartz/bootstrap-cli.mjs
index 8efa7b0..d068cd8 100755
--- a/quartz/bootstrap-cli.mjs
+++ b/quartz/bootstrap-cli.mjs
@@ -16,10 +16,11 @@
import serveHandler from "serve-handler"
import { WebSocketServer } from "ws"
import { randomUUID } from "crypto"
+import { Mutex } from "async-mutex"
const ORIGIN_NAME = "origin"
const UPSTREAM_NAME = "upstream"
-const QUARTZ_SOURCE_BRANCH = "v4-alpha"
+const QUARTZ_SOURCE_BRANCH = "v4"
const cwd = process.cwd()
const cacheDir = path.join(cwd, ".quartz-cache")
const cacheFile = "./.quartz-cache/transpiled-build.mjs"
@@ -76,6 +77,7 @@
},
baseDir: {
string: true,
+ default: "",
describe: "base path to serve your local server on",
},
port: {
@@ -112,6 +114,7 @@
}
async function stashContentFolder(contentFolder) {
+ await fs.promises.rm(contentCacheFolder, { force: true, recursive: true })
await fs.promises.cp(contentFolder, contentCacheFolder, {
force: true,
recursive: true,
@@ -134,7 +137,10 @@
function gitPull(origin, branch) {
const flags = ["--no-rebase", "--autostash", "-s", "recursive", "-X", "ours", "--no-edit"]
- spawnSync("git", ["pull", ...flags, origin, branch], { stdio: "inherit" })
+ const out = spawnSync("git", ["pull", ...flags, origin, branch], { stdio: "inherit" })
+ if (out.stderr) {
+ throw new Error(`Error while pulling updates: ${out.stderr}`)
+ }
}
yargs(hideBin(process.argv))
@@ -150,7 +156,7 @@
message: `Choose how to initialize the content in \`${contentFolder}\``,
options: [
{ value: "new", label: "Empty Quartz" },
- { value: "copy", label: "Replace with an existing folder", hint: "overwrites `content`" },
+ { value: "copy", label: "Copy an existing folder", hint: "overwrites `content`" },
{
value: "symlink",
label: "Symlink an existing folder",
@@ -163,12 +169,10 @@
async function rmContentFolder() {
const contentStat = await fs.promises.lstat(contentFolder)
- if (contentStat) {
- if (contentStat.isSymbolicLink()) {
- await fs.promises.unlink(contentFolder)
- } else {
- await rimraf(contentFolder)
- }
+ if (contentStat.isSymbolicLink()) {
+ await fs.promises.unlink(contentFolder)
+ } else {
+ await rimraf(contentFolder)
}
}
@@ -193,7 +197,10 @@
await rmContentFolder()
if (setupStrategy === "copy") {
- await fs.promises.cp(originalFolder, contentFolder, { recursive: true })
+ await fs.promises.cp(originalFolder, contentFolder, {
+ recursive: true,
+ preserveTimestamps: true,
+ })
} else if (setupStrategy === "symlink") {
await fs.promises.symlink(originalFolder, contentFolder, "dir")
}
@@ -248,37 +255,67 @@
outro(`You're all set! Not sure what to do next? Try:
• Customizing Quartz a bit more by editing \`quartz.config.ts\`
• Running \`npx quartz build --serve\` to preview your Quartz locally
- • Hosting your Quartz online (see: https://quartz.jzhao.xyz/setup/hosting)
+ • Hosting your Quartz online (see: https://quartz.jzhao.xyz/hosting)
`)
})
.command("update", "Get the latest Quartz updates", CommonArgv, async (argv) => {
const contentFolder = path.join(cwd, argv.directory)
console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`))
console.log("Backing up your content")
+ execSync(
+ `git remote show upstream || git remote add upstream https://github.com/jackyzha0/quartz.git`,
+ )
await stashContentFolder(contentFolder)
console.log(
"Pulling updates... you may need to resolve some `git` conflicts if you've made changes to components or plugins.",
)
- execSync(
- `git remote show upstream || git remote add upstream https://github.com/jackyzha0/quartz.git`,
- )
gitPull(UPSTREAM_NAME, QUARTZ_SOURCE_BRANCH)
await popContentFolder(contentFolder)
console.log("Ensuring dependencies are up to date")
spawnSync("npm", ["i"], { stdio: "inherit" })
console.log(chalk.green("Done!"))
})
+ .command(
+ "restore",
+ "Try to restore your content folder from the cache",
+ CommonArgv,
+ async (argv) => {
+ const contentFolder = path.join(cwd, argv.directory)
+ await popContentFolder(contentFolder)
+ },
+ )
.command("sync", "Sync your Quartz to and from GitHub.", SyncArgv, async (argv) => {
const contentFolder = path.join(cwd, argv.directory)
console.log(chalk.bgGreen.black(`\n Quartz v${version} \n`))
console.log("Backing up your content")
if (argv.commit) {
+ const contentStat = await fs.promises.lstat(contentFolder)
+ if (contentStat.isSymbolicLink()) {
+ const linkTarg = await fs.promises.readlink(contentFolder)
+ console.log(chalk.yellow("Detected symlink, trying to dereference before committing"))
+
+ // stash symlink file
+ await stashContentFolder(contentFolder)
+
+ // follow symlink and copy content
+ await fs.promises.cp(linkTarg, contentFolder, {
+ recursive: true,
+ preserveTimestamps: true,
+ })
+ }
+
const currentTimestamp = new Date().toLocaleString("en-US", {
dateStyle: "medium",
timeStyle: "short",
})
- spawnSync("git", ["commit", "-am", `Quartz sync: ${currentTimestamp}`], { stdio: "inherit" })
+ spawnSync("git", ["add", "."], { stdio: "inherit" })
+ spawnSync("git", ["commit", "-m", `Quartz sync: ${currentTimestamp}`], { stdio: "inherit" })
+
+ if (contentStat.isSymbolicLink()) {
+ // put symlink back
+ await popContentFolder(contentFolder)
+ }
}
await stashContentFolder(contentFolder)
@@ -355,8 +392,17 @@
],
})
+ const buildMutex = new Mutex()
const timeoutIds = new Set()
+ let firstBuild = true
const build = async (clientRefresh) => {
+ const release = await buildMutex.acquire()
+ if (firstBuild) {
+ firstBuild = false
+ } else {
+ console.log(chalk.yellow("Detected a source code change, doing a hard rebuild..."))
+ }
+
const result = await ctx.rebuild().catch((err) => {
console.error(`${chalk.red("Couldn't parse Quartz configuration:")} ${fp}`)
console.log(`Reason: ${chalk.grey(err)}`)
@@ -379,37 +425,62 @@
const { default: buildQuartz } = await import(cacheFile + `?update=${randomUUID()}`)
await buildQuartz(argv, clientRefresh)
clientRefresh()
+ release()
}
const rebuild = (clientRefresh) => {
timeoutIds.forEach((id) => clearTimeout(id))
+ timeoutIds.clear()
timeoutIds.add(setTimeout(() => build(clientRefresh), 250))
}
if (argv.serve) {
- const wss = new WebSocketServer({ port: 3001 })
const connections = []
- wss.on("connection", (ws) => connections.push(ws))
const clientRefresh = () => connections.forEach((conn) => conn.send("rebuild"))
+ if (argv.baseDir !== "" && !argv.baseDir.startsWith("/")) {
+ argv.baseDir = "/" + argv.baseDir
+ }
+
await build(clientRefresh)
const server = http.createServer(async (req, res) => {
+ if (argv.baseDir && !req.url?.startsWith(argv.baseDir)) {
+ console.log(
+ chalk.red(
+ `[404] ${req.url} (warning: link outside of site, this is likely a Quartz bug)`,
+ ),
+ )
+ res.writeHead(404)
+ res.end()
+ return
+ }
+
+ // strip baseDir prefix
+ req.url = req.url?.slice(argv.baseDir.length)
+
const serve = async () => {
await serveHandler(req, res, {
public: argv.output,
directoryListing: false,
+ headers: [
+ {
+ source: "**/*.html",
+ headers: [{ key: "Content-Disposition", value: "inline" }],
+ },
+ ],
})
const status = res.statusCode
const statusString =
status >= 200 && status < 300 ? chalk.green(`[${status}]`) : chalk.red(`[${status}]`)
- console.log(statusString + chalk.grey(` ${req.url}`))
+ console.log(statusString + chalk.grey(` ${argv.baseDir}${req.url}`))
}
const redirect = (newFp) => {
+ newFp = argv.baseDir + newFp
res.writeHead(302, {
Location: newFp,
})
- console.log(chalk.yellow("[302]") + chalk.grey(` ${req.url} -> ${newFp}`))
+ console.log(chalk.yellow("[302]") + chalk.grey(` ${argv.baseDir}${req.url} -> ${newFp}`))
res.end()
}
@@ -455,14 +526,19 @@
return serve()
})
server.listen(argv.port)
- console.log(chalk.cyan(`Started a Quartz server listening at http://localhost:${argv.port}`))
+ const wss = new WebSocketServer({ port: 3001 })
+ wss.on("connection", (ws) => connections.push(ws))
+ console.log(
+ chalk.cyan(
+ `Started a Quartz server listening at http://localhost:${argv.port}${argv.baseDir}`,
+ ),
+ )
console.log("hint: exit with ctrl+c")
chokidar
.watch(["**/*.ts", "**/*.tsx", "**/*.scss", "package.json"], {
ignoreInitial: true,
})
.on("all", async () => {
- console.log(chalk.yellow("Detected a source code change, doing a hard rebuild..."))
rebuild(clientRefresh)
})
} else {
--
Gitblit v1.10.0