refactor: move non-CacheHandler related types and utils from cache-types to blob-types module

Author: pieh

src/build/content/static.ts

@@ -6,8 +6,8 @@ import { trace } from '@opentelemetry/api'
 import { wrapTracer } from '@opentelemetry/api/experimental'
 import glob from 'fast-glob'
 
+import type { HtmlBlob } from '../../shared/blob-types.cjs'
 import { encodeBlobKey } from '../../shared/blobkey.js'
-import type { HtmlBlob } from '../../shared/cache-types.cjs'
 import { PluginContext } from '../plugin-context.js'
 import { verifyNetlifyForms } from '../verification.js'
 

src/run/handlers/cache.cts

@@ -11,6 +11,7 @@ import type { PrerenderManifest } from 'next/dist/build/index.js'
 import { NEXT_CACHE_TAGS_HEADER } from 'next/dist/lib/constants.js'
 
 import { name as nextRuntimePkgName, version as nextRuntimePkgVersion } from '../../../package.json'
+import { type TagManifest } from '../../shared/blob-types.cjs'
 import {
   type CacheHandlerContext,
   type CacheHandlerForMultipleVersions,
@@ -20,7 +21,6 @@ import {
   type NetlifyCachedRouteValue,
   type NetlifyCacheHandlerValue,
   type NetlifyIncrementalCacheValue,
-  type TagManifest,
 } from '../../shared/cache-types.cjs'
 import {
   getMemoizedKeyValueStoreBackedByRegionalBlobStore,

src/run/next.cts

@@ -4,7 +4,7 @@ import { relative, resolve } from 'path'
 // @ts-expect-error no types installed
 import { patchFs } from 'fs-monkey'
 
-import { HtmlBlob } from '../shared/cache-types.cjs'
+import { HtmlBlob } from '../shared/blob-types.cjs'
 
 import { getRequestContext } from './handlers/request-context.cjs'
 import { getTracer } from './handlers/tracer.cjs'

src/run/storage/request-scoped-in-memory-cache.cts

@@ -1,7 +1,10 @@
+import { isPromise } from 'node:util/types'
+
 import { LRUCache } from 'lru-cache'
 
-import { type BlobType, estimateBlobSize } from '../../shared/cache-types.cjs'
+import { type BlobType, isHtmlBlob, isTagManifest } from '../../shared/blob-types.cjs'
 import { getRequestContext } from '../handlers/request-context.cjs'
+import { recordWarning } from '../handlers/tracer.cjs'
 
 // lru-cache types don't like using `null` for values, so we use a symbol to represent it and do conversion
 // so it doesn't leak outside
@@ -22,6 +25,46 @@ export function setInMemoryCacheMaxSizeFromNextConfig(size: unknown) {
   }
 }
 
+const estimateBlobSize = (valueToStore: BlobType | null | Promise<unknown>): number => {
+  // very approximate size calculation to avoid expensive exact size calculation
+  // inspired by https://github.com/vercel/next.js/blob/ed10f7ed0246fcc763194197eb9beebcbd063162/packages/next/src/server/lib/incremental-cache/file-system-cache.ts#L60-L79
+  if (valueToStore === null || isPromise(valueToStore) || isTagManifest(valueToStore)) {
+    return 25
+  }
+  if (isHtmlBlob(valueToStore)) {
+    return valueToStore.html.length
+  }
+  let knownKindFailed = false
+  try {
+    if (valueToStore.value?.kind === 'FETCH') {
+      return valueToStore.value.data.body.length
+    }
+    if (valueToStore.value?.kind === 'APP_PAGE') {
+      return valueToStore.value.html.length + (valueToStore.value.rscData?.length ?? 0)
+    }
+    if (valueToStore.value?.kind === 'PAGE' || valueToStore.value?.kind === 'PAGES') {
+      return valueToStore.value.html.length + JSON.stringify(valueToStore.value.pageData).length
+    }
+    if (valueToStore.value?.kind === 'ROUTE' || valueToStore.value?.kind === 'APP_ROUTE') {
+      return valueToStore.value.body.length
+    }
+  } catch {
+    // size calculation rely on the shape of the value, so if it's not what we expect, we fallback to JSON.stringify
+    knownKindFailed = true
+  }
+
+  // fallback for not known kinds or known kinds that did fail to calculate size
+  // we should also monitor cases when fallback is used because it's not the most efficient way to calculate/estimate size
+  // and might indicate need to make adjustments or additions to the size calculation
+  recordWarning(
+    new Error(
+      `Blob size calculation did fallback to JSON.stringify. Kind: KnownKindFailed: ${knownKindFailed}, ${valueToStore.value?.kind ?? 'undefined'}`,
+    ),
+  )
+
+  return JSON.stringify(valueToStore).length
+}
+
 function getInMemoryLRUCache() {
   if (typeof extendedGlobalThis[IN_MEMORY_LRU_CACHE] === 'undefined') {
     const maxSize =

src/run/storage/storage.cts

@@ -3,7 +3,7 @@
 // and should not be used directly outside of this directory.
 // There is eslint `no-restricted-imports` rule to enforce this.
 
-import { type BlobType } from '../../shared/cache-types.cjs'
+import { type BlobType } from '../../shared/blob-types.cjs'
 import { getTracer } from '../handlers/tracer.cjs'
 
 import { getRegionalBlobStore } from './regional-blob-store.cjs'

src/shared/blob-types.cts

@@ -0,0 +1,18 @@
+import { type NetlifyCacheHandlerValue } from './cache-types.cjs'
+
+export type TagManifest = { revalidatedAt: number }
+
+export type HtmlBlob = {
+  html: string
+  isFallback: boolean
+}
+
+export type BlobType = NetlifyCacheHandlerValue | TagManifest | HtmlBlob
+
+export const isTagManifest = (value: BlobType): value is TagManifest => {
+  return false
+}
+
+export const isHtmlBlob = (value: BlobType): value is HtmlBlob => {
+  return false
+}

src/shared/cache-types.cts

@@ -1,5 +1,3 @@
-import { isPromise } from 'node:util/types'
-
 import type {
   CacheHandler,
   CacheHandlerValue,
@@ -12,8 +10,6 @@ import type {
   IncrementalCacheValue,
 } from 'next/dist/server/response-cache/types.js'
 
-import { recordWarning } from '../run/handlers/tracer.cjs'
-
 export type { CacheHandlerContext } from 'next/dist/server/lib/incremental-cache/index.js'
 
 type CacheControl = {
@@ -158,60 +154,3 @@ export type CacheHandlerForMultipleVersions = BaseCacheHandlerForMultipleVersion
     context: CacheHandlerSetContextForMultipleVersions,
   ) => ReturnType<BaseCacheHandlerForMultipleVersions['set']>
 }
-
-export type TagManifest = { revalidatedAt: number }
-
-export type HtmlBlob = {
-  html: string
-  isFallback: boolean
-}
-
-export type BlobType = NetlifyCacheHandlerValue | TagManifest | HtmlBlob
-
-const isTagManifest = (value: BlobType): value is TagManifest => {
-  return false
-}
-
-const isHtmlBlob = (value: BlobType): value is HtmlBlob => {
-  return false
-}
-
-export const estimateBlobSize = (valueToStore: BlobType | null | Promise<unknown>): number => {
-  // very approximate size calculation to avoid expensive exact size calculation
-  // inspired by https://github.com/vercel/next.js/blob/ed10f7ed0246fcc763194197eb9beebcbd063162/packages/next/src/server/lib/incremental-cache/file-system-cache.ts#L60-L79
-  if (valueToStore === null || isPromise(valueToStore) || isTagManifest(valueToStore)) {
-    return 25
-  }
-  if (isHtmlBlob(valueToStore)) {
-    return valueToStore.html.length
-  }
-  let knownKindFailed = false
-  try {
-    if (valueToStore.value?.kind === 'FETCH') {
-      return valueToStore.value.data.body.length
-    }
-    if (valueToStore.value?.kind === 'APP_PAGE') {
-      return valueToStore.value.html.length + (valueToStore.value.rscData?.length ?? 0)
-    }
-    if (valueToStore.value?.kind === 'PAGE' || valueToStore.value?.kind === 'PAGES') {
-      return valueToStore.value.html.length + JSON.stringify(valueToStore.value.pageData).length
-    }
-    if (valueToStore.value?.kind === 'ROUTE' || valueToStore.value?.kind === 'APP_ROUTE') {
-      return valueToStore.value.body.length
-    }
-  } catch {
-    // size calculation rely on the shape of the value, so if it's not what we expect, we fallback to JSON.stringify
-    knownKindFailed = true
-  }
-
-  // fallback for not known kinds or known kinds that did fail to calculate size
-  // we should also monitor cases when fallback is used because it's not the most efficient way to calculate/estimate size
-  // and might indicate need to make adjustments or additions to the size calculation
-  recordWarning(
-    new Error(
-      `Blob size calculation did fallback to JSON.stringify. Kind: KnownKindFailed: ${knownKindFailed}, ${valueToStore.value?.kind ?? 'undefined'}`,
-    ),
-  )
-
-  return JSON.stringify(valueToStore).length
-}