Stabilize watch tests (#4318)

lukastaegert · web-flow · commit 7f555711104e · 2021-12-30T07:43:27.000+01:00
* Use atomic file writes

* Use atomic file writes for regular watch tests

* Increase timeout
diff --git a/test/cli/samples/wait-for-bundle-input-object/_config.js b/test/cli/samples/wait-for-bundle-input-object/_config.js
@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+const { atomicWriteFileSync } = require('../../../utils');
 
 let second;
 let third;
@@ -17,9 +18,9 @@ module.exports = {
 	},
 	abortOnStderr(data) {
 		if (data.includes('waiting for input second')) {
-			fs.writeFileSync(second, "export default 'second'");
+			atomicWriteFileSync(second, "export default 'second'");
 		} else if (data.includes('waiting for input third')) {
-			fs.writeFileSync(third, "export default 'third'");
+			atomicWriteFileSync(third, "export default 'third'");
 		}
 	}
 };
diff --git a/test/cli/samples/wait-for-bundle-input/_config.js b/test/cli/samples/wait-for-bundle-input/_config.js
@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+const { atomicWriteFileSync } = require('../../../utils');
 
 let mainFile;
 
@@ -15,7 +16,7 @@ module.exports = {
 	abortOnStderr(data) {
 		if (data.includes('waiting for input main.js')) {
 			// wait longer than one polling interval
-			setTimeout(() => fs.writeFileSync(mainFile, 'export default 42;'), 600);
+			setTimeout(() => atomicWriteFileSync(mainFile, 'export default 42;'), 600);
 		}
 	}
 };
diff --git a/test/cli/samples/watch/bundle-error/_config.js b/test/cli/samples/watch/bundle-error/_config.js
@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+const { atomicWriteFileSync } = require('../../../../utils');
 
 let mainFile;
 
@@ -16,7 +17,7 @@ module.exports = {
 	},
 	abortOnStderr(data) {
 		if (data.includes('Error: Unexpected token')) {
-			setTimeout(() => fs.writeFileSync(mainFile, 'export default 42;'), 500);
+			setTimeout(() => atomicWriteFileSync(mainFile, 'export default 42;'), 500);
 			return false;
 		}
 		if (data.includes('created _actual')) {
diff --git a/test/cli/samples/watch/watch-config-early-update/_config.js b/test/cli/samples/watch/watch-config-early-update/_config.js
@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+const { atomicWriteFileSync } = require('../../../../utils');
 
 let configFile;
 
@@ -34,7 +35,7 @@ module.exports = {
 	},
 	abortOnStderr(data) {
 		if (data === 'initial\n') {
-			fs.writeFileSync(
+			atomicWriteFileSync(
 				configFile,
 				`
 				console.error('updated');
diff --git a/test/cli/samples/watch/watch-config-error/_config.js b/test/cli/samples/watch/watch-config-error/_config.js
@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+const { atomicWriteFileSync } = require('../../../../utils');
 
 let configFile;
 
@@ -25,12 +26,12 @@ module.exports = {
 	},
 	abortOnStderr(data) {
 		if (data.includes(`created _actual${path.sep}main1.js`)) {
-			fs.writeFileSync(configFile, 'throw new Error("Config contains errors");');
+			atomicWriteFileSync(configFile, 'throw new Error("Config contains errors");');
 			return false;
 		}
 		if (data.includes('Config contains errors')) {
 			setTimeout(() => {
-				fs.writeFileSync(
+				atomicWriteFileSync(
 					configFile,
 					'export default {\n' +
 						'\tinput: "main.js",\n' +
diff --git a/test/cli/samples/watch/watch-config-initial-error/_config.js b/test/cli/samples/watch/watch-config-initial-error/_config.js
@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+const { atomicWriteFileSync } = require('../../../../utils');
 
 let configFile;
 
@@ -16,7 +17,7 @@ module.exports = {
 	async abortOnStderr(data) {
 		if (data.includes('Config contains initial errors')) {
 			await new Promise(resolve => setTimeout(resolve, 100));
-			fs.writeFileSync(
+			atomicWriteFileSync(
 				configFile,
 				'export default {\n' +
 					'\tinput: "main.js",\n' +
diff --git a/test/cli/samples/watch/watch-config-no-update/_config.js b/test/cli/samples/watch/watch-config-no-update/_config.js
@@ -1,5 +1,6 @@
 const fs = require('fs');
 const path = require('path');
+const { atomicWriteFileSync } = require('../../../../utils');
 
 let configFile;
 const configContent =
@@ -23,7 +24,7 @@ module.exports = {
 	},
 	abortOnStderr(data) {
 		if (data.includes('created _actual/main.js')) {
-			fs.writeFileSync(configFile, configContent);
+			atomicWriteFileSync(configFile, configContent);
 			return new Promise(resolve => setTimeout(() => resolve(true), 500));
 		}
 	},
diff --git a/test/utils.js b/test/utils.js
@@ -1,4 +1,5 @@
 const assert = require('assert');
+const fs = require('fs');
 const path = require('path');
 const fixturify = require('fixturify');
 const sander = require('sander');
@@ -14,6 +15,7 @@ exports.runTestSuiteWithSamples = runTestSuiteWithSamples;
 exports.assertDirectoriesAreEqual = assertDirectoriesAreEqual;
 exports.assertFilesAreEqual = assertFilesAreEqual;
 exports.assertIncludes = assertIncludes;
+exports.atomicWriteFileSync = atomicWriteFileSync;
 
 function normaliseError(error) {
 	delete error.stack;
@@ -220,3 +222,12 @@ function assertIncludes(actual, expected) {
 		throw err;
 	}
 }
+
+// Workaround a race condition in fs.writeFileSync that temporarily creates
+// an empty file for a brief moment which may be read by rollup watch - even
+// if the content being overwritten is identical.
+function atomicWriteFileSync(filePath, contents) {
+	const stagingPath = filePath + '_';
+	fs.writeFileSync(stagingPath, contents);
+	fs.renameSync(stagingPath, filePath);
+}
diff --git a/test/watch/index.js b/test/watch/index.js

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`const fs = require('fs');`
`2`	`2`	`const path = require('path');`
	`3`	`+const { atomicWriteFileSync } = require('../../../utils');`
`3`	`4`
`4`	`5`	`let mainFile;`
`5`	`6`
`@@ -15,7 +16,7 @@ module.exports = {`
`15`	`16`	`abortOnStderr(data) {`
`16`	`17`	`if (data.includes('waiting for input main.js')) {`
`17`	`18`	`// wait longer than one polling interval`
`18`		`- setTimeout(() => fs.writeFileSync(mainFile, 'export default 42;'), 600);`
	`19`	`+ setTimeout(() => atomicWriteFileSync(mainFile, 'export default 42;'), 600);`
`19`	`20`	`}`
`20`	`21`	`}`
`21`	`22`	`};`