test: update interfaces in getBlobServerGets

Author: mrstork

tests/integration/cache-handler.test.ts

@@ -82,7 +82,7 @@ describe('page router', () => {
       countOfBlobServerGetsForKey(ctx, '/static/revalidate-automatic'),
       'should only try to get value once from blob store (date calculation should not trigger additional blobs.get)',
     ).toBe(1)
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
 
     // wait to have page regenerated in the background
     await new Promise<void>((resolve) => setTimeout(resolve, 1000))
@@ -116,7 +116,7 @@ describe('page router', () => {
       countOfBlobServerGetsForKey(ctx, '/static/revalidate-automatic'),
       'should only try to get value once from blob store (date calculation should not trigger additional blobs.get)',
     ).toBe(1)
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
 
     // ping that should serve the stale page for static/revalidate-slow, while revalidating in background
     await invokeFunction(ctx, { url: 'static/revalidate-slow' })
@@ -125,7 +125,7 @@ describe('page router', () => {
       countOfBlobServerGetsForKey(ctx, '/static/revalidate-slow'),
       'should only try to get value once from blob store (date calculation should not trigger additional blobs.get)',
     ).toBe(1)
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
 
     // wait to have a stale page
     await new Promise<void>((resolve) => setTimeout(resolve, 6_000))
@@ -136,7 +136,7 @@ describe('page router', () => {
       countOfBlobServerGetsForKey(ctx, '/static/revalidate-slow'),
       'should only try to get value once from blob store (date calculation should not trigger additional blobs.get)',
     ).toBe(1)
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
 
     // over 5 seconds since it was regenerated, so we should get stale response,
     // while fresh is generated in the background
@@ -160,7 +160,7 @@ describe('page router', () => {
       countOfBlobServerGetsForKey(ctx, '/static/revalidate-automatic'),
       'should only try to get value once from blob store (date calculation should not trigger additional blobs.get)',
     ).toBe(1)
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
 
     // Slow revalidate should still be a hit, but the maxage should be updated
     const callLater2 = await invokeFunction(ctx, { url: 'static/revalidate-slow' })
@@ -177,7 +177,7 @@ describe('page router', () => {
       countOfBlobServerGetsForKey(ctx, '/static/revalidate-slow'),
       'should only try to get value once from blob store (date calculation should not trigger additional blobs.get)',
     ).toBe(1)
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
 
     // 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))
@@ -204,7 +204,7 @@ describe('page router', () => {
       countOfBlobServerGetsForKey(ctx, '/static/revalidate-automatic'),
       'should only try to get value once from blob store (date calculation should not trigger additional blobs.get)',
     ).toBe(1)
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
   })
 })
 
@@ -245,7 +245,7 @@ describe('app router', () => {
       countOfBlobServerGetsForKey(ctx, '/posts/1'),
       'should only try to get value once from blob store (date calculation should not trigger additional blobs.get)',
     ).toBe(1)
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
 
     // test a prerendered page without TTL
     const post2 = await invokeFunction(ctx, { url: '/' })
@@ -263,7 +263,7 @@ describe('app router', () => {
       countOfBlobServerGetsForKey(ctx, '/index'),
       'should only try to get value once from blob store (date calculation should not trigger additional blobs.get)',
     ).toBe(1)
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
 
     expect(await ctx.blobStore.get(encodeBlobKey('/posts/3'))).toBeNull()
     // this page is not pre-rendered and should result in a cache miss
@@ -293,7 +293,7 @@ describe('app router', () => {
       countOfBlobServerGetsForKey(ctx, '/posts/1'),
       'should only try to get value once from blob store (date calculation should not trigger additional blobs.get)',
     ).toBe(1)
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
     // it should've been regenerated in the background after the first call
     // so the date should be different
     expect(staleDate, 'the date was cached and is matching the initial one').not.toBe(post1Date)
@@ -320,7 +320,7 @@ describe('app router', () => {
       countOfBlobServerGetsForKey(ctx, '/posts/1'),
       'should only try to get value once from blob store (date calculation should not trigger additional blobs.get)',
     ).toBe(1)
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
   })
 
   test<FixtureTestContext>("not-prerendered pages should be permanently cached when produced by sandboxed invocations that don't share memory", async (ctx) => {
@@ -405,7 +405,7 @@ describe('route', () => {
     })
     expect(blobEntry).not.toBeNull()
 
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
 
     // test the first invocation of the route - we should get stale response while fresh is generated in the background
     const call1 = await invokeFunction(ctx, { url: '/api/revalidate-handler' })
@@ -428,7 +428,7 @@ describe('route', () => {
       countOfBlobServerGetsForKey(ctx, '/api/revalidate-handler'),
       'should only try to get value once from blob store (date calculation should not trigger additional blobs.get)',
     ).toBe(1)
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
 
     // 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))
@@ -458,7 +458,7 @@ describe('route', () => {
       countOfBlobServerGetsForKey(ctx, '/api/revalidate-handler'),
       'should only try to get value once from blob store (date calculation should not trigger additional blobs.get)',
     ).toBe(1)
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
 
     // wait to have a stale route again
     await new Promise<void>((resolve) => setTimeout(resolve, 8_000))
@@ -485,7 +485,7 @@ describe('route', () => {
       countOfBlobServerGetsForKey(ctx, '/api/revalidate-handler'),
       'should only try to get value once from blob store (date calculation should not trigger additional blobs.get)',
     ).toBe(1)
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
 
     // 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))
@@ -510,7 +510,7 @@ describe('route', () => {
       countOfBlobServerGetsForKey(ctx, '/api/revalidate-handler'),
       'should only try to get value once from blob store (date calculation should not trigger additional blobs.get)',
     ).toBe(1)
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
   })
 
   test<FixtureTestContext>('cacheable route handler response not produced at build is served correctly', async (ctx) => {

tests/integration/fetch-handler.test.ts

@@ -363,7 +363,7 @@ test<FixtureTestContext>('does not fetch same cached fetch data from blobs twice
     'expected blobs for all types of values to be retrieved at most once per key (including fetch data, tag manifests, static files)',
   ).toBeDistinct()
 
-  ctx.blobServerGetSpy.mockClear()
+  ctx.blobServerOnRequestSpy.mockClear()
   handlerCalled = 0
   const request2 = await invokeFunction(ctx, {
     url: 'same-fetch-multiple-times/99',

tests/integration/request-context.test.ts

@@ -106,7 +106,7 @@ describe('request-context does NOT leak between concurrent requests', () => {
       lastModified: new Date(mockedDateForRevalidateSlow).getTime(),
     })
 
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
 
     const waitForCacheHandlerGetAndPausePromise =
       waitForCacheHandlerGetAndPause('/static/revalidate-slow')
@@ -182,7 +182,7 @@ describe('request-context does NOT leak between concurrent requests', () => {
       lastModified: new Date(mockedDateForStaticFetch2).getTime(),
     })
 
-    ctx.blobServerGetSpy.mockClear()
+    ctx.blobServerOnRequestSpy.mockClear()
 
     const waitForCacheHandlerGetAndPausePromise = waitForCacheHandlerGetAndPause('/static-fetch/2')
     const slowCallPromise = invokeFunction(ctx, {

tests/integration/revalidate-path.test.ts

@@ -58,7 +58,7 @@ test<FixtureTestContext>('should revalidate a route by path', async (ctx) => {
   expect(await ctx.blobStore.get(encodeBlobKey('/static-fetch/1'))).not.toBeNull()
   expect(await ctx.blobStore.get(encodeBlobKey('_N_T_/static-fetch/[id]/page'))).toBeNull()
 
-  ctx.blobServerGetSpy.mockClear()
+  ctx.blobServerOnRequestSpy.mockClear()
 
   // test the function call
   const post1 = await invokeFunction(ctx, { url: '/static-fetch/1' })
@@ -78,7 +78,7 @@ test<FixtureTestContext>('should revalidate a route by path', async (ctx) => {
     getBlobServerGets(ctx, isTagManifest),
     `expected tag manifests to be retrieved at most once per tag`,
   ).toBeDistinct()
-  ctx.blobServerGetSpy.mockClear()
+  ctx.blobServerOnRequestSpy.mockClear()
 
   const post1Route2 = await invokeFunction(ctx, { url: '/static-fetch/2' })
   expect(post1Route2.statusCode).toBe(200)
@@ -95,7 +95,7 @@ test<FixtureTestContext>('should revalidate a route by path', async (ctx) => {
     getBlobServerGets(ctx, isTagManifest),
     `expected tag manifests to be retrieved at most once per tag`,
   ).toBeDistinct()
-  ctx.blobServerGetSpy.mockClear()
+  ctx.blobServerOnRequestSpy.mockClear()
 
   const revalidate = await invokeFunction(ctx, { url: '/api/on-demand-revalidate/path' })
   expect(revalidate.statusCode).toBe(200)
@@ -106,7 +106,7 @@ test<FixtureTestContext>('should revalidate a route by path', async (ctx) => {
 
   expect(await ctx.blobStore.get(encodeBlobKey('_N_T_/static-fetch/[id]/page'))).not.toBeNull()
 
-  ctx.blobServerGetSpy.mockClear()
+  ctx.blobServerOnRequestSpy.mockClear()
 
   const post2 = await invokeFunction(ctx, { url: '/static-fetch/1' })
   const post2Date = load(post2.body)('[data-testid="date-now"]').text()
@@ -126,7 +126,7 @@ test<FixtureTestContext>('should revalidate a route by path', async (ctx) => {
     getBlobServerGets(ctx, isTagManifest),
     `expected tag manifests to be retrieved at most once per tag`,
   ).toBeDistinct()
-  ctx.blobServerGetSpy.mockClear()
+  ctx.blobServerOnRequestSpy.mockClear()
 
   const post2Route2 = await invokeFunction(ctx, { url: '/static-fetch/2' })
 
@@ -144,5 +144,5 @@ test<FixtureTestContext>('should revalidate a route by path', async (ctx) => {
     getBlobServerGets(ctx, isTagManifest),
     `expected tag manifests to be retrieved at most once per tag`,
   ).toBeDistinct()
-  ctx.blobServerGetSpy.mockClear()
+  ctx.blobServerOnRequestSpy.mockClear()
 })

tests/integration/revalidate-tags.test.ts

@@ -57,7 +57,7 @@ test<FixtureTestContext>('should revalidate a route by tag', async (ctx) => {
 
   expect(await ctx.blobStore.get(encodeBlobKey('/static-fetch-1'))).not.toBeNull()
 
-  ctx.blobServerGetSpy.mockClear()
+  ctx.blobServerOnRequestSpy.mockClear()
 
   // test the function call
   const post1 = await invokeFunction(ctx, { url: '/static-fetch-1' })
@@ -78,7 +78,7 @@ test<FixtureTestContext>('should revalidate a route by tag', async (ctx) => {
     getBlobServerGets(ctx, isTagManifest),
     `expected tag manifests to be retrieved at most once per tag`,
   ).toBeDistinct()
-  ctx.blobServerGetSpy.mockClear()
+  ctx.blobServerOnRequestSpy.mockClear()
 
   const revalidate = await invokeFunction(ctx, { url: '/api/on-demand-revalidate/tag' })
   expect(revalidate.statusCode).toBe(200)
@@ -87,7 +87,7 @@ test<FixtureTestContext>('should revalidate a route by tag', async (ctx) => {
   // it does not wait for the revalidation
   await new Promise<void>((resolve) => setTimeout(resolve, 100))
 
-  ctx.blobServerGetSpy.mockClear()
+  ctx.blobServerOnRequestSpy.mockClear()
 
   const post2 = await invokeFunction(ctx, { url: '/static-fetch-1' })
   const post2Date = load(post2.body)('[data-testid="date-now"]').text()
@@ -109,7 +109,7 @@ test<FixtureTestContext>('should revalidate a route by tag', async (ctx) => {
     getBlobServerGets(ctx, isTagManifest),
     `expected tag manifests to be retrieved at most once per tag`,
   ).toBeDistinct()
-  ctx.blobServerGetSpy.mockClear()
+  ctx.blobServerOnRequestSpy.mockClear()
 
   // 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, 100))
@@ -134,7 +134,7 @@ test<FixtureTestContext>('should revalidate a route by tag', async (ctx) => {
     getBlobServerGets(ctx, isTagManifest),
     `expected tag manifests to be retrieved at most once per tag`,
   ).toBeDistinct()
-  ctx.blobServerGetSpy.mockClear()
+  ctx.blobServerOnRequestSpy.mockClear()
 
   const revalidate2 = await invokeFunction(ctx, { url: '/api/on-demand-revalidate/tag' })
   expect(revalidate2.statusCode).toBe(200)
@@ -143,7 +143,7 @@ test<FixtureTestContext>('should revalidate a route by tag', async (ctx) => {
   // it does not wait for the revalidation
   await new Promise<void>((resolve) => setTimeout(resolve, 100))
 
-  ctx.blobServerGetSpy.mockClear()
+  ctx.blobServerOnRequestSpy.mockClear()
 
   const post4 = await invokeFunction(ctx, { url: '/static-fetch-1' })
   const post4Date = load(post4.body)('[data-testid="date-now"]').text()
@@ -165,5 +165,5 @@ test<FixtureTestContext>('should revalidate a route by tag', async (ctx) => {
     getBlobServerGets(ctx, isTagManifest),
     `expected tag manifests to be retrieved at most once per tag`,
   ).toBeDistinct()
-  ctx.blobServerGetSpy.mockClear()
+  ctx.blobServerOnRequestSpy.mockClear()
 })

tests/utils/contexts.ts

@@ -1,7 +1,7 @@
-import { type getStore } from '@netlify/blobs'
+import type { getStore } from '@netlify/blobs'
 import { BlobsServer } from '@netlify/blobs/server'
 import { type WriteStream } from 'node:fs'
-import { MockInstance, TestContext } from 'vitest'
+import { TestContext } from 'vitest'
 
 export interface FixtureTestContext extends TestContext {
   cwd: string
@@ -10,7 +10,7 @@ export interface FixtureTestContext extends TestContext {
   blobStoreHost: string
   blobStorePort: number
   blobServer: BlobsServer
-  blobServerGetSpy: MockInstance<Parameters<BlobsServer['get']>, ReturnType<BlobsServer['get']>>
+  blobServerOnRequestSpy: BlobsServer['onRequest']
   blobStore: ReturnType<typeof getStore>
   functionDist: string
   edgeFunctionPort: number

tests/utils/helpers.ts

@@ -1,7 +1,7 @@
 import getPort from 'get-port'
 
 import { getDeployStore } from '@netlify/blobs'
-import { BlobsServer } from '@netlify/blobs/server'
+import { BlobsServer, Operation } from '@netlify/blobs/server'
 import type { NetlifyPluginUtils } from '@netlify/build'
 import { Buffer } from 'node:buffer'
 import { mkdtemp } from 'node:fs/promises'
@@ -34,13 +34,14 @@ export const generateRandomObjectID = () => {
 export const startMockBlobStore = async (ctx: FixtureTestContext) => {
   const port = await getPort()
   // create new blob store server
+  ctx.blobServerOnRequestSpy = vi.fn()
   ctx.blobServer = new BlobsServer({
     port,
     token: BLOB_TOKEN,
+    onRequest: ctx.blobServerOnRequestSpy,
     directory: await mkdtemp(join(tmpdir(), 'opennextjs-netlify-blob-')),
   })
   await ctx.blobServer.start()
-  ctx.blobServerGetSpy = vi.spyOn(ctx.blobServer, 'get')
   ctx.blobStoreHost = `localhost:${port}`
   ctx.blobStorePort = port
   vi.stubEnv('NETLIFY_BLOBS_CONTEXT', createBlobContext(ctx))
@@ -72,11 +73,10 @@ export const getBlobEntries = async (ctx: FixtureTestContext) => {
 
 export function getBlobServerGets(ctx: FixtureTestContext, predicate?: (key: string) => boolean) {
   const isString = (arg: unknown): arg is string => typeof arg === 'string'
-  return ctx.blobServerGetSpy.mock.calls
+  return ctx.blobServerOnRequestSpy.mock.calls
     .map(([request]) => {
-      if (typeof request.url !== 'string') {
-        return undefined
-      }
+      if (request.type !== Operation.GET) return undefined
+      if (!isString(request.url)) return undefined
 
       let urlSegments = request.url.split('/').slice(1)