fix(vue-tsc): handle concurrency when setting up plugin (#643)

Author: kitsune7

.gitignore

@@ -110,4 +110,7 @@ dist
 lib/
 playground-temp/
 packages/runtime/public/build/bundle.js
-docs/.vitepress/cache
+docs/.vitepress/cache
+
+# vue-tsc fixture lock
+.vue-tsc-fixture.lock

packages/vite-plugin-checker/package.json

@@ -37,13 +37,15 @@
     "npm-run-path": "^6.0.0",
     "picocolors": "^1.1.1",
     "picomatch": "^4.0.3",
+    "proper-lockfile": "^4.1.2",
     "tiny-invariant": "^1.3.3",
     "tinyglobby": "^0.2.15",
     "vscode-uri": "^3.1.0"
   },
   "devDependencies": {
     "@types/eslint": "^8.56.12",
     "@types/picomatch": "^4.0.2",
+    "@types/proper-lockfile": "^4.1.4",
     "@vue/language-core": "~3.2.6",
     "meow": "^13.2.0",
     "stylelint": "^16.22.0",

packages/vite-plugin-checker/src/checkers/vueTsc/prepareVueTsc.ts

@@ -2,6 +2,7 @@ import { access, cp, mkdir, readFile, rm, writeFile } from 'node:fs/promises'
 import { createRequire } from 'node:module'
 import path, { dirname } from 'node:path'
 import { fileURLToPath } from 'node:url'
+import lockfile from 'proper-lockfile'
 
 const _require = createRequire(import.meta.url)
 
@@ -17,8 +18,30 @@ const proxyApiPath = _require.resolve(
 )
 const extraSupportedExtensions = ['.vue']
 
+const LOCK_TIMEOUT_MS = 60000 // Max wait time
+const STALE_TIMEOUT_MS = 30000 // Auto-release stale locks
+
+async function isFixtureValid(
+  targetTsDir: string,
+  vueTscFlagFile: string,
+  currTsVersion: string,
+) {
+  try {
+    await access(targetTsDir)
+    const targetTsVersion = JSON.parse(
+      await readFile(path.resolve(targetTsDir, 'package.json'), 'utf8'),
+    ).version
+    await access(vueTscFlagFile)
+    const fixtureFlagContent = await readFile(vueTscFlagFile, 'utf8')
+    return (
+      targetTsVersion === currTsVersion && fixtureFlagContent === proxyApiPath
+    )
+  } catch {
+    return false
+  }
+}
+
 export async function prepareVueTsc() {
-  // 1. copy typescript to folder
   const targetTsDir = path.resolve(_dirname, 'typescript-vue-tsc')
   const vueTscFlagFile = path.resolve(targetTsDir, 'vue-tsc-resolve-path')
   const currTsVersion = _require('typescript/package.json').version
@@ -30,37 +53,49 @@ export async function prepareVueTsc() {
     )
   }
 
-  let shouldBuildFixture = true
+  if (await isFixtureValid(targetTsDir, vueTscFlagFile, currTsVersion)) {
+    return { targetTsDir }
+  }
+
+  let release: Awaited<ReturnType<typeof lockfile.lock>>
+  try {
+    release = await lockfile.lock(_dirname, {
+      lockfilePath: path.resolve(_dirname, '.vue-tsc-fixture.lock'),
+      stale: STALE_TIMEOUT_MS,
+      retries: {
+        retries: Math.ceil(LOCK_TIMEOUT_MS / 1000),
+        factor: 1,
+        minTimeout: 1000,
+        maxTimeout: 2000,
+        randomize: true,
+      },
+    })
+  } catch (err) {
+    throw new Error(
+      '[vite-plugin-checker] Failed to acquire lock for vue-tsc fixture preparation. ' +
+        'Another process may be holding the lock.\n' +
+        String(err),
+    )
+  }
+
   try {
-    await access(targetTsDir)
-    const targetTsVersion = _require(
-      path.resolve(targetTsDir, 'package.json'),
-    ).version
-    // check fixture versions before re-use
-    await access(vueTscFlagFile)
-    const fixtureFlagContent = await readFile(vueTscFlagFile, 'utf8')
-    if (
-      targetTsVersion === currTsVersion &&
-      fixtureFlagContent === proxyApiPath
-    ) {
-      shouldBuildFixture = false
+    // Double-check that the fixture is valid, another process may have built while trying to acquire the lock
+    if (await isFixtureValid(targetTsDir, vueTscFlagFile, currTsVersion)) {
+      return { targetTsDir }
     }
-  } catch {
-    // no matter what error, we should rebuild the fixture
-    shouldBuildFixture = true
-  }
 
-  if (shouldBuildFixture) {
     await rm(targetTsDir, { force: true, recursive: true })
     await mkdir(targetTsDir, { recursive: true })
     const sourceTsDir = path.resolve(_require.resolve('typescript'), '../..')
     await cp(sourceTsDir, targetTsDir, { recursive: true })
     await writeFile(vueTscFlagFile, proxyApiPath)
 
-    // 2. sync modification of lib/tsc.js with vue-tsc
+    // sync modification of lib/tsc.js with vue-tsc
     await overrideTscJs(
       _require.resolve(path.resolve(targetTsDir, 'lib/typescript.js')),
     )
+  } finally {
+    await release()
   }
 
   return { targetTsDir }