refactor: cleanup .gitignore
[poolifier.git] / src / worker / thread-worker.ts
CommitLineData
f59e1027
JB
1import {
2 type MessagePort,
3 isMainThread,
4 parentPort,
5 threadId
6} from 'node:worker_threads'
b6b32453 7import type { MessageValue } from '../utility-types'
c97c7edb 8import { AbstractWorker } from './abstract-worker'
325f50bc 9import type { WorkerOptions } from './worker-options'
82ea6492 10import type { TaskFunction, TaskFunctions } from './task-functions'
a32e02ba 11
a32e02ba 12/**
729c563d 13 * A thread worker used by a poolifier `ThreadPool`.
4ade5f1f 14 *
729c563d
S
15 * When this worker is inactive for more than the given `maxInactiveTime`,
16 * it will send a termination request to its main thread.
17 *
18 * If you use a `DynamicThreadPool` the extra workers that were created will be terminated,
19 * but the minimum number of workers will be guaranteed.
20 *
e102732c
JB
21 * @typeParam Data - Type of data this worker receives from pool's execution. This can only be structured-cloneable data.
22 * @typeParam Response - Type of response the worker sends back to the main thread. This can only be structured-cloneable data.
4ade5f1f 23 * @author [Alessandro Pio Ardizio](https://github.com/pioardi)
a32e02ba 24 * @since 0.0.1
25 */
d3c8a1a8 26export class ThreadWorker<
deb85c12
JB
27 Data = unknown,
28 Response = unknown
d3c8a1a8 29> extends AbstractWorker<MessagePort, Data, Response> {
85aeb3f3 30 /**
2761efb4 31 * Message port used to communicate with the main worker.
85aeb3f3
JB
32 */
33 private port!: MessagePort
729c563d
S
34 /**
35 * Constructs a new poolifier thread worker.
36 *
82888165 37 * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked.
38e795c1 38 * @param opts - Options for the worker.
729c563d 39 */
d4aeae5a 40 public constructor (
82ea6492 41 taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>,
d4aeae5a
JB
42 opts: WorkerOptions = {}
43 ) {
82888165 44 super(
b5604034 45 'poolifier:thread-worker',
82888165 46 isMainThread,
e102732c 47 parentPort as MessagePort,
85aeb3f3 48 taskFunctions,
82888165
JB
49 opts
50 )
f59e1027
JB
51 }
52
85aeb3f3
JB
53 /** @inheritDoc */
54 protected handleReadyMessage (message: MessageValue<Data>): void {
55 if (
56 message.workerId === this.id &&
f05ed93c 57 message.ready === false &&
85aeb3f3
JB
58 message.port != null
59 ) {
f05ed93c
JB
60 try {
61 this.port = message.port
62 this.port.on('message', this.messageListener.bind(this))
a5d15204
JB
63 this.sendToMainWorker({
64 ready: true,
895b5341 65 taskFunctionNames: this.listTaskFunctionNames()
a5d15204 66 })
f05ed93c 67 } catch {
a5d15204
JB
68 this.sendToMainWorker({
69 ready: false,
895b5341 70 taskFunctionNames: this.listTaskFunctionNames()
a5d15204 71 })
f05ed93c 72 }
85aeb3f3
JB
73 }
74 }
75
984dc9c8 76 /** @inheritDoc */
d655027b 77 protected handleKillMessage (message: MessageValue<Data>): void {
984dc9c8
JB
78 super.handleKillMessage(message)
79 this.port?.unref()
80 this.port?.close()
81 }
82
85aeb3f3 83 /** @inheritDoc */
f59e1027
JB
84 protected get id (): number {
85 return threadId
106744f7 86 }
7784f548 87
afc003b2 88 /** @inheritDoc */
c97c7edb 89 protected sendToMainWorker (message: MessageValue<Response>): void {
895b5341 90 this.port.postMessage({ ...message, workerId: this.id })
7784f548 91 }
985d0e79
JB
92
93 /** @inheritDoc */
646bced2
JB
94 protected handleError (error: Error | string): string {
95 return error as string
985d0e79 96 }
a32e02ba 97}