Merge pull request #69 from DBB-Software/feat/PLATFORM-next15

feat: updated to support nextjs v15

Author: RomanBobrovskiy

package-lock.json

@@ -50,5 +50,8 @@
     "cookie": "0.6.0",
     "ua-parser-js": "1.0.37",
     "path-to-regexp": "6.2.2"
+  },
+  "peerDependencies": {
+    "next": "^14.1.0 || ^15.0.0"
   }
 }

packages/cache-core/package.json

@@ -4,13 +4,14 @@ import parser from 'ua-parser-js'
 import crypto from 'crypto'
 import { pathToRegexp } from 'path-to-regexp'
 import { NEXT_CACHE_IMPLICIT_TAG_ID } from 'next/dist/lib/constants'
-import type {
+import {
   NextCacheHandlerContext,
   CacheHandlerContext,
   CacheEntry,
   IncrementalCacheValue,
   CacheConfig,
-  CacheHandler
+  CacheHandler,
+  CachedRouteKind
 } from '../src/types'
 import { ConsoleLogger } from './logger'
 import { FileSystemCache } from './strategies/fileSystem'
@@ -184,7 +185,7 @@ export class Cache implements CacheHandler {
   }
 
   private transformCacheData(data: CacheEntry): CacheEntry {
-    if (data.value?.kind === 'ROUTE') {
+    if (data.value?.kind === CachedRouteKind.ROUTE || data.value?.kind === CachedRouteKind.APP_ROUTE) {
       return {
         ...data,
         value: {
@@ -193,12 +194,21 @@ export class Cache implements CacheHandler {
         }
       }
     }
+    if (data.value?.kind === CachedRouteKind.APP_PAGE) {
+      return {
+        ...data,
+        value: {
+          ...data.value,
+          rscData: Buffer.from(data.value.rscData as unknown as string, 'base64')
+        }
+      }
+    }
     return data
   }
 
   async set(pageKey: string, data: IncrementalCacheValue | null, ctx: CacheHandlerContext): Promise<void> {
     try {
-      if (!this.checkIsPathToCache(pageKey) || ['IMAGE', 'REDIRECT', 'FETCH'].includes(data?.kind ?? '')) return
+      if (!this.checkIsPathToCache(pageKey)) return
 
       Cache.config.logger.info(`Writing cache for ${pageKey}`)
       const context = {

packages/cache-core/src/cacheHandler.ts

@@ -1,8 +1,81 @@
-import type { IncrementalCacheKindHint, IncrementalCacheValue } from 'next/dist/server/response-cache'
+import type { IncrementalCacheKindHint } from 'next/dist/server/response-cache'
+import type { OutgoingHttpHeaders } from 'http'
 import type { CacheHandlerContext as NextCacheHandlerContext } from 'next/dist/server/lib/incremental-cache'
 import type { BaseLogger } from '../logger'
 
-export { NextCacheHandlerContext, IncrementalCacheValue, IncrementalCacheKindHint }
+export { NextCacheHandlerContext, IncrementalCacheKindHint }
+
+export type AnyObject = Record<string, any>
+
+export const enum CachedRouteKind {
+  APP_PAGE = 'APP_PAGE',
+  APP_ROUTE = 'APP_ROUTE',
+  ROUTE = 'ROUTE',
+  PAGES = 'PAGES',
+  PAGE = 'PAGE',
+  FETCH = 'FETCH',
+  REDIRECT = 'REDIRECT',
+  IMAGE = 'IMAGE'
+}
+
+export type CachedFetchData = {
+  headers: Record<string, string>
+  body: string
+  url: string
+  status?: number
+}
+
+export interface CachedFetchValue {
+  kind: CachedRouteKind.FETCH
+  data: CachedFetchData
+  tags?: string[]
+  revalidate: number
+}
+export interface CachedRedirectValue {
+  kind: CachedRouteKind.REDIRECT
+  props: AnyObject
+}
+
+export interface IncrementalCachedAppPageValue {
+  kind: CachedRouteKind.APP_PAGE
+  html: string
+  rscData: Buffer | undefined
+  headers: OutgoingHttpHeaders | undefined
+  postponed: string | undefined
+  status: number | undefined
+  segmentData: Map<string, Buffer> | undefined
+}
+export interface IncrementalCachedPageValue {
+  kind: CachedRouteKind.PAGES | CachedRouteKind.PAGE
+  html: string
+  pageData: AnyObject
+  headers: OutgoingHttpHeaders | undefined
+  status: number | undefined
+}
+
+export interface CachedRouteValue {
+  kind: CachedRouteKind.APP_ROUTE | CachedRouteKind.ROUTE
+  body: Buffer
+  status: number
+  headers: OutgoingHttpHeaders
+}
+export interface CachedImageValue {
+  kind: CachedRouteKind.IMAGE
+  etag: string
+  upstreamEtag: string
+  buffer: Buffer
+  extension: string
+  isMiss?: boolean
+  isStale?: boolean
+}
+
+export type IncrementalCacheValue =
+  | CachedRedirectValue
+  | IncrementalCachedPageValue
+  | IncrementalCachedAppPageValue
+  | CachedImageValue
+  | CachedFetchValue
+  | CachedRouteValue
 
 export interface CacheEntry {
   value: IncrementalCacheValue | null

packages/cache-core/src/types/index.ts

@@ -8,7 +8,7 @@
     "build": "rm -rf lib && rollup -c --bundleConfigAsCjs"
   },
   "peerDependencies": {
-    "next": "^14.1.0"
+    "next": "^14.1.0 || ^15.0.0"
   },
   "devDependencies": {
     "tsconfig": "*"

packages/common/package.json

@@ -1,11 +1,9 @@
-import { IncrementalCacheValue } from 'next/dist/server/response-cache'
 import { NEXT_CACHE_TAGS_HEADER } from 'next/dist/lib/constants'
 
 export const chunkArray = <T>(array: T[], chunkSize: number): T[][] =>
   Array.from({ length: Math.ceil(array.length / chunkSize) }, (v, i) =>
     array.slice(i * chunkSize, i * chunkSize + chunkSize)
   )
 
-export const checkHeaderTags = (value: IncrementalCacheValue | null, tag: string) =>
-  (value?.kind === 'PAGE' || value?.kind === 'ROUTE') &&
-  value.headers?.[NEXT_CACHE_TAGS_HEADER]?.toString()?.split(',').includes(tag)
+export const checkHeaderTags = (value: Record<string, any> | null, tag: string) =>
+  value?.headers?.[NEXT_CACHE_TAGS_HEADER]?.toString()?.split(',').includes(tag)

packages/common/src/utils/index.ts

@@ -9,7 +9,7 @@ import {
   RedisScripts,
   SchemaFieldTypes
 } from 'redis'
-import type { CacheEntry } from '@dbbs/next-cache-handler-core'
+import { CachedRouteKind, type CacheEntry } from '@dbbs/next-cache-handler-core'
 import { RedisAdapter, RedisJSON } from './types'
 import { CHUNK_LIMIT } from './constants'
 
@@ -54,10 +54,18 @@ export class RedisStack implements RedisAdapter {
   }
 
   async set(pageKey: string, cacheKey: string, data: CacheEntry): Promise<void> {
-    const headersTags =
-      data?.value?.kind === 'PAGE' || data?.value?.kind === 'ROUTE'
-        ? data?.value?.headers?.[NEXT_CACHE_TAGS_HEADER]?.toString()
-        : ''
+    const kind = data?.value?.kind
+    let headersTags = ''
+
+    if (
+      kind === CachedRouteKind.PAGE ||
+      kind === CachedRouteKind.PAGES ||
+      kind === CachedRouteKind.ROUTE ||
+      kind === CachedRouteKind.APP_ROUTE
+    ) {
+      headersTags = data?.value?.headers?.[NEXT_CACHE_TAGS_HEADER]?.toString() ?? ''
+    }
+
     const generalTags = [headersTags, data?.tags?.join(SEPARATOR)].filter(Boolean).join(SEPARATOR)
 
     const cacheData = { ...data, currentCacheKey: cacheKey, generalTags }