Merge pull request #72 from bloomuporg/main

fix: allow revalidateTags to also be called with an array of tags

Author: RomanBobrovskiy

packages/cache-core/__tests__/cacheHandler.spec.ts

@@ -372,6 +372,22 @@ describe('CacheHandler', () => {
     expect(mockLogger.info).toHaveBeenNthCalledWith(1, `Revalidate by path ${mockCacheKey}`)
   })
 
+  it('should revalidate multiple paths when passed as array', async () => {
+    Cache.setConfig({
+      logger: mockLogger,
+      cache: new FileSystemCache()
+    })
+    const cacheHandler = new Cache(mockNextHandlerContext)
+    const paths = [`${NEXT_CACHE_IMPLICIT_TAG_ID}path1`, `${NEXT_CACHE_IMPLICIT_TAG_ID}path2`]
+
+    await cacheHandler.revalidateTag(paths)
+
+    expect(mockLogger.info).toHaveBeenCalledTimes(2)
+    expect(mockLogger.info).toHaveBeenNthCalledWith(1, 'Revalidate by path path1')
+    expect(mockLogger.info).toHaveBeenNthCalledWith(2, 'Revalidate by path path2')
+    expect(mockDeleteAllByKeyMatchData).toHaveBeenCalledTimes(2)
+  })
+
   it('should log when revalidate tag', async () => {
     Cache.setConfig({
       logger: mockLogger,
@@ -385,6 +401,41 @@ describe('CacheHandler', () => {
     expect(mockLogger.info).toHaveBeenNthCalledWith(1, `Revalidate by tag ${mockCacheKey}`)
   })
 
+  it('should revalidate multiple tags when passed as array', async () => {
+    Cache.setConfig({
+      logger: mockLogger,
+      cache: new FileSystemCache()
+    })
+    const cacheHandler = new Cache(mockNextHandlerContext)
+    const tags = ['tag1', 'tag2', 'tag3']
+
+    await cacheHandler.revalidateTag(tags)
+
+    expect(mockLogger.info).toHaveBeenCalledTimes(3)
+    expect(mockLogger.info).toHaveBeenNthCalledWith(1, 'Revalidate by tag tag1')
+    expect(mockLogger.info).toHaveBeenNthCalledWith(2, 'Revalidate by tag tag2')
+    expect(mockLogger.info).toHaveBeenNthCalledWith(3, 'Revalidate by tag tag3')
+    expect(mockRevalidateTagData).toHaveBeenCalledTimes(3)
+  })
+
+  it('should handle mixed array of paths and regular tags', async () => {
+    Cache.setConfig({
+      logger: mockLogger,
+      cache: new FileSystemCache()
+    })
+    const cacheHandler = new Cache(mockNextHandlerContext)
+    const tags = [`${NEXT_CACHE_IMPLICIT_TAG_ID}path1`, 'regularTag', `${NEXT_CACHE_IMPLICIT_TAG_ID}path2`]
+
+    await cacheHandler.revalidateTag(tags)
+
+    expect(mockLogger.info).toHaveBeenCalledTimes(3)
+    expect(mockLogger.info).toHaveBeenNthCalledWith(1, 'Revalidate by path path1')
+    expect(mockLogger.info).toHaveBeenNthCalledWith(2, 'Revalidate by tag regularTag')
+    expect(mockLogger.info).toHaveBeenNthCalledWith(3, 'Revalidate by path path2')
+    expect(mockDeleteAllByKeyMatchData).toHaveBeenCalledTimes(2)
+    expect(mockRevalidateTagData).toHaveBeenCalledTimes(1)
+  })
+
   it('should log when failed to revalidate tag', async () => {
     const errorMessage = 'error revalidate'
     mockRevalidateTagData.mockRejectedValueOnce(errorMessage)
@@ -404,6 +455,31 @@ describe('CacheHandler', () => {
     expect(mockLogger.error).toHaveBeenCalledWith(`Failed revalidate by ${mockCacheKey}`, errorMessage)
   })
 
+  it('should continue processing tags in array if one fails', async () => {
+    const errorMessage = 'error revalidate'
+    mockRevalidateTagData.mockRejectedValueOnce(errorMessage)
+
+    Cache.setConfig({
+      logger: mockLogger,
+      cache: new FileSystemCache()
+    })
+    const cacheHandler = new Cache(mockNextHandlerContext)
+    const tags = ['tag1', 'tag2', 'tag3']
+
+    await cacheHandler.revalidateTag(tags)
+
+    expect(mockLogger.info).toHaveBeenCalledTimes(3)
+    expect(mockLogger.info).toHaveBeenNthCalledWith(1, 'Revalidate by tag tag1')
+    expect(mockLogger.info).toHaveBeenNthCalledWith(2, 'Revalidate by tag tag2')
+    expect(mockLogger.info).toHaveBeenNthCalledWith(3, 'Revalidate by tag tag3')
+
+    expect(mockLogger.error).toHaveBeenCalledTimes(1)
+    expect(mockLogger.error).toHaveBeenCalledWith('Failed revalidate by tag1', errorMessage)
+
+    // Should continue with other tags despite the error
+    expect(mockRevalidateTagData).toHaveBeenCalledTimes(3)
+  })
+
   it('should log when failed to revalidate path', async () => {
     const errorMessage = 'error revalidate'
     mockDeleteAllByKeyMatchData.mockRejectedValueOnce(errorMessage)

packages/cache-core/src/cacheHandler.ts

@@ -241,39 +241,42 @@ export class Cache implements CacheHandler {
     }
   }
 
-  async revalidateTag(tag: string) {
-    try {
-      if (tag.startsWith(NEXT_CACHE_IMPLICIT_TAG_ID)) {
-        const [path, query] = tag.slice(NEXT_CACHE_IMPLICIT_TAG_ID.length).split('?')
-        Cache.config.logger.info(`Revalidate by path ${path}`)
-
-        if (query) {
-          try {
-            this.queryCacheKey = this.buildCacheKey(
-              Cache.config.cacheQueries.toSorted(),
-              Object.fromEntries(new URLSearchParams(query)),
-              'query'
-            )
-          } catch (err) {
-            Cache.config.logger.error('Error building cache key from path', err)
+  async revalidateTag(tags: string | string[]) {
+    const tagArray = Array.isArray(tags) ? tags : [tags]
+
+    for (const tag of tagArray) {
+      try {
+        if (tag.startsWith(NEXT_CACHE_IMPLICIT_TAG_ID)) {
+          const [path, query] = tag.slice(NEXT_CACHE_IMPLICIT_TAG_ID.length).split('?')
+          Cache.config.logger.info(`Revalidate by path ${path}`)
+
+          if (query) {
+            try {
+              this.queryCacheKey = this.buildCacheKey(
+                Cache.config.cacheQueries.toSorted(),
+                Object.fromEntries(new URLSearchParams(query)),
+                'query'
+              )
+            } catch (err) {
+              Cache.config.logger.error('Error building cache key from path', err)
+            }
           }
-        }
-
-        const pageKey = this.removeSlashFromStart(path)
 
-        await Cache.config.cache.deleteAllByKeyMatch(!pageKey.length ? 'index' : pageKey, this.buildPageCacheKey(), {
-          serverCacheDirPath: this.serverCacheDirPath
-        })
-      } else {
-        Cache.config.logger.info(`Revalidate by tag ${tag}`)
-        // TODO: (ISSUE-1650)
-        await Cache.config.cache.revalidateTag(tag, [], {
-          serverCacheDirPath: this.serverCacheDirPath
-        })
+          const pageKey = this.removeSlashFromStart(path)
+
+          await Cache.config.cache.deleteAllByKeyMatch(!pageKey.length ? 'index' : pageKey, this.buildPageCacheKey(), {
+            serverCacheDirPath: this.serverCacheDirPath
+          })
+        } else {
+          Cache.config.logger.info(`Revalidate by tag ${tag}`)
+          // TODO: (ISSUE-1650)
+          await Cache.config.cache.revalidateTag(tag, [], {
+            serverCacheDirPath: this.serverCacheDirPath
+          })
+        }
+      } catch (err) {
+        Cache.config.logger.error(`Failed revalidate by ${tag}`, err)
       }
-    } catch (err) {
-      Cache.config.logger.error(`Failed revalidate by ${tag}`, err)
-      return
     }
   }