v5.0.1 Dynamically import puppeteer

brahma-dev · brahma-dev · commit d545ccb9d0f2 · 2025-08-13T18:33:01.000Z
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "metafetch",
   "description": "Metafetch fetches a given URL's title, description, images, links etc.",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "homepage": "https://github.com/brahma-dev/metafetch",
   "repository": {
     "type": "git",
@@ -25,7 +25,12 @@
     "linkedom": "^0.18.11"
   },
   "peerDependencies": {
-    "puppeteer": "^24.16.1"
+    "puppeteer": ">=22.0.0 <25.0.0"
+  },
+  "peerDependenciesMeta": {
+    "puppeteer": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "@istanbuljs/nyc-config-typescript": "^1.0.2",
diff --git a/src/index.ts b/src/index.ts
@@ -1,6 +1,5 @@
 import { parseHTML } from 'linkedom';
 import type { Document } from 'linkedom';
-import puppeteer from 'puppeteer';
 
 /**
  * The shape of the response object returned by Metafetch.
@@ -80,6 +79,14 @@ export class Metafetch {
 		return this.#userAgent;
 	}
 
+	/**
+	 * Wrapper for dynamic import of puppeteer to improve testability.
+	 * @private
+	 */
+	private async _getPuppeteer() {
+		return import('puppeteer');
+	}
+
 	/**
 	 * Fetches and parses metadata from a given URL.
 	 * @param url The URL to fetch.
@@ -112,6 +119,15 @@ export class Metafetch {
 				let encoding: string;
 
 				if (options.render) {
+					let puppeteer;
+					try {
+						const puppeteerModule = await this._getPuppeteer();
+						puppeteer = puppeteerModule.default;
+					} catch (err) {
+						throw new Error(
+							'The "render" option requires the "puppeteer" package. Please install it (`npm install puppeteer`) and try again.'
+						);
+					}
 					const browser = await puppeteer.launch({
 						headless: true, args: [
 							'--no-sandbox',
diff --git a/test/test.ts b/test/test.ts
@@ -37,7 +37,7 @@ describe('Metafetch: Optimized Tests', () => {
 					res.setHeader('Content-Type', 'text/html; charset=iso-8859-1').end('<body></body>');
 					return;
 				case '/charset-meta':
-					res.setHeader('Content-Type', 'text/html'); 
+					res.setHeader('Content-Type', 'text/html');
 					body = '<head><meta charset="windows-1252"></head>';
 					break;
 				case '/base-tag':
@@ -470,6 +470,21 @@ describe('Metafetch: Optimized Tests', () => {
 				expect(err.message).to.equal("Received an empty response body.");
 			}
 		});
+
+		it('should throw a helpful error when puppeteer fails to import', async () => {
+			const newInstance = new Metafetch();
+			// Stub the private method to simulate an import failure
+			const importStub = sinon.stub(newInstance as any, '_getPuppeteer').rejects(new Error('Simulated import failure'));
+
+			try {
+				await newInstance.fetch(`${BASE_URL}/page`, { render: true });
+				throw new Error("Test failed: Metafetch should have thrown an error.");
+			} catch (err: any) {
+				expect(err.message).to.equal('The "render" option requires the "puppeteer" package. Please install it (`npm install puppeteer`) and try again.');
+			} finally {
+				importStub.restore();
+			}
+		});
 	});
 
 	describe('Request Retries', () => {
