-
Notifications
You must be signed in to change notification settings - Fork 386
/
job.js
1974 lines (1687 loc) · 65.4 KB
/
job.js
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
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Cronicle Server Job Manager
// Copyright (c) 2015 Joseph Huckaby
// Released under the MIT License
var async = require('async');
var cp = require('child_process');
var fs = require('fs');
var os = require('os');
var path = require('path');
var sqparse = require('shell-quote').parse;
var zlib = require('zlib');
var Class = require("pixl-class");
var Tools = require("pixl-tools");
var JSONStream = require("pixl-json-stream");
var PixlMail = require('pixl-mail');
module.exports = Class.create({
launchOrQueueJob: function(event, callback) {
// launch job, or queue upon failure (if event desires)
var self = this;
// must be master to do this
if (!this.multi.master) return callback( new Error("Only a master server can launch jobs.") );
this.launchJob(event, function(err, jobs) {
if (err && event.queue) {
// event supports queuing
var queue_max = event.queue_max || 0;
if (!self.eventQueue[event.id]) self.eventQueue[event.id] = 0;
if (!queue_max || (self.eventQueue[event.id] < queue_max)) {
// queue has room for one more
self.eventQueue[event.id]++;
self.authSocketEmit( 'update', { eventQueue: self.eventQueue } );
// special 0-job response denotes an enqueue occurred
err = null;
jobs = [];
// add now time if not already set
if (!event.now) event.now = Tools.timeNow(true);
// add job to actual queue in storage, async
self.storage.listPush( 'global/event_queue/' + event.id, event, function(err) {
if (err) {
self.logError('queue', "Failed to push job onto event queue: " + err);
}
} );
}
else {
// queue is full, change error message
err = new Error( "Job could not be queued: Event queue reached max of " + queue_max + " items" );
}
}
callback(err, jobs);
});
},
launchJob: function(event, callback) {
// locate suitable server and launch job
var self = this;
var orig_event = null;
var server_group = null;
var plugin = null;
var category = null;
var servers = [];
// must be master to do this
if (!this.multi.master) return callback( new Error("Only a master server can launch jobs.") );
async.series([
function(callback) {
// event target may refer to server group OR hostname
var slave = self.slaves[ event.target ] || null;
if (slave && !slave.disabled) {
servers.push( slave );
return callback();
}
self.storage.listFind( 'global/server_groups', { id: event.target }, function(err, item) {
server_group = item;
callback(err);
} );
},
function(callback) {
self.storage.listFind( 'global/plugins', { id: event.plugin }, function(err, item) {
plugin = item;
callback(err);
} );
},
function(callback) {
self.storage.listFind( 'global/categories', { id: event.category }, function(err, item) {
category = item;
callback(err);
} );
},
function(callback) {
self.storage.listFind( 'global/schedule', { id: event.id }, function(err, item) {
orig_event = item;
callback(err);
} );
}
],
function(err) {
// all resources loaded
if (err) return callback(err);
if (!server_group && !servers.length) return callback( new Error("Server or Server Group not found: " + event.target) );
if (!plugin) return callback( new Error("Plugin not found: " + event.plugin) );
if (!category) return callback( new Error("Category not found: " + event.category) );
if (!orig_event) return callback( new Error("Event not found: " + event.id) );
var all_jobs = self.getAllActiveJobs(true); // include pending jobs
var job_list = Tools.hashValuesToArray( all_jobs );
// check running jobs vs. max children
if (orig_event.max_children) {
var event_jobs = Tools.findObjectsIdx( job_list, { 'event': event.id } );
if (event_jobs.length >= orig_event.max_children) {
// too many event children running
return callback( new Error("Maximum of "+orig_event.max_children+" "+Tools.pluralize("job", orig_event.max_children)+" already running for event: " + event.title) );
}
}
if (category.max_children) {
var cat_jobs = Tools.findObjectsIdx( job_list, { 'category': event.category } );
if (cat_jobs.length >= category.max_children) {
// too many category children running
return callback( new Error("Maximum of "+category.max_children+" "+Tools.pluralize("job", category.max_children)+" already running for category: " + category.title) );
}
}
var max_jobs = self.server.config.get('max_jobs') || 0;
if (max_jobs && (job_list.length >= max_jobs)) {
return callback( new Error("Global maximum of " + max_jobs + " " + Tools.pluralize("job", max_jobs) + " already running.") );
}
if (!category.enabled) {
return callback( new Error("Category '" + category.title + "' is disabled.") );
}
if (!plugin.enabled) {
return callback( new Error("Plugin '" + plugin.title + "' is disabled.") );
}
// automatically pick server if needed
if (!servers.length && server_group) {
var candidates = [];
var regex = new RegExp( server_group.regexp );
for (var hostname in self.slaves) {
var slave = self.slaves[hostname];
// only consider slaves that match the group hostname pattern, and are not disabled
if (hostname.match(regex) && !slave.disabled) {
candidates.push( self.slaves[hostname] );
}
}
if (!candidates.length) {
return callback( new Error("Could not find any servers for group: " + server_group.title) );
}
// sort the candidates by hostname ascending
candidates = candidates.sort( function(a, b) {
return a.hostname.localeCompare( b.hostname );
} );
if (event.multiplex) {
// run on ALL servers in group simultaneously (multiplex)
servers = candidates;
}
else {
// run on one server in group, chosen by custom algo
servers.push( self.chooseServer(candidates, event) );
}
} // find slave
if (!servers.length) {
// event was targetting server that is no longer with us
return callback( new Error("Target server is not available: " + event.target) );
}
var jobs = [];
// loop through each matched server, launching job on each
for (var idx = 0, len = servers.length; idx < len; idx++) {
var slave = servers[idx];
// construct job object based on event
var job = Tools.copyHash( event, true );
delete job.id;
delete job.title;
delete job.timing;
delete job.enabled;
delete job.max_children;
// delete job.target;
delete job.username;
delete job.api_key;
delete job.session_id;
delete job.modified;
delete job.created;
job.id = self.getUniqueID('j');
job.time_start = Tools.timeNow();
job.hostname = slave.hostname;
job.event = event.id;
job.params = event.params || {};
job.now = event.now || Tools.timeNow(true);
job.event_title = event.title;
job.plugin_title = plugin.title;
job.category_title = category.title;
job.nice_target = server_group ? server_group.title : event.target;
// pull in properties from plugin
job.command = plugin.command;
if (plugin.cwd) job.cwd = plugin.cwd;
if (plugin.uid) job.uid = plugin.uid;
if (plugin.gid) job.gid = plugin.gid;
if (plugin.env) job.env = plugin.env;
// plugin params may have changed outside of event,
// so recopy missing / hidden ones
if (plugin.params) plugin.params.forEach( function(param) {
if (!(param.id in job.params) || (param.type == 'hidden')) {
job.params[ param.id ] = param.value;
}
} );
// pull in defaults from category
if (!job.notify_success && category.notify_success) job.notify_success = category.notify_success;
if (!job.notify_fail && category.notify_fail) job.notify_fail = category.notify_fail;
if (!job.web_hook && category.web_hook) job.web_hook = category.web_hook;
if (!job.memory_limit && category.memory_limit) {
job.memory_limit = category.memory_limit;
job.memory_sustain = category.memory_sustain || 0;
}
if (!job.cpu_limit && category.cpu_limit) {
job.cpu_limit = category.cpu_limit;
job.cpu_sustain = category.cpu_sustain || 0;
}
// multiplex stagger if desired
if (event.multiplex && event.stagger && (idx > 0)) {
// delay job by N seconds, based on stagger and host position in group
job.when = Tools.timeNow() + (event.stagger * idx);
job.time_start = job.when;
}
// send remote or run local
if (slave.master) {
// run the event here
self.launchLocalJob( job );
}
else if (slave.socket) {
// send the job to remote slave server
self.logDebug(6, "Sending remote job to: " + slave.hostname, job);
slave.socket.emit( 'launch_job', job );
// Pre-insert job into slave's active_jobs, so something will show in getAllActiveJobs() right away.
// Important for when the scheduler is catching up, and may try to launch a bunch of jobs in a row.
if (!slave.active_jobs) slave.active_jobs = {};
slave.active_jobs[ job.id ] = job;
}
// fire web hook
var hook_data = Tools.mergeHashes( job, { action: 'job_start' } );
// prepare nice text summary (compatible with Slack Incoming WebHooks)
hook_data.base_app_url = self.server.config.get('base_app_url');
hook_data.job_details_url = self.server.config.get('base_app_url') + '/#JobDetails?id=' + job.id;
hook_data.edit_event_url = self.server.config.get('base_app_url') + '/#Schedule?sub=edit_event&id=' + job.event;
var hook_text_templates = self.server.config.get('web_hook_text_templates') || self.defaultWebHookTextTemplates;
if (hook_text_templates[hook_data.action]) {
hook_data.text = hook_data.content = Tools.sub( hook_text_templates[hook_data.action], hook_data );
// include web_hook_config_keys if configured
if (self.server.config.get('web_hook_config_keys')) {
var web_hook_config_keys = self.server.config.get('web_hook_config_keys');
for (var idy = 0, ley = web_hook_config_keys.length; idy < ley; idy++) {
var key = web_hook_config_keys[idy];
hook_data[key] = self.server.config.get(key);
}
}
// include web_hook_custom_data if configured
if (self.server.config.get('web_hook_custom_data')) {
var web_hook_custom_data = self.server.config.get('web_hook_custom_data');
for (var key in web_hook_custom_data) hook_data[key] = web_hook_custom_data[key];
}
// custom http options for web hook
var hook_opts = self.server.config.get('web_hook_custom_opts') || {};
if (job.web_hook) {
self.logDebug(9, "Firing web hook for job start: " + job.id + ": " + job.web_hook);
self.request.json( job.web_hook, hook_data, hook_opts, function(err, resp, data) {
// log response
if (err) self.logDebug(9, "Web Hook Error: " + job.web_hook + ": " + err);
else self.logDebug(9, "Web Hook Response: " + job.web_hook + ": HTTP " + resp.statusCode + " " + resp.statusMessage);
} );
}
if (self.server.config.get('universal_web_hook')) {
self.logDebug(9, "Firing universal web hook for job start: " + self.server.config.get('universal_web_hook'));
self.request.json( self.server.config.get('universal_web_hook'), hook_data, hook_opts, function(err, resp, data) {
// log response
if (err) self.logDebug(9, "Universal Web Hook Error: " + err);
else self.logDebug(9, "Universal Web Hook Response: HTTP " + resp.statusCode + " " + resp.statusMessage);
} );
}
} // yes fire hook
jobs.push( job );
} // foreach slave
// no error
callback( null, jobs );
});
},
chooseServer: function(candidates, event) {
// choose server for event, based on algo
var server = null;
var hostnames = [];
for (var idx = 0, len = candidates.length; idx < len; idx++) {
hostnames.push( candidates[idx].hostname );
}
this.logDebug(9, "Choosing server for event using algo: " + event.algo || 'random', hostnames);
switch (event.algo || 'random') {
case "random":
// random server from group
server = Tools.randArray( candidates );
break;
case "round_robin":
// pick each server in sequence, repeat
if (!this.state.robins) this.state.robins = {};
var robin = this.state.robins[ event.id ] || 0;
if (robin >= candidates.length) robin = 0;
server = candidates[robin];
this.state.robins[ event.id ] = robin + 1;
break;
case "least_cpu":
// pick server with least CPU in use
var cpus = {};
var servers = this.getAllServers();
for (var hostname in servers) {
cpus[hostname] = 0;
if (servers[hostname] && servers[hostname].data && servers[hostname].data.cpu) {
cpus[hostname] = servers[hostname].data.cpu;
}
}
var jobs = this.getAllActiveJobs();
for (var job_id in jobs) {
var job = jobs[job_id];
if (job.cpu && job.cpu.current) {
if (!cpus[job.hostname]) cpus[job.hostname] = 0;
cpus[job.hostname] += job.cpu.current;
}
}
var least_value = -1;
var least_hostname = '';
for (var idx = 0, len = candidates.length; idx < len; idx++) {
var hostname = candidates[idx].hostname;
if ((least_value == -1) || (cpus[hostname] < least_value)) {
least_value = cpus[hostname];
least_hostname = hostname;
}
}
this.logDebug(9, "CPU Snapshot:", cpus);
server = Tools.findObject( candidates, { hostname: least_hostname } );
break;
case "least_mem":
// pick server with least memory in use
var mems = {};
var servers = this.getAllServers();
for (var hostname in servers) {
mems[hostname] = 0;
if (servers[hostname] && servers[hostname].data && servers[hostname].data.mem) {
mems[hostname] = servers[hostname].data.mem;
}
}
var jobs = this.getAllActiveJobs();
for (var job_id in jobs) {
var job = jobs[job_id];
if (job.mem && job.mem.current) {
if (!mems[job.hostname]) mems[job.hostname] = 0;
mems[job.hostname] += job.mem.current;
}
}
var least_value = -1;
var least_hostname = '';
for (var idx = 0, len = candidates.length; idx < len; idx++) {
var hostname = candidates[idx].hostname;
if ((least_value == -1) || (mems[hostname] < least_value)) {
least_value = mems[hostname];
least_hostname = hostname;
}
}
this.logDebug(9, "Mem Snapshot:", mems);
server = Tools.findObject( candidates, { hostname: least_hostname } );
break;
case "prefer_first":
// pick server towards top of sorted list
server = candidates[0];
break;
case "prefer_last":
// pick server towards bottom of sorted list
server = candidates[ candidates.length - 1 ];
break;
} // switch event.algo
this.logDebug(9, "Chose server: " + server.hostname + " via algo: " + (event.algo || "random") );
return server;
},
launchLocalJob: function(job) {
// launch job as a local child process
var self = this;
var child = null;
var worker = null;
// check for job delay request (multiplex stagger)
if (job.when && (job.when > Tools.timeNow())) {
this.logDebug(6, "Job " + job.id + " will be delayed for " +
Tools.getTextFromSeconds( job.when - Tools.timeNow() ));
job.action = 'launchLocalJob';
this.enqueueInternal(job);
return;
}
// construct fully qualified path to job log file
job.log_file = path.resolve( path.join(
this.server.config.get('log_dir'), 'jobs',
job.id + (job.detached ? '-detached' : '') + '.log'
) );
this.logDebug(6, "Launching local job", job);
// if we are the master server or job is detached,
// save copy of job file to disk next to log (for crash recovery)
if (this.multi.master || job.detached) {
fs.writeFile( job.log_file.replace(/\.log$/, '.json'), JSON.stringify(job), function(err) {
if (err) self.logError('job', "Failed to write JSON job file: " + job.log_file.replace(/\.log$/, '.json') + ": " + err);
} );
}
// setup environment for child
var child_opts = {
cwd: job.cwd || process.cwd(),
uid: job.uid || process.getuid(),
gid: process.getgid(),
env: Tools.mergeHashes(
this.server.config.get('job_env') || {},
Tools.mergeHashes( process.env, job.env || {} )
)
};
child_opts.env['CRONICLE'] = this.server.__version;
child_opts.env['JOB_ID'] = job.id;
child_opts.env['JOB_LOG'] = job.log_file;
child_opts.env['JOB_NOW'] = job.now;
child_opts.env['PWD'] = child_opts.cwd;
// copy all top-level job keys into child env, if number/string/boolean
for (var key in job) {
switch (typeof(job[key])) {
case 'string':
case 'number':
child_opts.env['JOB_' + key.toUpperCase()] = '' + job[key];
break;
case 'boolean':
child_opts.env['JOB_' + key.toUpperCase()] = job[key] ? 1 : 0;
break;
}
}
// get uid / gid info for child env vars
var user_info = Tools.getpwnam( child_opts.uid, true );
if (user_info) {
child_opts.uid = user_info.uid;
child_opts.gid = user_info.gid;
child_opts.env.USER = child_opts.env.USERNAME = user_info.username;
child_opts.env.HOME = user_info.dir;
child_opts.env.SHELL = user_info.shell;
}
else if (child_opts.uid != process.getuid()) {
// user not found
job.pid = 0;
job.code = 1;
job.description = "Plugin Error: User does not exist: " + child_opts.uid;
this.logError("child", job.description);
this.activeJobs[ job.id ] = job;
this.finishLocalJob( job );
return;
}
child_opts.uid = parseInt( child_opts.uid );
child_opts.gid = parseInt( child_opts.gid );
// add plugin params as env vars, expand $INLINE vars (unless escaped)
if (job.params) {
for (var key in job.params) {
child_opts.env[key.toUpperCase()] =
(''+job.params[key]).replace(/(\\?)\$(\w+)/g, function(m_all, m_g1, m_g2) {
return m_g1 ? ('$' + m_g2) : ((m_g2 in child_opts.env) ? child_opts.env[m_g2] : '');
});
}
}
this.logDebug(9, "Child spawn options:", child_opts);
// create log file, write header to it
var dargs = Tools.getDateArgs( new Date() );
fs.appendFileSync( job.log_file, [
"# Job ID: " + job.id,
"# Event Title: " + job.event_title,
"# Hostname: " + this.server.hostname,
"# Date/Time: " + dargs.yyyy_mm_dd + ' ' + dargs.hh_mi_ss + ' (' + dargs.tz + ')'
].join("\n") + "\n\n");
// make sure child can write to log file
fs.chmodSync( job.log_file, "777" );
if (job.detached) {
// spawn detached child
var temp_file = path.join( os.tmpdir(), 'cronicle-job-temp-' + job.id + '.json' );
// tell child where the queue dir is
job.queue_dir = path.resolve( this.server.config.get('queue_dir') );
// write job file
fs.writeFileSync( temp_file, JSON.stringify(job) );
fs.chmodSync( temp_file, "777" );
this.logDebug(9, "Job temp file: " + temp_file );
// spawn child
child_opts.detached = true;
child_opts.stdio = ['ignore', 'ignore', 'ignore'];
try {
child = cp.spawn( path.resolve("bin/run-detached.js"), ["detached", temp_file], child_opts );
}
catch (err) {
job.pid = 0;
job.code = 1;
job.description = "Child process error: " + Tools.getErrorDescription(err);
this.logError("child", job.description);
this.activeJobs[ job.id ] = job;
this.finishLocalJob( job );
return;
}
job.pid = child.pid || 0;
this.logDebug(3, "Spawned detached process: " + job.pid + " for job: " + job.id, job.command);
worker = {
pid: job.pid
};
child.unref();
}
else {
// spawn child normally
var child_cmd = job.command;
var child_args = [];
// if command has cli args, parse using shell-quote
if (child_cmd.match(/\s+(.+)$/)) {
var cargs_raw = RegExp.$1;
child_cmd = child_cmd.replace(/\s+(.+)$/, '');
child_args = sqparse( cargs_raw, child_opts.env );
}
worker = {};
// attach streams
worker.log_fd = fs.openSync(job.log_file, 'a');
child_opts.stdio = ['pipe', 'pipe', worker.log_fd];
// spawn child
try {
child = cp.spawn( child_cmd, child_args, child_opts );
if (!child || !child.pid || !child.stdin || !child.stdout) {
throw new Error("Child process failed to spawn (Check executable location and permissions?)");
}
}
catch (err) {
if (child) child.on('error', function() {}); // prevent crash
if (worker.log_fd) { fs.closeSync(worker.log_fd); worker.log_fd = null; }
job.pid = 0;
job.code = 1;
job.description = "Child spawn error: " + child_cmd + ": " + Tools.getErrorDescription(err);
this.logError("child", job.description);
this.activeJobs[ job.id ] = job;
this.finishLocalJob( job );
return;
}
job.pid = child.pid || 0;
this.logDebug(3, "Spawned child process: " + job.pid + " for job: " + job.id, child_cmd);
// connect json stream to child's stdio
// order reversed deliberately (out, in)
var stream = new JSONStream( child.stdout, child.stdin );
stream.recordRegExp = /^\s*\{.+\}\s*$/;
worker.pid = job.pid;
worker.child = child;
worker.stream = stream;
stream.on('json', function(data) {
// received data from child
self.handleChildResponse(job, worker, data);
} );
stream.on('text', function(line) {
// received non-json text from child, log it
fs.appendFileSync(job.log_file, line);
} );
stream.on('error', function(err, text) {
// Probably a JSON parse error (child emitting garbage)
self.logError('job', "Child stream error: Job ID " + job.id + ": PID " + job.pid + ": " + err);
if (text) fs.appendFileSync(job.log_file, text + "\n");
} );
child.on('error', function (err) {
// child error
if (worker.log_fd) { fs.closeSync(worker.log_fd); worker.log_fd = null; }
job.code = 1;
job.description = "Child process error: " + Tools.getErrorDescription(err);
worker.child_exited = true;
self.logError("child", job.description);
self.finishLocalJob( job );
} );
child.on('exit', function (code, signal) {
// child exited
self.logDebug(3, "Child " + job.pid + " exited with code: " + (code || signal || 0));
worker.child_exited = true;
if (job.complete) {
// child already reported completion, so finish job now
if (worker.log_fd) { fs.closeSync(worker.log_fd); worker.log_fd = null; }
self.finishLocalJob( job );
}
else {
// job is not complete but process exited (could be coming in next tick)
// set timeout just in case something went wrong
worker.complete_timer = setTimeout( function() {
if (worker.log_fd) { fs.closeSync(worker.log_fd); worker.log_fd = null; }
job.code = code || 1;
job.description = code ?
("Child " + job.pid + " crashed with code: " + (code || signal)) :
("Process exited without reporting job completion.");
if (!code) job.unknown = 1;
self.finishLocalJob( job );
}, 1000 );
}
} ); // on exit
// send initial job + params
stream.write( job );
// we're done writing to the child -- don't hold open its stdin
worker.child.stdin.end();
} // spawn normally
// track job in our own hash
this.activeJobs[ job.id ] = job;
this.kids[ job.pid ] = worker;
},
handleChildResponse: function(job, worker, data) {
// child sent us some datas (progress or completion)
this.logDebug(10, "Got job update from child: " + job.pid, data);
// sanity check -- disallow updates after job completion
if (job.complete) {
this.logDebug(10, "Job update received after completion -- ignoring");
return;
}
// only pull in properties we recognize
['progress', 'complete', 'code', 'description', 'perf', 'update_event', 'table', 'html', 'chain', 'chain_data', 'chain_error', 'notify_success', 'notify_fail'].forEach( function(key) {
if (key in data) job[key] = data[key];
} );
// assume success if complete but no code specified
if (job.complete && !job.code) job.code = 0;
if (job.complete && worker.child_exited) {
// in case this update came in after child exited
this.finishLocalJob( job );
}
},
detachedJobUpdate: function(data) {
// receive update from detached child via queue system
var id = data.id;
delete data.id;
var in_progress = data.in_progress || false;
delete data.in_progress;
this.logDebug(9, "Received update from detached job: " + id, data);
var job = this.activeJobs[id];
if (!job) {
// if this is an in-progress update, we can just silently skip (queue files arrived out of order)
if (in_progress) return;
// service may have restarted - try to recover job from temp file
var job_file = this.server.config.get('log_dir') + '/jobs/' + id + '-detached' + '.json';
this.logDebug(6, "Detached job is not in memory: " + id + ": Attempting to recover from disk", job_file);
// okay to use sync here, as this should be a very rare event
if (fs.existsSync(job_file)) {
var json_raw = fs.readFileSync(job_file, { encoding: 'utf8' });
try { job = JSON.parse(json_raw); }
catch (err) {
this.logError('job', "Failed to read detached job file: " + job_file + ": " + err);
}
}
else {
this.logError('job', "Could not locate detached job file: " + job_file);
}
if (job) {
this.logDebug(6, "Recovered job data from disk: " + job_file, job);
this.activeJobs[id] = job;
this.kids[ job.pid ] = { pid: job.pid };
}
else {
this.logError('job', "Failed to locate active job for update: " + id, data);
return;
}
} // no job in memory
// delegate to handleChildResponse, but create a temp fake worker object
// with child_exited set to true, so detached job can complete normally
this.handleChildResponse(job, { child_exited: true }, data);
},
rewindJob: function(job) {
// reset cursor state to minute before job started (use 'now' property in case start was delayed)
// only do this if job has catch_up, was launched via the scheduler, and is not multiplexed
if (!this.multi.master) return;
if (job.catch_up && !job.source && !job.multiplex) {
var new_start = Tools.normalizeTime( job.now - 60, { sec: 0 } );
this.state.cursors[ job.event ] = new_start;
var dargs = Tools.getDateArgs( new_start );
this.logDebug(5, "Reset event " + job.event + " cursor to: " + dargs.yyyy_mm_dd + " " + dargs.hh + ":" + dargs.mi + ":00" );
}
},
findJob: function(stub) {
// find active or pending job
// stub should have: id
if (!this.multi.master) return false;
if (typeof(stub) == 'string') stub = { id: stub };
// check all jobs, local, remote and pending
var all_jobs = this.getAllActiveJobs( true );
var job = all_jobs[stub.id];
if (!job) {
// check pending jobs (they have separate IDs)
for (var key in all_jobs) {
if (all_jobs[key].id == stub.id) {
job = all_jobs[key];
break;
}
}
}
return job || false;
},
updateJob: function(stub) {
// update active job
// stub should have: id
if (!this.multi.master) return false;
var job = this.findJob(stub);
if (!job) {
// should never happen
this.logDebug(1, "Could not locate job: " + stub.id);
return false;
}
if (job.hostname == this.server.hostname) {
// local job
this.updateLocalJob(stub);
}
else {
// remote job
var slave = this.slaves[ job.hostname ];
if (!slave) {
// should never happen
this.logDebug(1, "Could not locate slave: " + job.hostname);
return false;
}
this.logDebug(6, "Sending job update command to: " + slave.hostname, stub);
slave.socket.emit( 'update_job', stub );
}
return true;
},
updateLocalJob: function(stub) {
// update local job properties
var job = this.activeJobs[ stub.id ];
if (!job) {
// must be a pending job
if (this.internalQueue) {
for (var key in this.internalQueue) {
var task = this.internalQueue[key];
if ((task.action = 'launchLocalJob') && (task.id == stub.id)) {
job = task;
break;
}
}
}
if (!job) {
// should never happen
this.logDebug(1, "Could not locate job: " + stub.id);
return false;
}
}
this.logDebug(4, "Updating local job: " + stub.id, stub);
// update properties
for (var key in stub) {
if (key != 'id') job[key] = stub[key];
}
return true;
},
abortJob: function(stub) {
// abort active job
// stub should have: id, reason
if (!this.multi.master) return false;
// check all jobs, local, remote and pending
var all_jobs = this.getAllActiveJobs( true );
var job = all_jobs[stub.id];
if (!job) {
// check pending jobs (they have separate IDs)
for (var key in all_jobs) {
if (all_jobs[key].id == stub.id) {
job = all_jobs[key];
break;
}
}
}
if (!job) {
// should never happen
this.logDebug(1, "Could not locate job: " + stub.id);
return false;
}
if (job.hostname == this.server.hostname) {
// local job
this.abortLocalJob(stub);
}
else {
// remote job
var slave = this.slaves[ job.hostname ];
if (!slave) {
// should never happen
this.logDebug(1, "Could not locate slave: " + job.hostname);
return false;
}
this.logDebug(6, "Sending job abort command to: " + slave.hostname, stub);
slave.socket.emit( 'abort_job', stub );
}
// rewind cursor if needed
if (!stub.no_rewind) this.rewindJob(job);
if (job.pending && !job.log_file) {
// job is pre-launch, so log activity
this.logActivity( 'error', { description: "Pending job #"+stub.id+" ("+(job.event_title || 'Unknown')+") was aborted pre-launch: " + stub.reason } );
}
return true;
},
abortLocalPendingJob: function(stub) {
// abort job currently in pending queue
var job = null;
if (this.internalQueue) {
for (var key in this.internalQueue) {
var task = this.internalQueue[key];
if ((task.action = 'launchLocalJob') && (task.id == stub.id)) {
job = task;
delete this.internalQueue[key];
break;
}
}
}
if (!job) {
// should never happen
this.logDebug(1, "Could not locate pending job to abort: " + stub.id);
return;
}
this.logDebug(4, "Aborting local pending job: " + stub.id + ": " + stub.reason, job);
job.abort_reason = stub.reason;
// determine if job needs to be 'finished' (i.e. aborted in retry delay)
// or hasn't actually launched yet (i.e. multiplex stagger)
if (job.log_file) {
this.activeJobs[ job.id ] = job; // trick it into acceptance
this.finishLocalJob( job );
}
},
abortLocalJob: function(stub) {
// abort locally running job on this server
// stub should have: id, reason
var self = this;
var job = this.activeJobs[ stub.id ];
if (!job) {
// must be a pending job
this.abortLocalPendingJob(stub);
return;
}
var worker = this.kids[ job.pid ] || {};
this.logDebug(4, "Aborting local job: " + stub.id + ": " + stub.reason, job);
job.abort_reason = stub.reason;
if (worker.child) {
// owned process
if (worker.log_fd) { fs.closeSync(worker.log_fd); worker.log_fd = null; }
worker.kill_timer = setTimeout( function() {
// child didn't die, kill with prejudice
self.logDebug(3, "Child did not exit, killing harder: " + job.pid);
worker.child.kill('SIGKILL');
}, this.server.config.get('child_kill_timeout') * 1000 );
// try killing nicely first
worker.child.kill('SIGTERM');
}
else {
// detached process
if (job.pid) {
try { process.kill( job.pid, 'SIGTERM' ); }
catch (e) {
this.logDebug(5, "Could not term process: " + job.pid + ", killing it.");
try { process.kill( job.pid, 'SIGKILL' ); } catch (e) {;}
}
// make sure process actually exits
setTimeout( function() {
var ping = false;
try { ping = process.kill( job.pid, 0 ); }
catch (e) {;}
if (ping) {
self.logDebug(3, "Child did not exit, killing: " + job.pid);
try { process.kill( job.pid, 'SIGKILL' ); } catch (e) {;}
}
}, this.server.config.get('child_kill_timeout') * 1000 );
} // job.pid
// assume job is finished at this point
this.finishLocalJob(job);
}
},
finishLocalJob: function(job) {
// complete job, remove from tracking, update history
var self = this;
// job may already be removed