From 3cb3833319c737f8c2e7f335985f7cb60e059bf5 Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Wed, 24 Sep 2025 13:18:19 +0200 Subject: [PATCH 1/6] feat: add an experimental KV based tag cache --- .changeset/silver-walls-cover.md | 5 + examples/common/apps.ts | 1 + examples/overrides/kv-tag-next/.gitignore | 47 +++ examples/overrides/kv-tag-next/app/action.ts | 11 + .../app/components/revalidationButtons.tsx | 27 ++ .../overrides/kv-tag-next/app/favicon.ico | Bin 0 -> 25931 bytes .../overrides/kv-tag-next/app/globals.css | 14 + examples/overrides/kv-tag-next/app/layout.tsx | 28 ++ .../overrides/kv-tag-next/app/page.module.css | 17 + examples/overrides/kv-tag-next/app/page.tsx | 26 ++ .../overrides/kv-tag-next/e2e/base.spec.ts | 47 +++ .../kv-tag-next/e2e/playwright.config.ts | 4 + examples/overrides/kv-tag-next/next.config.ts | 11 + .../overrides/kv-tag-next/open-next.config.ts | 8 + examples/overrides/kv-tag-next/package.json | 29 ++ examples/overrides/kv-tag-next/tsconfig.json | 27 ++ .../overrides/kv-tag-next/wrangler.e2e.jsonc | 25 ++ .../cloudflare/src/api/cloudflare-context.ts | 3 + .../tag-cache/d1-next-tag-cache.spec.ts | 2 +- .../overrides/tag-cache/d1-next-tag-cache.ts | 7 +- .../tag-cache/do-sharded-tag-cache.ts | 2 +- .../tag-cache/kv-next-tag-cache.spec.ts | 306 ++++++++++++++++++ .../overrides/tag-cache/kv-next-tag-cache.ts | 95 ++++++ pnpm-lock.yaml | 88 +++-- pnpm-workspace.yaml | 2 +- 25 files changed, 797 insertions(+), 35 deletions(-) create mode 100644 .changeset/silver-walls-cover.md create mode 100644 examples/overrides/kv-tag-next/.gitignore create mode 100644 examples/overrides/kv-tag-next/app/action.ts create mode 100644 examples/overrides/kv-tag-next/app/components/revalidationButtons.tsx create mode 100644 examples/overrides/kv-tag-next/app/favicon.ico create mode 100644 examples/overrides/kv-tag-next/app/globals.css create mode 100644 examples/overrides/kv-tag-next/app/layout.tsx create mode 100644 examples/overrides/kv-tag-next/app/page.module.css create mode 100644 examples/overrides/kv-tag-next/app/page.tsx create mode 100644 examples/overrides/kv-tag-next/e2e/base.spec.ts create mode 100644 examples/overrides/kv-tag-next/e2e/playwright.config.ts create mode 100644 examples/overrides/kv-tag-next/next.config.ts create mode 100644 examples/overrides/kv-tag-next/open-next.config.ts create mode 100644 examples/overrides/kv-tag-next/package.json create mode 100644 examples/overrides/kv-tag-next/tsconfig.json create mode 100644 examples/overrides/kv-tag-next/wrangler.e2e.jsonc create mode 100644 packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.spec.ts create mode 100644 packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts diff --git a/.changeset/silver-walls-cover.md b/.changeset/silver-walls-cover.md new file mode 100644 index 000000000..14461fadd --- /dev/null +++ b/.changeset/silver-walls-cover.md @@ -0,0 +1,5 @@ +--- +"@opennextjs/cloudflare": minor +--- + +feat: add an experimental KV based tag cache diff --git a/examples/common/apps.ts b/examples/common/apps.ts index 07fa3c7f2..811daa65c 100644 --- a/examples/common/apps.ts +++ b/examples/common/apps.ts @@ -16,6 +16,7 @@ const apps = [ "experimental", // overrides "d1-tag-next", + "kv-tag-next", "memory-queue", "r2-incremental-cache", "static-assets-incremental-cache", diff --git a/examples/overrides/kv-tag-next/.gitignore b/examples/overrides/kv-tag-next/.gitignore new file mode 100644 index 000000000..3f753f293 --- /dev/null +++ b/examples/overrides/kv-tag-next/.gitignore @@ -0,0 +1,47 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.* +.yarn/* +!.yarn/patches +!.yarn/plugins +!.yarn/releases +!.yarn/versions + +# testing +/coverage + +# next.js +/.next/ +/out/ + +# production +/build + +# misc +.DS_Store +*.pem + +# debug +npm-debug.log* +yarn-debug.log* +yarn-error.log* +.pnpm-debug.log* + +# env files (can opt-in for committing if needed) +.env* + +# vercel +.vercel + +# typescript +*.tsbuildinfo +next-env.d.ts + +# playwright +/test-results/ +/playwright-report/ +/blob-report/ +/playwright/.cache/ diff --git a/examples/overrides/kv-tag-next/app/action.ts b/examples/overrides/kv-tag-next/app/action.ts new file mode 100644 index 000000000..2a21534eb --- /dev/null +++ b/examples/overrides/kv-tag-next/app/action.ts @@ -0,0 +1,11 @@ +"use server"; + +import { revalidatePath, revalidateTag } from "next/cache"; + +export async function revalidateTagAction() { + revalidateTag("date"); +} + +export async function revalidatePathAction() { + revalidatePath("/"); +} diff --git a/examples/overrides/kv-tag-next/app/components/revalidationButtons.tsx b/examples/overrides/kv-tag-next/app/components/revalidationButtons.tsx new file mode 100644 index 000000000..0b42b0167 --- /dev/null +++ b/examples/overrides/kv-tag-next/app/components/revalidationButtons.tsx @@ -0,0 +1,27 @@ +"use client"; + +import { revalidateTagAction, revalidatePathAction } from "../action"; + +export default function RevalidationButtons() { + return ( +
+ + + +
+ ); +} diff --git a/examples/overrides/kv-tag-next/app/favicon.ico b/examples/overrides/kv-tag-next/app/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..718d6fea4835ec2d246af9800eddb7ffb276240c GIT binary patch literal 25931 zcmeHv30#a{`}aL_*G&7qml|y<+KVaDM2m#dVr!KsA!#An?kSQM(q<_dDNCpjEux83 zLb9Z^XxbDl(w>%i@8hT6>)&Gu{h#Oeyszu?xtw#Zb1mO{pgX9699l+Qppw7jXaYf~-84xW z)w4x8?=youko|}Vr~(D$UXIbiXABHh`p1?nn8Po~fxRJv}|0e(BPs|G`(TT%kKVJAdg5*Z|x0leQq0 zkdUBvb#>9F()jo|T~kx@OM8$9wzs~t2l;K=woNssA3l6|sx2r3+kdfVW@e^8e*E}v zA1y5{bRi+3Z`uD3{F7LgFJDdvm;nJilkzDku>BwXH(8ItVCXk*-lSJnR?-2UN%hJ){&rlvg`CDTj z)Bzo!3v7Ou#83zEDEFcKt(f1E0~=rqeEbTnMvWR#{+9pg%7G8y>u1OVRUSoox-ovF z2Ydma(;=YuBY(eI|04{hXzZD6_f(v~H;C~y5=DhAC{MMS>2fm~1H_t2$56pc$NH8( z5bH|<)71dV-_oCHIrzrT`2s-5w_+2CM0$95I6X8p^r!gHp+j_gd;9O<1~CEQQGS8) zS9Qh3#p&JM-G8rHekNmKVewU;pJRcTAog68KYo^dRo}(M>36U4Us zfgYWSiHZL3;lpWT=zNAW>Dh#mB!_@Lg%$ms8N-;aPqMn+C2HqZgz&9~Eu z4|Kp<`$q)Uw1R?y(~S>ePdonHxpV1#eSP1B;Ogo+-Pk}6#0GsZZ5!||ev2MGdh}_m z{DeR7?0-1^zVs&`AV6Vt;r3`I`OI_wgs*w=eO%_#7Kepl{B@xiyCANc(l zzIyd4y|c6PXWq9-|KM8(zIk8LPk(>a)zyFWjhT!$HJ$qX1vo@d25W<fvZQ2zUz5WRc(UnFMKHwe1| zWmlB1qdbiA(C0jmnV<}GfbKtmcu^2*P^O?MBLZKt|As~ge8&AAO~2K@zbXelK|4T<{|y4`raF{=72kC2Kn(L4YyenWgrPiv z@^mr$t{#X5VuIMeL!7Ab6_kG$&#&5p*Z{+?5U|TZ`B!7llpVmp@skYz&n^8QfPJzL z0G6K_OJM9x+Wu2gfN45phANGt{7=C>i34CV{Xqlx(fWpeAoj^N0Biu`w+MVcCUyU* zDZuzO0>4Z6fbu^T_arWW5n!E45vX8N=bxTVeFoep_G#VmNlQzAI_KTIc{6>c+04vr zx@W}zE5JNSU>!THJ{J=cqjz+4{L4A{Ob9$ZJ*S1?Ggg3klFp!+Y1@K+pK1DqI|_gq z5ZDXVpge8-cs!o|;K73#YXZ3AShj50wBvuq3NTOZ`M&qtjj#GOFfgExjg8Gn8>Vq5 z`85n+9|!iLCZF5$HJ$Iu($dm?8~-ofu}tEc+-pyke=3!im#6pk_Wo8IA|fJwD&~~F zc16osQ)EBo58U7XDuMexaPRjU@h8tXe%S{fA0NH3vGJFhuyyO!Uyl2^&EOpX{9As0 zWj+P>{@}jxH)8|r;2HdupP!vie{sJ28b&bo!8`D^x}TE$%zXNb^X1p@0PJ86`dZyj z%ce7*{^oo+6%&~I!8hQy-vQ7E)0t0ybH4l%KltWOo~8cO`T=157JqL(oq_rC%ea&4 z2NcTJe-HgFjNg-gZ$6!Y`SMHrlj}Etf7?r!zQTPPSv}{so2e>Fjs1{gzk~LGeesX%r(Lh6rbhSo_n)@@G-FTQy93;l#E)hgP@d_SGvyCp0~o(Y;Ee8{ zdVUDbHm5`2taPUOY^MAGOw*>=s7=Gst=D+p+2yON!0%Hk` zz5mAhyT4lS*T3LS^WSxUy86q&GnoHxzQ6vm8)VS}_zuqG?+3td68_x;etQAdu@sc6 zQJ&5|4(I?~3d-QOAODHpZ=hlSg(lBZ!JZWCtHHSj`0Wh93-Uk)_S%zsJ~aD>{`A0~ z9{AG(e|q3g5B%wYKRxiL2Y$8(4w6bzchKuloQW#e&S3n+P- z8!ds-%f;TJ1>)v)##>gd{PdS2Oc3VaR`fr=`O8QIO(6(N!A?pr5C#6fc~Ge@N%Vvu zaoAX2&(a6eWy_q&UwOhU)|P3J0Qc%OdhzW=F4D|pt0E4osw;%<%Dn58hAWD^XnZD= z>9~H(3bmLtxpF?a7su6J7M*x1By7YSUbxGi)Ot0P77`}P3{)&5Un{KD?`-e?r21!4vTTnN(4Y6Lin?UkSM z`MXCTC1@4A4~mvz%Rh2&EwY))LeoT=*`tMoqcEXI>TZU9WTP#l?uFv+@Dn~b(>xh2 z;>B?;Tz2SR&KVb>vGiBSB`@U7VIWFSo=LDSb9F{GF^DbmWAfpms8Sx9OX4CnBJca3 zlj9(x!dIjN?OG1X4l*imJNvRCk}F%!?SOfiOq5y^mZW)jFL@a|r-@d#f7 z2gmU8L3IZq0ynIws=}~m^#@&C%J6QFo~Mo4V`>v7MI-_!EBMMtb%_M&kvAaN)@ZVw z+`toz&WG#HkWDjnZE!6nk{e-oFdL^$YnbOCN}JC&{$#$O27@|Tn-skXr)2ml2~O!5 zX+gYoxhoc7qoU?C^3~&!U?kRFtnSEecWuH0B0OvLodgUAi}8p1 zrO6RSXHH}DMc$&|?D004DiOVMHV8kXCP@7NKB zgaZq^^O<7PoKEp72kby@W0Z!Y*Ay{&vfg#C&gG@YVR9g?FEocMUi1gSN$+V+ayF45{a zuDZDTN}mS|;BO%gEf}pjBfN2-gIrU#G5~cucA;dokXW89%>AyXJJI z9X4UlIWA|ZYHgbI z5?oFk@A=Ik7lrEQPDH!H+b`7_Y~aDb_qa=B2^Y&Ow41cU=4WDd40dp5(QS-WMN-=Y z9g;6_-JdNU;|6cPwf$ak*aJIcwL@1n$#l~zi{c{EW?T;DaW*E8DYq?Umtz{nJ&w-M zEMyTDrC&9K$d|kZe2#ws6)L=7K+{ zQw{XnV6UC$6-rW0emqm8wJoeZK)wJIcV?dST}Z;G0Arq{dVDu0&4kd%N!3F1*;*pW zR&qUiFzK=@44#QGw7k1`3t_d8&*kBV->O##t|tonFc2YWrL7_eqg+=+k;!F-`^b8> z#KWCE8%u4k@EprxqiV$VmmtiWxDLgnGu$Vs<8rppV5EajBXL4nyyZM$SWVm!wnCj-B!Wjqj5-5dNXukI2$$|Bu3Lrw}z65Lc=1G z^-#WuQOj$hwNGG?*CM_TO8Bg-1+qc>J7k5c51U8g?ZU5n?HYor;~JIjoWH-G>AoUP ztrWWLbRNqIjW#RT*WqZgPJXU7C)VaW5}MiijYbABmzoru6EmQ*N8cVK7a3|aOB#O& zBl8JY2WKfmj;h#Q!pN%9o@VNLv{OUL?rixHwOZuvX7{IJ{(EdPpuVFoQqIOa7giLVkBOKL@^smUA!tZ1CKRK}#SSM)iQHk)*R~?M!qkCruaS!#oIL1c z?J;U~&FfH#*98^G?i}pA{ z9Jg36t4=%6mhY(quYq*vSxptes9qy|7xSlH?G=S@>u>Ebe;|LVhs~@+06N<4CViBk zUiY$thvX;>Tby6z9Y1edAMQaiH zm^r3v#$Q#2T=X>bsY#D%s!bhs^M9PMAcHbCc0FMHV{u-dwlL;a1eJ63v5U*?Q_8JO zT#50!RD619#j_Uf))0ooADz~*9&lN!bBDRUgE>Vud-i5ck%vT=r^yD*^?Mp@Q^v+V zG#-?gKlr}Eeqifb{|So?HM&g91P8|av8hQoCmQXkd?7wIJwb z_^v8bbg`SAn{I*4bH$u(RZ6*xUhuA~hc=8czK8SHEKTzSxgbwi~9(OqJB&gwb^l4+m`k*Q;_?>Y-APi1{k zAHQ)P)G)f|AyjSgcCFps)Fh6Bca*Xznq36!pV6Az&m{O8$wGFD? zY&O*3*J0;_EqM#jh6^gMQKpXV?#1?>$ml1xvh8nSN>-?H=V;nJIwB07YX$e6vLxH( zqYwQ>qxwR(i4f)DLd)-$P>T-no_c!LsN@)8`e;W@)-Hj0>nJ-}Kla4-ZdPJzI&Mce zv)V_j;(3ERN3_@I$N<^|4Lf`B;8n+bX@bHbcZTopEmDI*Jfl)-pFDvo6svPRoo@(x z);_{lY<;);XzT`dBFpRmGrr}z5u1=pC^S-{ce6iXQlLGcItwJ^mZx{m$&DA_oEZ)B{_bYPq-HA zcH8WGoBG(aBU_j)vEy+_71T34@4dmSg!|M8Vf92Zj6WH7Q7t#OHQqWgFE3ARt+%!T z?oLovLVlnf?2c7pTc)~cc^($_8nyKwsN`RA-23ed3sdj(ys%pjjM+9JrctL;dy8a( z@en&CQmnV(()bu|Y%G1-4a(6x{aLytn$T-;(&{QIJB9vMox11U-1HpD@d(QkaJdEb zG{)+6Dos_L+O3NpWo^=gR?evp|CqEG?L&Ut#D*KLaRFOgOEK(Kq1@!EGcTfo+%A&I z=dLbB+d$u{sh?u)xP{PF8L%;YPPW53+@{>5W=Jt#wQpN;0_HYdw1{ksf_XhO4#2F= zyPx6Lx2<92L-;L5PD`zn6zwIH`Jk($?Qw({erA$^bC;q33hv!d!>%wRhj# zal^hk+WGNg;rJtb-EB(?czvOM=H7dl=vblBwAv>}%1@{}mnpUznfq1cE^sgsL0*4I zJ##!*B?=vI_OEVis5o+_IwMIRrpQyT_Sq~ZU%oY7c5JMIADzpD!Upz9h@iWg_>>~j zOLS;wp^i$-E?4<_cp?RiS%Rd?i;f*mOz=~(&3lo<=@(nR!_Rqiprh@weZlL!t#NCc zO!QTcInq|%#>OVgobj{~ixEUec`E25zJ~*DofsQdzIa@5^nOXj2T;8O`l--(QyU^$t?TGY^7#&FQ+2SS3B#qK*k3`ye?8jUYSajE5iBbJls75CCc(m3dk{t?- zopcER9{Z?TC)mk~gpi^kbbu>b-+a{m#8-y2^p$ka4n60w;Sc2}HMf<8JUvhCL0B&Btk)T`ctE$*qNW8L$`7!r^9T+>=<=2qaq-;ll2{`{Rg zc5a0ZUI$oG&j-qVOuKa=*v4aY#IsoM+1|c4Z)<}lEDvy;5huB@1RJPquU2U*U-;gu z=En2m+qjBzR#DEJDO`WU)hdd{Vj%^0V*KoyZ|5lzV87&g_j~NCjwv0uQVqXOb*QrQ zy|Qn`hxx(58c70$E;L(X0uZZ72M1!6oeg)(cdKO ze0gDaTz+ohR-#d)NbAH4x{I(21yjwvBQfmpLu$)|m{XolbgF!pmsqJ#D}(ylp6uC> z{bqtcI#hT#HW=wl7>p!38sKsJ`r8}lt-q%Keqy%u(xk=yiIJiUw6|5IvkS+#?JTBl z8H5(Q?l#wzazujH!8o>1xtn8#_w+397*_cy8!pQGP%K(Ga3pAjsaTbbXJlQF_+m+-UpUUent@xM zg%jqLUExj~o^vQ3Gl*>wh=_gOr2*|U64_iXb+-111aH}$TjeajM+I20xw(((>fej-@CIz4S1pi$(#}P7`4({6QS2CaQS4NPENDp>sAqD z$bH4KGzXGffkJ7R>V>)>tC)uax{UsN*dbeNC*v}#8Y#OWYwL4t$ePR?VTyIs!wea+ z5Urmc)X|^`MG~*dS6pGSbU+gPJoq*^a=_>$n4|P^w$sMBBy@f*Z^Jg6?n5?oId6f{ z$LW4M|4m502z0t7g<#Bx%X;9<=)smFolV&(V^(7Cv2-sxbxopQ!)*#ZRhTBpx1)Fc zNm1T%bONzv6@#|dz(w02AH8OXe>kQ#1FMCzO}2J_mST)+ExmBr9cva-@?;wnmWMOk z{3_~EX_xadgJGv&H@zK_8{(x84`}+c?oSBX*Ge3VdfTt&F}yCpFP?CpW+BE^cWY0^ zb&uBN!Ja3UzYHK-CTyA5=L zEMW{l3Usky#ly=7px648W31UNV@K)&Ub&zP1c7%)`{);I4b0Q<)B}3;NMG2JH=X$U zfIW4)4n9ZM`-yRj67I)YSLDK)qfUJ_ij}a#aZN~9EXrh8eZY2&=uY%2N0UFF7<~%M zsB8=erOWZ>Ct_#^tHZ|*q`H;A)5;ycw*IcmVxi8_0Xk}aJA^ath+E;xg!x+As(M#0=)3!NJR6H&9+zd#iP(m0PIW8$ z1Y^VX`>jm`W!=WpF*{ioM?C9`yOR>@0q=u7o>BP-eSHqCgMDj!2anwH?s%i2p+Q7D zzszIf5XJpE)IG4;d_(La-xenmF(tgAxK`Y4sQ}BSJEPs6N_U2vI{8=0C_F?@7<(G; zo$~G=8p+076G;`}>{MQ>t>7cm=zGtfbdDXm6||jUU|?X?CaE?(<6bKDYKeHlz}DA8 zXT={X=yp_R;HfJ9h%?eWvQ!dRgz&Su*JfNt!Wu>|XfU&68iRikRrHRW|ZxzRR^`eIGt zIeiDgVS>IeExKVRWW8-=A=yA`}`)ZkWBrZD`hpWIxBGkh&f#ijr449~m`j6{4jiJ*C!oVA8ZC?$1RM#K(_b zL9TW)kN*Y4%^-qPpMP7d4)o?Nk#>aoYHT(*g)qmRUb?**F@pnNiy6Fv9rEiUqD(^O zzyS?nBrX63BTRYduaG(0VVG2yJRe%o&rVrLjbxTaAFTd8s;<<@Qs>u(<193R8>}2_ zuwp{7;H2a*X7_jryzriZXMg?bTuegABb^87@SsKkr2)0Gyiax8KQWstw^v#ix45EVrcEhr>!NMhprl$InQMzjSFH54x5k9qHc`@9uKQzvL4ihcq{^B zPrVR=o_ic%Y>6&rMN)hTZsI7I<3&`#(nl+3y3ys9A~&^=4?PL&nd8)`OfG#n zwAMN$1&>K++c{^|7<4P=2y(B{jJsQ0a#U;HTo4ZmWZYvI{+s;Td{Yzem%0*k#)vjpB zia;J&>}ICate44SFYY3vEelqStQWFihx%^vQ@Do(sOy7yR2@WNv7Y9I^yL=nZr3mb zXKV5t@=?-Sk|b{XMhA7ZGB@2hqsx}4xwCW!in#C zI@}scZlr3-NFJ@NFaJlhyfcw{k^vvtGl`N9xSo**rDW4S}i zM9{fMPWo%4wYDG~BZ18BD+}h|GQKc-g^{++3MY>}W_uq7jGHx{mwE9fZiPCoxN$+7 zrODGGJrOkcPQUB(FD5aoS4g~7#6NR^ma7-!>mHuJfY5kTe6PpNNKC9GGRiu^L31uG z$7v`*JknQHsYB!Tm_W{a32TM099djW%5e+j0Ve_ct}IM>XLF1Ap+YvcrLV=|CKo6S zb+9Nl3_YdKP6%Cxy@6TxZ>;4&nTneadr z_ES90ydCev)LV!dN=#(*f}|ZORFdvkYBni^aLbUk>BajeWIOcmHP#8S)*2U~QKI%S zyrLmtPqb&TphJ;>yAxri#;{uyk`JJqODDw%(Z=2`1uc}br^V%>j!gS)D*q*f_-qf8&D;W1dJgQMlaH5er zN2U<%Smb7==vE}dDI8K7cKz!vs^73o9f>2sgiTzWcwY|BMYHH5%Vn7#kiw&eItCqa zIkR2~Q}>X=Ar8W|^Ms41Fm8o6IB2_j60eOeBB1Br!boW7JnoeX6Gs)?7rW0^5psc- zjS16yb>dFn>KPOF;imD}e!enuIniFzv}n$m2#gCCv4jM#ArwlzZ$7@9&XkFxZ4n!V zj3dyiwW4Ki2QG{@i>yuZXQizw_OkZI^-3otXC{!(lUpJF33gI60ak;Uqitp74|B6I zgg{b=Iz}WkhCGj1M=hu4#Aw173YxIVbISaoc z-nLZC*6Tgivd5V`K%GxhBsp@SUU60-rfc$=wb>zdJzXS&-5(NRRodFk;Kxk!S(O(a0e7oY=E( zAyS;Ow?6Q&XA+cnkCb{28_1N8H#?J!*$MmIwLq^*T_9-z^&UE@A(z9oGYtFy6EZef LrJugUA?W`A8`#=m literal 0 HcmV?d00001 diff --git a/examples/overrides/kv-tag-next/app/globals.css b/examples/overrides/kv-tag-next/app/globals.css new file mode 100644 index 000000000..64152de8b --- /dev/null +++ b/examples/overrides/kv-tag-next/app/globals.css @@ -0,0 +1,14 @@ +html, +body { + max-width: 100vw; + overflow-x: hidden; + height: 100vh; + display: flex; + flex-direction: column; +} + +footer { + padding: 1rem; + display: flex; + justify-content: end; +} diff --git a/examples/overrides/kv-tag-next/app/layout.tsx b/examples/overrides/kv-tag-next/app/layout.tsx new file mode 100644 index 000000000..1189b7eff --- /dev/null +++ b/examples/overrides/kv-tag-next/app/layout.tsx @@ -0,0 +1,28 @@ +import type { Metadata } from "next"; +import "./globals.css"; + +import { getCloudflareContext } from "@opennextjs/cloudflare"; + +export const metadata: Metadata = { + title: "SSG App", + description: "An app in which all the routes are SSG'd", +}; + +export default async function RootLayout({ + children, +}: Readonly<{ + children: React.ReactNode; +}>) { + const cloudflareContext = await getCloudflareContext({ + async: true, + }); + + return ( + + + {children} +
{cloudflareContext.env.APP_VERSION}
+ + + ); +} diff --git a/examples/overrides/kv-tag-next/app/page.module.css b/examples/overrides/kv-tag-next/app/page.module.css new file mode 100644 index 000000000..aad95c19a --- /dev/null +++ b/examples/overrides/kv-tag-next/app/page.module.css @@ -0,0 +1,17 @@ +.page { + display: grid; + grid-template-rows: 20px 1fr 20px; + align-items: center; + justify-items: center; + flex: 1; + border: 3px solid gray; + margin: 1rem; + margin-block-end: 0; +} + +.main { + display: flex; + flex-direction: column; + gap: 32px; + grid-row-start: 2; +} diff --git a/examples/overrides/kv-tag-next/app/page.tsx b/examples/overrides/kv-tag-next/app/page.tsx new file mode 100644 index 000000000..863cddce9 --- /dev/null +++ b/examples/overrides/kv-tag-next/app/page.tsx @@ -0,0 +1,26 @@ +import { unstable_cache } from "next/cache"; +import styles from "./page.module.css"; +import RevalidationButtons from "./components/revalidationButtons"; + +const fetchedDateCb = unstable_cache( + async () => { + return Date.now(); + }, + ["date"], + { tags: ["date"] } +); + +export default async function Home() { + const fetchedDate = await fetchedDateCb(); + return ( +
+
+

Hello from a Statically generated page

+

{Date.now()}

+

{fetchedDate}

+ + +
+
+ ); +} diff --git a/examples/overrides/kv-tag-next/e2e/base.spec.ts b/examples/overrides/kv-tag-next/e2e/base.spec.ts new file mode 100644 index 000000000..e6fef12a8 --- /dev/null +++ b/examples/overrides/kv-tag-next/e2e/base.spec.ts @@ -0,0 +1,47 @@ +import { test, expect } from "@playwright/test"; + +test.describe("kv-tag-next", () => { + test("the index page should work", async ({ page }) => { + await page.goto("/"); + await expect(page.getByText("Hello from a Statically generated page")).toBeVisible(); + }); + + test("the index page should keep the same date on reload", async ({ page }) => { + await page.goto("/"); + const date = await page.getByTestId("date-local").textContent(); + expect(date).not.toBeNull(); + await page.reload(); + const newDate = await page.getByTestId("date-local").textContent(); + expect(date).toEqual(newDate); + }); + + test("the index page should revalidate the date on click on revalidateTag", async ({ page }) => { + await page.goto("/"); + const date = await page.getByTestId("date-fetched").textContent(); + await page.getByTestId("revalidate-tag").click(); + await page.waitForTimeout(100); + const newDate = await page.getByTestId("date-fetched").textContent(); + expect(date).not.toEqual(newDate); + }); + + test("the index page should revalidate the date on click on revalidatePath", async ({ page }) => { + await page.goto("/"); + const date = await page.getByTestId("date-fetched").textContent(); + await page.getByTestId("revalidate-path").click(); + await page.waitForTimeout(100); + const newDate = await page.getByTestId("date-fetched").textContent(); + expect(date).not.toEqual(newDate); + }); + + test("the index page should keep the same date on reload after revalidation", async ({ page }) => { + await page.goto("/"); + const initialDate = await page.getByTestId("date-fetched").textContent(); + await page.getByTestId("revalidate-tag").click(); + await page.waitForTimeout(100); + const date = await page.getByTestId("date-fetched").textContent(); + expect(initialDate).not.toEqual(date); + await page.reload(); + const newDate = await page.getByTestId("date-fetched").textContent(); + expect(date).toEqual(newDate); + }); +}); diff --git a/examples/overrides/kv-tag-next/e2e/playwright.config.ts b/examples/overrides/kv-tag-next/e2e/playwright.config.ts new file mode 100644 index 000000000..76dba7ee5 --- /dev/null +++ b/examples/overrides/kv-tag-next/e2e/playwright.config.ts @@ -0,0 +1,4 @@ +import { configurePlaywright } from "../../../common/config-e2e"; + +// Here we don't want to run the tests in parallel +export default configurePlaywright("kv-tag-next", { parallel: false }); diff --git a/examples/overrides/kv-tag-next/next.config.ts b/examples/overrides/kv-tag-next/next.config.ts new file mode 100644 index 000000000..0fe271b3b --- /dev/null +++ b/examples/overrides/kv-tag-next/next.config.ts @@ -0,0 +1,11 @@ +import type { NextConfig } from "next"; +import { initOpenNextCloudflareForDev } from "@opennextjs/cloudflare"; + +initOpenNextCloudflareForDev(); + +const nextConfig: NextConfig = { + typescript: { ignoreBuildErrors: true }, + eslint: { ignoreDuringBuilds: true }, +}; + +export default nextConfig; diff --git a/examples/overrides/kv-tag-next/open-next.config.ts b/examples/overrides/kv-tag-next/open-next.config.ts new file mode 100644 index 000000000..6315815fc --- /dev/null +++ b/examples/overrides/kv-tag-next/open-next.config.ts @@ -0,0 +1,8 @@ +import { defineCloudflareConfig } from "@opennextjs/cloudflare"; +import kvIncrementalCache from "@opennextjs/cloudflare/overrides/incremental-cache/kv-incremental-cache"; +import kvNextTagCache from "@opennextjs/cloudflare/overrides/tag-cache/kv-next-tag-cache"; + +export default defineCloudflareConfig({ + incrementalCache: kvIncrementalCache, + tagCache: kvNextTagCache, +}); diff --git a/examples/overrides/kv-tag-next/package.json b/examples/overrides/kv-tag-next/package.json new file mode 100644 index 000000000..d3e4a395f --- /dev/null +++ b/examples/overrides/kv-tag-next/package.json @@ -0,0 +1,29 @@ +{ + "name": "d1-tag-next", + "version": "0.1.0", + "private": true, + "scripts": { + "dev": "next dev", + "build": "next build", + "start": "next start", + "lint": "next lint", + "build:worker": "pnpm opennextjs-cloudflare build --skipWranglerConfigCheck", + "preview:worker": "pnpm opennextjs-cloudflare preview --config wrangler.e2e.jsonc", + "preview": "pnpm build:worker && pnpm preview:worker", + "e2e": "playwright test -c e2e/playwright.config.ts" + }, + "dependencies": { + "react": "catalog:e2e", + "react-dom": "catalog:e2e", + "next": "catalog:e2e" + }, + "devDependencies": { + "@opennextjs/cloudflare": "workspace:*", + "@playwright/test": "catalog:", + "@types/node": "catalog:", + "@types/react": "catalog:e2e", + "@types/react-dom": "catalog:e2e", + "typescript": "catalog:", + "wrangler": "catalog:" + } +} diff --git a/examples/overrides/kv-tag-next/tsconfig.json b/examples/overrides/kv-tag-next/tsconfig.json new file mode 100644 index 000000000..96f8e1b62 --- /dev/null +++ b/examples/overrides/kv-tag-next/tsconfig.json @@ -0,0 +1,27 @@ +{ + "compilerOptions": { + "target": "ES2017", + "lib": ["dom", "dom.iterable", "esnext"], + "allowJs": true, + "skipLibCheck": true, + "strict": true, + "noEmit": true, + "esModuleInterop": true, + "module": "esnext", + "moduleResolution": "bundler", + "resolveJsonModule": true, + "isolatedModules": true, + "jsx": "preserve", + "incremental": true, + "plugins": [ + { + "name": "next" + } + ], + "paths": { + "@/*": ["./*"] + } + }, + "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"], + "exclude": ["node_modules"] +} diff --git a/examples/overrides/kv-tag-next/wrangler.e2e.jsonc b/examples/overrides/kv-tag-next/wrangler.e2e.jsonc new file mode 100644 index 000000000..0f8b55572 --- /dev/null +++ b/examples/overrides/kv-tag-next/wrangler.e2e.jsonc @@ -0,0 +1,25 @@ +{ + "$schema": "node_modules/wrangler/config-schema.json", + "main": ".open-next/worker.js", + "name": "ssg-app", + "compatibility_date": "2025-02-04", + "compatibility_flags": ["nodejs_compat", "global_fetch_strictly_public"], + "assets": { + "directory": ".open-next/assets", + "binding": "ASSETS", + }, + "vars": { + "APP_VERSION": "1.2.345", + }, + "kv_namespaces": [ + { + "binding": "NEXT_INC_CACHE_KV", + "id": "INC-CACHE", + "preview_id": "", + }, + { + "binding": "NEXT_TAG_CACHE_KV", + "id": "TAG-CACHE", + }, + ], +} diff --git a/packages/cloudflare/src/api/cloudflare-context.ts b/packages/cloudflare/src/api/cloudflare-context.ts index d10d79d30..7fce98bde 100644 --- a/packages/cloudflare/src/api/cloudflare-context.ts +++ b/packages/cloudflare/src/api/cloudflare-context.ts @@ -33,6 +33,9 @@ declare global { // D1 db used for the tag cache NEXT_TAG_CACHE_D1?: D1Database; + // KV used for the tag cache + NEXT_TAG_CACHE_KV?: KVNamespace; + // Durables object namespace to use for the sharded tag cache NEXT_TAG_CACHE_DO_SHARDED?: DurableObjectNamespace; // Queue of failed tag write diff --git a/packages/cloudflare/src/api/overrides/tag-cache/d1-next-tag-cache.spec.ts b/packages/cloudflare/src/api/overrides/tag-cache/d1-next-tag-cache.spec.ts index f70be6dd7..7d73619ae 100644 --- a/packages/cloudflare/src/api/overrides/tag-cache/d1-next-tag-cache.spec.ts +++ b/packages/cloudflare/src/api/overrides/tag-cache/d1-next-tag-cache.spec.ts @@ -59,7 +59,7 @@ describe("D1NextModeTagCache", () => { env: { [BINDING_NAME]: mockDb, }, - } as ReturnType); + } as unknown as ReturnType); // Reset global config (globalThis as { openNextConfig?: { dangerous?: { disableTagCache?: boolean } } }).openNextConfig = { diff --git a/packages/cloudflare/src/api/overrides/tag-cache/d1-next-tag-cache.ts b/packages/cloudflare/src/api/overrides/tag-cache/d1-next-tag-cache.ts index 040032e4e..7c98ab0b9 100644 --- a/packages/cloudflare/src/api/overrides/tag-cache/d1-next-tag-cache.ts +++ b/packages/cloudflare/src/api/overrides/tag-cache/d1-next-tag-cache.ts @@ -1,7 +1,6 @@ import { error } from "@opennextjs/aws/adapters/logger.js"; import type { NextModeTagCache } from "@opennextjs/aws/types/overrides.js"; -import type { OpenNextConfig } from "../../../api/config.js"; import { getCloudflareContext } from "../../cloudflare-context.js"; import { debugCache, FALLBACK_BUILD_ID, purgeCacheByTags } from "../internal.js"; @@ -28,9 +27,9 @@ export class D1NextModeTagCache implements NextModeTagCache { // We only care about the most recent revalidation return (result.results[0]?.time ?? 0) as number; } catch (e) { - error(e); // By default we don't want to crash here, so we return false // We still log the error though so we can debug it + error(e); return 0; } } @@ -57,7 +56,6 @@ export class D1NextModeTagCache implements NextModeTagCache { async writeTags(tags: string[]): Promise { const { isDisabled, db } = this.getConfig(); - // TODO: Remove `tags.length === 0` when https://github.com/opennextjs/opennextjs-aws/pull/828 is used if (isDisabled || tags.length === 0) return Promise.resolve(); await db.batch( @@ -75,8 +73,7 @@ export class D1NextModeTagCache implements NextModeTagCache { if (!db) debugCache("No D1 database found"); - const isDisabled = !!(globalThis as unknown as { openNextConfig: OpenNextConfig }).openNextConfig - .dangerous?.disableTagCache; + const isDisabled = Boolean(globalThis.openNextConfig.dangerous?.disableTagCache); return !db || isDisabled ? { isDisabled: true as const } diff --git a/packages/cloudflare/src/api/overrides/tag-cache/do-sharded-tag-cache.ts b/packages/cloudflare/src/api/overrides/tag-cache/do-sharded-tag-cache.ts index cfbeacfb1..618cc1445 100644 --- a/packages/cloudflare/src/api/overrides/tag-cache/do-sharded-tag-cache.ts +++ b/packages/cloudflare/src/api/overrides/tag-cache/do-sharded-tag-cache.ts @@ -3,8 +3,8 @@ import { generateShardId } from "@opennextjs/aws/core/routing/queue.js"; import type { NextModeTagCache } from "@opennextjs/aws/types/overrides.js"; import { IgnorableError } from "@opennextjs/aws/utils/error.js"; -import type { OpenNextConfig } from "../../../api/config.js"; import { getCloudflareContext } from "../../cloudflare-context.js"; +import type { OpenNextConfig } from "../../config.js"; import { DOShardedTagCache } from "../../durable-objects/sharded-tag-cache.js"; import { debugCache, purgeCacheByTags } from "../internal.js"; diff --git a/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.spec.ts b/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.spec.ts new file mode 100644 index 000000000..0c7ae1807 --- /dev/null +++ b/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.spec.ts @@ -0,0 +1,306 @@ +import { error } from "@opennextjs/aws/adapters/logger.js"; +import { beforeEach, describe, expect, it, vi } from "vitest"; + +import { getCloudflareContext } from "../../cloudflare-context.js"; +import { FALLBACK_BUILD_ID, purgeCacheByTags } from "../internal.js"; +import { BINDING_NAME, KVNextModeTagCache, NAME } from "./kv-next-tag-cache.js"; + +// Mock dependencies +vi.mock("@opennextjs/aws/adapters/logger.js", () => ({ + error: vi.fn(), +})); + +vi.mock("../../cloudflare-context.js", () => ({ + getCloudflareContext: vi.fn(), +})); + +vi.mock("../internal.js", () => ({ + debugCache: vi.fn(), + FALLBACK_BUILD_ID: "fallback-build-id", + purgeCacheByTags: vi.fn(), +})); + +describe("KVNextModeTagCache", () => { + let tagCache: KVNextModeTagCache; + let mockKv: { + put: ReturnType; + get: ReturnType; + }; + let mockGet: ReturnType; + let mockPut: ReturnType; + + beforeEach(() => { + vi.clearAllMocks(); + + // Setup mock database + mockGet = vi.fn(); + mockPut = vi.fn(); + + mockKv = { + get: mockGet, + put: mockPut, + }; + + // Setup cloudflare context mock + vi.mocked(getCloudflareContext).mockReturnValue({ + env: { + [BINDING_NAME]: mockKv, + }, + } as unknown as ReturnType); + + // Reset global config + (globalThis as { openNextConfig?: { dangerous?: { disableTagCache?: boolean } } }).openNextConfig = { + dangerous: { + disableTagCache: false, + }, + }; + + // Reset environment variables + vi.unstubAllEnvs(); + + tagCache = new KVNextModeTagCache(); + }); + + describe("constructor and properties", () => { + it("should have correct mode and name", () => { + expect(tagCache.mode).toBe("nextMode"); + expect(tagCache.name).toBe(NAME); + }); + }); + + describe("getLastRevalidated", () => { + it("should return 0 when cache is disabled", async () => { + ( + globalThis as { openNextConfig?: { dangerous?: { disableTagCache?: boolean } } } + ).openNextConfig!.dangerous!.disableTagCache = true; + + const result = await tagCache.getLastRevalidated(["tag1", "tag2"]); + + expect(result).toBe(0); + expect(mockGet).not.toHaveBeenCalled(); + }); + + it("should return 0 when no KV is available", async () => { + vi.mocked(getCloudflareContext).mockReturnValue({ + env: {}, + } as ReturnType); + + const result = await tagCache.getLastRevalidated(["tag1", "tag2"]); + + expect(result).toBe(0); + expect(error).toHaveBeenCalledWith("No KV binding NEXT_TAG_CACHE_KV found"); + }); + + it("should return the maximum revalidation time for given tags", async () => { + const mockTime = 1234567890; + mockGet.mockResolvedValue( + new Map([ + ["tag1", mockTime], + ["tag2", mockTime - 100], + ]) + ); + + const tags = ["tag1", "tag2"]; + const result = await tagCache.getLastRevalidated(tags); + + expect(result).toBe(mockTime); + expect(mockGet).toHaveBeenCalledWith([`${FALLBACK_BUILD_ID}/tag1`, `${FALLBACK_BUILD_ID}/tag2`], { + type: "json", + }); + }); + + it("should return 0 when no results are found", async () => { + mockGet.mockResolvedValue(new Map([["tag1", null]])); + + const result = await tagCache.getLastRevalidated(["tag1"]); + + expect(result).toBe(0); + }); + + it("should return 0 when KV get throws an error", async () => { + const mockError = new Error("Database error"); + mockGet.mockRejectedValue(mockError); + + const result = await tagCache.getLastRevalidated(["tag1"]); + + expect(result).toBe(0); + expect(error).toHaveBeenCalledWith(mockError); + }); + + it("should use custom build ID when NEXT_BUILD_ID is set", async () => { + const customBuildId = "custom-build-id"; + vi.stubEnv("NEXT_BUILD_ID", customBuildId); + + mockGet.mockResolvedValue(new Map([["tag1", null]])); + + await tagCache.getLastRevalidated(["tag1"]); + + expect(mockGet).toHaveBeenCalledWith([`${customBuildId}/tag1`], { type: "json" }); + }); + }); + + describe("hasBeenRevalidated", () => { + it("should return false when cache is disabled", async () => { + ( + globalThis as { openNextConfig?: { dangerous?: { disableTagCache?: boolean } } } + ).openNextConfig!.dangerous!.disableTagCache = true; + + const result = await tagCache.hasBeenRevalidated(["tag1"], 1000); + + expect(result).toBe(false); + expect(mockGet).not.toHaveBeenCalled(); + }); + + it("should return false when no KV is available", async () => { + vi.mocked(getCloudflareContext).mockReturnValue({ + env: {}, + } as ReturnType); + + const result = await tagCache.hasBeenRevalidated(["tag1"], 1000); + + expect(result).toBe(false); + }); + + it("should return true when tags have been revalidated after lastModified", async () => { + mockGet.mockResolvedValue( + new Map([ + ["tag1", 1000], + ["tag2", null], + ]) + ); + + const tags = ["tag1", "tag2"]; + const lastModified = 500; + const result = await tagCache.hasBeenRevalidated(tags, lastModified); + + expect(result).toBe(true); + }); + + it("should return false when no tags have been revalidated", async () => { + mockGet.mockResolvedValue( + new Map([ + ["tag1", null], + ["tag2", null], + ]) + ); + + const result = await tagCache.hasBeenRevalidated(["tag1", "tag2"], 1000); + + expect(result).toBe(false); + }); + + it("should return false when KV get throws an error", async () => { + const mockError = new Error("Database error"); + mockGet.mockRejectedValue(mockError); + + const result = await tagCache.hasBeenRevalidated(["tag1"], 1000); + + expect(result).toBe(false); + expect(error).toHaveBeenCalledWith(mockError); + }); + }); + + describe("writeTags", () => { + it("should do nothing when cache is disabled", async () => { + ( + globalThis as { openNextConfig?: { dangerous?: { disableTagCache?: boolean } } } + ).openNextConfig!.dangerous!.disableTagCache = true; + + await tagCache.writeTags(["tag1", "tag2"]); + + expect(mockPut).not.toHaveBeenCalled(); + expect(purgeCacheByTags).not.toHaveBeenCalled(); + }); + + it("should do nothing when no KV is available", async () => { + vi.mocked(getCloudflareContext).mockReturnValue({ + env: {}, + } as ReturnType); + + await tagCache.writeTags(["tag1", "tag2"]); + + expect(mockPut).not.toHaveBeenCalled(); + expect(purgeCacheByTags).not.toHaveBeenCalled(); + }); + + it("should do nothing when tags array is empty", async () => { + await tagCache.writeTags([]); + + expect(mockPut).not.toHaveBeenCalled(); + expect(purgeCacheByTags).not.toHaveBeenCalled(); + }); + + it("should write tags to KV and purge cache", async () => { + const currentTime = Date.now(); + vi.spyOn(Date, "now").mockReturnValue(currentTime); + + const tags = ["tag1", "tag2"]; + await tagCache.writeTags(tags); + + expect(mockPut).toHaveBeenCalledTimes(2); + expect(mockPut).toHaveBeenCalledWith("fallback-build-id/tag1", String(currentTime)); + expect(mockPut).toHaveBeenCalledWith("fallback-build-id/tag2", String(currentTime)); + + expect(purgeCacheByTags).toHaveBeenCalledWith(tags); + }); + + it("should handle single tag", async () => { + const currentTime = Date.now(); + vi.spyOn(Date, "now").mockReturnValue(currentTime); + + await tagCache.writeTags(["single-tag"]); + + expect(mockPut).toHaveBeenCalledTimes(1); + expect(mockPut).toHaveBeenCalledWith("fallback-build-id/single-tag", String(currentTime)); + + expect(purgeCacheByTags).toHaveBeenCalledWith(["single-tag"]); + }); + }); + + describe("getCacheKey", () => { + it("should generate cache key with build ID and tag", () => { + const key = "test-tag"; + const cacheKey = (tagCache as unknown as { getCacheKey: (key: string) => string }).getCacheKey(key); + + expect(cacheKey).toBe(`${FALLBACK_BUILD_ID}/${key}`); + }); + + it("should use custom build ID when NEXT_BUILD_ID is set", () => { + const customBuildId = "custom-build-id"; + vi.stubEnv("NEXT_BUILD_ID", customBuildId); + + const key = "test-tag"; + const cacheKey = (tagCache as unknown as { getCacheKey: (key: string) => string }).getCacheKey(key); + + expect(cacheKey).toBe(`${customBuildId}/${key}`); + }); + + it("should handle double slashes by replacing them with single slash", () => { + vi.stubEnv("NEXT_BUILD_ID", "build//id"); + + const key = "test-tag"; + const cacheKey = (tagCache as unknown as { getCacheKey: (key: string) => string }).getCacheKey(key); + + expect(cacheKey).toBe("build/id/test-tag"); + }); + }); + + describe("getBuildId", () => { + it("should return NEXT_BUILD_ID when set", () => { + const customBuildId = "custom-build-id"; + vi.stubEnv("NEXT_BUILD_ID", customBuildId); + + const buildId = (tagCache as unknown as { getBuildId: () => string }).getBuildId(); + + expect(buildId).toBe(customBuildId); + }); + + it("should return fallback build ID when NEXT_BUILD_ID is not set", () => { + // Environment variables are cleared by vi.unstubAllEnvs() in beforeEach + + const buildId = (tagCache as unknown as { getBuildId: () => string }).getBuildId(); + + expect(buildId).toBe(FALLBACK_BUILD_ID); + }); + }); +}); diff --git a/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts b/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts new file mode 100644 index 000000000..1c3f52aff --- /dev/null +++ b/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts @@ -0,0 +1,95 @@ +import { error } from "@opennextjs/aws/adapters/logger.js"; +import type { NextModeTagCache } from "@opennextjs/aws/types/overrides.js"; + +import { getCloudflareContext } from "../../cloudflare-context.js"; +import { FALLBACK_BUILD_ID, purgeCacheByTags } from "../internal.js"; + +export const NAME = "kv-next-mode-tag-cache"; + +export const BINDING_NAME = "NEXT_TAG_CACHE_KV"; + +/** + * Tag Cache based on a KV namespace + * + * Warning: + * This implementation is considered experimental for now. + * KV is eventually consistency and can take up to 60s to reflect the last write. + * This means that: + * - revalidations can take up to 60s to apply + * - when a page depends on multiple tags they can be inconsistent for up to 60s + */ +export class KVNextModeTagCache implements NextModeTagCache { + readonly mode = "nextMode" as const; + readonly name = NAME; + + async getLastRevalidated(tags: string[]): Promise { + const kv = this.getKv(); + if (!kv) { + return 0; + } + + console.log(`[KVNextModeTagCache] getLastRevalidated, tags=${tags}`); + try { + const keys = tags.map((tag) => this.getCacheKey(tag)); + // Use the `json` type to get back numbers/null + const result: Map = await kv.get(keys, { type: "json" }); + + const revalidations = [...result.values()].filter((v) => v != null); + + return revalidations.length === 0 ? 0 : Math.max(...revalidations); + } catch (e) { + // By default we don't want to crash here, so we return false + // We still log the error though so we can debug it + error(e); + return 0; + } + } + + async hasBeenRevalidated(tags: string[], lastModified?: number): Promise { + return (await this.getLastRevalidated(tags)) > (lastModified ?? Date.now()); + } + + async writeTags(tags: string[]): Promise { + const kv = this.getKv(); + if (!kv || tags.length === 0) { + return Promise.resolve(); + } + + const timeMs = String(Date.now()); + + await Promise.all( + tags.map(async (tag) => { + await kv.put(this.getCacheKey(tag), timeMs); + }) + ); + await purgeCacheByTags(tags); + } + + /** + * Returns the KV namespace when it exists and tag cache is not disabled. + * + * @returns KV namespace or undefined + */ + private getKv(): KVNamespace | undefined { + const kv = getCloudflareContext().env[BINDING_NAME]; + + if (!kv) { + error(`No KV binding ${BINDING_NAME} found`); + return undefined; + } + + const isDisabled = Boolean(globalThis.openNextConfig.dangerous?.disableTagCache); + + return isDisabled ? undefined : kv; + } + + protected getCacheKey(key: string) { + return `${this.getBuildId()}/${key}`.replaceAll("//", "/"); + } + + protected getBuildId() { + return process.env.NEXT_BUILD_ID ?? FALLBACK_BUILD_ID; + } +} + +export default new KVNextModeTagCache(); diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 442a2240b..6a98ff508 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -7,8 +7,8 @@ settings: catalogs: default: '@cloudflare/workers-types': - specifier: ^4.20250224.0 - version: 4.20250224.0 + specifier: ^4.20250917.0 + version: 4.20250924.0 '@dotenvx/dotenvx': specifier: 1.31.0 version: 1.31.0 @@ -198,7 +198,7 @@ importers: version: 5.7.3 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/bugs/gh-219: dependencies: @@ -426,7 +426,7 @@ importers: version: 5.7.3 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/e2e/app-pages-router: dependencies: @@ -472,7 +472,7 @@ importers: version: 5.7.3 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/e2e/app-router: dependencies: @@ -518,7 +518,7 @@ importers: version: 5.7.3 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/e2e/experimental: dependencies: @@ -552,7 +552,7 @@ importers: version: 5.7.3 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/e2e/pages-router: dependencies: @@ -598,7 +598,7 @@ importers: version: 5.7.3 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/e2e/shared: dependencies: @@ -657,7 +657,7 @@ importers: version: 5.7.3 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/next-partial-prerendering: dependencies: @@ -718,7 +718,7 @@ importers: version: 5.5.3 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/overrides/d1-tag-next: dependencies: @@ -752,7 +752,41 @@ importers: version: 5.7.3 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) + + examples/overrides/kv-tag-next: + dependencies: + next: + specifier: catalog:e2e + version: 15.4.5(@opentelemetry/api@1.9.0)(@playwright/test@1.51.1)(react-dom@19.0.0(react@19.0.0))(react@19.0.0) + react: + specifier: catalog:e2e + version: 19.0.0 + react-dom: + specifier: catalog:e2e + version: 19.0.0(react@19.0.0) + devDependencies: + '@opennextjs/cloudflare': + specifier: workspace:* + version: link:../../../packages/cloudflare + '@playwright/test': + specifier: 'catalog:' + version: 1.51.1 + '@types/node': + specifier: 'catalog:' + version: 22.2.0 + '@types/react': + specifier: catalog:e2e + version: 19.0.0 + '@types/react-dom': + specifier: catalog:e2e + version: 19.0.0 + typescript: + specifier: 'catalog:' + version: 5.7.3 + wrangler: + specifier: 'catalog:' + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/overrides/memory-queue: dependencies: @@ -786,7 +820,7 @@ importers: version: 5.7.3 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/overrides/r2-incremental-cache: dependencies: @@ -820,7 +854,7 @@ importers: version: 5.7.3 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/overrides/static-assets-incremental-cache: dependencies: @@ -854,7 +888,7 @@ importers: version: 5.7.3 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/playground14: dependencies: @@ -879,7 +913,7 @@ importers: version: 22.2.0 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/playground15: dependencies: @@ -904,7 +938,7 @@ importers: version: 22.2.0 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/prisma: dependencies: @@ -944,7 +978,7 @@ importers: version: 5.7.3 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/ssg-app: dependencies: @@ -978,7 +1012,7 @@ importers: version: 5.7.3 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) examples/vercel-blog-starter: dependencies: @@ -1033,7 +1067,7 @@ importers: version: 5.7.3 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) packages/cloudflare: dependencies: @@ -1057,14 +1091,14 @@ importers: version: 0.8.6 wrangler: specifier: 'catalog:' - version: 4.38.0(@cloudflare/workers-types@4.20250224.0) + version: 4.38.0(@cloudflare/workers-types@4.20250924.0) yargs: specifier: 'catalog:' version: 18.0.0 devDependencies: '@cloudflare/workers-types': specifier: 'catalog:' - version: 4.20250224.0 + version: 4.20250924.0 '@eslint/js': specifier: 'catalog:' version: 9.11.1 @@ -1756,8 +1790,8 @@ packages: '@cloudflare/workers-types@4.20250214.0': resolution: {integrity: sha512-+M8oOFVbyXT5GeJrYLWMUGyPf5wGB4+k59PPqdedtOig7NjZ5r4S79wMdaZ/EV5IV8JPtZBSNjTKpDnNmfxjaQ==} - '@cloudflare/workers-types@4.20250224.0': - resolution: {integrity: sha512-j6ZwQ5G2moQRaEtGI2u5TBQhVXv/XwOS5jfBAheZHcpCM07zm8j0i8jZHHLq/6VA8e6VRjKohOyj5j6tZ1KHLQ==} + '@cloudflare/workers-types@4.20250924.0': + resolution: {integrity: sha512-pi/OYCroYdwjFWbkciC5oYzlyimDF4ymNotDK0zpLNq91Ogz1IXnVBAYV7fCFAJ/zIxU0RiIBrJIOll/C0pR9Q==} '@cspotcode/source-map-support@0.8.1': resolution: {integrity: sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==} @@ -11266,7 +11300,7 @@ snapshots: '@cloudflare/workers-types@4.20250214.0': {} - '@cloudflare/workers-types@4.20250224.0': {} + '@cloudflare/workers-types@4.20250924.0': {} '@cspotcode/source-map-support@0.8.1': dependencies: @@ -14098,7 +14132,7 @@ snapshots: '@types/mock-fs@4.13.4': dependencies: - '@types/node': 22.2.0 + '@types/node': 20.14.10 '@types/ms@0.7.34': {} @@ -20611,7 +20645,7 @@ snapshots: - bufferutil - utf-8-validate - wrangler@4.38.0(@cloudflare/workers-types@4.20250224.0): + wrangler@4.38.0(@cloudflare/workers-types@4.20250924.0): dependencies: '@cloudflare/kv-asset-handler': 0.4.0 '@cloudflare/unenv-preset': 2.7.4(unenv@2.0.0-rc.21)(workerd@1.20250917.0) @@ -20622,7 +20656,7 @@ snapshots: unenv: 2.0.0-rc.21 workerd: 1.20250917.0 optionalDependencies: - '@cloudflare/workers-types': 4.20250224.0 + '@cloudflare/workers-types': 4.20250924.0 fsevents: 2.3.3 transitivePeerDependencies: - bufferutil diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml index e3bff2094..eefb93448 100644 --- a/pnpm-workspace.yaml +++ b/pnpm-workspace.yaml @@ -8,7 +8,7 @@ packages: - benchmarking catalog: - "@cloudflare/workers-types": ^4.20250224.0 + "@cloudflare/workers-types": ^4.20250917.0 "@dotenvx/dotenvx": 1.31.0 "@eslint/js": ^9.11.1 "@playwright/test": ^1.51.1 From d1a92ed989d4bd7e8b9cfccd65bd0cbf68cff62e Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Wed, 24 Sep 2025 14:31:10 +0200 Subject: [PATCH 2/6] fixup! remove debug logs --- .../cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts b/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts index 1c3f52aff..db2d30e2c 100644 --- a/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts +++ b/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts @@ -28,7 +28,6 @@ export class KVNextModeTagCache implements NextModeTagCache { return 0; } - console.log(`[KVNextModeTagCache] getLastRevalidated, tags=${tags}`); try { const keys = tags.map((tag) => this.getCacheKey(tag)); // Use the `json` type to get back numbers/null From ff2b42d184c7e9bc0522c77952bbd3a977d196dc Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Wed, 24 Sep 2025 19:05:18 +0200 Subject: [PATCH 3/6] Update packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts Co-authored-by: conico974 --- .../cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts b/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts index db2d30e2c..684f1dfb6 100644 --- a/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts +++ b/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts @@ -13,7 +13,7 @@ export const BINDING_NAME = "NEXT_TAG_CACHE_KV"; * * Warning: * This implementation is considered experimental for now. - * KV is eventually consistency and can take up to 60s to reflect the last write. + * KV is eventually consistent and can take up to 60s to reflect the last write. * This means that: * - revalidations can take up to 60s to apply * - when a page depends on multiple tags they can be inconsistent for up to 60s From cf565ec02be6b15628825169c35492a29fe9ed68 Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Wed, 24 Sep 2025 19:06:53 +0200 Subject: [PATCH 4/6] Update examples/overrides/kv-tag-next/package.json Co-authored-by: conico974 --- examples/overrides/kv-tag-next/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/overrides/kv-tag-next/package.json b/examples/overrides/kv-tag-next/package.json index d3e4a395f..0906798b6 100644 --- a/examples/overrides/kv-tag-next/package.json +++ b/examples/overrides/kv-tag-next/package.json @@ -1,5 +1,5 @@ { - "name": "d1-tag-next", + "name": "kv-tag-next", "version": "0.1.0", "private": true, "scripts": { From e2e1b0a81435349333373e5a78ebb995d6a4eca9 Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Thu, 25 Sep 2025 08:41:56 +0200 Subject: [PATCH 5/6] fixup! clarify comment --- .../src/api/overrides/tag-cache/kv-next-tag-cache.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts b/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts index 684f1dfb6..f3d684ec6 100644 --- a/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts +++ b/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts @@ -16,7 +16,9 @@ export const BINDING_NAME = "NEXT_TAG_CACHE_KV"; * KV is eventually consistent and can take up to 60s to reflect the last write. * This means that: * - revalidations can take up to 60s to apply - * - when a page depends on multiple tags they can be inconsistent for up to 60s + * - when a page depends on multiple tags they can be inconsistent for up to 60s. + * It also means that cached data could be outdated for one tag when other tags + * are revalidated resulting in the page being generated based on outdated data. */ export class KVNextModeTagCache implements NextModeTagCache { readonly mode = "nextMode" as const; From b27784bfc9585262d61dfa5d0f985b636f8edca1 Mon Sep 17 00:00:00 2001 From: Victor Berchet Date: Thu, 25 Sep 2025 10:44:24 +0200 Subject: [PATCH 6/6] fixup: add TODO comments --- .../cloudflare/src/api/overrides/tag-cache/d1-next-tag-cache.ts | 2 ++ .../src/api/overrides/tag-cache/do-sharded-tag-cache.ts | 2 ++ .../cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts | 2 ++ 3 files changed, 6 insertions(+) diff --git a/packages/cloudflare/src/api/overrides/tag-cache/d1-next-tag-cache.ts b/packages/cloudflare/src/api/overrides/tag-cache/d1-next-tag-cache.ts index 7c98ab0b9..b554de787 100644 --- a/packages/cloudflare/src/api/overrides/tag-cache/d1-next-tag-cache.ts +++ b/packages/cloudflare/src/api/overrides/tag-cache/d1-next-tag-cache.ts @@ -65,6 +65,8 @@ export class D1NextModeTagCache implements NextModeTagCache { .bind(this.getCacheKey(tag), Date.now()) ) ); + + // TODO: See https://github.com/opennextjs/opennextjs-aws/issues/986 await purgeCacheByTags(tags); } diff --git a/packages/cloudflare/src/api/overrides/tag-cache/do-sharded-tag-cache.ts b/packages/cloudflare/src/api/overrides/tag-cache/do-sharded-tag-cache.ts index 618cc1445..30f9c9fbb 100644 --- a/packages/cloudflare/src/api/overrides/tag-cache/do-sharded-tag-cache.ts +++ b/packages/cloudflare/src/api/overrides/tag-cache/do-sharded-tag-cache.ts @@ -227,6 +227,8 @@ class ShardedDOTagCache implements NextModeTagCache { await this.performWriteTagsWithRetry(doId, tags, currentTime); }) ); + + // TODO: See https://github.com/opennextjs/opennextjs-aws/issues/986 await purgeCacheByTags(tags); } diff --git a/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts b/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts index f3d684ec6..5628e9497 100644 --- a/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts +++ b/packages/cloudflare/src/api/overrides/tag-cache/kv-next-tag-cache.ts @@ -63,6 +63,8 @@ export class KVNextModeTagCache implements NextModeTagCache { await kv.put(this.getCacheKey(tag), timeMs); }) ); + + // TODO: See https://github.com/opennextjs/opennextjs-aws/issues/986 await purgeCacheByTags(tags); }