fix: async-mutex not exclusively locking correectly

Jacky Zhao

2023-08-21 b69556c918e2a4a27b047e8de6b02861f04d5a9e

 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: {
@@ -135,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))
@@ -192,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")
      }
@@ -247,20 +255,20 @@
    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")
@@ -292,7 +300,6 @@

        // follow symlink and copy content
        await fs.promises.cp(linkTarg, contentFolder, {
          force: true,
          recursive: true,
          preserveTimestamps: true,
        })
@@ -302,7 +309,8 @@
        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
@@ -384,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)}`)
@@ -408,21 +425,39 @@
      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,
@@ -431,14 +466,15 @@
          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()
        }

@@ -484,14 +520,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 {