fix(bundle-source): Accommodate Windows lack of atomic rename (merge #…

…1957)
endojs · Jan 11, 2024 · 6bbcc75 · 6bbcc75
2 parents b3bed95 + 48135aa
commit 6bbcc75
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 5 deletions.
diff --git a/packages/bundle-source/cache.js b/packages/bundle-source/cache.js
@@ -296,12 +296,13 @@ export const makeNodeBundleCache = async (
   pid,
   nonce,
 ) => {
-  const [fs, path, url, crypto, timers] = await Promise.all([
+  const [fs, path, url, crypto, timers, os] = await Promise.all([
     await loadModule('fs'),
     await loadModule('path'),
     await loadModule('url'),
     await loadModule('crypto'),
     await loadModule('timers'),
+    await loadModule('os'),
   ]);
 
   if (nonce === undefined) {
@@ -316,6 +317,6 @@ export const makeNodeBundleCache = async (
 
   const cwd = makeFileReader('', { fs, path });
   await fs.promises.mkdir(dest, { recursive: true });
-  const destWr = makeAtomicFileWriter(dest, { fs, path }, pid, nonce);
+  const destWr = makeAtomicFileWriter(dest, { fs, path, os }, pid, nonce);
   return makeBundleCache(destWr, cwd, readPowers, options);
 };
diff --git a/packages/bundle-source/src/fs.js b/packages/bundle-source/src/fs.js
@@ -120,19 +120,34 @@ export const makeFileWriter = (
  *       >,
  *     },
  *   path: Pick<import('path'), 'resolve' | 'relative' | 'normalize'>,
+ *   os: Pick<import('os'), 'platform'>,
  * }} io
  * @param {number} [pid]
  * @param {number} [nonce]
  * @param {(there: string) => ReturnType<makeAtomicFileWriter>} make
  */
 export const makeAtomicFileWriter = (
   fileName,
-  { fs, path },
+  { fs, path, os },
   pid = undefined,
   nonce = undefined,
-  make = there => makeAtomicFileWriter(there, { fs, path }, pid, nonce, make),
+  make = there =>
+    makeAtomicFileWriter(there, { fs, path, os }, pid, nonce, make),
 ) => {
   const writer = makeFileWriter(fileName, { fs, path }, make);
+
+  // Windows does not support atomic rename so we do the next best albeit racey
+  // thing.
+  if (os.platform() === 'win32') {
+    return harden({
+      ...writer,
+      atomicWriteText: async (txt, opts) => {
+        await writer.writeText(txt, opts);
+        return writer.readOnly().stat();
+      },
+    });
+  }
+
   return harden({
     ...writer,
     atomicWriteText: async (txt, opts) => {

diff --git a/packages/bundle-source/src/tool.js b/packages/bundle-source/src/tool.js
@@ -5,7 +5,7 @@ import { main } from './main.js';
 const { Fail } = assert;
 
 /* global process */
-const allowedModules = ['fs', 'path', 'url', 'crypto', 'timers'];
+const allowedModules = ['fs', 'path', 'url', 'crypto', 'timers', 'os'];
 const loadModule = spec => {
   allowedModules.includes(spec) || Fail`Not allowed to import ${spec}`;
   return import(spec);