@empiricalrun/playwright-utils 0.6.0 → 0.6.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @empiricalrun/playwright-utils
 
+## 0.6.2
+
+### Patch Changes
+
+- cfc58de: fix: reduce highlighter log size and internal timeout fix
+
+## 0.6.1
+
+### Patch Changes
+
+- de76cd6: fix: wrap mouse-pointer highlighter in try/catch
+
 ## 0.6.0
 
 ### Minor Changes

package/dist/test/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const DEFAULT_SCRIPT_EXECUTION_TIMEOUT = 500;
+//# sourceMappingURL=constants.d.ts.map

package/dist/test/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/test/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gCAAgC,MAAM,CAAC"}

package/dist/test/constants.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_SCRIPT_EXECUTION_TIMEOUT = void 0;
+exports.DEFAULT_SCRIPT_EXECUTION_TIMEOUT = 500;

package/dist/test/scripts/mouse-pointer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mouse-pointer.d.ts","sourceRoot":"","sources":["../../../src/test/scripts/mouse-pointer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7C,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,IAAI,QAgGpD"}
+{"version":3,"file":"mouse-pointer.d.ts","sourceRoot":"","sources":["../../../src/test/scripts/mouse-pointer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAE7C,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,IAAI,QAoGpD"}

package/dist/test/scripts/mouse-pointer.js

@@ -3,11 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.addMousePointerHighlighter = void 0;
 function addMousePointerHighlighter(page) {
     page.on("load", async () => {
-        await page?.evaluate(() => {
-            const box = document.createElement("div");
-            box.classList.add("empirical-mouse-pointer");
-            const styleElement = document.createElement("style");
-            styleElement.textContent = `
+        try {
+            await page?.evaluate(() => {
+                const box = document.createElement("div");
+                box.classList.add("empirical-mouse-pointer");
+                const styleElement = document.createElement("style");
+                styleElement.textContent = `
       .empirical-mouse-pointer {
         pointer-events: none;
         position: absolute;
@@ -53,28 +54,32 @@ function addMousePointerHighlighter(page) {
         outline: 2px dashed #FF000D !important;
       }
     `;
-            document.head.appendChild(styleElement);
-            document.body.appendChild(box);
-            document.addEventListener("mousemove", (event) => {
-                box.style.left = `${event.pageX}px`;
-                box.style.top = `${event.pageY}px`;
-                updateButtons(event.buttons);
-            }, true);
-            document.addEventListener("mousedown", (event) => {
-                updateButtons(event.buttons);
-                box.classList.add(`button-${event.button + 1}`);
-            }, true);
-            document.addEventListener("mouseup", (event) => {
-                updateButtons(event.buttons);
-                box.classList.remove(`button-${event.button + 1}`);
-            }, true);
-            // @ts-ignore
-            function updateButtons(buttons) {
-                for (let i = 0; i < 5; i++) {
-                    box.classList.toggle(`button-${i + 1}`, (buttons / Math.pow(2, i)) % 2 >= 1);
+                document.head.appendChild(styleElement);
+                document.body.appendChild(box);
+                document.addEventListener("mousemove", (event) => {
+                    box.style.left = `${event.pageX}px`;
+                    box.style.top = `${event.pageY}px`;
+                    updateButtons(event.buttons);
+                }, true);
+                document.addEventListener("mousedown", (event) => {
+                    updateButtons(event.buttons);
+                    box.classList.add(`button-${event.button + 1}`);
+                }, true);
+                document.addEventListener("mouseup", (event) => {
+                    updateButtons(event.buttons);
+                    box.classList.remove(`button-${event.button + 1}`);
+                }, true);
+                // @ts-ignore
+                function updateButtons(buttons) {
+                    for (let i = 0; i < 5; i++) {
+                        box.classList.toggle(`button-${i + 1}`, (buttons / Math.pow(2, i)) % 2 >= 1);
+                    }
                 }
-            }
-        });
+            });
+        }
+        catch (e) {
+            console.log(`Error adding mouse pointer highlighter`, e);
+        }
     });
 }
 exports.addMousePointerHighlighter = addMousePointerHighlighter;

package/dist/test/scripts/pw-locator-patch/expect.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"expect.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/expect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,wBAAgB,WAAW,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QA2B/D"}
+{"version":3,"file":"expect.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/expect.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAIhD,wBAAgB,WAAW,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QA+B/D"}

package/dist/test/scripts/pw-locator-patch/expect.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.patchExpect = void 0;
+const constants_1 = require("../../constants");
 function patchExpect(LocatorClass) {
     //@ts-ignore _expect returnsPromise<{ matches: boolean, received?: any, log?: string[], timedOut?: boolean }>
     const originalExpect = LocatorClass.prototype._expect;
@@ -10,18 +11,18 @@ function patchExpect(LocatorClass) {
         const result = await originalExpect.apply(this, [expression, options]);
         if (result.matches) {
             try {
-                await this.scrollIntoViewIfNeeded();
                 await this.evaluate((node) => {
+                    node.scrollIntoViewIfNeeded();
                     node.classList.add("empirical-element-grab-highlight");
                     setTimeout(() => {
-                        if (node.isConnected) {
+                        if (node && node.isConnected && node.classList) {
                             node.classList.remove("empirical-element-grab-highlight");
                         }
                     }, 2000);
-                });
+                }, undefined, { timeout: constants_1.DEFAULT_SCRIPT_EXECUTION_TIMEOUT });
             }
             catch (e) {
-                console.error("Failed to add highlight for locator method: _expect", e);
+                console.warn("Failed to add highlight for locator method: _expect");
             }
         }
         return result;

package/dist/test/scripts/pw-locator-patch/hover.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"hover.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/hover.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,wBAAgB,UAAU,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAmB9D"}
+{"version":3,"file":"hover.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/hover.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAI3C,wBAAgB,UAAU,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAuB9D"}

package/dist/test/scripts/pw-locator-patch/hover.js

@@ -1,24 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.patchHover = void 0;
+const constants_1 = require("../../constants");
 function patchHover(LocatorClass) {
     const originalHover = LocatorClass.prototype.hover;
     LocatorClass.prototype.hover = async function (options) {
         // ref: https://github.com/microsoft/playwright/blob/69287f26bc514b740eac40160503d6fac8185d37/packages/playwright-core/src/client/locator.ts#L243
         await originalHover.apply(this, [options]);
         try {
-            await this.scrollIntoViewIfNeeded();
             await this.evaluate((node) => {
+                node.scrollIntoViewIfNeeded();
                 node.classList.add("empirical-element-grab-highlight");
                 setTimeout(() => {
-                    if (node.isConnected) {
+                    if (node && node.isConnected && node.classList) {
                         node.classList.remove("empirical-element-grab-highlight");
                     }
                 }, 2000);
-            });
+            }, undefined, { timeout: constants_1.DEFAULT_SCRIPT_EXECUTION_TIMEOUT });
         }
         catch (e) {
-            console.log("Failed to add highlight for locator method: hover", e);
+            console.warn("Failed to add highlight for locator method: hover");
         }
     };
 }

package/dist/test/scripts/pw-locator-patch/inner-text.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"inner-text.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/inner-text.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,wBAAgB,cAAc,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAoBlE"}
+{"version":3,"file":"inner-text.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/inner-text.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAIhD,wBAAgB,cAAc,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAwBlE"}

package/dist/test/scripts/pw-locator-patch/inner-text.js

@@ -1,24 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.patchInnerText = void 0;
+const constants_1 = require("../../constants");
 function patchInnerText(LocatorClass) {
     const originalInputValue = LocatorClass.prototype.innerText;
     //ref: https://github.com/microsoft/playwright/blob/69287f26bc514b740eac40160503d6fac8185d37/packages/playwright-core/src/client/locator.ts#L251
     LocatorClass.prototype.innerText = async function (options) {
         const result = await originalInputValue.apply(this, [options]);
         try {
-            await this.scrollIntoViewIfNeeded();
             await this.evaluate((node) => {
+                node.scrollIntoViewIfNeeded();
                 node.classList.add("empirical-element-grab-highlight");
                 setTimeout(() => {
-                    if (node.isConnected) {
+                    if (node && node.isConnected && node.classList) {
                         node.classList.remove("empirical-element-grab-highlight");
                     }
                 }, 2000);
-            });
+            }, undefined, { timeout: constants_1.DEFAULT_SCRIPT_EXECUTION_TIMEOUT });
         }
         catch (e) {
-            console.log("Failed to add highlight for locator method: innerText", e);
+            console.warn("Failed to add highlight for locator method: innerText");
         }
         return result;
     };

package/dist/test/scripts/pw-locator-patch/input-value.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"input-value.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/input-value.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,wBAAgB,eAAe,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAoBnE"}
+{"version":3,"file":"input-value.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/input-value.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAIhD,wBAAgB,eAAe,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAwBnE"}

package/dist/test/scripts/pw-locator-patch/input-value.js

@@ -1,24 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.patchInputValue = void 0;
+const constants_1 = require("../../constants");
 function patchInputValue(LocatorClass) {
     const originalInputValue = LocatorClass.prototype.inputValue;
     //ref: github.com/microsoft/playwright/blob/69287f26bc514b740eac40160503d6fac8185d37/packages/playwright-core/src/client/locator.ts#L255
     LocatorClass.prototype.inputValue = async function (options) {
         const result = await originalInputValue.apply(this, [options]);
         try {
-            await this.scrollIntoViewIfNeeded();
             await this.evaluate((node) => {
+                node.scrollIntoViewIfNeeded();
                 node.classList.add("empirical-element-grab-highlight");
                 setTimeout(() => {
-                    if (node.isConnected) {
+                    if (node && node.isConnected && node.classList) {
                         node.classList.remove("empirical-element-grab-highlight");
                     }
                 }, 2000);
-            });
+            }, undefined, { timeout: constants_1.DEFAULT_SCRIPT_EXECUTION_TIMEOUT });
         }
         catch (e) {
-            console.log("Failed to add highlight for locator method: inputValue", e);
+            console.warn("Failed to add highlight for locator method: inputValue");
         }
         return result;
     };

package/dist/test/scripts/pw-locator-patch/is-checked.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-checked.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/is-checked.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,wBAAgB,cAAc,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAoBlE"}
+{"version":3,"file":"is-checked.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/is-checked.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAI3C,wBAAgB,cAAc,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAwBlE"}

package/dist/test/scripts/pw-locator-patch/is-checked.js

@@ -1,24 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.patchIsChecked = void 0;
+const constants_1 = require("../../constants");
 function patchIsChecked(LocatorClass) {
     const originalIsChecked = LocatorClass.prototype.isChecked;
     LocatorClass.prototype.isChecked = async function (options) {
         // ref: https://github.com/microsoft/playwright/blob/69287f26bc514b740eac40160503d6fac8185d37/packages/playwright-core/src/client/locator.ts#L259
         const result = await originalIsChecked.apply(this, [options]);
         try {
-            await this.scrollIntoViewIfNeeded();
             await this.evaluate((node) => {
+                node.scrollIntoViewIfNeeded();
                 node.classList.add("empirical-element-grab-highlight");
                 setTimeout(() => {
-                    if (node.isConnected) {
+                    if (node && node.isConnected && node.classList) {
                         node.classList.remove("empirical-element-grab-highlight");
                     }
                 }, 2000);
-            });
+            }, undefined, { timeout: constants_1.DEFAULT_SCRIPT_EXECUTION_TIMEOUT });
         }
         catch (e) {
-            console.log("Failed to add highlight for locator method: isChecked", e);
+            console.warn("Failed to add highlight for locator method: isChecked");
         }
         return result;
     };

package/dist/test/scripts/pw-locator-patch/is-disabled.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-disabled.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/is-disabled.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,wBAAgB,eAAe,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAoBnE"}
+{"version":3,"file":"is-disabled.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/is-disabled.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAI3C,wBAAgB,eAAe,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAwBnE"}

package/dist/test/scripts/pw-locator-patch/is-disabled.js

@@ -1,24 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.patchIsDisabled = void 0;
+const constants_1 = require("../../constants");
 function patchIsDisabled(LocatorClass) {
     const originalIsDisabled = LocatorClass.prototype.isDisabled;
     LocatorClass.prototype.isDisabled = async function (options) {
         // ref: https://github.com/microsoft/playwright/blob/69287f26bc514b740eac40160503d6fac8185d37/packages/playwright-core/src/client/locator.ts#L263
         const result = await originalIsDisabled.apply(this, [options]);
         try {
-            await this.scrollIntoViewIfNeeded();
             await this.evaluate((node) => {
+                node.scrollIntoViewIfNeeded();
                 node.classList.add("empirical-element-grab-highlight");
                 setTimeout(() => {
-                    if (node.isConnected) {
+                    if (node && node.isConnected && node.classList) {
                         node.classList.remove("empirical-element-grab-highlight");
                     }
                 }, 2000);
-            });
+            }, undefined, { timeout: constants_1.DEFAULT_SCRIPT_EXECUTION_TIMEOUT });
         }
         catch (e) {
-            console.log("Failed to add highlight for locator method: isDisabled", e);
+            console.warn("Failed to add highlight for locator method: isDisabled");
         }
         return result;
     };

package/dist/test/scripts/pw-locator-patch/is-editable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"is-editable.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/is-editable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAE3C,wBAAgB,eAAe,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAoBnE"}
+{"version":3,"file":"is-editable.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/is-editable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAI3C,wBAAgB,eAAe,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAwBnE"}

package/dist/test/scripts/pw-locator-patch/is-editable.js

@@ -1,24 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.patchIsEditable = void 0;
+const constants_1 = require("../../constants");
 function patchIsEditable(LocatorClass) {
     const originalIsEditable = LocatorClass.prototype.isEditable;
     LocatorClass.prototype.isEditable = async function (options) {
         // ref: https://github.com/microsoft/playwright/blob/69287f26bc514b740eac40160503d6fac8185d37/packages/playwright-core/src/client/locator.ts#L267
         const result = await originalIsEditable.apply(this, [options]);
         try {
-            await this.scrollIntoViewIfNeeded();
             await this.evaluate((node) => {
+                node.scrollIntoViewIfNeeded();
                 node.classList.add("empirical-element-grab-highlight");
                 setTimeout(() => {
-                    if (node.isConnected) {
+                    if (node && node.isConnected && node.classList) {
                         node.classList.remove("empirical-element-grab-highlight");
                     }
                 }, 2000);
-            });
+            }, undefined, { timeout: constants_1.DEFAULT_SCRIPT_EXECUTION_TIMEOUT });
         }
         catch (e) {
-            console.log("Failed to add highlight for locator method: isEditable", e);
+            console.warn("Failed to add highlight for locator method: isEditable");
         }
         return result;
     };

package/dist/test/scripts/pw-locator-patch/text-content.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"text-content.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/text-content.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,wBAAgB,gBAAgB,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAoBpE"}
+{"version":3,"file":"text-content.d.ts","sourceRoot":"","sources":["../../../../src/test/scripts/pw-locator-patch/text-content.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAIhD,wBAAgB,gBAAgB,CAAC,YAAY,EAAE;IAAE,SAAS,EAAE,OAAO,CAAA;CAAE,QAwBpE"}

package/dist/test/scripts/pw-locator-patch/text-content.js

@@ -1,24 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.patchTextContent = void 0;
+const constants_1 = require("../../constants");
 function patchTextContent(LocatorClass) {
     const originalTextContent = LocatorClass.prototype.textContent;
     //ref: https://github.com/microsoft/playwright/blob/69287f26bc514b740eac40160503d6fac8185d37/packages/playwright-core/src/client/locator.ts#L318
     LocatorClass.prototype.textContent = async function (options) {
         const result = await originalTextContent.apply(this, [options]);
         try {
-            await this.scrollIntoViewIfNeeded();
             await this.evaluate((node) => {
+                node.scrollIntoViewIfNeeded();
                 node.classList.add("empirical-element-grab-highlight");
                 setTimeout(() => {
-                    if (node.isConnected) {
+                    if (node && node.isConnected && node.classList) {
                         node.classList.remove("empirical-element-grab-highlight");
                     }
                 }, 2000);
-            });
+            }, undefined, { timeout: constants_1.DEFAULT_SCRIPT_EXECUTION_TIMEOUT });
         }
         catch (e) {
-            console.log("Failed to add highlight for locator method: textContent", e);
+            console.warn("Failed to add highlight for locator method: textContent");
         }
         return result;
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@empiricalrun/playwright-utils",
-  "version": "0.6.0",
+  "version": "0.6.2",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"