fix: access locators via a shortcut (#595)

Note that the Stringify extension can still use Locators as envisioned in the generated code and only the Runner extension needs to avoid the static dependency on Puppeteer.
puppeteer · Jul 7, 2023 · 1dacd34 · 1dacd34
1 parent cde53a8
commit 1dacd34
Show file tree

Hide file tree

Showing 3 changed files with 75 additions and 65 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -77,8 +77,8 @@
     "mime": "3.0.0",
     "mocha": "10.1.0",
     "prettier": "2.7.1",
-    "puppeteer": "20.7.4",
-    "puppeteer-core": "20.7.4",
+    "puppeteer": "20.8.0",
+    "puppeteer-core": "20.8.0",
     "rimraf": "3.0.2",
     "rollup": "3.2.2",
     "rollup-plugin-dts": "5.0.0",
@@ -91,7 +91,7 @@
   },
   "peerDependencies": {
     "lighthouse": ">=10.0.0",
-    "puppeteer": ">=20.7.3"
+    "puppeteer": ">=20.8.0"
   },
   "peerDependenciesMeta": {
     "puppeteer": {

diff --git a/src/PuppeteerRunnerExtension.ts b/src/PuppeteerRunnerExtension.ts
@@ -13,13 +13,12 @@
     See the License for the specific language governing permissions and
     limitations under the License.
  */
-import {
+import type {
   Browser,
   ElementHandle,
   Frame,
-  Page,
-  Locator,
   LocatorEmittedEvents,
+  Page,
 } from 'puppeteer';
 import { Frame as InternalFrame } from 'puppeteer-core/internal/common/Frame.js';
 import { CDPPage as InternalPage } from 'puppeteer-core/internal/common/Page.js';
@@ -119,18 +118,21 @@ export class PuppeteerRunnerExtension extends RunnerExtension {
     const startWaitingForEvents = () => {
       assertedEventsPromise = waitForEvents(localFrame, step, timeout);
     };
+    const locatorRace = (this.page as unknown as InternalPage).locatorRace;
 
     switch (step.type) {
       case StepType.DoubleClick:
-        await Locator.race(
+        await locatorRace(
           step.selectors.map((selector) => {
-            return targetPageOrFrame.locator(
-              selectorToPElementSelector(selector)
-            );
+            return (
+              targetPageOrFrame as unknown as InternalPage | InternalFrame
+            ).locator(selectorToPElementSelector(selector));
           })
         )
           .setTimeout(timeout)
-          .on(LocatorEmittedEvents.Action, () => startWaitingForEvents())
+          .on('action' as LocatorEmittedEvents.Action, () =>
+            startWaitingForEvents()
+          )
           .click({
             count: 2,
             button: step.button && mouseButtonMap.get(step.button),
@@ -142,15 +144,17 @@ export class PuppeteerRunnerExtension extends RunnerExtension {
           });
         break;
       case StepType.Click:
-        await Locator.race(
+        await locatorRace(
           step.selectors.map((selector) => {
-            return targetPageOrFrame.locator(
-              selectorToPElementSelector(selector)
-            );
+            return (
+              targetPageOrFrame as unknown as InternalPage | InternalFrame
+            ).locator(selectorToPElementSelector(selector));
           })
         )
           .setTimeout(timeout)
-          .on(LocatorEmittedEvents.Action, () => startWaitingForEvents())
+          .on('action' as LocatorEmittedEvents.Action, () =>
+            startWaitingForEvents()
+          )
           .click({
             delay: step.duration,
             button: step.button && mouseButtonMap.get(step.button),
@@ -161,15 +165,17 @@ export class PuppeteerRunnerExtension extends RunnerExtension {
           });
         break;
       case StepType.Hover:
-        await Locator.race(
+        await locatorRace(
           step.selectors.map((selector) => {
-            return targetPageOrFrame.locator(
-              selectorToPElementSelector(selector)
-            );
+            return (
+              targetPageOrFrame as unknown as InternalPage | InternalFrame
+            ).locator(selectorToPElementSelector(selector));
           })
         )
           .setTimeout(timeout)
-          .on(LocatorEmittedEvents.Action, () => startWaitingForEvents())
+          .on('action' as LocatorEmittedEvents.Action, () =>
+            startWaitingForEvents()
+          )
           .hover();
         break;
       case StepType.EmulateNetworkConditions:
@@ -201,14 +207,16 @@ export class PuppeteerRunnerExtension extends RunnerExtension {
         }
         break;
       case StepType.Change:
-        await Locator.race(
+        await locatorRace(
           step.selectors.map((selector) => {
-            return targetPageOrFrame.locator(
-              selectorToPElementSelector(selector)
-            );
+            return (
+              targetPageOrFrame as unknown as InternalPage | InternalFrame
+            ).locator(selectorToPElementSelector(selector));
           })
         )
-          .on(LocatorEmittedEvents.Action, () => startWaitingForEvents())
+          .on('action' as LocatorEmittedEvents.Action, () =>
+            startWaitingForEvents()
+          )
           .setTimeout(timeout)
           .fill(step.value);
         break;
@@ -221,14 +229,16 @@ export class PuppeteerRunnerExtension extends RunnerExtension {
       }
       case StepType.Scroll: {
         if ('selectors' in step) {
-          await Locator.race(
+          await locatorRace(
             step.selectors.map((selector) => {
-              return targetPageOrFrame.locator(
-                selectorToPElementSelector(selector)
-              );
+              return (
+                targetPageOrFrame as unknown as InternalPage | InternalFrame
+              ).locator(selectorToPElementSelector(selector));
             })
           )
-            .on(LocatorEmittedEvents.Action, () => startWaitingForEvents())
+            .on('action' as LocatorEmittedEvents.Action, () =>
+              startWaitingForEvents()
+            )
             .setTimeout(timeout)
             .scroll({
               scrollLeft: step.x || 0,