fix: use handleRawCacheData in purgeTags event handler (#82)

dulnan · Nov 14, 2024 · 69e9bbe · 69e9bbe
1 parent a9068b3
commit 69e9bbe
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 5 deletions.
diff --git a/playground-disk/pages/cachedPageFromDisk.vue b/playground-disk/pages/cachedPageFromDisk.vue
@@ -10,6 +10,6 @@ const random = useState('random_data', () => {
 })
 
 useRouteCache((helper) => {
-  helper.setCacheable()
+  helper.setCacheable().addTags(['test_tag'])
 })
 </script>
diff --git a/src/runtime/server/api/purgeTags.ts b/src/runtime/server/api/purgeTags.ts
@@ -3,6 +3,7 @@ import { readBody, defineEventHandler, createError } from 'h3'
 import {
   decodeComponentCacheItem,
   decodeRouteCacheItem,
+  handleRawCacheData,
 } from '../../helpers/cacheItem'
 import { useMultiCacheApp } from '../utils/useMultiCacheApp'
 import { onlyUnique } from '../../helpers/server'
@@ -94,12 +95,16 @@ export class DebouncedInvalidator {
         return (item as any).cacheTags
       }
     } else if (cacheName === 'route') {
-      const cached = await this.cacheContext?.[cacheName]?.getItemRaw(key)
+      const cached = handleRawCacheData(
+        await this.cacheContext?.[cacheName]?.getItemRaw(key),
+      )
       if (cached) {
         return decodeRouteCacheItem(cached)?.cacheTags
       }
     } else if (cacheName === 'component') {
-      const cached = await this.cacheContext?.[cacheName]?.getItemRaw(key)
+      const cached = handleRawCacheData(
+        await this.cacheContext?.[cacheName]?.getItemRaw(key),
+      )
       if (cached) {
         return decodeComponentCacheItem(cached)?.cacheTags
       }

diff --git a/test/__helpers__/getRouteCacheItems.ts b/test/__helpers__/getRouteCacheItems.ts
@@ -0,0 +1,7 @@
+import { $fetch } from '@nuxt/test-utils/e2e'
+
+export default function (): Promise<any> {
+  return $fetch(`/__nuxt_multi_cache/stats/route`, {
+    method: 'get',
+  })
+}
diff --git a/test/__helpers__/purgeTags.ts b/test/__helpers__/purgeTags.ts
@@ -0,0 +1,9 @@
+import { $fetch } from '@nuxt/test-utils/e2e'
+
+export default function purgeTags(tags: string[] | string) {
+  const body: string[] = Array.isArray(tags) ? tags : [tags]
+  return $fetch(`/__nuxt_multi_cache/purge/tags`, {
+    method: 'post',
+    body: JSON.stringify(body),
+  })
+}
diff --git a/test/fileSystemDriver.e2e.spec.ts b/test/fileSystemDriver.e2e.spec.ts
@@ -2,8 +2,12 @@ import path from 'path'
 import { setup } from '@nuxt/test-utils/e2e'
 import { describe, test, expect } from 'vitest'
 import type { NuxtMultiCacheOptions } from '../src/runtime/types'
-import { createPageWithoutHydration } from './__helpers__'
+import { createPageWithoutHydration, sleep } from './__helpers__'
 import purgeAll from './__helpers__/purgeAll'
+import getRouteCacheItems from './__helpers__/getRouteCacheItems'
+import purgeByKey from './__helpers__/purgeByKey'
+import purgeTags from './__helpers__/purgeTags'
+import exp from 'constants'
 
 const multiCache: NuxtMultiCacheOptions = {
   route: {
@@ -15,7 +19,7 @@ const multiCache: NuxtMultiCacheOptions = {
   api: {
     enabled: true,
     authorization: false,
-    cacheTagInvalidationDelay: 5000,
+    cacheTagInvalidationDelay: 10,
   },
 }
 
@@ -66,4 +70,16 @@ describe('Caching with the file system driver', () => {
     const text3 = await page3.locator('#cached-component-number').innerText()
     expect(text3).to.not.equal(text1)
   })
+
+  test('correctly invalidates by tag for FS cache items', async () => {
+    await purgeAll()
+    await createPageWithoutHydration('/cachedPageFromDisk', 'en')
+    const data1 = await getRouteCacheItems()
+    expect(data1?.rows).toHaveLength(1)
+    await purgeTags('test_tag')
+    await sleep(1000)
+
+    const data2 = await getRouteCacheItems()
+    expect(data2?.rows).toHaveLength(0)
+  })
 })