@d-zero/puppeteer-scroll 3.1.14 → 3.1.16

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 D-ZERO Co., Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/scroll-all-over.d.ts

@@ -7,6 +7,11 @@ export type Options = {
 };
 /**
  * Scrolls the page vertically until the end or a maximum height is reached.
+ *
+ * Detects stuck scrolling (e.g. fullpage.js or other scroll-jacking libraries
+ * that block `scrollBy` while `body.scrollHeight` exceeds the viewport) and
+ * bails out after {@link MAX_STUCK_ITERATIONS} consecutive iterations without
+ * progress.
  * @param page - The Puppeteer page object.
  * @param options - Optional parameters for scrolling.
  * @param options.distance - The distance to scroll on each iteration (default: 100).

package/dist/scroll-all-over.js

@@ -1,6 +1,20 @@
 import { delay } from '@d-zero/shared/delay';
+/**
+ * Number of consecutive iterations without scroll progress before bailing out.
+ *
+ * Scroll-jacking libraries (e.g. fullpage.js) can block `scrollBy` while
+ * `body.scrollHeight` remains larger than the viewport, causing an infinite
+ * loop. Three stuck iterations (≈ 900 ms at the default interval) is enough
+ * to confirm that scrolling is genuinely blocked.
+ */
+const MAX_STUCK_ITERATIONS = 3;
 /**
  * Scrolls the page vertically until the end or a maximum height is reached.
+ *
+ * Detects stuck scrolling (e.g. fullpage.js or other scroll-jacking libraries
+ * that block `scrollBy` while `body.scrollHeight` exceeds the viewport) and
+ * bails out after {@link MAX_STUCK_ITERATIONS} consecutive iterations without
+ * progress.
  * @param page - The Puppeteer page object.
  * @param options - Optional parameters for scrolling.
  * @param options.distance - The distance to scroll on each iteration (default: 100).
@@ -11,6 +25,8 @@ export async function scrollAllOver(page, options) {
     const interval = options?.interval ?? 300;
     let currentScrollY = 0;
     let scrollHeight = await page.evaluate(() => document.body.scrollHeight);
+    let prevScrollY = -1;
+    let stuckCount = 0;
     while (Math.ceil(currentScrollY) < Math.ceil(scrollHeight)) {
         [currentScrollY, scrollHeight] = await page.evaluate(() => {
             // Move the scroll position to the bottom of the page.
@@ -22,6 +38,17 @@ export async function scrollAllOver(page, options) {
             ];
         });
         options?.logger?.(currentScrollY, scrollHeight, 'Scrolling');
+        if (currentScrollY === prevScrollY) {
+            stuckCount++;
+            if (stuckCount >= MAX_STUCK_ITERATIONS) {
+                options?.logger?.(currentScrollY, scrollHeight, 'Scroll stuck, bailing out');
+                break;
+            }
+        }
+        else {
+            stuckCount = 0;
+        }
+        prevScrollY = currentScrollY;
         await delay(interval);
     }
     options?.logger?.(currentScrollY, scrollHeight, 'End of page');

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/puppeteer-scroll",
-	"version": "3.1.14",
+	"version": "3.1.16",
 	"description": "Scroll function for puppeteer",
 	"author": "D-ZERO",
 	"license": "MIT",
@@ -23,12 +23,13 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@d-zero/shared": "0.21.0"
+		"@d-zero/shared": "0.21.1"
 	},
 	"devDependencies": {
 		"puppeteer": "24.37.5"
 	},
 	"peerDependencies": {
 		"puppeteer": "24.37.5"
-	}
+	},
+	"gitHead": "a347e4e88968fca7f2ace7639090d32014479d9f"
 }