fix(core): frame navigations on redirects

blakebyrnes · blakebyrnes · commit de3ea248a0fd · 2021-12-14T11:52:00.000-05:00
diff --git a/core/lib/FrameNavigations.ts b/core/lib/FrameNavigations.ts
@@ -221,7 +221,7 @@ export default class FrameNavigations extends TypedEventEmitter<IFrameNavigation
   public assignLoaderId(navigation: INavigation, loaderId: string, url?: string): void {
     if (!loaderId) return;
 
-    this.historyByLoaderId[loaderId] = navigation;
+    this.historyByLoaderId[loaderId] ??= navigation;
     navigation.loaderId = loaderId;
     if (
       url &&
@@ -306,7 +306,7 @@ export default class FrameNavigations extends TypedEventEmitter<IFrameNavigation
     if (!navigation) return;
     if (!navigation.loaderId && loaderId) {
       navigation.loaderId = loaderId;
-      this.historyByLoaderId[loaderId] = navigation;
+      this.historyByLoaderId[loaderId] ??= navigation;
     }
     if (navigation.stateChanges.has(newStatus)) {
       if (statusChangeDate && statusChangeDate < navigation.stateChanges.get(newStatus)) {
diff --git a/core/test/navigation.test.ts b/core/test/navigation.test.ts
@@ -538,6 +538,22 @@ perfObserver.observe({ type: 'largest-contentful-paint', buffered: true });
 });
 
 describe('PaintingStable tests', () => {
+  it('should trigger painting stable after a redirect', async () => {
+    const startingUrl = `${koaServer.baseUrl}/stable-redirect`;
+    koaServer.get('/stable-redirect', async ctx => {
+      await new Promise(resolve => setTimeout(resolve, 100));
+      ctx.redirect('/post-stable-redirect');
+    });
+    koaServer.get('/post-stable-redirect', ctx => {
+      ctx.body = '<html lang="en"><body><h1>So stable</h1></body></html>';
+    });
+    const { tab } = await createSession();
+    const resource = await tab.goto(startingUrl);
+    await expect(tab.waitForLoad(LocationStatus.PaintingStable)).resolves.toBe(undefined);
+    expect(resource.request.url).toBe(`${koaServer.baseUrl}/post-stable-redirect`);
+    expect(resource.isRedirect).toBe(false);
+  });
+
   it('should trigger a painting stable on a page that never triggers load', async () => {
     const { tab } = await createSession();
 
diff --git a/puppet/test/TestPage.ts b/puppet/test/TestPage.ts
@@ -1,5 +1,5 @@
 import { IPuppetPage } from '@secret-agent/interfaces/IPuppetPage';
-import { ILifecycleEvents, IPuppetFrame } from '@secret-agent/interfaces/IPuppetFrame';
+import { IPuppetFrame } from '@secret-agent/interfaces/IPuppetFrame';
 import { IKeyboardKey } from '@secret-agent/interfaces/IKeyboardLayoutUS';
 import { keyDefinitions } from '@secret-agent/puppet-chrome/interfaces/USKeyboardLayout';
 import IPuppetContext from '@secret-agent/interfaces/IPuppetContext';
