repositories
/
poolifier.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
docs: refine code documentation
[poolifier.git]
/
src
/
worker
/
abstract-worker.ts
diff --git
a/src/worker/abstract-worker.ts
b/src/worker/abstract-worker.ts
index a84bb0691fc588d3a8e51b0fe1696d7c85bb7dc9..2a027269f990375f2a1556372a463e5b9f726655 100644
(file)
--- a/
src/worker/abstract-worker.ts
+++ b/
src/worker/abstract-worker.ts
@@
-28,8
+28,8
@@
const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
* Base class that implements some shared logic for all poolifier workers.
*
* @typeParam MainWorker - Type of main worker.
* Base class that implements some shared logic for all poolifier workers.
*
* @typeParam MainWorker - Type of main worker.
- * @typeParam Data - Type of data this worker receives from pool's execution. This can only be s
erializ
able data.
- * @typeParam Response - Type of response the worker sends back to the main worker. This can only be s
erializ
able data.
+ * @typeParam Data - Type of data this worker receives from pool's execution. This can only be s
tructured-clone
able data.
+ * @typeParam Response - Type of response the worker sends back to the main worker. This can only be s
tructured-clone
able data.
*/
export abstract class AbstractWorker<
MainWorker extends Worker | MessagePort,
*/
export abstract class AbstractWorker<
MainWorker extends Worker | MessagePort,
@@
-45,7
+45,7
@@
export abstract class AbstractWorker<
*/
protected lastTaskTimestamp!: number
/**
*/
protected lastTaskTimestamp!: number
/**
- * Performance statistics computation.
+ * Performance statistics computation
requirements
.
*/
protected statistics!: WorkerStatistics
/**
*/
protected statistics!: WorkerStatistics
/**
@@
-67,7
+67,7
@@
export abstract class AbstractWorker<
taskFunctions:
| WorkerFunction<Data, Response>
| TaskFunctions<Data, Response>,
taskFunctions:
| WorkerFunction<Data, Response>
| TaskFunctions<Data, Response>,
- protected
mainWorker: MainWorker | undefined | null
,
+ protected
readonly mainWorker: MainWorker
,
protected readonly opts: WorkerOptions = {
/**
* The kill behavior option on this worker or its default value.
protected readonly opts: WorkerOptions = {
/**
* The kill behavior option on this worker or its default value.
@@
-90,8
+90,8
@@
export abstract class AbstractWorker<
(this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
)
this.checkAlive.bind(this)()
(this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
)
this.checkAlive.bind(this)()
+ this.mainWorker?.on('message', this.messageListener.bind(this))
}
}
- this.mainWorker?.on('message', this.messageListener.bind(this))
}
private checkWorkerOptions (opts: WorkerOptions): void {
}
private checkWorkerOptions (opts: WorkerOptions): void {
@@
-146,9
+146,7
@@
export abstract class AbstractWorker<
*
* @param message - Message received.
*/
*
* @param message - Message received.
*/
- protected messageListener (
- message: MessageValue<Data, Data, MainWorker>
- ): void {
+ protected messageListener (message: MessageValue<Data, Data>): void {
if (message.id != null && message.data != null) {
// Task message received
const fn = this.getTaskFunction(message.name)
if (message.id != null && message.data != null) {
// Task message received
const fn = this.getTaskFunction(message.name)
@@
-157,16
+155,13
@@
export abstract class AbstractWorker<
} else {
this.runInAsyncScope(this.runSync.bind(this), this, fn, message)
}
} else {
this.runInAsyncScope(this.runSync.bind(this), this, fn, message)
}
- } else if (message.
parent
!= null) {
- //
Main worker reference
message received
- this.
mainWorker = message.parent
+ } else if (message.
statistics
!= null) {
+ //
Statistics
message received
+ this.
statistics = message.statistics
} else if (message.kill != null) {
// Kill message received
this.aliveInterval != null && clearInterval(this.aliveInterval)
this.emitDestroy()
} else if (message.kill != null) {
// Kill message received
this.aliveInterval != null && clearInterval(this.aliveInterval)
this.emitDestroy()
- } else if (message.statistics != null) {
- // Statistics message received
- this.statistics = message.statistics
}
}
}
}
@@
-177,7
+172,7
@@
export abstract class AbstractWorker<
*/
protected getMainWorker (): MainWorker {
if (this.mainWorker == null) {
*/
protected getMainWorker (): MainWorker {
if (this.mainWorker == null) {
- throw new Error('Main worker
was
not set')
+ throw new Error('Main worker not set')
}
return this.mainWorker
}
}
return this.mainWorker
}
@@
-207,7
+202,7
@@
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.
* 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.
- * @returns
Message of the error
.
+ * @returns
The error message
.
*/
protected handleError (e: Error | string): string {
return e as string
*/
protected handleError (e: Error | string): string {
return e as string
@@
-298,6
+293,7
@@
export abstract class AbstractWorker<
}
private beginTaskPerformance (): TaskPerformance {
}
private beginTaskPerformance (): TaskPerformance {
+ this.checkStatistics()
return {
timestamp: performance.now(),
...(this.statistics.elu && { elu: performance.eventLoopUtilization() })
return {
timestamp: performance.now(),
...(this.statistics.elu && { elu: performance.eventLoopUtilization() })
@@
-307,6
+303,7
@@
export abstract class AbstractWorker<
private endTaskPerformance (
taskPerformance: TaskPerformance
): TaskPerformance {
private endTaskPerformance (
taskPerformance: TaskPerformance
): TaskPerformance {
+ this.checkStatistics()
return {
...taskPerformance,
...(this.statistics.runTime && {
return {
...taskPerformance,
...(this.statistics.runTime && {
@@
-317,4
+314,10
@@
export abstract class AbstractWorker<
})
}
}
})
}
}
+
+ private checkStatistics (): void {
+ if (this.statistics == null) {
+ throw new Error('Performance statistics computation requirements not set')
+ }
+ }
}
}