@d-zero/puppeteer-dealer 0.6.5 → 0.7.0

package/README.md

@@ -1,10 +1,18 @@
 # `@d-zero/puppeteer-dealer`
 
+Puppeteerを使ってマルチプロセスで複数のURLを処理するためのパッケージです。
+
+## API
+
+### `deal`
+
+URLリストを処理するメイン関数です。
+
 ```ts
-import { deal } from '@d-zero/puppeteer-dealer';
+import { deal, createProcess } from '@d-zero/puppeteer-dealer';
 
 await deal(
-	// Input list data
+	// URLリスト
 	[
 		{
 			id: '1',
@@ -16,39 +24,233 @@ await deal(
 		},
 	],
 
-	// Header log
+	// ヘッダーログ
 	(progress, done, total) => {
 		return `Header ${Math.ceil(progress * 100)}% ${done}/${total}`;
 	},
 
-	// Handlers
+	// プロセス作成関数
+	() => {
+		return createProcess(
+			'./child-process.js', // 子プロセスのパス
+			{
+				// 子プロセスに渡すパラメータ
+				// 任意のデータを渡すことができます
+			},
+			{
+				// オプション
+				locale: 'ja-JP',
+				headless: true,
+			},
+		);
+	},
+
+	// オプション
 	{
-		async beforeOpenPage(id, url, logger) {
-			if (condition) {
-				// continue (like Event preventDefault)
-				return false;
-			}
+		limit: 10,
+		debug: false,
+		verbose: false,
+	},
+);
+```
 
-			return true;
-		},
-		async deal(page, id, url, logger) {
-			// Do something
+**型定義:**
+
+```ts
+function deal<T, R = void>(
+	list: readonly URLInfo[],
+	header: DealHeader,
+	createProcess: () => (needAuth: boolean) => ChildProcessManager<T, R>,
+	options?: Omit<DealOptions, 'header'> & {
+		each?: (
+			result: R,
+			push: (...items: URLInfo[]) => Promise<void>,
+		) => void | Promise<void>;
+	},
+): Promise<void>;
+
+type URLInfo = {
+	readonly id: string | null;
+	readonly url: string | URL;
+};
+
+type DealHeader = (
+	progress: number,
+	done: number,
+	total: number,
+	limit: number,
+) => string;
+```
+
+### `createProcess`
+
+子プロセスを作成する関数です。`deal`関数の第3引数で使用します。
+
+```ts
+import { createProcess } from '@d-zero/puppeteer-dealer';
+
+const processFactory = createProcess(
+	'./child-process.js', // 子プロセスのパス
+	{
+		// 子プロセスに渡すパラメータ
+		param1: 'value1',
+		param2: 'value2',
+	},
+	{
+		// Puppeteerオプション
+		locale: 'ja-JP',
+		headless: true,
+		// その他のLaunchOptions
+	},
+);
+```
+
+**型定義:**
+
+```ts
+function createProcess<P, R = void>(
+	subModulePath: string,
+	params: P,
+	options?: PuppeteerDealerOptions & LaunchOptions,
+): (needAuth: boolean) => ChildProcessManager<P, R>;
+
+type PuppeteerDealerOptions = {
+	readonly locale?: string;
+} & DealOptions;
+```
+
+### `createChildProcess`
+
+子プロセス側で使用する関数です。Puppeteerページの処理を定義します。
+
+```ts
+// child-process.ts
+import { createChildProcess } from '@d-zero/puppeteer-dealer';
+
+type ChildProcessParams = {
+	param1: string;
+	param2: string;
+};
+
+createChildProcess<ChildProcessParams>((params) => {
+	const { param1, param2, needAuth } = params;
+
+	return {
+		async eachPage({ page, id, url, index }, logger) {
+			// Puppeteerページの処理
+			logger('ページにアクセスしています...');
 			await page.goto(url);
+
+			logger('処理を実行しています...');
 			await page.evaluate(() => {
-				// Do something
+				// ページ内での処理
 			});
+
+			// 戻り値を返すことができます
+			return { success: true };
 		},
-	},
+	};
+});
+```
+
+**型定義:**
+
+```ts
+function createChildProcess<P, R = void>(
+	handler: ChildProcessHandler<P & CommonParams, R>,
+): void;
+
+type ChildProcessHandler<P extends CommonParams, R> = (
+	params: P,
+) => Promise<ChildProcessMethods<R>> | ChildProcessMethods<R>;
+
+type ChildProcessMethods<R> = {
+	eachPage: (params: EachPageParams, logger: Logger) => Promise<R>;
+};
+
+type EachPageParams = {
+	readonly page: Page;
+	readonly id: string;
+	readonly url: string;
+	readonly index: number;
+};
+
+type CommonParams = {
+	readonly needAuth: boolean;
+};
 
-	// Options
+type Logger = (log: string) => void;
+```
+
+## 使用例
+
+完全な使用例:
+
+**main-process.ts:**
+
+```ts
+import path from 'node:path';
+import { deal, createProcess } from '@d-zero/puppeteer-dealer';
+
+type ChildProcessParams = {
+	outputDir: string;
+};
+
+await deal(
+	[
+		{ id: '1', url: 'https://example.com/page1' },
+		{ id: '2', url: 'https://example.com/page2' },
+	],
+	(_, done, total) => {
+		return `処理中: ${done}/${total}`;
+	},
+	() => {
+		return createProcess<ChildProcessParams>(
+			path.resolve(import.meta.dirname, 'child-process.js'),
+			{
+				outputDir: './output',
+			},
+			{
+				locale: 'ja-JP',
+				headless: true,
+			},
+		);
+	},
 	{
-		locale: 'ja-JP',
+		limit: 5,
 		debug: false,
-		limit: 10,
-		verbose: false,
-
-		// Puppeteer launch options
-		headless: true,
 	},
 );
 ```
+
+**child-process.ts:**
+
+```ts
+import { createChildProcess } from '@d-zero/puppeteer-dealer';
+
+type ChildProcessParams = {
+	outputDir: string;
+};
+
+createChildProcess<ChildProcessParams>(async (params) => {
+	const { outputDir, needAuth } = params;
+
+	return {
+		async eachPage({ page, id, url }, logger) {
+			logger(`${url}を処理しています...`);
+
+			await page.goto(url);
+
+			const title = await page.title();
+			logger(`タイトル: ${title}`);
+
+			// スクリーンショットを撮る
+			await page.screenshot({
+				path: `${outputDir}/${id}.png`,
+			});
+
+			logger('完了');
+		},
+	};
+});
+```

package/dist/deal.d.ts

@@ -9,5 +9,5 @@ import type { DealHeader, DealOptions } from '@d-zero/dealer';
  * @param options
  */
 export declare function deal<T, R = void>(list: readonly URLInfo[], header: DealHeader, createProcess: () => (needAuth: boolean) => ChildProcessManager<T, R>, options?: Omit<DealOptions, 'header'> & {
-    each?: (result: R) => void | Promise<void>;
+    each?: (result: R, push: (...items: URLInfo[]) => Promise<void>) => void | Promise<void>;
 }): Promise<void>;

package/dist/deal.js

@@ -12,7 +12,7 @@ export function deal(list, header, createProcess, options) {
         const urlObj = new URL(url);
         return !!(urlObj.username && urlObj.password);
     });
-    return coreDeal(list, ({ id, url }, update, index, setLineHeader) => {
+    return coreDeal(list, ({ id, url }, update, index, setLineHeader, push) => {
         const fileId = id || index.toString().padStart(3, '0');
         const lineHeader = `%braille% ${c.bgWhite(` ${fileId} `)} ${c.gray(url.toString())}: `;
         setLineHeader(lineHeader);
@@ -24,7 +24,7 @@ export function deal(list, header, createProcess, options) {
             processManager.log((log) => update(log));
             const result = await processManager.each(fileId, url.toString(), index);
             if (options?.each) {
-                await options.each(result);
+                await options.each(result, push);
             }
             await processManager.close();
         };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@d-zero/puppeteer-dealer",
-	"version": "0.6.5",
+	"version": "0.7.0",
 	"description": "Puppeteer handles each page",
 	"author": "D-ZERO",
 	"license": "MIT",
@@ -23,19 +23,19 @@
 		"clean": "tsc --build --clean"
 	},
 	"dependencies": {
-		"@d-zero/dealer": "1.5.3",
-		"@d-zero/proc-talk": "0.4.14",
-		"@d-zero/shared": "0.17.1",
+		"@d-zero/dealer": "1.6.0",
+		"@d-zero/proc-talk": "0.4.15",
+		"@d-zero/shared": "0.18.0",
 		"ansi-colors": "4.1.3",
 		"debug": "4.4.3",
 		"puppeteer-extra": "3.3.6",
 		"puppeteer-extra-plugin-stealth": "2.11.2"
 	},
 	"devDependencies": {
-		"puppeteer": "24.36.0"
+		"puppeteer": "24.37.2"
 	},
 	"peerDependencies": {
-		"puppeteer": "24.36.0"
+		"puppeteer": "24.37.2"
 	},
-	"gitHead": "e2189e6878674b8fef5fa3c121ad109c448040fe"
+	"gitHead": "a6d7b36c485bbc0782375c6e1ad0d0606f423e97"
 }