attempt to fix flakey tests on win

Author: gmaclennan

test/reader-watch.test.js

@@ -10,23 +10,14 @@ import { createReaderWatch } from '../src/reader-watch.js'
 
 /** @import {Reader} from 'styled-map-package' */
 
+const isWin = process.platform === 'win32'
 const __dirname = path.dirname(fileURLToPath(import.meta.url))
 const FIXTURE1_PATH = path.join(__dirname, 'fixtures', 'demotiles-z2.smp')
 const FIXTURE2_PATH = path.join(__dirname, 'fixtures', 'osm-bright-z6.smp')
 
 /** @param {import('node:test').TestContext} t */
-function tempDir(t) {
-	const dir = fs.mkdtempSync(path.join(tmpdir(), 'comapeo-map-server-'))
-	t.after(async () => {
-		console.log('tempDir cleanup')
-		// Wait on Windows to ensure all file handles are released
-		if (process.platform === 'win32') {
-			await setTimeout(1000)
-		}
-		console.log('attempting to delete')
-		fs.rmSync(dir, { recursive: true, force: true })
-	})
-	return dir
+function tempDir() {
+	return fs.mkdtempSync(path.join(tmpdir(), 'comapeo-map-server-'))
 }
 
 test('createReaderWatch - valid smp file', async (t) => {
@@ -41,12 +32,15 @@ test('createReaderWatch - valid smp file', async (t) => {
 })
 
 test('createReaderWatch - file does not exist initially', async (t) => {
-	const dir = tempDir(t)
+	const dir = tempDir()
 	const nonExistentPath = path.join(dir, 'nonexistent.smp')
 	assert(!fs.existsSync(nonExistentPath), 'File should not exist yet')
 
 	const getReader = createReaderWatch(nonExistentPath)
-	t.after(getReader.close)
+	t.after(async () => {
+		await getReader.close()
+		await rmDir(dir)
+	})
 	const reader1 = getReader()
 	// Attempting to read from non-existent file should throw
 	await assert.rejects(
@@ -55,33 +49,34 @@ test('createReaderWatch - file does not exist initially', async (t) => {
 		'Reading from non-existent file should throw error with ENOENT code and filepath in message',
 	)
 	fs.copyFileSync(FIXTURE1_PATH, nonExistentPath)
-	await setTimeout(200) // Wait for watcher to detect change
+	await syncDir(dir) // Ensure copy is flushed and directory is synced
 	const reader2 = getReader()
 	// Now the reader should point to the new file
 	const style = await reader2.getStyle()
 	assert(style, 'Style should be readable after file is created')
 })
 
 test('createReaderWatch - file is replaced with different file', async (t) => {
-	const dir = tempDir(t)
+	const dir = tempDir()
 	const targetPath = path.join(dir, 'replaced.smp')
 
 	// Start with the fixture file
 	fs.copyFileSync(FIXTURE1_PATH, targetPath)
-	// Ensure file is fully written (otherwise the copy triggers the watcher)
-	await setTimeout(200)
+	await syncDir(dir)
 
 	const getReader = createReaderWatch(targetPath)
-	t.after(getReader.close)
+	t.after(async () => {
+		await getReader.close()
+		await rmDir(dir)
+	})
 
 	// Read from initial file
 	const reader1 = getReader()
 	const style1 = await reader1.getStyle()
 	assert.equal(style1.name, 'MapLibre', 'Expected style name from fixture 1')
 
 	fs.copyFileSync(FIXTURE2_PATH, targetPath)
-	// Wait for file system watcher to detect the change
-	await setTimeout(200)
+	await syncDir(dir)
 
 	// The reader should be recreated
 	const reader2 = getReader()
@@ -90,13 +85,16 @@ test('createReaderWatch - file is replaced with different file', async (t) => {
 })
 
 test('createReaderWatch - file is deleted', async (t) => {
-	const dir = tempDir(t)
+	const dir = tempDir()
 	const targetPath = path.join(dir, 'to-delete.smp')
 	fs.copyFileSync(FIXTURE1_PATH, targetPath)
 	await setTimeout(200) // Ensure file is fully written
 
 	const getReader = createReaderWatch(targetPath)
-	t.after(getReader.close)
+	t.after(async () => {
+		await getReader.close()
+		await rmDir(dir)
+	})
 
 	const reader1 = getReader()
 	const style1 = await reader1.getStyle()
@@ -108,7 +106,7 @@ test('createReaderWatch - file is deleted', async (t) => {
 
 	// Delete the file
 	fs.unlinkSync(targetPath)
-	await setTimeout(200) // Wait for watcher to detect change
+	await syncDir(dir)
 
 	const reader2 = getReader()
 	try {
@@ -126,15 +124,18 @@ test('createReaderWatch - file is deleted', async (t) => {
 })
 
 test('createReaderWatch - invalid file (non-smp file)', async (t) => {
-	const dir = tempDir(t)
+	const dir = tempDir()
 	const invalidPath = path.join(dir, 'invalid.smp')
 
 	// Create an invalid file (just some text)
 	fs.writeFileSync(invalidPath, 'This is not a valid SMP file')
-	await setTimeout(200) // Ensure file is fully written
+	await syncDir(dir)
 
 	const getReader = createReaderWatch(invalidPath)
-	t.after(getReader.close)
+	t.after(async () => {
+		await getReader.close()
+		await rmDir(dir)
+	})
 
 	const reader = getReader()
 	assert(reader, 'Reader instance should be returned even for invalid file')
@@ -146,7 +147,7 @@ test('createReaderWatch - invalid file (non-smp file)', async (t) => {
 	)
 
 	fs.copyFileSync(FIXTURE1_PATH, invalidPath)
-	await setTimeout(200) // Wait for watcher to detect change
+	await syncDir(dir)
 
 	const reader2 = getReader()
 	const style = await reader2.getStyle()
@@ -158,12 +159,15 @@ test('createReaderWatch - invalid file (non-smp file)', async (t) => {
 })
 
 test('createReaderWatch - close() cleans up watcher', async (t) => {
-	const dir = tempDir(t)
+	const dir = tempDir()
 	const targetPath = path.join(dir, 'to-close.smp')
 	fs.copyFileSync(FIXTURE1_PATH, targetPath)
-	await setTimeout(200) // Ensure file is fully written
+	await syncDir(dir)
 
 	const getReader = createReaderWatch(targetPath)
+	t.after(async () => {
+		await rmDir(dir)
+	})
 
 	const reader1 = getReader()
 	const style = await reader1.getStyle()
@@ -174,7 +178,7 @@ test('createReaderWatch - close() cleans up watcher', async (t) => {
 
 	// Modify the file after closing
 	fs.copyFileSync(FIXTURE2_PATH, targetPath)
-	await setTimeout(200) // Wait to see if any watcher events occur
+	await syncDir(dir)
 
 	const reader2 = getReader()
 	// The reader should still be the old instance
@@ -194,14 +198,17 @@ test('createReaderWatch - close() cleans up watcher', async (t) => {
 
 test('createReaderWatch - AbortSignal integration', async (t) => {
 	const controller = new AbortController()
-	const dir = tempDir(t)
+	const dir = tempDir()
 	const targetPath = path.join(dir, 'with-signal.smp')
 	fs.copyFileSync(FIXTURE1_PATH, targetPath)
-	await setTimeout(200) // Ensure file is fully written
+	await syncDir(dir)
 	const getReader = createReaderWatch(targetPath, {
 		signal: controller.signal,
 	})
-	t.after(getReader.close)
+	t.after(async () => {
+		await getReader.close()
+		await rmDir(dir)
+	})
 
 	const reader = getReader()
 	const style = await reader.getStyle()
@@ -211,7 +218,7 @@ test('createReaderWatch - AbortSignal integration', async (t) => {
 	controller.abort()
 
 	fs.copyFileSync(FIXTURE2_PATH, targetPath)
-	await setTimeout(200)
+	await syncDir(dir)
 
 	// reader should still be same instance because watcher is closed
 	const reader2 = getReader()
@@ -229,18 +236,22 @@ test('createReaderWatch - AbortSignal integration', async (t) => {
 })
 
 test('createReaderWatch - watcher only recreates reader for target file changes', async (t) => {
-	const dir = tempDir(t)
+	const dir = tempDir()
 
 	const targetPath = path.join(dir, 'target.smp')
 	const otherPath = path.join(dir, 'other-file.txt')
 
 	// Copy fixture to target
 	fs.copyFileSync(FIXTURE1_PATH, targetPath)
-	await setTimeout(200) // Ensure file is fully written
+	await syncDir(dir)
 
 	const getReader = createReaderWatch(targetPath)
 
 	const reader1 = getReader()
+	t.after(async () => {
+		await getReader.close()
+		await rmDir(dir)
+	})
 	const style1 = await reader1.getStyle()
 	assert(style1, 'Initial style should be readable')
 
@@ -249,7 +260,7 @@ test('createReaderWatch - watcher only recreates reader for target file changes'
 	// the reader should NOT be recreated. However, on some platforms filename
 	// may be null, causing recreation. We test the happy path here.
 	fs.writeFileSync(otherPath, 'Some other content')
-	await setTimeout(200) // Ensure file is fully written
+	await syncDir(dir)
 
 	// reader should be same instance (not changed because of file watcher)
 	const reader2 = getReader()
@@ -282,3 +293,16 @@ async function concat(stream) {
 	}
 	return Buffer.concat(chunks)
 }
+
+/** @param {string} dirPath */
+async function syncDir(dirPath) {
+	const dh = await fs.promises.open(dirPath, 'r')
+	await dh.sync()
+	await dh.close()
+	await setTimeout(isWin ? 50 : 10)
+}
+
+/** @param {string} dirPath */
+async function rmDir(dirPath) {
+	await fs.promises.rm(dirPath, { recursive: true, force: true, maxRetries: 5 })
+}