From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Sat, 19 Aug 2023 10:27:55 +0000 (+0200)
Subject: refactor: factor out worker public API input sanity checks
X-Git-Tag: v2.6.30~2
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=d5e3c4fff00e3ef76442041c6e0a6d01a2b24650;p=poolifier.git

refactor: factor out worker public API input sanity checks

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
---

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 292bba15..3a5cac15 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -214,7 +214,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add safe helper `availableParallelism` to help sizing the pool.
+- Add safe helper `availableParallelism()` to help sizing the pool.
 
 ### Fixed
 
@@ -229,7 +229,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 
 - Artificial version bump to 2.6.5 to workaround publication issue.
-- Ensure cluster pool destroy() gracefully shutdowns worker's server.
+- Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
 - Ensure pool event is emitted before task error promise rejection.
 - Fix queued tasks count computation.
 
@@ -245,7 +245,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- Ensure cluster pool destroy() gracefully shutdowns worker's server.
+- Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
 - Ensure pool event is emitted before task error promise rejection.
 - Fix queued tasks count computation.
 
diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts
index f42fae17..75a8d784 100644
--- a/src/worker/abstract-worker.ts
+++ b/src/worker/abstract-worker.ts
@@ -165,12 +165,7 @@ export abstract class AbstractWorker<
    * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
    */
   public hasTaskFunction (name: string): boolean {
-    if (typeof name !== 'string') {
-      throw new TypeError('name parameter is not a string')
-    }
-    if (typeof name === 'string' && name.trim().length === 0) {
-      throw new TypeError('name parameter is an empty string')
-    }
+    this.checkTaskFunctionName(name)
     return this.taskFunctions.has(name)
   }
 
@@ -189,12 +184,7 @@ export abstract class AbstractWorker<
     name: string,
     fn: TaskFunction<Data, Response>
   ): boolean {
-    if (typeof name !== 'string') {
-      throw new TypeError('name parameter is not a string')
-    }
-    if (typeof name === 'string' && name.trim().length === 0) {
-      throw new TypeError('name parameter is an empty string')
-    }
+    this.checkTaskFunctionName(name)
     if (name === DEFAULT_TASK_NAME) {
       throw new Error(
         'Cannot add a task function with the default reserved name'
@@ -229,12 +219,7 @@ export abstract class AbstractWorker<
    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the task function used as default task function.
    */
   public removeTaskFunction (name: string): boolean {
-    if (typeof name !== 'string') {
-      throw new TypeError('name parameter is not a string')
-    }
-    if (typeof name === 'string' && name.trim().length === 0) {
-      throw new TypeError('name parameter is an empty string')
-    }
+    this.checkTaskFunctionName(name)
     if (name === DEFAULT_TASK_NAME) {
       throw new Error(
         'Cannot remove the task function with the default reserved name'
@@ -288,12 +273,7 @@ export abstract class AbstractWorker<
    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is a non-existing task function.
    */
   public setDefaultTaskFunction (name: string): boolean {
-    if (typeof name !== 'string') {
-      throw new TypeError('name parameter is not a string')
-    }
-    if (typeof name === 'string' && name.trim().length === 0) {
-      throw new TypeError('name parameter is an empty string')
-    }
+    this.checkTaskFunctionName(name)
     if (name === DEFAULT_TASK_NAME) {
       throw new Error(
         'Cannot set the default task function reserved name as the default task function'
@@ -315,6 +295,15 @@ export abstract class AbstractWorker<
     }
   }
 
+  private checkTaskFunctionName (name: string): void {
+    if (typeof name !== 'string') {
+      throw new TypeError('name parameter is not a string')
+    }
+    if (typeof name === 'string' && name.trim().length === 0) {
+      throw new TypeError('name parameter is an empty string')
+    }
+  }
+
   /**
    * Handles the ready message sent by the main worker.
    *