fix: blob key collisions (#212)

* fix: ensure blob keys for routes begin with leading slash

* chore: update tests

* chore: update blobkey tests

Author: orinokai

src/build/content/prerendered.ts

@@ -15,7 +15,7 @@ import type {
 /**
  * Normalize routes by stripping leading slashes and ensuring root path is index
  */
-const routeToFilePath = (path: string) => path.replace(/^\//, '') || 'index'
+const routeToFilePath = (path: string) => (path === '/' ? '/index' : path)
 
 const buildPagesCacheValue = async (path: string): Promise<PageCacheValue> => ({
   kind: 'PAGE',
@@ -78,7 +78,7 @@ export const copyPrerenderedContent = async (ctx: PluginContext): Promise<void>
     // app router 404 pages are not in the prerender manifest
     // so we need to check for them manually
     if (existsSync(join(ctx.publishDir, `server/app/_not-found.html`))) {
-      const key = '404'
+      const key = '/404'
       const value = await buildAppCacheValue(join(ctx.publishDir, 'server/app/_not-found'))
       await ctx.writeCacheEntry(key, value)
     }

src/run/next.cts

@@ -12,7 +12,7 @@ export async function getMockedRequestHandlers(...args: Parameters<typeof getReq
   const store = getDeployStore()
   const ofs = { ...fs }
 
-  const { encodeBlobKey } = await import("../shared/blobkey.js")
+  const { encodeBlobKey } = await import('../shared/blobkey.js')
 
   async function readFileFallbackBlobStore(...fsargs: Parameters<FS['promises']['readFile']>) {
     const [path, options] = fsargs

src/shared/blobkey.test.ts

@@ -1,30 +1,22 @@
 import { Buffer } from 'node:buffer'
 
-import { expect, describe, it } from 'vitest'
+import { describe, expect, it } from 'vitest'
 
 import { encodeBlobKey } from './blobkey.js'
 
 describe('encodeBlobKey', () => {
-  it('ignores leading slashes', async () => {
-    expect(await encodeBlobKey('/foo')).toEqual(await encodeBlobKey('foo'))
-  })
-
   const longKey = 'long'.repeat(100)
 
   it('truncates long keys to 180 characters', async () => {
     expect(await encodeBlobKey(longKey)).toHaveLength(180)
   })
 
-  it('truncated keys also ignore leading slashes', async () => {
-    expect(await encodeBlobKey(`/${longKey}`)).toEqual(await encodeBlobKey(longKey))
-  })
-
   it('adds a differentiating hash to truncated keys', async () => {
     expect(await encodeBlobKey(`${longKey}a`)).not.toEqual(await encodeBlobKey(`${longKey}b`))
   })
 
   it('truncated keys keep having a readable start', async () => {
     const key = await encodeBlobKey(`/products/${longKey}`)
-    expect(Buffer.from(key, 'base64url').toString().startsWith('products/')).toBe(true)
+    expect(Buffer.from(key, 'base64url').toString().startsWith('/products/')).toBe(true)
   })
 })

src/shared/blobkey.ts

@@ -10,7 +10,7 @@ const maxLength = 180
  * Longer keys are truncated and appended with a hash to ensure uniqueness.
  */
 export async function encodeBlobKey(key: string): Promise<string> {
-  const buffer = Buffer.from(key.replace(/^\//, '') || 'index')
+  const buffer = Buffer.from(key)
   const base64 = buffer.toString('base64url')
   if (base64.length <= maxLength) {
     return base64

tests/integration/cache-handler.test.ts

@@ -41,13 +41,13 @@ describe('page router', () => {
     // check if the blob entries where successful set on the build plugin
     const blobEntries = await getBlobEntries(ctx)
     expect(blobEntries.map(({ key }) => decodeBlobKey(key.substring(0, 50))).sort()).toEqual([
+      // the real key is much longer and ends in a hash, but we only assert on the first 50 chars to make it easier
+      '/products/an-incredibly-long-product-',
+      '/static/revalidate-automatic',
+      '/static/revalidate-manual',
+      '/static/revalidate-slow',
       '404.html',
       '500.html',
-      // the real key is much longer and ends in a hash, but we only assert on the first 50 chars to make it easier
-      'products/an-incredibly-long-product-n',
-      'static/revalidate-automatic',
-      'static/revalidate-manual',
-      'static/revalidate-slow',
     ])
 
     // test the function call
@@ -116,14 +116,14 @@ describe('app router', () => {
     // check if the blob entries where successful set on the build plugin
     const blobEntries = await getBlobEntries(ctx)
     expect(blobEntries.map(({ key }) => decodeBlobKey(key)).sort()).toEqual([
-      '404',
+      '/404',
+      '/index',
+      '/posts/1',
+      '/posts/2',
       '404.html',
       '460ed46cd9a194efa197be9f2571e51b729a039d1cff9834297f416dce5ada29',
       '500.html',
       'ad74683e49684ff4fe3d01ba1bef627bc0e38b61fa6bd8244145fbaca87f3c49',
-      'index',
-      'posts/1',
-      'posts/2',
     ])
 
     // test the function call
@@ -138,7 +138,7 @@ describe('app router', () => {
       }),
     )
 
-    expect(await ctx.blobStore.get(decodeBlobKey('posts/3'))).toBeNull()
+    expect(await ctx.blobStore.get(encodeBlobKey('/posts/3'))).toBeNull()
     // this page is not pre-rendered and should result in a cache miss
     const post3 = await invokeFunction(ctx, { url: 'posts/3' })
     expect(post3.statusCode).toBe(200)
@@ -152,7 +152,7 @@ describe('app router', () => {
     // wait to have a stale page
     await new Promise<void>((resolve) => setTimeout(resolve, 5_000))
     // after the dynamic call of `posts/3` it should be in cache, not this is after the timout as the cache set happens async
-    expect(await ctx.blobStore.get(encodeBlobKey('posts/3'))).not.toBeNull()
+    expect(await ctx.blobStore.get(encodeBlobKey('/posts/3'))).not.toBeNull()
 
     const stale = await invokeFunction(ctx, { url: 'posts/1' })
     const staleDate = load(stale.body)('[data-testid="date-now"]').text()
@@ -188,20 +188,20 @@ describe('plugin', () => {
     // check if the blob entries where successful set on the build plugin
     const blobEntries = await getBlobEntries(ctx)
     expect(blobEntries.map(({ key }) => decodeBlobKey(key)).sort()).toEqual([
-      '404',
+      '/404',
+      '/api/revalidate-handler',
+      '/index',
+      '/revalidate-fetch',
+      '/static-fetch-1',
+      '/static-fetch-2',
+      '/static-fetch-3',
+      '/static-fetch/1',
+      '/static-fetch/2',
       '404.html',
       '460ed46cd9a194efa197be9f2571e51b729a039d1cff9834297f416dce5ada29',
       '500.html',
       'ac26c54e17c3018c17bfe5ae6adc0e6d37dbfaf28445c1f767ff267144264ac9',
       'ad74683e49684ff4fe3d01ba1bef627bc0e38b61fa6bd8244145fbaca87f3c49',
-      'api/revalidate-handler',
-      'index',
-      'revalidate-fetch',
-      'static-fetch-1',
-      'static-fetch-2',
-      'static-fetch-3',
-      'static-fetch/1',
-      'static-fetch/2',
     ])
   })
 })
@@ -212,7 +212,7 @@ describe('route', () => {
     await runPlugin(ctx)
 
     // check if the route got prerendered
-    const blobEntry = await ctx.blobStore.get(encodeBlobKey('api/revalidate-handler'), {
+    const blobEntry = await ctx.blobStore.get(encodeBlobKey('/api/revalidate-handler'), {
       type: 'json',
     })
     expect(blobEntry).not.toBeNull()

tests/integration/fetch-handler.test.ts

@@ -76,7 +76,7 @@ test<FixtureTestContext>('if the fetch call is cached correctly', async (ctx) =>
 
   await Promise.all([
     // delete the page cache so that it falls back to the fetch call
-    ctx.blobStore.delete(encodeBlobKey('posts/1')),
+    ctx.blobStore.delete(encodeBlobKey('/posts/1')),
     // delete the original key as we use the fake key only
     ctx.blobStore.delete(encodeBlobKey(originalKey)),
     ctx.blobStore.setJSON(encodeBlobKey(fakeKey), fetchEntry),
@@ -85,13 +85,13 @@ test<FixtureTestContext>('if the fetch call is cached correctly', async (ctx) =>
   const blobEntries = await getBlobEntries(ctx)
   expect(blobEntries.map(({ key }) => decodeBlobKey(key)).sort()).toEqual(
     [
+      '/404',
+      '/index',
+      '/posts/2',
       fakeKey,
-      'ad74683e49684ff4fe3d01ba1bef627bc0e38b61fa6bd8244145fbaca87f3c49',
-      '404',
-      'index',
-      'posts/2',
       '404.html',
       '500.html',
+      'ad74683e49684ff4fe3d01ba1bef627bc0e38b61fa6bd8244145fbaca87f3c49',
     ].sort(),
   )
   const post1 = await invokeFunction(ctx, {

tests/integration/page-router.test.ts

@@ -71,7 +71,7 @@ test<FixtureTestContext>('Should revalidate path with On-demand Revalidation', a
 
   expect(staticPageInitial.statusCode).toBe(200)
   expect(staticPageInitial.headers?.['cache-status']).toMatch(/"Next.js"; hit/)
-  const blobDataInitial = await ctx.blobStore.get(encodeBlobKey('static/revalidate-manual'), {
+  const blobDataInitial = await ctx.blobStore.get(encodeBlobKey('/static/revalidate-manual'), {
     type: 'json',
   })
   const blobDateInitial = load(blobDataInitial.value.html).html('[data-testid="date-now"]')
@@ -81,7 +81,7 @@ test<FixtureTestContext>('Should revalidate path with On-demand Revalidation', a
 
   await new Promise<void>((resolve) => setTimeout(resolve, 100))
 
-  const blobDataRevalidated = await ctx.blobStore.get(encodeBlobKey('static/revalidate-manual'), {
+  const blobDataRevalidated = await ctx.blobStore.get(encodeBlobKey('/static/revalidate-manual'), {
     type: 'json',
   })
 

tests/integration/revalidate-path.test.ts

@@ -8,12 +8,7 @@ import {
   runPlugin,
   type FixtureTestContext,
 } from '../utils/fixture.js'
-import {
-  encodeBlobKey,
-  generateRandomObjectID,
-  getBlobEntries,
-  startMockBlobStore,
-} from '../utils/helpers.js'
+import { encodeBlobKey, generateRandomObjectID, startMockBlobStore } from '../utils/helpers.js'
 
 // Disable the verbose logging of the lambda-local runtime
 getLogger().level = 'alert'
@@ -35,7 +30,7 @@ test<FixtureTestContext>('should revalidate a route by path', async (ctx) => {
   await createFixture('server-components', ctx)
   await runPlugin(ctx)
 
-  expect(await ctx.blobStore.get(encodeBlobKey('static-fetch/1'))).not.toBeNull()
+  expect(await ctx.blobStore.get(encodeBlobKey('/static-fetch/1'))).not.toBeNull()
   expect(await ctx.blobStore.get(encodeBlobKey('_N_T_/static-fetch/[id]/page'))).toBeNull()
 
   // test the function call
@@ -68,7 +63,6 @@ test<FixtureTestContext>('should revalidate a route by path', async (ctx) => {
   // it does not wait for the cache.set so we have to manually wait here until the blob storage got populated
   await new Promise<void>((resolve) => setTimeout(resolve, 1000))
 
-  const entries = await getBlobEntries(ctx)
   expect(await ctx.blobStore.get(encodeBlobKey('_N_T_/static-fetch/[id]/page'))).not.toBeNull()
 
   const [post2, post2Route2] = await Promise.all([

tests/integration/revalidate-tags.test.ts

@@ -30,7 +30,7 @@ test<FixtureTestContext>('should revalidate a route by tag', async (ctx) => {
   await createFixture('server-components', ctx)
   await runPlugin(ctx)
 
-  expect(await ctx.blobStore.get(encodeBlobKey('static-fetch-1'))).not.toBeNull()
+  expect(await ctx.blobStore.get(encodeBlobKey('/static-fetch-1'))).not.toBeNull()
 
   // test the function call
   const post1 = await invokeFunction(ctx, { url: '/static-fetch-1' })

tests/integration/simple-app.test.ts

@@ -36,14 +36,14 @@ test<FixtureTestContext>('Test that the simple next app is working', async (ctx)
   // check if the blob entries where successful set on the build plugin
   const blobEntries = await getBlobEntries(ctx)
   expect(blobEntries.map(({ key }) => decodeBlobKey(key)).sort()).toEqual([
-    '404',
+    '/404',
+    '/image',
+    '/index',
+    '/other',
+    '/redirect',
+    '/redirect/response',
     '404.html',
     '500.html',
-    'image',
-    'index',
-    'other',
-    'redirect',
-    'redirect/response',
   ])
 
   // test the function call