graceful-playwright 1.0.0 → 1.1.1

package/README.md

@@ -6,10 +6,12 @@ Gracefully handle timeout and network error with auto retry.
 
 ## Features
 
-- auto retry when `page.goto()` timeout or encountered `/ERR_NETWORK_CHANGED/i`
+- auto retry when `page.goto()` timeout or encountered `ERR_NETWORK_CHANGED`
 
 - auto restart page when `page.goto()` crashed with `/page crashed/i` error
 
+- helper method to auto retry when failed with `The object has been collected to prevent unbounded heap growth` error
+
 - support restarting page from `Browser` or `BrowserContext` instance
 
 - support wrapping existing `Page` instance
@@ -36,16 +38,70 @@ import { GracefulPage } from 'graceful-playwright'
 let browser = await chromium.launch()
 let page = new GracefulPage({ from: browser })
 
-await page.goto('http://example.net')
-let lines: string[] = await page.evaluate(() =>
-  Array.from(document.querySelectorAll('a'), a => a.href),
-)
+let lines: string[] = await page.autoRetryWhenFailed(async () => {
+  await page.goto('http://example.net')
+  return await page.evaluate(() =>
+    Array.from(document.querySelectorAll('a'), a => a.href),
+  )
+})
 console.log('lines:', lines)
 
 await page.close()
 await browser.close()
 ```
 
+## Typescript Signature
+
+```typescript
+import { Browser, BrowserContext, Page, Response } from 'playwright'
+
+export class GracefulPage {
+  constructor(
+    public options: {
+      from: Browser | BrowserContext
+      page?: Page | Promise<Page>
+      /**
+       * @default 5000 ms
+       */
+      retryInterval?: number
+      /**
+       * @default error => console.error(error)
+       */
+      onError?: (error: unknown) => void
+    },
+  )
+
+  fork(): GracefulPage
+
+  getPage(): Page | Promise<Page>
+
+  restart(options?: Parameters<Page['close']>[0]): Promise<Page>
+
+  /** @description optimized version of page.close() */
+  close: Page['close']
+
+  /** @description graceful version of page.goto() */
+  goto(
+    url: string,
+    /**
+     * @default { waitUtil: "domcontentloaded" }
+     */
+    options?: Parameters<Page['goto']>[1],
+  ): Promise<Response | null>
+
+  autoRetryWhenFailed<T>(f: () => T | Promise<T>): Promise<T>
+
+  /** @description proxy method to (await this.getPage())[method] */
+  evaluate: Page['evaluate']
+  fill: Page['fill']
+  click: Page['click']
+  content: Page['content']
+  title: Page['title']
+  innerHTML: Page['innerHTML']
+  innerText: Page['innerText']
+}
+```
+
 ## License
 
 This project is licensed with [BSD-2-Clause](./LICENSE)

package/core.d.ts

@@ -29,11 +29,15 @@ export declare class GracefulPage {
     getOnError(): (error: unknown) => void;
     getPage(): Page | Promise<Page>;
     restart(options?: Parameters<Page['close']>[0]): Promise<Page>;
+    /** @description optimized version of page.close() */
+    close: Page['close'];
+    /** @description graceful version of page.goto() */
     goto(url: string, 
     /**
      * @default { waitUtil: "domcontentloaded" }
      */
     options?: Parameters<Page['goto']>[1]): Promise<import("playwright").Response | null>;
+    autoRetryWhenFailed<T>(f: () => T | Promise<T>): Promise<T>;
     /** @description proxy method to (await this.getPage()).evaluate */
     evaluate: Page['evaluate'];
     /** @description proxy method to (await this.getPage()).fill */
@@ -48,6 +52,4 @@ export declare class GracefulPage {
     innerHTML: Page['innerHTML'];
     /** @description proxy method to (await this.getPage()).innerText */
     innerText: Page['innerText'];
-    /** @description proxy method to (await this.getPage()).click */
-    close: Page['close'];
 }

package/core.js

@@ -24,6 +24,15 @@ class GracefulPage {
         await this.close(options);
         return this.getPage();
     }
+    /** @description optimized version of page.close() */
+    close = async (options) => {
+        let promise = Promise.resolve(this.options.page)
+            .then(page => page?.close(options))
+            .catch(this.getOnError());
+        this.options.page = undefined;
+        return promise;
+    };
+    /** @description graceful version of page.goto() */
     async goto(url, 
     /**
      * @default { waitUtil: "domcontentloaded" }
@@ -41,10 +50,11 @@ class GracefulPage {
             catch (error) {
                 let message = String(error);
                 let flags = {
-                    retry: message.match(/timeout/i) || message.match(/ERR_NETWORK_CHANGED/i),
+                    retry: message.match(/timeout/i) || message.match(/ERR_NETWORK_CHANGED/),
                     restart: message.match(/page crashed/i),
                 };
                 if (flags.retry || flags.restart) {
+                    this.getOnError()(error);
                     if (flags.restart) {
                         await this.restart();
                     }
@@ -55,6 +65,26 @@ class GracefulPage {
             }
         }
     }
+    async autoRetryWhenFailed(f) {
+        for (;;) {
+            try {
+                return await f();
+            }
+            catch (error) {
+                let message = String(error);
+                let flags = {
+                    restart: message.match(/The object has been collected to prevent unbounded heap growth/),
+                };
+                if (flags.restart) {
+                    this.getOnError()(error);
+                    await this.restart();
+                    await sleep(this.getRetryInterval());
+                    continue;
+                }
+                throw error;
+            }
+        }
+    }
     /** @description proxy method to (await this.getPage()).evaluate */
     evaluate = async (pageFunction, arg) => {
         let page = await this.getPage();
@@ -90,14 +120,6 @@ class GracefulPage {
         let page = await this.getPage();
         return await page.innerText(selector, options);
     };
-    /** @description proxy method to (await this.getPage()).click */
-    close = async (options) => {
-        let promise = Promise.resolve(this.options.page)
-            .then(page => page?.close(options))
-            .catch(this.getOnError());
-        this.options.page = undefined;
-        return promise;
-    };
 }
 exports.GracefulPage = GracefulPage;
 function sleep(ms) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graceful-playwright",
-  "version": "1.0.0",
+  "version": "1.1.1",
   "description": "Gracefully handle timeout and network error with auto retry.",
   "keywords": [
     "graceful",