-
Notifications
You must be signed in to change notification settings - Fork 6
/
internalApi.ts
561 lines (501 loc) · 16.7 KB
/
internalApi.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
import { ThreadedClassConfig } from './api'
import { ChildInstance } from './manager'
import { isBrowser } from './lib'
export const DEFAULT_CHILD_FREEZE_TIME = 1000 // how long to wait before considering a child to be unresponsive
export type InitProps = Array<InitProp>
export enum InitPropType {
FUNCTION = 'function',
VALUE = 'value'
}
export interface InitPropDescriptor {
/** If the property is a part of the prototype (and how many levels deep) */
inProto: number
// configurable: boolean
enumerable: boolean
/** If the property has a getter */
get: boolean
/** If the property has a setter */
set: boolean
/** If the property is writable */
writable: boolean
/** If the property is readable */
readable: boolean
}
export interface InitProp {
type: InitPropType
key: string
descriptor: InitPropDescriptor
}
export enum MessageType {
INIT = 'init',
PING = 'ping',
FUNCTION = 'fcn',
REPLY = 'reply',
LOG = 'log',
SET = 'set',
KILL = 'kill',
CALLBACK = 'callback'
}
export interface MessageSent {
instanceId: string
cmdId: number
}
export interface MessageInitConstr {
cmd: MessageType.INIT
modulePath: string
className: string
classFunction?: Function // only used in single-thread mode
args: Array<ArgDefinition>
config: ThreadedClassConfig
}
export type MessageInit = MessageInitConstr & MessageSent
export interface MessagePingConstr {
cmd: MessageType.PING
}
export type MessagePing = MessagePingConstr & MessageSent
export interface MessageFcnConstr {
cmd: MessageType.FUNCTION
fcn: string
args: Array<ArgDefinition>
}
export type MessageFcn = MessageFcnConstr & MessageSent
export interface MessageSetConstr {
cmd: MessageType.SET
property: string
value: ArgDefinition
}
export type MessageSet = MessageSetConstr & MessageSent
export interface MessageReplyConstr {
cmd: MessageType.REPLY
replyTo: number
reply?: any
error?: Error | string
}
export type MessageReply = MessageReplyConstr & MessageSent
export interface MessageKillConstr {
cmd: MessageType.KILL
}
export type MessageKill = MessageKillConstr & MessageSent
export interface MessageCallbackConstr {
cmd: MessageType.CALLBACK
callbackId: string
args: Array<any>
}
export type MessageCallback = MessageCallbackConstr & MessageSent
export type MessageToChildConstr = MessageInitConstr | MessageFcnConstr | MessageReplyConstr | MessageSetConstr | MessageKillConstr | MessageCallbackConstr | MessagePingConstr
export type MessageToChild = MessageInit | MessageFcn | MessageReply | MessageSet | MessageKill | MessageCallback | MessagePing
export type MessageFromChildReplyConstr = MessageReplyConstr
export type MessageFromChildReply = MessageFromChildReplyConstr & MessageSent
export interface MessageFromChildLogConstr {
cmd: MessageType.LOG
log: Array<any>
}
export type MessageFromChildLog = MessageFromChildLogConstr & MessageSent
export type MessageFromChildCallbackConstr = MessageCallbackConstr
export type MessageFromChildCallback = MessageCallback
export type MessageFromChildConstr = MessageFromChildReplyConstr | MessageFromChildLogConstr | MessageFromChildCallbackConstr
export type MessageFromChild = MessageFromChildReply | MessageFromChildLog | MessageFromChildCallback
export type InstanceCallbackFunction = (instance: ChildInstance, e: Error | string | null, encodedResult?: ArgDefinition) => void
export type InstanceCallbackInitFunction = (instance: ChildInstance, e: Error | string | null, initProps?: InitProps) => boolean
export type CallbackFunction = (e: Error | string | null, res?: ArgDefinition) => void
export interface ArgDefinition {
type: ArgumentType
original?: any
value: any
}
export enum ArgumentType {
STRING = 'string',
NUMBER = 'number',
UNDEFINED = 'undefined',
NULL = 'null',
OBJECT = 'object',
FUNCTION = 'function',
BUFFER = 'buffer',
OTHER = 'other'
}
export interface InstanceHandle {
id: string
cmdId: number
queue: {[cmdId: string]: CallbackFunction}
instance: any
}
export abstract class Worker {
protected instanceHandles: {[instanceId: string]: InstanceHandle} = {}
private callbacks: {[key: string]: Function} = {}
protected disabledMultithreading: boolean = false
private _pingCount: number = 0
private _config?: ThreadedClassConfig
protected abstract killInstance (handle: InstanceHandle): void
protected decodeArgumentsFromParent (handle: InstanceHandle, args: Array<ArgDefinition>) {
// Note: handle.instance could change if this was called for the constructor parameters, so it needs to be loose
return decodeArguments(() => handle.instance, args, (a: ArgDefinition) => {
return ((...args: any[]) => {
return new Promise((resolve, reject) => {
const callbackId = a.value
this.sendCallback(
handle,
callbackId,
args,
(err, encodedResult) => {
if (err) {
reject(err)
} else {
const result = encodedResult ? this.decodeArgumentsFromParent(handle, [encodedResult]) : [encodedResult]
resolve(result[0])
}
}
)
})
})
})
}
protected encodeArgumentsToParent (instance: any, args: any[]): ArgDefinition[] {
return encodeArguments(instance, this.callbacks, args, this.disabledMultithreading)
}
protected reply (handle: InstanceHandle, m: MessageToChild, reply: any) {
this.sendReplyToParent(handle, m.cmdId, undefined, reply)
}
protected replyError (handle: InstanceHandle, m: MessageToChild, error: any) {
this.sendReplyToParent(handle, m.cmdId, error)
}
protected sendReplyToParent (handle: InstanceHandle, replyTo: number, error?: Error, reply?: any) {
let msg: MessageFromChildReplyConstr = {
cmd: MessageType.REPLY,
replyTo: replyTo,
error: error ? (error.stack || error).toString() : error,
reply: reply
}
this.sendMessageToParent(handle, msg)
}
protected sendLog (log: any[]) {
let msg: MessageFromChildLogConstr = {
cmd: MessageType.LOG,
log: log
}
this.sendMessageToParent(null, msg)
}
protected sendCallback (handle: InstanceHandle, callbackId: string, args: any[], cb: CallbackFunction) {
let msg: MessageFromChildCallbackConstr = {
cmd: MessageType.CALLBACK,
callbackId: callbackId,
args: args
}
this.sendMessageToParent(handle, msg, cb)
}
protected getAllProperties (obj: Object) {
let props: Array<string> = []
do {
props = props.concat(Object.getOwnPropertyNames(obj))
obj = Object.getPrototypeOf(obj)
} while (obj)
return props
}
log = (...data: any[]) => {
this.sendLog(data)
}
logError = (...data: any[]) => {
this.sendLog(['Error', ...data])
}
protected abstract sendMessageToParent (handle: InstanceHandle | null, msg: MessageFromChildConstr, cb?: CallbackFunction): void
public onMessageFromParent (m: MessageToChild) {
// A message was received from Parent
let handle = this.instanceHandles[m.instanceId]
if (!handle && m.cmd !== MessageType.INIT) {
console.log(`Child process: Unknown instanceId: "${m.instanceId}"`)
return // fail silently?
}
if (!handle) {
// create temporary handle:
handle = {
id: m.instanceId,
cmdId: 0,
queue: {},
instance: {}
}
}
try {
const instance = handle.instance
if (m.cmd === MessageType.INIT) {
const msg: MessageInit = m
this._config = m.config
let pModuleClass: Promise<any>
// Load in the class:
if (isBrowser()) {
pModuleClass = new Promise((resolve, reject) => {
// @ts-ignore
let oReq = new XMLHttpRequest()
oReq.open('GET', msg.modulePath, true)
// oReq.responseType = 'blob'
oReq.onload = () => {
if (oReq.response) {
resolve(oReq.response)
} else {
reject(Error(`Bad reply from ${msg.modulePath} in instance ${handle.id}`))
}
}
oReq.send()
})
.then((bodyString: string) => {
// This is a terrible hack, I'm ashamed of myself.
// Better solutions are very much appreciated.
// tslint:disable-next-line:no-var-keyword
var f: any = null
let fcn: string = `
f = function() {
${bodyString}
;
return ${msg.className}
}
`
// tslint:disable-next-line:no-eval
let moduleClass = eval(fcn)()
f = f
if (!moduleClass) {
throw Error(`${msg.className} not found in ${msg.modulePath}`)
}
return moduleClass
})
} else {
pModuleClass = Promise.resolve(require(msg.modulePath))
.then((module) => {
return module[msg.className]
})
}
pModuleClass
.then((moduleClass) => {
if (m.classFunction) {
// In single thread mode.
// When classFunction is provided, use that instead of the imported js file.
return m.classFunction
} else {
return moduleClass
}
})
.then((moduleClass) => {
const handle: InstanceHandle = {
id: msg.instanceId,
cmdId: 0,
queue: {},
instance: null // Note: This is dangerous, but gets set right after.
}
const decodedArgs = this.decodeArgumentsFromParent(handle, msg.args)
handle.instance = ((...args: Array<any>) => {
return new moduleClass(...args)
}).apply(null, decodedArgs)
this.instanceHandles[handle.id] = handle
const instance = handle.instance
const allProps = this.getAllProperties(instance)
const props: InitProps = []
allProps.forEach((prop: string) => {
if ([
'constructor',
'__defineGetter__',
'__defineSetter__',
'hasOwnProperty',
'__lookupGetter__',
'__lookupSetter__',
'isPrototypeOf',
'propertyIsEnumerable',
'toString',
'valueOf',
'__proto__',
'toLocaleString'
].indexOf(prop) !== -1) return
let descriptor = Object.getOwnPropertyDescriptor(instance, prop)
let inProto: number = 0
let proto = instance.__proto__
while (!descriptor) {
if (!proto) break
descriptor = Object.getOwnPropertyDescriptor(proto, prop)
inProto++
proto = proto.__proto__
}
if (!descriptor) descriptor = {}
let descr: InitPropDescriptor = {
// configurable: !!descriptor.configurable,
inProto: inProto,
enumerable: !!descriptor.enumerable,
writable: !!descriptor.writable,
get: !!descriptor.get,
set: !!descriptor.set,
readable: !!(!descriptor.get && !descriptor.get) // if no getter or setter, ie an ordinary property
}
if (typeof instance[prop] === 'function') {
props.push({
key: prop,
type: InitPropType.FUNCTION,
descriptor: descr
})
} else {
props.push({
key: prop,
type: InitPropType.VALUE,
descriptor: descr
})
}
})
this.reply(handle, msg, props)
})
.catch((e: any) => {
console.log('INIT error', e)
})
if (!m.config.disableMultithreading) {
this.startOrphanMonitoring()
}
} else if (m.cmd === MessageType.PING) {
this._pingCount++
this.reply(handle, m, null)
} else if (m.cmd === MessageType.REPLY) {
const msg: MessageReply = m
let cb = handle.queue[msg.replyTo + '']
if (!cb) throw Error(`cmdId "${msg.cmdId}" not found in instance ${m.instanceId}!`)
if (msg.error) {
cb(msg.error)
} else {
cb(null, msg.reply)
}
delete handle.queue[msg.replyTo + '']
} else if (m.cmd === MessageType.FUNCTION) {
// A function has been called by parent
let msg: MessageFcn = m
const fixedArgs = this.decodeArgumentsFromParent(handle, msg.args)
let p = (
typeof instance[msg.fcn] === 'function' ?
instance[msg.fcn](...fixedArgs) :
instance[msg.fcn]
) // in case instance[msg.fcn] does not exist, it will simply resolve to undefined on the consumer side
Promise.resolve(p)
.then((result) => {
const encodedResult = this.encodeArgumentsToParent(instance, [result])
this.reply(handle, msg, encodedResult[0])
})
.catch((err) => {
let errorResponse: string = (err.stack || err.toString()) + `\n executing function "${msg.fcn}" of instance "${m.instanceId}"`
this.replyError(handle, msg, errorResponse)
})
} else if (m.cmd === MessageType.SET) {
let msg: MessageSet = m
const fixedValue = this.decodeArgumentsFromParent(handle, [msg.value])[0]
instance[msg.property] = fixedValue
this.reply(handle, msg, fixedValue)
} else if (m.cmd === MessageType.KILL) {
let msg: MessageKill = m
// kill off instance
this.killInstance(handle)
this.reply(handle, msg, null)
} else if (m.cmd === MessageType.CALLBACK) {
let msg: MessageCallback = m
let callback = this.callbacks[msg.callbackId]
if (callback) {
try {
Promise.resolve(callback(...msg.args))
.then((result: any) => {
const encodedResult = this.encodeArgumentsToParent(instance, [result])
this.reply(handle, msg, encodedResult[0])
})
.catch((err: Error) => {
let errorResponse: string = (err.stack || err.toString()) + `\n executing callback of instance "${m.instanceId}"`
this.replyError(handle, msg, errorResponse)
})
} catch (err) {
let errorResponse: string = (err.stack || err.toString()) + `\n executing (outer) callback of instance "${m.instanceId}"`
this.replyError(handle, msg, errorResponse)
}
} else {
this.replyError(handle, msg, `Callback "${msg.callbackId}" not found on instance "${m.instanceId}"`)
}
}
} catch (e) {
if (m.cmdId) {
this.replyError(handle, m, `Error: ${e.toString()} ${e.stack} on instance "${m.instanceId}"`)
} else this.log('Error: ' + e.toString(), e.stack)
}
}
private startOrphanMonitoring () {
// expect our parent process to PING us now every and then
// otherwise we consider ourselves to be orphaned
// then we should exit the process
if (this._config) {
const pingTime: number = Math.max(
500,
this._config.freezeLimit || DEFAULT_CHILD_FREEZE_TIME
)
let missed: number = 0
let previousPingCount: number = 0
setInterval(() => {
if (this._pingCount === previousPingCount) {
// no ping has been received since last time
missed++
} else {
missed = 0
}
previousPingCount = this._pingCount
if (missed > 2) {
// We've missed too many pings
console.log(`Child missed ${missed} pings, exiting process!`)
setTimeout(() => {
process.exit(27)
}, 100)
}
}, pingTime)
}
}
}
let argumentsCallbackId: number = 0
export function encodeArguments (instance: any, callbacks: {[key: string]: Function}, args: any[], disabledMultithreading: boolean): ArgDefinition[] {
try {
return args.map((arg, i): ArgDefinition => {
try {
if (typeof arg === 'object' && arg === instance) {
return { type: ArgumentType.OBJECT, value: 'self' }
}
if (disabledMultithreading) {
// In single-threaded mode, we can send the arguments directly, without any conversion:
if (arg instanceof Buffer) return { type: ArgumentType.BUFFER, original: arg, value: null }
if (typeof arg === 'object') return { type: ArgumentType.OBJECT, original: arg, value: null }
}
if (arg instanceof Buffer) return { type: ArgumentType.BUFFER, value: arg.toString('hex') }
if (typeof arg === 'string') return { type: ArgumentType.STRING, value: arg }
if (typeof arg === 'number') return { type: ArgumentType.NUMBER, value: arg }
if (typeof arg === 'function') {
const callbackId = argumentsCallbackId++
callbacks[callbackId + ''] = arg
return { type: ArgumentType.FUNCTION, value: callbackId + '' }
}
if (arg === undefined) return { type: ArgumentType.UNDEFINED, value: arg }
if (arg === null) return { type: ArgumentType.NULL, value: arg }
if (typeof arg === 'object') return { type: ArgumentType.OBJECT, value: arg }
return { type: ArgumentType.OTHER, value: arg }
} catch (e) {
if (e.stack) e.stack += '\nIn encodeArguments, argument ' + i
throw e
}
})
} catch (e) {
if (e.stack) e.stack += '\nThreadedClass, unsupported attribute'
throw e
}
}
export type ArgCallback = (...args: any[]) => Promise<any>
export function decodeArguments (instance: () => any, args: Array<ArgDefinition>, getCallback: (arg: ArgDefinition) => ArgCallback): Array<any | ArgCallback> {
// Go through arguments and de-serialize them
return args.map((a) => {
if (a.original !== undefined) return a.original
if (a.type === ArgumentType.STRING) return a.value
if (a.type === ArgumentType.NUMBER) return a.value
if (a.type === ArgumentType.BUFFER) return Buffer.from(a.value, 'hex')
if (a.type === ArgumentType.UNDEFINED) return a.value
if (a.type === ArgumentType.NULL) return a.value
if (a.type === ArgumentType.FUNCTION) {
return getCallback(a)
}
if (a.type === ArgumentType.OBJECT) {
if (a.value === 'self') {
return instance()
} else {
return a.value
}
}
return a.value
})
}