graceful-playwright 1.3.0 → 1.5.0

package/README.md

@@ -52,6 +52,8 @@ await browser.close()
 
 ## Typescript Signature
 
+Main Class: `GracefulPage`
+
 ```typescript
 import { Browser, BrowserContext, Page, Response } from 'playwright'
 
@@ -80,7 +82,10 @@ export class GracefulPage {
   /** @description optimized version of page.close() */
   close: Page['close']
 
-  /** @description graceful version of page.goto() */
+  /**
+   * @description graceful version of page.goto()
+   * @throws GotoError with response details when got 429 Too Many Requests without retry-after header
+   */
   goto(
     url: string,
     /**
@@ -103,6 +108,20 @@ export class GracefulPage {
 }
 ```
 
+Error Class: `GotoError`
+
+```typescript
+export class GotoError extends Error {
+  constructor(message: string, public details: GotoErrorDetails)
+}
+
+export type GotoErrorDetails = {
+  url: string
+  options?: Parameters<Page['goto']>[1]
+  response: Awaited<ReturnType<Page['goto']>>
+}
+```
+
 ## License
 
 This project is licensed with [BSD-2-Clause](./LICENSE)

package/core.d.ts

@@ -31,7 +31,10 @@ export declare class GracefulPage {
     restart(options?: Parameters<Page['close']>[0]): Promise<Page>;
     /** @description optimized version of page.close() */
     close: Page['close'];
-    /** @description graceful version of page.goto() */
+    /**
+     * @description graceful version of page.goto()
+     * @throws GotoError with response details when got 429 Too Many Requests without retry-after header
+     */
     goto(url: string, 
     /**
      * @default { waitUtil: "domcontentloaded" }
@@ -55,3 +58,13 @@ export declare class GracefulPage {
     /** @description proxy method to (await this.getPage()).innerText */
     innerText: Page['innerText'];
 }
+export type GotoErrorDetails = {
+    url: string;
+    options?: Parameters<Page['goto']>[1];
+    response: Awaited<ReturnType<Page['goto']>>;
+};
+export declare class GotoError extends Error {
+    details: GotoErrorDetails;
+    constructor(message: string, details: GotoErrorDetails);
+}
+export declare function parseRetryAfter(headerValue: string | null): number | null;

package/core.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GracefulPage = void 0;
+exports.GotoError = exports.GracefulPage = void 0;
+exports.parseRetryAfter = parseRetryAfter;
 class GracefulPage {
     options;
     constructor(options) {
@@ -36,7 +37,10 @@ class GracefulPage {
         this.options.page = undefined;
         return promise;
     };
-    /** @description graceful version of page.goto() */
+    /**
+     * @description graceful version of page.goto()
+     * @throws GotoError with response details when got 429 Too Many Requests without retry-after header
+     */
     async goto(url, 
     /**
      * @default { waitUtil: "domcontentloaded" }
@@ -50,24 +54,14 @@ class GracefulPage {
                     ...options,
                 });
                 if (response && response.status() === 429) {
-                    let retryAfter = await response.headerValue('Retry-After');
-                    if (retryAfter && +retryAfter) {
-                        // e.g. 120 (seconds)
-                        await sleep(+retryAfter * 1000);
+                    let headerValue = await response.headerValue('Retry-After');
+                    let interval = parseRetryAfter(headerValue);
+                    if (interval) {
+                        await sleep(interval);
                         continue;
                     }
-                    else if (retryAfter && new Date(retryAfter).getTime()) {
-                        // e.g. "Wed, 21 Oct 2015 07:28:00 GMT"
-                        let target = new Date(retryAfter).getTime();
-                        let now = Date.now();
-                        let diff = target - now;
-                        await sleep(diff);
-                        continue;
-                    }
-                    else {
-                        let statusText = response.statusText() || 'Too Many Requests';
-                        throw new Error(statusText);
-                    }
+                    let statusText = response.statusText() || 'Too Many Requests';
+                    throw new GotoError(statusText, { url, options, response });
                 }
                 return response;
             }
@@ -156,6 +150,30 @@ class GracefulPage {
     };
 }
 exports.GracefulPage = GracefulPage;
+class GotoError extends Error {
+    details;
+    constructor(message, details) {
+        super(message);
+        this.details = details;
+    }
+}
+exports.GotoError = GotoError;
 function sleep(ms) {
     return new Promise(resolve => setTimeout(resolve, ms));
 }
+function parseRetryAfter(headerValue) {
+    if (!headerValue)
+        return null;
+    // e.g. 120 (seconds)
+    let seconds = +headerValue;
+    if (seconds) {
+        return seconds * 1000;
+    }
+    // e.g. "Wed, 21 Oct 2015 07:28:00 GMT"
+    let target = new Date(headerValue).getTime();
+    if (target) {
+        let diff = target - Date.now();
+        return diff;
+    }
+    return null;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "graceful-playwright",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "Gracefully handle timeout and network error with auto retry.",
   "keywords": [
     "graceful",
@@ -58,14 +58,13 @@
     "@types/sinon": "^17.0.1",
     "chai": "4",
     "express": "^4.18.2",
-    "mocha": "^10.3.0",
+    "mocha": "^11.2.2",
     "npm-run-all": "^4.1.5",
-    "playwright": "^1.50.0",
-    "rimraf": "^5.0.5",
-    "sinon": "^17.0.1",
-    "ts-mocha": "^10.0.0",
+    "playwright": "^1.52.0",
+    "rimraf": "^6.0.1",
+    "sinon": "^20.0.0",
+    "ts-mocha": "^11.1.0",
     "ts-node": "^10.9.2",
-    "ts-node-dev": "^2.0.0",
     "typescript": "^5.3.3"
   }
 }