fix(puppet): consisten timeout handling

Author: blakebyrnes

core/lib/FrameEnvironment.ts

@@ -355,7 +355,8 @@ b) Use the UserProfile feature to set cookies for 1 or more domains before they'
     return this.waitForDom(jsPath, options);
   }
 
-  public waitForLoad(status: IPipelineStatus, options?: IWaitForOptions): Promise<void> {
+  public async waitForLoad(status: IPipelineStatus, options?: IWaitForOptions): Promise<void> {
+    await this.isReady;
     return this.navigationsObserver.waitForLoad(status, options);
   }
 

core/test/domRecorder.test.ts

@@ -225,7 +225,7 @@ function sort() {
     const domFrames = domChanges.filter(x => x.tagName === 'IFRAME');
     expect(domFrames).toHaveLength(3);
 
-    await tab.puppetPage.frames[3].waitForLoad();
+    await tab.frameEnvironmentsByPuppetId.get(tab.puppetPage.frames[3].id).isReady;
 
     await state.db.flush();
     const frames = state.db.frames.all();

interfaces/IPuppetFrame.ts

@@ -14,7 +14,7 @@ export interface IPuppetFrame extends ITypedEventEmitter<IPuppetFrameEvents> {
   isDefaultUrl: boolean;
   isAttached(): boolean;
   resolveNodeId(backendNodeId: number): Promise<string>;
-  waitForLoad(eventName?: keyof ILifecycleEvents): Promise<void>;
+  waitForLoad(eventName?: keyof ILifecycleEvents, timeoutMs?: number): Promise<void>;
   waitForLoader(loaderId?: string): Promise<Error | undefined>;
   canEvaluate(isolatedFromWebPageEnvironment: boolean): boolean;
   getFrameElementNodeId(): Promise<string>;

puppet-chrome/lib/Frame.ts

@@ -304,12 +304,12 @@ export default class Frame extends TypedEventEmitter<IPuppetFrameEvents> impleme
     }
   }
 
-  public async waitForLoader(loaderId?: string): Promise<Error | null> {
+  public async waitForLoader(loaderId?: string, timeoutMs = 60e3): Promise<Error | null> {
     if (!loaderId) {
       loaderId = this.activeLoaderId;
       if (loaderId === this.defaultLoaderId) {
         // wait for an actual frame to load
-        const frameLoader = await this.waitOn('frame-loader-created', null, 60e3);
+        const frameLoader = await this.waitOn('frame-loader-created', null, timeoutMs);
         loaderId = frameLoader.loaderId;
       }
     }
@@ -438,9 +438,15 @@ export default class Frame extends TypedEventEmitter<IPuppetFrameEvents> impleme
     };
   }
 
-  public async waitForLoad(event: keyof ILifecycleEvents = 'load'): Promise<void> {
+  public async waitForLoad(
+    event: keyof ILifecycleEvents = 'load',
+    timeoutMs = 30e3,
+  ): Promise<void> {
+    event ??= 'load';
+    timeoutMs ??= 30e3;
+    await this.waitForLoader(null, timeoutMs);
     if (this.lifecycleEvents[event]) return;
-    await this.waitOn('frame-lifecycle', x => x.name === event, 30e3);
+    await this.waitOn('frame-lifecycle', x => x.name === event, timeoutMs);
   }
 
   private setLoader(loaderId: string): void {

puppet-chrome/lib/FramesManager.ts

@@ -92,6 +92,7 @@ export default class FramesManager extends TypedEventEmitter<IPuppetFrameManager
         }
       } catch (error) {
         if (error instanceof CanceledPromiseError) {
+          resolve();
           return;
         }
         reject(error);

puppet/test/TestPage.ts

@@ -10,7 +10,7 @@ export interface ITestPage extends IPuppetPage {
   type(text: string): Promise<void>;
   attachFrame(frameId: string, url: string): Promise<IPuppetFrame>;
   detachFrame(frameId: string): Promise<void>;
-  goto(url: string, waitOnLifecycle?: string): Promise<void>;
+  goto(url: string, waitOnLifecycle?: string, timeoutMs?: number): Promise<void>;
   setContent(content: string): Promise<void>;
   waitForPopup(): Promise<IPuppetPage>;
 }
@@ -81,10 +81,15 @@ export async function goto(
   page: IPuppetPage,
   url: string,
   waitOnLifecycle: 'load' | 'DOMContentLoaded' = 'load',
+  timeoutMs?: number,
 ) {
-  const nav = page.navigate(url);
-  const lifecycle = page.mainFrame.waitOn('frame-lifecycle', ev => ev.name === waitOnLifecycle);
-  await Promise.all([lifecycle, nav, page.mainFrame.waitOn('frame-navigated')]);
+  waitOnLifecycle ??= 'load';
+  timeoutMs ??= 30e3;
+  await Promise.all([
+    page.navigate(url),
+    page.mainFrame.waitOn('frame-navigated', null, timeoutMs),
+  ]);
+  await page.mainFrame.waitForLoad(waitOnLifecycle, timeoutMs);
 }
 
 export async function setContent(page: IPuppetPage, content: string) {