Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions cloudflare-worker.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
// Supported OpenNext custom-worker entry point. Build generates the import.
import handler from './.open-next/worker.js';
import { applyCachePolicy } from './cloudflare/cache-policy.mjs';
export { DOQueueHandler, DOShardedTagCache, BucketCachePurge } from './.open-next/worker.js';
const worker = {
async fetch(request, env, ctx) {
return applyCachePolicy(request, await handler.fetch(request, env, ctx));
},
};

export default worker;
37 changes: 37 additions & 0 deletions cloudflare/cache-policy.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// Only explicitly cacheable public responses may enter Workers Cache.
// Preserve Next.js lifetimes and variants. Unknown routes fail closed.
const USER = '[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,37}[a-zA-Z0-9])?';
const REPO = '[A-Za-z0-9._-]{1,100}';
const PUBLIC = new RegExp(`^/(?:${USER}(?:/${REPO})?|api/og(?:/${USER}(?:/${REPO})?)?|api/card/${USER})?/?$`);
const DENY = /(?:^|,)\s*(?:private|no-store|no-cache)(?:\s|,|=|$)/i;
const POSITIVE_TTL = /(?:^|,)\s*(?:s-maxage|max-age)\s*=\s*"?([1-9][0-9]*)"?(?:\s|,|$)/i;

export function applyCachePolicy(request, response) {
const headers = new Headers(response.headers);
const controls = ['cache-control', 'cdn-cache-control', 'cloudflare-cdn-cache-control']
.map(name => headers.get(name)).filter(Boolean);
const safe = ['GET', 'HEAD'].includes(request.method)
&& PUBLIC.test(new URL(request.url).pathname)
&& !/^\/(?:api|_next|internal)(?:\/|$)/.test(new URL(request.url).pathname.replace(/^\/api\/(?:og|card)(?:\/|$)/, '/'))
&& response.status === 200
&& !request.headers.has('cookie')
&& !request.headers.has('authorization')
&& !headers.has('set-cookie')
&& !controls.some(value => DENY.test(value))
&& controls.length > 0
&& POSITIVE_TTL.test(headers.get('cloudflare-cdn-cache-control')
|| headers.get('cdn-cache-control') || headers.get('cache-control') || '');

// Vary is checked before invoking the Worker. Add these even on anonymous
// fills, so a later stateful request cannot hit that anonymous response.
const vary = new Map((headers.get('vary') || '').split(',').map(x => x.trim())
.filter(Boolean).map(x => [x.toLowerCase(), x]));
for (const name of ['RSC', 'Next-Router-State-Tree', 'Next-Router-Prefetch', 'Next-Router-Segment-Prefetch', 'Next-Url', 'Cookie', 'Authorization', 'Host']) vary.set(name.toLowerCase(), name);
headers.set('vary', [...vary.values()].join(', '));
if (!safe) {
headers.set('cloudflare-cdn-cache-control', 'no-store');
headers.set('cdn-cache-control', 'no-store');
headers.set('cache-control', 'private, no-store');
}
return new Response(response.body, {status: response.status, statusText: response.statusText, headers});
}
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@
"private": true,
"scripts": {
"dev": "next dev",
"build": "next build --webpack",
"build": "npm test && next build --webpack",
"start": "next start",
"lint": "eslint",
"preview": "opennextjs-cloudflare build && opennextjs-cloudflare preview",
"deploy": "opennextjs-cloudflare build && opennextjs-cloudflare deploy"
"deploy": "opennextjs-cloudflare build && opennextjs-cloudflare deploy",
"test": "node --test tests/*.test.mjs"
},
"dependencies": {
"@opennextjs/cloudflare": "^1.17.1",
Expand Down
36 changes: 36 additions & 0 deletions tests/cache-policy.test.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
import test from 'node:test';
import assert from 'node:assert/strict';
import {applyCachePolicy} from '../cloudflare/cache-policy.mjs';
const base='https://gitshow.dev';
const response=(status=200,headers={})=>new Response(status===204?null:'public',{status,headers:{'cache-control':'s-maxage=86400, stale-while-revalidate=2592000','vary':'RSC, Next-Router-State-Tree, Next-Router-Prefetch, Next-Url',...headers}});
for(const path of ['/','/ofershap','/ofershap/gitshow','/api/og','/api/og/ofershap','/api/og/ofershap/gitshow','/api/card/ofershap']) {
test('preserves public TTL and variants '+path,()=>{
const r=applyCachePolicy(new Request(base+path),response());
assert.equal(r.headers.get('cache-control'),'s-maxage=86400, stale-while-revalidate=2592000');
for(const v of ['RSC','Next-Router-State-Tree','Next-Router-Prefetch','Next-Url','Cookie','Authorization','Host']) assert.ok(r.headers.get('vary').includes(v));
});
}
for(const [name,path,method,req,res] of [
['unknown route','/internal/admin/details','GET',{},response()],
['unknown API','/api/admin','GET',{},response()],
['higher-priority zero TTL','/ofershap','GET',{},response(200,{'cdn-cache-control':'max-age=0'})],
['highest-priority zero TTL','/ofershap','GET',{},response(200,{'cloudflare-cdn-cache-control':'max-age=0'})],
['post','/ofershap','POST',{},response()],
['cookie','/ofershap','GET',{'cookie':'session=example'},response()],
['authorization','/ofershap','GET',{'authorization':'Bearer test'},response()],
...[301,302,307,308,400,401,403,404,429,500,503].map(s=>['status '+s,'/ofershap','GET',{},response(s)]),
...['private, max-age=100','no-store','no-cache','max-age=0',''].map(s=>['control '+s,'/ofershap','GET',{},response(200,{'cache-control':s})]),
['cookie set','/ofershap','GET',{},response(200,{'set-cookie':'sid=test'})],
['cdn private','/ofershap','GET',{},response(200,{'cdn-cache-control':'private'})],
['cf private','/ofershap','GET',{},response(200,{'cloudflare-cdn-cache-control':'no-store'})],
]) test('does not cache '+name,()=>{
const r=applyCachePolicy(new Request(base+path,{method,headers:req}),res);
assert.equal(r.headers.get('cloudflare-cdn-cache-control'),'no-store');
assert.equal(r.headers.get('cache-control'),'private, no-store');
});
test('HEAD preserves a public response',()=>assert.equal(applyCachePolicy(new Request(base+'/ofershap',{method:'HEAD'}),response()).status,200));
test('RSC and prefetch retain content type and Next dimensions',()=>{
const r=applyCachePolicy(new Request(base+'/ofershap',{headers:{RSC:'1','Next-Router-Prefetch':'1'}}),response(200,{'content-type':'text/x-component'}));
assert.equal(r.headers.get('content-type'),'text/x-component');
assert.ok(r.headers.get('vary').includes('RSC'));
});
23 changes: 18 additions & 5 deletions wrangler.jsonc
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
{
"$schema": "./node_modules/wrangler/config-schema.json",
"name": "gitshow",
"main": ".open-next/worker.js",
"main": "cloudflare-worker.mjs",
"compatibility_date": "2026-06-27",
"compatibility_flags": ["nodejs_compat", "global_fetch_strictly_public"],
"compatibility_flags": [
"nodejs_compat",
"global_fetch_strictly_public"
],
"workers_dev": true,
"assets": {
"directory": ".open-next/assets",
Expand All @@ -26,12 +29,22 @@
}
],
"durable_objects": {
"bindings": [{ "name": "NEXT_CACHE_DO_QUEUE", "class_name": "DOQueueHandler" }]
"bindings": [
{
"name": "NEXT_CACHE_DO_QUEUE",
"class_name": "DOQueueHandler"
}
]
},
"migrations": [
{
"tag": "v1",
"new_sqlite_classes": ["DOQueueHandler"]
"new_sqlite_classes": [
"DOQueueHandler"
]
}
]
],
"cache": {
"enabled": true
}
}
Loading