X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=f0ef59327c6099bc3719be1d84b537b0496fdd22;hb=37b32d84b2a0d8f8addad8c5e6a306c7dd22d58d;hp=75a8d784f87d4cd18126d2f81ce9ba54fae65323;hpb=fd13902fd959335e2c0f95d1b464317a2da8b6cf;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index 75a8d784..f0ef5932 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -88,20 +88,71 @@ export abstract class AbstractWorker< protected opts: WorkerOptions = DEFAULT_WORKER_OPTIONS ) { super(type) - this.checkWorkerOptions(this.opts) + if (this.isMain == null) { + throw new Error('isMain parameter is mandatory') + } this.checkTaskFunctions(taskFunctions) + this.checkWorkerOptions(this.opts) if (!this.isMain) { - this.getMainWorker()?.on('message', this.handleReadyMessage.bind(this)) + this.getMainWorker().on('message', this.handleReadyMessage.bind(this)) } } private checkWorkerOptions (opts: WorkerOptions): void { + if (opts != null && !isPlainObject(opts)) { + throw new TypeError('opts worker options parameter is not a plain object') + } + if ( + opts?.killBehavior != null && + !Object.values(KillBehaviors).includes(opts.killBehavior) + ) { + throw new TypeError( + `killBehavior option '${opts.killBehavior}' is not valid` + ) + } + if ( + opts?.maxInactiveTime != null && + !Number.isSafeInteger(opts.maxInactiveTime) + ) { + throw new TypeError('maxInactiveTime option is not an integer') + } + if (opts?.maxInactiveTime != null && opts.maxInactiveTime < 5) { + throw new TypeError( + 'maxInactiveTime option is not a positive integer greater or equal than 5' + ) + } + if (opts?.killHandler != null && typeof opts.killHandler !== 'function') { + throw new TypeError('killHandler option is not a function') + } + if (opts?.async != null) { + throw new Error('async option is deprecated') + } this.opts = { ...DEFAULT_WORKER_OPTIONS, ...opts } - delete this.opts.async + } + + private checkValidTaskFunctionEntry ( + name: string, + fn: TaskFunction + ): void { + if (typeof name !== 'string') { + throw new TypeError( + 'A taskFunctions parameter object key is not a string' + ) + } + if (typeof name === 'string' && name.trim().length === 0) { + throw new TypeError( + 'A taskFunctions parameter object key is an empty string' + ) + } + if (typeof fn !== 'function') { + throw new TypeError( + 'A taskFunctions parameter object value is not a function' + ) + } } /** - * Checks if the `taskFunctions` parameter is passed to the constructor. + * Checks if the `taskFunctions` parameter is passed to the constructor and valid. * * @param taskFunctions - The task function(s) parameter that should be checked. */ @@ -125,21 +176,7 @@ export abstract class AbstractWorker< } else if (isPlainObject(taskFunctions)) { let firstEntry = true for (const [name, fn] of Object.entries(taskFunctions)) { - if (typeof name !== 'string') { - throw new TypeError( - 'A taskFunctions parameter object key is not a string' - ) - } - if (typeof name === 'string' && name.trim().length === 0) { - throw new TypeError( - 'A taskFunctions parameter object key an empty string' - ) - } - if (typeof fn !== 'function') { - throw new TypeError( - 'A taskFunctions parameter object value is not a function' - ) - } + this.checkValidTaskFunctionEntry(name, fn) const boundFn = fn.bind(this) if (firstEntry) { this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn) @@ -258,7 +295,7 @@ export abstract class AbstractWorker< names[names.indexOf(DEFAULT_TASK_NAME)], defaultTaskFunctionName, ...names.filter( - (name) => name !== DEFAULT_TASK_NAME && name !== defaultTaskFunctionName + name => name !== DEFAULT_TASK_NAME && name !== defaultTaskFunctionName ) ] } @@ -419,6 +456,7 @@ export abstract class AbstractWorker< * Returns the main worker. * * @returns Reference to the main worker. + * @throws {@link https://nodejs.org/api/errors.html#class-error} If the main worker is not set. */ protected getMainWorker (): MainWorker { if (this.mainWorker == null) { @@ -449,11 +487,11 @@ export abstract class AbstractWorker< /** * Handles an error and convert it to a string so it can be sent back to the main worker. * - * @param e - The error raised by the worker. + * @param error - The error raised by the worker. * @returns The error message. */ - protected handleError (e: Error | string): string { - return e instanceof Error ? e.message : e + protected handleError (error: Error | string): string { + return error instanceof Error ? error.message : error } /** @@ -463,7 +501,20 @@ export abstract class AbstractWorker< * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found. */ protected run (task: Task): void { - const fn = this.getTaskFunction(task.name) + const { name, taskId, data } = task + const fn = this.taskFunctions.get(name ?? DEFAULT_TASK_NAME) + if (fn == null) { + this.sendToMainWorker({ + taskError: { + name: name as string, + message: `Task function '${name as string}' not found`, + data + }, + workerId: this.id, + taskId + }) + return + } if (isAsyncFunction(fn)) { this.runInAsyncScope(this.runAsync.bind(this), this, fn, task) } else { @@ -492,12 +543,11 @@ export abstract class AbstractWorker< workerId: this.id, taskId }) - } catch (e) { - const errorMessage = this.handleError(e as Error | string) + } catch (error) { this.sendToMainWorker({ taskError: { - name: name ?? DEFAULT_TASK_NAME, - message: errorMessage, + name: name as string, + message: this.handleError(error as Error | string), data }, workerId: this.id, @@ -521,7 +571,7 @@ export abstract class AbstractWorker< const { name, taskId, data } = task let taskPerformance = this.beginTaskPerformance(name) fn(data) - .then((res) => { + .then(res => { taskPerformance = this.endTaskPerformance(taskPerformance) this.sendToMainWorker({ data: res, @@ -531,12 +581,11 @@ export abstract class AbstractWorker< }) return null }) - .catch((e) => { - const errorMessage = this.handleError(e as Error | string) + .catch(error => { this.sendToMainWorker({ taskError: { - name: name ?? DEFAULT_TASK_NAME, - message: errorMessage, + name: name as string, + message: this.handleError(error as Error | string), data }, workerId: this.id, @@ -549,22 +598,6 @@ export abstract class AbstractWorker< .catch(EMPTY_FUNCTION) } - /** - * Gets the task function with the given name. - * - * @param name - Name of the task function that will be returned. - * @returns The task function. - * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found. - */ - private getTaskFunction (name?: string): TaskFunction { - name = name ?? DEFAULT_TASK_NAME - const fn = this.taskFunctions.get(name) - if (fn == null) { - throw new Error(`Task function '${name}' not found`) - } - return fn - } - private beginTaskPerformance (name?: string): TaskPerformance { this.checkStatistics() return {