From 07c886159faafc691645c30ad0917f19069d8c6a Mon Sep 17 00:00:00 2001 From: DuCanhGH <75556609+DuCanhGH@users.noreply.github.com> Date: Wed, 31 Jan 2024 23:41:24 +0700 Subject: [PATCH] fix(core): fixed invalid precache manifest with `assetPrefix` [bump] --- .changeset/poor-pumpkins-protect.md | 7 ++++ .../integration/asset-prefix/app/favicon.ico | Bin 0 -> 25931 bytes .../integration/asset-prefix/app/layout.tsx | 8 +++++ .../integration/asset-prefix/app/page.tsx | 10 ++++++ .../integration/asset-prefix/index.test.ts | 28 +++++++++++++++ .../integration/asset-prefix/next.config.mjs | 15 ++++++++ .../integration/asset-prefix/public/next.svg | 1 + .../integration/asset-prefix/tsconfig.json | 29 ++++++++++++++++ packages/next-pwa/src/context.ts | 25 ++++++++++---- packages/next-pwa/src/utils/index.ts | 2 ++ .../next-pwa/src/utils/normalize-path-sep.ts | 9 +++++ .../src/utils/relative-to-output-path.ts | 32 ++++++++++++++++++ 12 files changed, 159 insertions(+), 7 deletions(-) create mode 100644 .changeset/poor-pumpkins-protect.md create mode 100644 packages/next-pwa/__tests__/integration/asset-prefix/app/favicon.ico create mode 100644 packages/next-pwa/__tests__/integration/asset-prefix/app/layout.tsx create mode 100644 packages/next-pwa/__tests__/integration/asset-prefix/app/page.tsx create mode 100644 packages/next-pwa/__tests__/integration/asset-prefix/index.test.ts create mode 100644 packages/next-pwa/__tests__/integration/asset-prefix/next.config.mjs create mode 100644 packages/next-pwa/__tests__/integration/asset-prefix/public/next.svg create mode 100644 packages/next-pwa/__tests__/integration/asset-prefix/tsconfig.json create mode 100644 packages/next-pwa/src/utils/normalize-path-sep.ts create mode 100644 packages/next-pwa/src/utils/relative-to-output-path.ts diff --git a/.changeset/poor-pumpkins-protect.md b/.changeset/poor-pumpkins-protect.md new file mode 100644 index 00000000..a7483573 --- /dev/null +++ b/.changeset/poor-pumpkins-protect.md @@ -0,0 +1,7 @@ +--- +"@ducanh2912/next-pwa": patch +--- + +fix(core): fixed invalid precache manifest with `assetPrefix` + +- Turns out it is much more complex than we thought. To make this work with `assetPrefix`, `distDir`, and `basePath`, we now remove `${publicPath}${publicDirRelativeToOutputPath}` from public files in `manifestTransforms` because `assetPrefix` is not intended for files that are in the public directory and we also want to remove `/_next/${publicDirRelativeToOutputPath}` from the URL, since that is not how we resolve files in the public directory. \ No newline at end of file diff --git a/packages/next-pwa/__tests__/integration/asset-prefix/app/favicon.ico b/packages/next-pwa/__tests__/integration/asset-prefix/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/packages/next-pwa/__tests__/integration/asset-prefix/app/layout.tsx b/packages/next-pwa/__tests__/integration/asset-prefix/app/layout.tsx new file mode 100644 index 00000000..7d0f37de --- /dev/null +++ b/packages/next-pwa/__tests__/integration/asset-prefix/app/layout.tsx @@ -0,0 +1,8 @@ +const RootLayout = ({ children }: { children: React.ReactNode }) => ( + + + {children} + +); + +export default RootLayout; diff --git a/packages/next-pwa/__tests__/integration/asset-prefix/app/page.tsx b/packages/next-pwa/__tests__/integration/asset-prefix/app/page.tsx new file mode 100644 index 00000000..23bede38 --- /dev/null +++ b/packages/next-pwa/__tests__/integration/asset-prefix/app/page.tsx @@ -0,0 +1,10 @@ +import Image from "next/image"; + +const Page = () => ( +
+

This is a Next.js PWA!

+ Next.js Logo +
+); + +export default Page; diff --git a/packages/next-pwa/__tests__/integration/asset-prefix/index.test.ts b/packages/next-pwa/__tests__/integration/asset-prefix/index.test.ts new file mode 100644 index 00000000..25369d82 --- /dev/null +++ b/packages/next-pwa/__tests__/integration/asset-prefix/index.test.ts @@ -0,0 +1,28 @@ +import { createDescribe } from "../../test-utils/index.ts"; + +createDescribe("integration basePath", { sourceDir: __dirname, skipInstall: false }, ({ next, testMode }) => { + it("should render", async () => { + const $ = await next.render("/next-pwa"); + expect($("#welcome-text").text()).toBe("This is a Next.js PWA!"); + }); + + it("should fetch image", async () => { + const image = await next.fetch("/next-pwa/next.svg"); + expect(image.status).toBe(200); + const favicon = await next.fetch("/next-pwa/favicon.ico"); + expect(favicon.status).toBe(200); + }); + + it("should be able to fetch service worker", async () => { + const sw = await next.fetch("/next-pwa/sw.js"); + expect(sw.status).toBe(200); + expect(sw.headers.get("Content-Type")?.includes("application/javascript")).toBe(true); + const swContent = await sw.text(); + if (testMode === "start") { + expect(/url:\"\/next-pwa\/swe-worker-(.*?).js\"/.test(swContent)).toBe(true); + expect(/url:\"\/next-pwa\/_next\/..\/public\/swe-worker-(.*?).js\"/.test(swContent)).toBe(false); + expect(/url:\"https:\/\/example.com\/_next\/..\/public\/swe-worker-(.*?).js\"/.test(swContent)).toBe(false); + expect(/url:\"https:\/\/example.com\/_next\/static\/chunks\/main-app-(.*?).js\"/.test(swContent)).toBe(true); + } + }); +}); diff --git a/packages/next-pwa/__tests__/integration/asset-prefix/next.config.mjs b/packages/next-pwa/__tests__/integration/asset-prefix/next.config.mjs new file mode 100644 index 00000000..f0735b92 --- /dev/null +++ b/packages/next-pwa/__tests__/integration/asset-prefix/next.config.mjs @@ -0,0 +1,15 @@ +// @ts-check +import withPWAInit from "@ducanh2912/next-pwa"; + +const withPWA = withPWAInit({ + dest: "public", + cacheOnFrontEndNav: true, +}); + +/** @type {import('next').NextConfig} */ +const nextConfig = { + assetPrefix: "https://example.com", + basePath: "/next-pwa", +}; + +export default withPWA(nextConfig); diff --git a/packages/next-pwa/__tests__/integration/asset-prefix/public/next.svg b/packages/next-pwa/__tests__/integration/asset-prefix/public/next.svg new file mode 100644 index 00000000..5174b28c --- /dev/null +++ b/packages/next-pwa/__tests__/integration/asset-prefix/public/next.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/packages/next-pwa/__tests__/integration/asset-prefix/tsconfig.json b/packages/next-pwa/__tests__/integration/asset-prefix/tsconfig.json new file mode 100644 index 00000000..a8922ff1 --- /dev/null +++ b/packages/next-pwa/__tests__/integration/asset-prefix/tsconfig.json @@ -0,0 +1,29 @@ +{ + "compilerOptions": { + "allowImportingTsExtensions": true, + "target": "es5", + "lib": ["dom", "dom.iterable", "esnext"], + "allowJs": true, + "skipLibCheck": true, + "strict": true, + "forceConsistentCasingInFileNames": true, + "noEmit": true, + "esModuleInterop": true, + "module": "esnext", + "moduleResolution": "node", + "resolveJsonModule": true, + "isolatedModules": true, + "jsx": "preserve", + "incremental": true, + "plugins": [ + { + "name": "next" + } + ], + "paths": { + "@/*": ["./src/*"] + } + }, + "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"], + "exclude": ["node_modules"] +} diff --git a/packages/next-pwa/src/context.ts b/packages/next-pwa/src/context.ts index a9dd6a36..b33cce96 100644 --- a/packages/next-pwa/src/context.ts +++ b/packages/next-pwa/src/context.ts @@ -4,9 +4,9 @@ import { fileURLToPath } from "node:url"; import fg from "fast-glob"; import type { NextConfig, NextConfigComplete, WebpackConfigContext } from "next/dist/server/config-shared.js"; import type { TsConfigJson } from "type-fest"; -import type { Asset, Configuration as WebpackConfig, default as Webpack } from "webpack"; +import type { Asset, Compilation, Configuration as WebpackConfig, default as Webpack } from "webpack"; -import { loadTSConfig, logger } from "#utils/index.js"; +import { loadTSConfig, logger, relativeToOutputPath } from "#utils/index.js"; import { RequireFields, WorkboxOptions } from "./private-types.js"; import type { PluginOptions } from "./types.js"; @@ -68,8 +68,9 @@ export const parseOptions = ( ): PluginOptionsComplete | { disable: true } => { if (disable) return { disable }; + const publicDir = path.resolve(webpackContext.dir, "public"); + if (!additionalManifestEntries) { - const publicDir = path.resolve(webpackContext.dir, "public"); additionalManifestEntries = fg .sync( [ @@ -159,11 +160,21 @@ export const parseOptions = ( manifestTransforms: [ ..._manifestTransforms, async (manifestEntries, compilation) => { + // This path always uses forward slashes, so it is safe to use it in the following string replace. + const publicDirRelativeOutput = relativeToOutputPath(compilation as Compilation, publicDir); + // `publicPath` is always `${assetPrefix}/_next/` for Next.js apps. + const publicFilesPrefix = `${publicPath}${publicDirRelativeOutput}`; const manifest = manifestEntries.map((m) => { - m.url = m.url - .replace("/_next//static/image", "/_next/static/image") - .replace("/_next//static/media", "/_next/static/media") - .replace("/_next/../public", ""); + m.url = m.url.replace("/_next//static/image", "/_next/static/image").replace("/_next//static/media", "/_next/static/media"); + + // We remove `${publicPath}/${publicDirRelativeOutput}` because `assetPrefix` + // is not intended for files that are in the public directory and we also want + // to remove `/_next/${publicDirRelativeOutput}` from the URL, since that is not how + // we resolve files in the public directory. + if (m.url.startsWith(publicFilesPrefix)) { + m.url = path.posix.join(nextConfig.basePath, m.url.replace(publicFilesPrefix, "")); + } + if (m.revision === null) { let key = m.url; if (typeof publicPath === "string" && key.startsWith(publicPath)) { diff --git a/packages/next-pwa/src/utils/index.ts b/packages/next-pwa/src/utils/index.ts index 25bb475c..6562136c 100644 --- a/packages/next-pwa/src/utils/index.ts +++ b/packages/next-pwa/src/utils/index.ts @@ -3,3 +3,5 @@ export { findFirstTruthy } from "./find-first-truthy.js"; export { getPackageVersion } from "./get-package-version.js"; export { loadTSConfig } from "./load-tsconfig.js"; export * as logger from "./logger.js"; +export { normalizePathSep } from "./normalize-path-sep.js"; +export { relativeToOutputPath } from "./relative-to-output-path.js"; diff --git a/packages/next-pwa/src/utils/normalize-path-sep.ts b/packages/next-pwa/src/utils/normalize-path-sep.ts new file mode 100644 index 00000000..53b79264 --- /dev/null +++ b/packages/next-pwa/src/utils/normalize-path-sep.ts @@ -0,0 +1,9 @@ +/** + * For a given path, this function ensures that there is no backslash + * escaping slashes in the path. + * + * @param path + */ +export const normalizePathSep = (path: string): string => { + return path.replace(/\\/g, "/"); +}; diff --git a/packages/next-pwa/src/utils/relative-to-output-path.ts b/packages/next-pwa/src/utils/relative-to-output-path.ts new file mode 100644 index 00000000..6f52056f --- /dev/null +++ b/packages/next-pwa/src/utils/relative-to-output-path.ts @@ -0,0 +1,32 @@ +/* + Copyright 2018 Google LLC + + Use of this source code is governed by an MIT-style + license that can be found in the LICENSE file or at + https://opensource.org/licenses/MIT. +*/ + +import path from "node:path"; + +import type { Compilation } from "webpack"; + +import { normalizePathSep } from "./normalize-path-sep.js"; + +/** + * @param compilation The webpack compilation. + * @param pathValue The original path value. + * + * @returns If path was not absolute, the returns path as-is. + * Otherwise, returns path relative to the compilation's output path. + * + * @private + */ +export function relativeToOutputPath(compilation: Compilation, pathValue: string): string { + // See https://github.com/jantimon/html-webpack-plugin/pull/266/files#diff-168726dbe96b3ce427e7fedce31bb0bcR38 + if (path.resolve(pathValue) === path.normalize(pathValue)) { + return normalizePathSep(path.relative(compilation.options.output.path!, pathValue)); + } + + // Otherwise, return swDest as-is. + return normalizePathSep(pathValue); +}