From f0b9e1f7e9f8bf01c8239d61b64a830bad4e45dd Mon Sep 17 00:00:00 2001
From: Paul Fitzpatrick <paulfitz@alum.mit.edu>
Date: Thu, 27 Jul 2023 12:02:17 +0100
Subject: [PATCH] allow Grist front-end to function when location history is
 unavailable (#596)

* allow Grist front-end to function when location history is unavailable

When the Grist front-end is embedded in an iframe, using a srcdoc
attribute, history.pushState and similar methods are unavailable.
Currently, that makes it impossible to navigate between Grist pages,
since an access error is thrown (behavior may be browser dependent).
With this change, navigation succeeds.

* give unrelated possibly slow test a little more time
---
 app/client/lib/UrlState.ts               |  22 ++++++++++++++++------
 test/fixtures/docs/SelectBySummary.grist | Bin 618496 -> 622592 bytes
 test/nbrowser/SelectByRefList.ts         |   2 +-
 3 files changed, 17 insertions(+), 7 deletions(-)

diff --git a/app/client/lib/UrlState.ts b/app/client/lib/UrlState.ts
index d2487e9e..f2ad4d21 100644
--- a/app/client/lib/UrlState.ts
+++ b/app/client/lib/UrlState.ts
@@ -77,13 +77,23 @@ export class UrlState<IUrlState extends object> extends Disposable {
 
     if (samePage) {
       await this._stateImpl.delayPushUrl(prevState, newState);
-      if (options.replace) {
-        this._window.history.replaceState(null, '', newUrl);
-      } else {
-        this._window.history.pushState(null, '', newUrl);
+      try {
+        if (options.replace) {
+          this._window.history.replaceState(null, '', newUrl);
+        } else {
+          this._window.history.pushState(null, '', newUrl);
+        }
+        // pushState/replaceState above do not trigger 'popstate' event, so we call loadState() manually.
+        this.loadState();
+      } catch (e) {
+        // If we fail, we may be in a context where Grist doesn't have
+        // control over history, e.g. an iframe with srcdoc. Go ahead
+        // and apply the application state change (e.g. switching to a
+        // different Grist page). The back button won't work, but what
+        // it should do in an embedded context is full of nuance anyway.
+        log.debug(`pushUrl failure: ${e}`);
+        this.state.set(this._stateImpl.decodeUrl(new URL(newUrl)));
       }
-      // pushState/replaceState above do not trigger 'popstate' event, so we call loadState() manually.
-      this.loadState();
     } else {
       this._window._urlStateLoadPage!(newUrl);
     }
diff --git a/test/fixtures/docs/SelectBySummary.grist b/test/fixtures/docs/SelectBySummary.grist
index c7d67c1b1b38743af931561d952e0409a3b63c20..453c483fad3d3776eb1fcdd04de12ae0e9cf850e 100644
GIT binary patch
delta 2854
zcmbtVYfKbZ6rOwMb!T_y&MpWmunXhzE(ps$0BzH<D593~uvnYa2G`j^G0P6!U82TD
z-1XVg_y|d_Ce|iROw+1~2xODC@sU2_50YYkwAe?Y>5u-gsp*fVX-(Ui1<fi{Ax?6V
z``!DU^PQPF=iGg_O84z6J6>R;DT+F&+x<s4QSD`Esz#wkLpz2*a^&lw!tA6KGSo5{
z)|6nlC#FW?RPxfk?_U5VBR^cJ7J#%%x-DImPK{Zw?vjS|NVYtHP<L=^SoJ_BQ_ApE
zD-sY$@6`3g2K)Pi(cL}DcCAlQV?A0#jqlXVg)~pC_<x$o<b*ucFb`qIUl4WST+_%H
zKb7a^;BVA9>CX|Hb=iq?fr%sF8UP=StcPb!2eyd3-R}oSl(9}&2uVE)3W};_S4fR1
z(Y}FrpB8b+-7T+n%d1<~1U9yH%jM;%E*4CfmRKpv9pNnc237O#aCbRBJ4{<s`Bv};
zG#%KLn~wTcHaSrU@>3nz;8{qf9Kewp&H=l3<eTvXkbaiFl0KG>N}ALrRY?N=72m)U
zV>T<nu6%PA1yG&{1Tp;}ghVE)Dq1uY$~PHj<l-@4FA(O^;4F;@$H3oog?O6q$ARC0
z!+0}p!_VPr?7$ZBo_I(6QJfS%6VHpMb<Ne{5Uwy&001QFT9i2}3zuhNn+=y`VyhLG
zW@1UgC7BpwT%3VTqKI9Y*kZxUGO;;m#&YI{$%KnCu^`~W3@jjootc>Du_F_694^Sj
zESq}s3^<smGzyX$rlkNr#5_+8Tdte0oAXVZgeVG&5q^}Lg4LXtJx4Qoxdcu73k!IA
zRTVfGOI@jgdqJ^Y9Q|s)Hm52o6B|o;du1g^s-&kFj;_&(1AUQ*8gj|a9UW~gf%XSA
z<gQFMRPgrFQh1;?ZuCXZwrF20-m^*#hhv#*>Lf`N!yLvqASaeXC+T#8Lh@5Fbg)rv
z=ep2{jmu@CnieNA19Hhf1%M-O(_kqR-#wrjhn%8C;%bE0YGF>^U`&l}P<!X*p88yd
zBQTX!0#Ad@)H2?_Vg=Y=kWOv>E}eh3bk&BIKzEDW9cXTAkzMnUNT&@H5l=Zhyv1Ev
znb<1x_J#(KROXYKY2-(O%xsoCR%nJp5&$?zbs2P|+AH8TdMKIW;_a=iV1MO&Y7dW}
zM^qm^EPJf_!(5kK(HD}}wRg9WVF0p>d=94$)xbS<c5#40mPsfUNxWqekK>?p0b}t~
zy&K0Z{w{s|0g!M~G`&3@A6Qvin;y5@wOD+muff;QSgX~BG$mFW?O(rkXIty0$ol5h
zWb`~*O0G;J&f5WaN)UAa#d^PxLafCnZKht-<qIf;$Qu#Z<nKbW`5?5|h<i1G^LO#H
z{ye`}|EZ0JKRfHsvWxZK5`ntEe(R*aC&Mh#ANy+DHHxoGzix~G<Z1*i$$RWCaPq$N
z{n<sfXz(R}7dI=-af^_?eE~V4PaFgCzeOL&)=M&DJ<ME$y3x8Zy0N-(y73<}7g1Bb
z7g{Lk6Z#U$;wSk-d=tFI{l$%Q5ojTfyQni2xr@$#wlz#bg!O8#-{0%@ZuQrDgC4iq
z5cK*y^{UsaHhP1;P+f1Gr?)=j_VzZ08a*CQonKMvdOb=*NKyRmx~+{=G989EUly8D
zCx1ubegs)eSuV3!uU^P@9;;43MCnTKy|$+oOHj#?;43+uPa9}Z(EmzMG4AyC!T!D^
z39$58&f4ASJhh96-=bPl+%E)3S0i0SZnd&GWQriOe$$TbpsTX?405`6Afk77^fja}
z2iKAt=g|`?VJR`%iS{js>|7u(-Qhe~kUp9z-UaC|B}S*fCv%O`TyU;N_bwo2dUENL
zBA3X&K$aZ+4#~5h-ZtmclWXJ1Mcf*EhAf}fSGOYiYWM7_#F&2-#$E|A-@Lyv-i*9{
tbB0_(-k(4$`C=Ls&+v>K$(IiT=xHD_EeRE=%VD9Jez!?r#u)28=|7w#7McJ6

delta 944
zcmZ9KO-PhM7{}+C_hV+<ec#zF>rJ=ac10~eiYzw?$=t$>u-MWdC@WJ7Y;&VLL<sqs
zWmHtMhY11?K?F%*yV`3V?33sa*asb|Lq(Sk9mGTQaj04M?N9^%2j>6q<C*!-^!1hY
zeJr^Y@B>0fNc~+fRJl?Ev~2C$+Z|mez)nq_2+g&9SVa+>NVc~n_8jf(?m>3C@7-Dm
zrrzJLWQZT*Z}=T9GQJ1LxW#7>F91qg+V&+nSKy$kqgu+Sh<wm38dTh!-J@7EfOS+e
z+Y2i5OnC&efVp5*`bBuTu9#?qe^2>+k)e^;_!)Qz@GP|nKgk=28N`Z4;Y>*;jzd^j
z8U&oJ8jR=VS0L|Kc8$KGmE^oWtw*(UN`+JCgKt>;h~Pp`*+A?39NQ{}LQv>b&xKm-
zoSg^9yYeY#z(4b+{06_kle~#naF+4=UYjBQ8HE@tFn}4^<(D@!j&!ysk92hGY*huj
z2)~p<vsaKy5S2u|>GTf6DSNR|hkWQU;xY3ydh8kZ@I21i=rFmfXSAE@jOtgm;|aW6
z-tmf4SBz7btu7%}SsC;%6|0KyZD*<!4}+-`5v#TqP6m6jvCf7$TX^aEZ4I%OhHy)4
zT~kB2DA%z87K-0X@gVP4BL9Hd+(owVlK;S5CkuXAB0+m!m{>J6(BJM(luslgvhd>n
zz^o|-%kk{Qg$^ml2NdV3AG*N}93j|fRaL=2)Y({!*MM_s8SbsJ<a<-&Fy?vY1ixkO
zH}m-}<B@S#hPT7;#3?}lb^uZNa|{*}7ZObO#EI(?A|SyUJ#o!7G)-(Zvxe##s+!|=
zAIx&tburGl$uX+2>McMJV|GA%%FvLgGg!HfP+TWS>`mg$-s-sGVu~VOcCkh<G7$c~
z=xW%P4y(RFbree}QmT|DrAv|P>L{&WumU$Deosl$IpjGxP3rMS{ii;rcZ<+8jbqH6
q?rAy<Vyu8QY8zDBz#`bp>Yd9oG;v4=?<De0$|T0T&SZkEQ~m(6is;e+

diff --git a/test/nbrowser/SelectByRefList.ts b/test/nbrowser/SelectByRefList.ts
index 7982817c..34bbb860 100644
--- a/test/nbrowser/SelectByRefList.ts
+++ b/test/nbrowser/SelectByRefList.ts
@@ -4,7 +4,7 @@ import * as gu from 'test/nbrowser/gristUtils';
 import {server, setupTestSuite} from 'test/nbrowser/testUtils';
 
 describe('SelectByRefList', function() {
-  this.timeout(60000);
+  this.timeout(80000);
   setupTestSuite();
   addToRepl('gu2', gu);
   gu.bigScreen();