feat(click): start wiring auto-waiting click in firefox

Author: pavelfeldman

package.json

@@ -9,7 +9,7 @@
   "main": "index.js",
   "playwright": {
     "chromium_revision": "747023",
-    "firefox_revision": "1032",
+    "firefox_revision": "1035",
     "webkit_revision": "1168"
   },
   "scripts": {

src/firefox/ffPage.ts

@@ -60,10 +60,11 @@ export class FFPage implements PageDelegate {
       helper.addEventListener(this._session, 'Page.frameDetached', this._onFrameDetached.bind(this)),
       helper.addEventListener(this._session, 'Page.navigationAborted', this._onNavigationAborted.bind(this)),
       helper.addEventListener(this._session, 'Page.navigationCommitted', this._onNavigationCommitted.bind(this)),
-      helper.addEventListener(this._session, 'Page.navigationStarted', this._onNavigationStarted.bind(this)),
+      helper.addEventListener(this._session, 'Page.navigationStarted', event => this._onNavigationStarted(event.frameId)),
       helper.addEventListener(this._session, 'Page.sameDocumentNavigation', this._onSameDocumentNavigation.bind(this)),
       helper.addEventListener(this._session, 'Runtime.executionContextCreated', this._onExecutionContextCreated.bind(this)),
       helper.addEventListener(this._session, 'Runtime.executionContextDestroyed', this._onExecutionContextDestroyed.bind(this)),
+      helper.addEventListener(this._session, 'Page.linkClicked', event => this._onLinkClicked(event.frameId, event.ack)),
       helper.addEventListener(this._session, 'Page.uncaughtError', this._onUncaughtError.bind(this)),
       helper.addEventListener(this._session, 'Runtime.console', this._onConsole.bind(this)),
       helper.addEventListener(this._session, 'Page.dialogOpened', this._onDialogOpened.bind(this)),
@@ -116,7 +117,15 @@ export class FFPage implements PageDelegate {
     }
   }
 
-  _onNavigationStarted() {
+  _onLinkClicked(frameId: string, ack: boolean) {
+    if (ack)
+      this._page._frameManager.frameDidRequestNavigation();
+    else
+      this._page._frameManager.frameWillRequestNavigation();
+  }
+
+  _onNavigationStarted(frameId: string) {
+    this._page._frameManager.frameRequestedNavigation(frameId);
   }
 
   _onNavigationAborted(params: Protocol.Page.navigationAbortedPayload) {

src/frames.ts

@@ -59,7 +59,9 @@ export class FrameManager {
   private _mainFrame: Frame;
   readonly _lifecycleWatchers = new Set<() => void>();
   readonly _consoleMessageTags = new Map<string, ConsoleTagHandler>();
-  private _navigationRequestCollectors = new Set<Set<string>>();
+  private _inflightNavigationFrames: Set<string> | undefined;
+  private _requestNavigationPromise: Promise<void> | undefined;
+  private _requestNavigationPromiseCallback: (() => void) | undefined;
 
   constructor(page: Page) {
     this._page = page;
@@ -110,28 +112,40 @@ export class FrameManager {
 
   async waitForNavigationsCreatedBy<T>(action: () => Promise<T>): Promise<T> {
     const frameIds = new Set<string>();
-    this._navigationRequestCollectors.add(frameIds);
+    this._inflightNavigationFrames = frameIds;
     try {
       const result = await action();
+      if (this._requestNavigationPromise)
+        await this._requestNavigationPromise;
       if (!frameIds.size)
         return result;
       const frames = Array.from(frameIds.values()).map(frameId => this._frames.get(frameId));
       await Promise.all(frames.map(frame => frame!.waitForNavigation({ waitUntil: []}))).catch(e => {});
       await new Promise(platform.makeWaitForNextTask());
       return result;
     } finally {
-      this._navigationRequestCollectors.delete(frameIds);
+      this._inflightNavigationFrames = undefined;
     }
   }
 
+  frameWillRequestNavigation() {
+    this._requestNavigationPromise = new Promise(f => this._requestNavigationPromiseCallback = f);
+  }
+
+  frameDidRequestNavigation() {
+    if (this._requestNavigationPromiseCallback)
+      this._requestNavigationPromiseCallback();
+    this._requestNavigationPromiseCallback = undefined;
+  }
+
   frameRequestedNavigation(frameId: string) {
-    for (const frameIds of this._navigationRequestCollectors)
-      frameIds.add(frameId);
+    if (this._inflightNavigationFrames)
+      this._inflightNavigationFrames.add(frameId);
   }
 
   _cancelFrameRequestedNavigation(frameId: string) {
-    for (const frameIds of this._navigationRequestCollectors)
-      frameIds.delete(frameId);
+    if (this._inflightNavigationFrames)
+      this._inflightNavigationFrames.delete(frameId);
   }
 
   frameCommittedNewDocumentNavigation(frameId: string, url: string, name: string, documentId: string, initial: boolean) {

test/browsercontext.spec.js

@@ -344,7 +344,7 @@ module.exports.describe = function({testRunner, expect, playwright, CHROMIUM, FF
       expect(error.message).toBe('Function "baz" has been already registered in one of the pages');
       await context.close();
     });
-    it.skip(FFOX)('should be callable from-inside addInitScript', async({browser, server}) => {
+    it.fail(FFOX)('should be callable from-inside addInitScript', async({browser, server}) => {
       const context = await browser.newContext();
       let args = [];
       await context.exposeFunction('woof', function(arg) {

test/navigation.spec.js

@@ -561,7 +561,7 @@ module.exports.describe = function({testRunner, expect, playwright, MAC, WIN, FF
           return page.setContent(`<script src='networkidle.js'></script>`, { waitUntil: 'networkidle2' });
         }, true);
       });
-      it.skip(FFOX)('should wait for networkidle0 in setContent with request from previous navigation', async({page, server}) => {
+      it.fail(FFOX)('should wait for networkidle0 in setContent with request from previous navigation', async({page, server}) => {
         // TODO: in Firefox window.stop() does not cancel outstanding requests, and we also lack 'init' lifecycle,
         // therefore we don't clear inflight requests at the right time.
         await page.goto(server.EMPTY_PAGE);
@@ -571,7 +571,7 @@ module.exports.describe = function({testRunner, expect, playwright, MAC, WIN, FF
           return page.setContent(`<script src='networkidle.js'></script>`, { waitUntil: 'networkidle0' });
         }, true);
       });
-      it.skip(FFOX)('should wait for networkidle2 in setContent with request from previous navigation', async({page, server}) => {
+      it.fail(FFOX)('should wait for networkidle2 in setContent with request from previous navigation', async({page, server}) => {
         // TODO: in Firefox window.stop() does not cancel outstanding requests, and we also lack 'init' lifecycle,
         // therefore we don't clear inflight requests at the right time.
         await page.goto(server.EMPTY_PAGE);
@@ -800,7 +800,7 @@ module.exports.describe = function({testRunner, expect, playwright, MAC, WIN, FF
     });
   });
 
-  describe.fail(FFOX)('Page.automaticWaiting', () => {
+  describe('Page.automaticWaiting', () => {
     it('clicking anchor should await navigation', async({page, server}) => {
       const messages = [];
       server.setRoute('/empty.html', async (req, res) => {
@@ -881,7 +881,20 @@ module.exports.describe = function({testRunner, expect, playwright, MAC, WIN, FF
       ]);
       expect(messages.join('|')).toBe('route|waitForNavigation|evaluate');
     });
-    it('should await navigating specified target', async({page, server, httpsServer}) => {
+    it('evaluating reload should await navigation', async({page, server}) => {
+      const messages = [];
+      await page.goto(server.EMPTY_PAGE);
+      server.setRoute('/empty.html', async (req, res) => {
+        messages.push('route');
+        res.end('done');
+      });
+      await Promise.all([
+        page.evaluate(`window.location.reload()`).then(() => messages.push('evaluate')),
+        page.waitForNavigation({ waitUntil: [] }).then(() => messages.push('waitForNavigation')),
+      ]);
+      expect(messages.join('|')).toBe('route|waitForNavigation|evaluate');
+    });
+    it('should await navigating specified target', async({page, server}) => {
       const messages = [];
       server.setRoute('/empty.html', async (req, res) => {
         messages.push('route');