fix(file): delete cache file if corrupted (#97)

Author: Julien-R44

.changeset/kind-needles-sing.md

@@ -0,0 +1,5 @@
+---
+'bentocache': patch
+---
+
+Delete cache file if corrupted. See #93

packages/bentocache/src/drivers/file/cleaner.js

@@ -19,6 +19,16 @@ async function deleteFileIfExpired({ filePath, onError }) {
 
     if (expiry < Date.now()) await unlink(filePath)
   } catch (error) {
+    /**
+     * If the file is empty or contains invalid JSON, we should delete it
+     * as its a corrupted cache file that wont be readable anyway
+     */
+    if (error instanceof SyntaxError) {
+      if (onError) onError({ filePath, error })
+      await unlink(filePath).catch(() => {})
+      return
+    }
+
     if (onError) onError({ filePath, error })
   }
 }

packages/bentocache/tests/drivers/file.spec.ts

@@ -41,7 +41,7 @@ test.group('File Driver | Prune', () => {
     assert.isTrue(await fs.exists('foo4'))
   })
 
-  test('continue if invalid file is inside the cache directory', async ({
+  test('delete corrupted cache files (invalid JSON) during prune', async ({
     assert,
     fs,
     cleanup,
@@ -59,11 +59,28 @@ test.group('File Driver | Prune', () => {
 
     await sleep(1000)
 
-    assert.isTrue(await fs.exists('foo'))
+    assert.isFalse(await fs.exists('foo'))
     assert.isFalse(await fs.exists('foo2'))
     assert.isFalse(await fs.exists('foo3/1'))
   })
 
+  test('delete empty cache files during prune', async ({ assert, fs, cleanup }) => {
+    const driver = new FileDriver({
+      pruneInterval: 500,
+      directory: fileURLToPath(BASE_URL),
+    })
+
+    cleanup(() => driver.disconnect())
+
+    await fs.create('emptyFile', '')
+    await driver.set('validKey', 'bar', 300)
+
+    await sleep(1000)
+
+    assert.isFalse(await fs.exists('emptyFile'))
+    assert.isFalse(await fs.exists('validKey'))
+  })
+
   test('use configured logger', async ({ assert, fs, cleanup }) => {
     const logger = testLogger()
     const driver = new FileDriver({