Merge pull request #19 from J-Hoplin/fix/fix-2.0.8

2.0.8-beta

Author: J-Hoplin

Readme.md

@@ -20,25 +20,55 @@
   ```
   pnpm install puppeteer @hoplin/puppeteer-pool
   ```
-  <details>
-  <summary><b>Patch Note</b></summary>
-  <div markdown="1">
 
-### Release 2.0.8
+## Release 2.0.8(and it's sub versions)
+
+- `PuppeteerPool.start` required parameter as config type
+
+  ```typescript
+  type PuppeteerPoolStartOptions = {
+    /**
+     * Number of concurrency,
+     * Default is 3
+     */
+    concurrencyLevel: number;
+    /**
+     * Context mode
+     * Default is ContextMode.SHARED
+     */
+    contextMode: ContextMode;
+    /**
+     * Puppeteer launch options
+     * Default is {}
+     */
+    options?: puppeteer.LaunchOptions;
+    /**
+     * Custom config path
+     */
+    customConfigPath?: string;
+    /**
+     * Enable log
+     * Default is true
+     */
+    enableLog?: boolean;
+    /**
+     * Log level
+     * Default is LogLevel.DEBUG
+     */
+    logLevel?: LogLevel;
+  };
+  ```
 
 - Remove pino logger dependency and implement custom logger
   - You can config `log level` and `enable log` in `PuppeteerPool.start` function
 - Enhanced Concurrency Control
 
-### Next Features in 2.0.9
+## Next Features in 2.0.9
 
 - Detailed Metrics Monitoring
   - Monitor metrics by context
 - Support to use Playwright instead of Puppeteer
 
-</div>
-</details>
-
 ## Fully changed from 2.0.0
 
 The internal implementation is event-based, which significantly improves the stability. In addition, instead of relying
@@ -58,32 +88,50 @@ After that you can use dispatcher to control pool manager.
 - PuppeteePool
   - `PuppeteerPool` is singleton class. You can use `PuppeteerPool.start` to initialize pool manager.
 - PuppeteerPool.start
+
   - Static Method
   - Description: Initialize pool manager. You need to call this function to start puppeteer pool. Even if you invoke
     this function multiple times with differenct arguments, it will return the first initialized instance.
-  - Args
-    - concurrencyLevel
-      - Required
-      - number
-    - contextMode: ContextMode
-      - Required
-        - `ContextMode.ISOLATED` | `ContextMode.SHARED`
-    - enableLog: boolean
-      - Optional
-      - Default: `true`
-    - logLevel: LogLevel
-      - Optional
-      - Default: `LogLevel.DEBUG`
-    - options
-      - Optional
-      - [puppeteer.LaunchOptions](https://pptr.dev/api/puppeteer.launchoptions)
-      - Default: `{}`
-    - customConfigPath
-      - Optional
-      - string (Default: `puppeteer-pool-config.json` in project root)
+  - Args: `PuppeteerPoolStartOptions`
+
+    ```typescript
+    type PuppeteerPoolStartOptions = {
+      /**
+       * Number of concurrency,
+       * Default is 3
+       */
+      concurrencyLevel: number;
+      /**
+       * Context mode
+       * Default is ContextMode.SHARED
+       */
+      contextMode: ContextMode;
+      /**
+       * Puppeteer launch options
+       * Default is {}
+       */
+      options?: puppeteer.LaunchOptions;
+      /**
+       * Custom config path
+       */
+      customConfigPath?: string;
+      /**
+       * Enable log
+       * Default is true
+       */
+      enableLog?: boolean;
+      /**
+       * Log level
+       * Default is LogLevel.DEBUG
+       */
+      logLevel?: LogLevel;
+    };
+    ```
+
   - Return
     - `Promise<PuppeteerPool>`
     - Returns PuppeteerPool Instance.
+
 - Instance<PuppeteerPool>.stop
   - Description: Stop pool manager. It will close all sessions and terminate pool manager.
   - Return
@@ -114,7 +162,10 @@ After that you can use dispatcher to control pool manager.
 import { ContextMode, PuppeteerPool } from '@hoplin/puppeteer-pool';
 
 async function main() {
-  const poolInstance = await PuppeteerPool.start(2, ContextMode.ISOLATED);
+  const poolInstance = await PuppeteerPool.start({
+    concurrencyLevel: 2,
+    contextMode: ContextMode.ISOLATED,
+  });
 
   const urls = [
     'https://www.google.com',

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hoplin/puppeteer-pool",
-  "version": "2.0.8",
+  "version": "2.0.8-beta",
   "main": "dist/index.js",
   "description": "Puppeteer Pool Manager for worker server, process daemon, commands etc...",
   "repository": "https://github.com/J-Hoplin/Puppeteer-Pool.git",

src/client/rest.ts

@@ -8,6 +8,33 @@ import { RequestedTask } from '../types';
 import * as puppeteer from 'puppeteer';
 import { LogLevel } from '../logger';
 
+export type PuppeteerPoolStartOptions = {
+  /**
+   * Number of concurrency
+   */
+  concurrencyLevel: number;
+  /**
+   * Context mode
+   */
+  contextMode: ContextMode;
+  /**
+   * Puppeteer launch options
+   */
+  options?: puppeteer.LaunchOptions;
+  /**
+   * Custom config path
+   */
+  customConfigPath?: string;
+  /**
+   * Enable log
+   */
+  enableLog?: boolean;
+  /**
+   * Log level
+   */
+  logLevel?: LogLevel;
+};
+
 export class PuppeteerPool {
   private static isInitialized = false;
   private static dispatcherInstance: TaskDispatcher;
@@ -31,24 +58,26 @@ export class PuppeteerPool {
   /**
    * Invoke this function to start a new Puppeteer Pool
    */
-  public static async start(
-    concurrencyLevel: number,
-    contextMode: ContextMode,
-    enableLog: boolean = true,
-    logLevel: LogLevel = LogLevel.DEBUG,
-    options?: puppeteer.LaunchOptions,
-    customConfigPath?: string,
-  ) {
+  public static async start(options: PuppeteerPoolStartOptions) {
+    const startOptions: PuppeteerPoolStartOptions = {
+      concurrencyLevel: 3,
+      contextMode: ContextMode.SHARED,
+      options: {},
+      enableLog: true,
+      logLevel: LogLevel.DEBUG,
+      ...options,
+    };
+
     if (!PuppeteerPool.isInitialized) {
       // Initialize Task Dispatcher
       PuppeteerPool.dispatcherInstance = new TaskDispatcher();
       await PuppeteerPool.dispatcherInstance.init(
-        concurrencyLevel,
-        contextMode,
-        enableLog,
-        logLevel,
-        options,
-        customConfigPath,
+        startOptions.concurrencyLevel,
+        startOptions.contextMode,
+        startOptions.enableLog,
+        startOptions.logLevel,
+        startOptions.options,
+        startOptions.customConfigPath,
       );
       // Initialize REST Client Instance
       PuppeteerPool.instance = new PuppeteerPool();