import { MockFetch } from '@netlify/test-utils' import { describe, test, expect, beforeEach, afterAll, vi } from 'vitest' import { NetlifyCacheStorage } from './bootstrap/cachestorage.js' import { fetchWithCache } from './fetchwithcache.js' import { sleep } from './test/util.js' import { decodeHeaders } from './test/headers.js' const host = 'host.netlify' const url = 'https://example.netlify/.netlify/cache' const token = 'mock-token' const originalCaches = globalThis.caches beforeEach(async () => { globalThis.caches = new NetlifyCacheStorage({ getContext: () => ({ host, token, url }), }) }) afterAll(() => { globalThis.caches = originalCaches }) describe('`fetchWithCache`', () => { test('Returns the response from cache, if available', async () => { const headers = new Headers() headers.set('content-type', 'text/html') headers.set('x-custom-header', 'foobar') const cachedResponse = new Response('

Hello world

', { headers }) const mockFetch = new MockFetch() .post({ response: new Response(null, { status: 201 }), url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', }) .get({ response: () => cachedResponse, url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', }) .inject() const resourceURL = 'https://netlify.com' const cache = await caches.open('') await cache.put(resourceURL, cachedResponse) const response = await fetchWithCache(resourceURL) expect(await response.text()).toBe('

Hello world

') mockFetch.restore() expect(mockFetch.requests.length).toBe(2) }) test('Respects request headers', async () => { const headers = new Headers() headers.set('content-type', 'text/html') headers.set('vary', 'x-custom-header') const cachedResponse = new Response('

Hello world

', { headers }) const mockFetch = new MockFetch() .post({ response: new Response(null, { status: 201 }), url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', }) .get({ headers: (headers) => { expect(headers.vary).toBe('x-custom-header') }, response: () => cachedResponse, url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', }) .inject() const resourceURL = 'https://netlify.com' const cache = await caches.open('') await cache.put(resourceURL, cachedResponse) const response = await fetchWithCache(resourceURL, { headers: { vary: 'x-custom-header', }, }) expect(await response.text()).toBe('

Hello world

') mockFetch.restore() expect(mockFetch.requests.length).toBe(2) }) test('Throws when used with a method other than GET', async () => { const mockFetch = new MockFetch().inject() const resourceURL = 'https://netlify.com' await expect(() => fetchWithCache(resourceURL, { method: 'POST' })).rejects.toThrow() await expect(() => fetchWithCache(resourceURL, { method: 'PUT' })).rejects.toThrow() await expect(() => fetchWithCache(new Request(resourceURL, { method: 'POST' }))).rejects.toThrow() await expect(() => fetchWithCache(new Request(resourceURL, { method: 'PUT' }))).rejects.toThrow() mockFetch.restore() expect(mockFetch.requests.length).toBe(0) }) describe('When not in the cache, fetches the resource and adds it to the cache', () => { test('Without a `onCachePut` handler and no `waitUntil` available', async () => { const headers = new Headers() headers.set('content-type', 'text/html') headers.set('x-custom-header', 'foobar') const cacheOptions = { tags: ['tag1', 'tag2'], ttl: 30, } const ac = new AbortController() const mockFetch = new MockFetch() .get({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: new Response(null, { status: 404 }), }) .post({ body: async (body) => { expect(body).toBe('

Hello world

') }, headers: async (reqHeaders) => { const headers = decodeHeaders(reqHeaders['netlify-programmable-headers']) expect(headers.get('netlify-cache-tag')).toBe(cacheOptions.tags.join(', ')) expect(headers.get('netlify-cdn-cache-control')).toBe(`s-maxage=${cacheOptions.ttl}`) }, response: () => new Promise((resolve) => { ac.signal.onabort = () => resolve(new Response(null, { status: 201 })) }), url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', }) .get({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: () => new Response('

Hello world

', { headers }), }) .get({ url: 'https://netlify.com/', response: new Response('

Hello world

', { headers }) }) .inject() const resourceURL = 'https://netlify.com' // `fetchWithCache` doesn't resolve until the cache put resolves. expect(await Promise.race([fetchWithCache(resourceURL, cacheOptions), sleep(50, 'timeout')])).toBe('timeout') ac.abort() const cached = await fetchWithCache(resourceURL, cacheOptions) expect(await cached.text()).toBe('

Hello world

') mockFetch.restore() expect(mockFetch.fulfilled).toBe(true) }) test('Without a `onCachePut` handler and with `waitUntil` available', async () => { const headers = new Headers() headers.set('content-type', 'text/html') headers.set('x-custom-header', 'foobar') const cacheOptions = { tags: ['tag1', 'tag2'], ttl: 30, } const ac = new AbortController() const mockFetch = new MockFetch() .get({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: new Response(null, { status: 404 }), }) .post({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', headers: (reqHeaders) => { const headers = decodeHeaders(reqHeaders['netlify-programmable-headers']) expect(headers.get('netlify-cache-tag')).toBe(cacheOptions.tags.join(', ')) expect(headers.get('netlify-cdn-cache-control')).toBe(`s-maxage=${cacheOptions.ttl}`) }, response: () => new Promise((resolve) => { ac.signal.onabort = () => resolve(new Response(null, { status: 201 })) }), }) .get({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: new Response('

Hello world

', { headers }), }) .get({ url: 'https://netlify.com/', response: new Response('

Hello world

', { headers }), }) .inject() const resourceURL = 'https://netlify.com' const waitUntil = vi.fn() // @ts-expect-error globalThis.Netlify = { context: { waitUntil, }, } // `fetchWithCache` resolves without the cache put having resolved. const fresh = await fetchWithCache(resourceURL, cacheOptions) expect(await fresh.text()).toBe('

Hello world

') // @ts-expect-error delete globalThis.Netlify expect(ac.signal.aborted).toBe(false) expect(waitUntil).toHaveBeenCalledOnce() ac.abort() const cached = await fetchWithCache(resourceURL, cacheOptions) expect(await cached.text()).toBe('

Hello world

') mockFetch.restore() expect(mockFetch.fulfilled).toBe(true) }) test('With a `onCachePut` handler', async () => { const headers = new Headers() headers.set('content-type', 'text/html') headers.set('x-custom-header', 'foobar') const cacheOptions = { tags: ['tag1', 'tag2'], ttl: 30, } const ac = new AbortController() const mockFetch = new MockFetch() .get({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: new Response(null, { status: 404 }), }) .post({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', headers: (reqHeaders) => { const headers = decodeHeaders(reqHeaders['netlify-programmable-headers']) expect(headers.get('netlify-cache-tag')).toBe(cacheOptions.tags.join(', ')) expect(headers.get('netlify-cdn-cache-control')).toBe(`s-maxage=${cacheOptions.ttl}`) }, response: () => new Promise((resolve) => { ac.signal.onabort = () => resolve(new Response(null, { status: 201 })) }), }) .get({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: new Response('

Hello world

', { headers }), }) .get({ url: 'https://netlify.com/', response: new Response('

Hello world

', { headers }), }) .inject() const resourceURL = 'https://netlify.com' const onCachePut = vi.fn() // `fetchWithCache` resolves without the cache put having resolved. const fresh = await fetchWithCache(resourceURL, { ...cacheOptions, onCachePut, }) expect(await fresh.text()).toBe('

Hello world

') expect(ac.signal.aborted).toBe(false) expect(onCachePut).toHaveBeenCalledOnce() ac.abort() const cached = await fetchWithCache(resourceURL, cacheOptions) expect(await cached.text()).toBe('

Hello world

') mockFetch.restore() expect(mockFetch.fulfilled).toBe(true) }) }) test('Uses the exported `caches` proxy', async () => { const html = '

Hello world

' const mockFetch = new MockFetch() .get({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: new Response(html), }) .get({ url: 'https://netlify.com/', response: new Response(html), }) .inject() const resourceURL = 'https://netlify.com' const responseWithCache = await fetchWithCache(resourceURL) expect(await responseWithCache.text()).toBe('

Hello world

') // @ts-expect-error delete globalThis.caches const responseWithProxy = await fetchWithCache(resourceURL) expect(await responseWithProxy.text()).toBe('

Hello world

') mockFetch.restore() expect(mockFetch.fulfilled).toBe(true) }) test('Accepts a custom `fetch` implementation', async () => { const mockFetch = new MockFetch() .get({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: new Response(null, { status: 404 }), }) .post({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: new Response(null, { status: 201 }), }) .inject() const customFetch: typeof globalThis.fetch = async () => new Response('rijwiel') const response = await fetchWithCache('https://netlify.com', { fetch: customFetch }) expect(await response.text()).toBe('rijwiel') mockFetch.restore() expect(mockFetch.fulfilled).toBe(true) }) describe('SWR revalidation', () => { test('Triggers background revalidation on cache hit with SWR signal', async () => { const staleBody = '

Stale

' const freshBody = '

Fresh

' const cacheOptions = { tags: ['tag1'], ttl: 60, } const staleHeaders = new Headers() staleHeaders.set('cache-status', '"Netlify Durable"; hit; ttl=-10; detail=client-revalidate') const mockFetch = new MockFetch() .get({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: new Response(staleBody, { headers: staleHeaders }), }) .get({ url: 'https://netlify.com/', response: new Response(freshBody), }) .post({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', headers: (reqHeaders) => { const headers = decodeHeaders(reqHeaders['netlify-programmable-headers']) expect(headers.get('netlify-cache-tag')).toBe('tag1') expect(headers.get('netlify-cdn-cache-control')).toBe('s-maxage=60') }, response: new Response(null, { status: 201 }), }) .inject() const response = await fetchWithCache('https://netlify.com', cacheOptions) expect(await response.text()).toBe(staleBody) // Wait for the fire-and-forget revalidation to complete. await sleep(10) mockFetch.restore() expect(mockFetch.fulfilled).toBe(true) }) test('Uses waitUntil for background revalidation when available', async () => { const staleHeaders = new Headers() staleHeaders.set('cache-status', '"Netlify Durable"; hit; ttl=-10; detail=client-revalidate') const mockFetch = new MockFetch() .get({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: new Response('

Stale

', { headers: staleHeaders }), }) .get({ url: 'https://netlify.com/', response: new Response('

Fresh

'), }) .post({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: new Response(null, { status: 201 }), }) .inject() const waitUntil = vi.fn() // @ts-expect-error globalThis.Netlify = { context: { waitUntil } } const response = await fetchWithCache('https://netlify.com') expect(await response.text()).toBe('

Stale

') expect(waitUntil).toHaveBeenCalledOnce() // @ts-expect-error delete globalThis.Netlify // Wait for the revalidation to complete. await waitUntil.mock.calls[0][0] mockFetch.restore() expect(mockFetch.fulfilled).toBe(true) }) test('Uses onCachePut for background revalidation when provided', async () => { const staleHeaders = new Headers() staleHeaders.set('cache-status', '"Netlify Durable"; hit; ttl=-10; detail=client-revalidate') const mockFetch = new MockFetch() .get({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: new Response('

Stale

', { headers: staleHeaders }), }) .get({ url: 'https://netlify.com/', response: new Response('

Fresh

'), }) .post({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: new Response(null, { status: 201 }), }) .inject() const onCachePut = vi.fn() const response = await fetchWithCache('https://netlify.com', { onCachePut }) expect(await response.text()).toBe('

Stale

') expect(onCachePut).toHaveBeenCalledOnce() // Wait for the revalidation to complete. await onCachePut.mock.calls[0][0] mockFetch.restore() expect(mockFetch.fulfilled).toBe(true) }) test('Does not trigger revalidation for cache hits without SWR signal', async () => { const headers = new Headers() headers.set('content-type', 'text/html') const cachedResponse = new Response('

Hello

', { headers }) const mockFetch = new MockFetch() .post({ response: new Response(null, { status: 201 }), url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', }) .get({ response: () => cachedResponse, url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', }) .inject() const cache = await caches.open('') await cache.put('https://netlify.com', cachedResponse) const response = await fetchWithCache('https://netlify.com') expect(await response.text()).toBe('

Hello

') mockFetch.restore() // Only the cache.put POST and cache.match GET — no origin fetch. expect(mockFetch.requests.length).toBe(2) expect(mockFetch.fulfilled).toBe(true) }) test('Background revalidation errors do not affect the caller', async () => { const staleHeaders = new Headers() staleHeaders.set('cache-status', '"Netlify Durable"; hit; ttl=-10; detail=client-revalidate') const mockFetch = new MockFetch() .get({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: new Response('

Stale

', { headers: staleHeaders }), }) .get({ url: 'https://netlify.com/', response: new Error('Network error'), }) .inject() const response = await fetchWithCache('https://netlify.com') expect(await response.text()).toBe('

Stale

') // Wait for the fire-and-forget revalidation to settle. await sleep(10) mockFetch.restore() expect(mockFetch.fulfilled).toBe(true) }) }) test('Does not throw an error when response returns a 5xx error', async () => { const mockFetch = new MockFetch() .get({ url: 'https://example.netlify/.netlify/cache/https%3A%2F%2Fnetlify.com%2F', response: new Response(null, { status: 404 }), }) .get({ url: 'https://netlify.com/', response: new Response('Internal Server Error', { status: 500 }), }) .inject() const resourceURL = 'https://netlify.com' const response = await fetchWithCache(resourceURL) expect(response.status).toBe(500) expect(await response.text()).toBe('Internal Server Error') mockFetch.restore() expect(mockFetch.fulfilled).toBe(true) }) })