-
Notifications
You must be signed in to change notification settings - Fork 15
/
loader.js
603 lines (506 loc) · 23.7 KB
/
loader.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
// Authors:
// - cadorn, Christoph Dorn <christoph@christophdorn.com>, Copyright 2011, MIT License
var boot = exports.boot = function(options)
{
const VERSION = "0.0.2";
var timers = {
start: new Date().getTime(),
loadAdditional: 0
};
try
{
options = options || {};
// ######################################################################
// # Adapter
// ######################################################################
// Before we can do anything we need to have a basic file and
// system API available. Since this loader can be run in various
// host environments we need to decide which adapter to load.
var adapter;
// TODO: Bypass the adapter selection if an option is provided
if (typeof this.window == "undefined" || ""+this.window == "undefined")
{
// We are running on a server or headless environment
// Test for NodeJS
var httpId = "http";
if (typeof process != "undefined" && typeof require(httpId).Server != "undefined")
{
adapter = "node";
}
else
// Test for Jetpack
if (typeof __url__ != "undefined" && typeof packaging != "undefined" && typeof memory != "undefined")
{
adapter = "jetpack";
}
else
{
// Test for Narwhal
try
{
var narwhal = "narwhal";
if (typeof require(narwhal).ensureEngine != "undefined")
{
adapter = "narwhal";
}
}
catch(e) {}
}
}
else
{
// We are most likely running in a browser
}
if (!adapter)
throw new Error("Cannot select platform adapter. Unable to identify host JavaScript platform.");
// Normalize JS environment to ES5
require("./bravojs/global-es5");
var API = require("./api");
API.SANDBOX = require("./sandbox");
API.CONSOLE = require("./console");
API.ENV.timers = timers;
API.DEBUG.enabled = options.debug || void 0;
API.SYSTEM.print = options.print || void 0;
API.ENV.platformRequire = options.platformRequire || void 0;
API.ENV.platformOptions = options.platformOptions || void 0;
API.ENV.mustClean = options.clean || false;
// NOTE: If you modify this line you need to update: ../programs/bundle-loader/lib/bundler.js
require("./adapter/" + adapter).init(API);
// Now that we have a basic file and system API available we can proceed
// ######################################################################
// # CLI
// ######################################################################
// Setup command line options
API.ARGS = require("./args");
var optParser = new API.ARGS.Parser(),
cliOptions;
//command.help('Announce a new release of a package');
optParser.arg(".../[program.json]").optional();
optParser.help("Runs the PINF JavaScript Loader.");
optParser.option("-v", "--verbose").bool().help("Enables progress messages");
optParser.option("--pidfile").set().help("Write the process ID to the specified file. Remove file on exit. Ensures only one instance at a time.");
optParser.option("--daemonize").bool().help("Daemonize the process. Requires: npm install -g daemon");
// TODO: Rename `platform` to `engine` everywhere?
optParser.option("--platform").set().help("The platform to use");
optParser.option("--test-platform").set().help("Make sure a platform is working properly");
optParser.option("--sources").set().help("The path to a sources.json file to overlay source repositories");
optParser.option("--script").set().help("Call a script defined in the program boot package");
optParser.option("--link-program-to").set().help("Link the program package to the given directory");
optParser.option("--discover-packages").bool().help("Discover all packages and add to program.json");
optParser.option("--clean").bool().help("Removes all downloaded packages first");
optParser.option("--terminate").bool().help("Asks program to terminate if it was going to deamonize (primarily used for testing)");
optParser.option("-h", "--help").bool().help("Display usage information");
if (typeof options.program != "undefined")
cliOptions = optParser.parse(["pinf-loader"].concat([options.program]));
else
cliOptions = optParser.parse(["pinf-loader"].concat(API.SYSTEM.args));
if (cliOptions.help === true)
{
optParser.printHelp(cliOptions);
return;
}
if (typeof API.DEBUG.enabled == "undefined")
{
if (cliOptions.verbose === true)
API.DEBUG.enabled = true;
}
if (cliOptions.terminate === true)
API.ENV.mustTerminate = true;
if (cliOptions.clean === true)
API.ENV.mustClean = true;
var knownCliPlatforms = [
"node",
"narwhal"
];
function spawnForPlatform(platform)
{
// A different platform is requested than is running
// TODO: Get this working with all adapters
if (API.ENV.platform != "node")
throw new Error("NYI - Spawning loader for platform '" + platform + "' from platform '" + API.ENV.platform + "'");
if (knownCliPlatforms.indexOf(platform) === -1)
throw new Error("Unknown command line platform: " + platform);
API.SYSTEM.exec("which " + platform, function (stdout, stderr, error) {
if (!stdout)
throw new Error("Platform command '" + platform + "' not found via 'which'!");
API.SYSTEM.spawn(stdout.split("\n").shift(), [API.ENV.loaderRoot + "/pinf-loader.js"].concat(API.SYSTEM.args));
});
}
if (typeof cliOptions["test-platform"] != "undefined")
{
if (knownCliPlatforms.indexOf(cliOptions["test-platform"]) === -1)
throw new Error("Unknown command line platform: " + cliOptions["test-platform"]);
API.SYSTEM.exec("which " + cliOptions["test-platform"], function (stdout, stderr, error) {
if (!stdout)
API.SYSTEM.print("\0red(FAIL: 'which " + cliOptions["test-platform"] + "' did not locate command!\0)");
else
{
var cmd = stdout.split("\n").shift();
API.SYSTEM.exec(cmd + " -h", function (stdout, stderr, error) {
// TODO: This check should be more definitive
if (!stdout)
API.SYSTEM.print("\0red(FAIL: '" + cmd + " -h' did not yield expected output!\0)");
else
API.SYSTEM.print("\0green(OK\0)");
});
}
});
return;
}
else
if (typeof cliOptions.platform != "undefined" && cliOptions.platform != API.ENV.platform)
{
spawnForPlatform(cliOptions.platform);
return;
}
function run()
{
API.DEBUG.print("\0magenta(----------------------------------------------------------------------------");
API.DEBUG.print("\0bold(| PINF Loader v" + VERSION + " ~ https://github.com/pinf/loader-js/\0)");
API.DEBUG.print("----------------------------------------------------------------------------\0)");
API.DEBUG.print("Loaded adapter: " + API.ENV.platform);
var pinfPackagesPath = "/pinf/pinf_packages";
if (!API.FILE.exists(pinfPackagesPath)) {
pinfPackagesPath = API.SYSTEM.pwd + "/.pinf-packages";
}
var downloader = new ((API.DOWNLOADER = require("./downloader")).Downloader)({
basePath: pinfPackagesPath
});
var assembler = API.ENV.assembler = new (require("./assembler").Assembler)(downloader);
API.ENV.loadSourceDescriptorsForProgram = function(path, existingSourceDescriptors)
{
var DESCRIPTORS = require("./descriptors");
var sourceDescriptors = [],
files = [];
if (typeof existingSourceDescriptors !== "undefined") {
existingSourceDescriptors.forEach(function(descriptor)
{
sourceDescriptors[descriptor.path] = descriptor;
});
}
if (cliOptions.sources)
{
if (!API.FILE.exists(cliOptions.sources))
throw new Error("Source repository overlay file specified via --sources not found at: " + cliOptions.sources);
files.push(cliOptions.sources);
}
if (options.sources)
{
if (!API.FILE.exists(options.sources))
throw new Error("Source repository overlay file specified via options.sources not found at: " + options.sources);
files.push(options.sources);
}
if (API.SYSTEM.pwd !== "__PWD__")
{
files.push(API.SYSTEM.pwd + "/sources.local.json");
}
files.push(API.FILE.dirname(path) + "/sources.local.json");
if (typeof API.SYSTEM.env.HOME != "undefined" && API.SYSTEM.env.HOME)
files.push(API.SYSTEM.env.HOME + "/.pinf/config/sources.json");
files.push("/pinf/etc/pinf/sources.json");
files.push(API.FILE.dirname(path) + "/sources.json");
files.forEach(function(sourcesPath)
{
if (!sourceDescriptors[sourcesPath] && API.FILE.exists(sourcesPath))
sourceDescriptors[sourcesPath] = new DESCRIPTORS.Sources(sourcesPath);
});
var descriptors = [];
for (var key in sourceDescriptors)
descriptors.push(sourceDescriptors[key]);
sourceDescriptors = descriptors;
if (API.DEBUG.enabled)
{
if (sourceDescriptors.length > 0)
{
API.DEBUG.print("Using source overlay files:");
sourceDescriptors.forEach(function(sourceDescriptor)
{
API.DEBUG.print(" \0cyan(" + sourceDescriptor.path + "\0)");
});
}
else
API.DEBUG.print("Not using any source overlay files.");
}
return sourceDescriptors;
}
var init = function(path)
{
path = path || "";
if (path.charAt(0) != "/")
path = API.SYSTEM.pwd + "/" + path;
path = path.split("/");
if (/\.zip$/.test(path[path.length-1]))
{
path[path.length-1] += "!/";
}
if (!path[path.length-1] || path[path.length-1] != "program.json")
{
API.DEBUG.print("No descriptor URI argument. Assuming: '[./]program.json'");
path.push("program.json");
}
path = API.FILE.realpath(path.join("/"));
API.DEBUG.print("Loading program descriptor from: " + path);
var pinfPackagesPath = "/pinf/pinf_packages";
if (!API.FILE.exists(pinfPackagesPath)) {
pinfPackagesPath = path.substring(0, path.length-13) + "/.pinf-packages";
}
downloader.basePath = pinfPackagesPath;
if (cliOptions["link-program-to"])
{
if (!API.FILE.exists(cliOptions["link-program-to"]))
{
if (!API.FILE.exists(API.FILE.dirname(cliOptions["link-program-to"])))
API.FILE.mkdirs(API.FILE.dirname(cliOptions["link-program-to"]), 0775);
API.SYSTEM.exec("ln -s " + API.FILE.dirname(path) + " " + cliOptions["link-program-to"], function(stdout, stderr)
{
console.log(stdout);
console.log(stderr);
});
}
}
API.DEBUG.print("Using program cache directory: " + downloader.basePath);
// ######################################################################
// # Sandbox
// ######################################################################
var sandbox = new API.SANDBOX.Sandbox({
mainModuleDir: API.FILE.dirname(path) + "/"
});
// ######################################################################
// # Simple script
// ######################################################################
if (!API.FILE.isFile(path))
{
var scriptPath = cliOptions.args[0];
if (scriptPath.charAt(0) != "/")
{
scriptPath = API.FILE.realpath(API.SYSTEM.pwd + "/" + scriptPath);
if (!/\.js$/.test(scriptPath))
scriptPath += ".js";
}
if (!API.FILE.exists(scriptPath))
{
if (/\.js$/.test(scriptPath))
scriptPath = scriptPath.substring(0, scriptPath.length-3);
if (!API.FILE.exists(scriptPath))
throw new Error("Script not found at: " + scriptPath);
}
sandbox.init();
sandbox.declare([ scriptPath ], function(require, exports, module)
{
var scriptModule = require(scriptPath);
if (typeof scriptModule.main == "undefined")
throw new Error("Script at '" + scriptPath + "' does not export 'main()'");
API.DEBUG.print("Running script: " + scriptPath);
API.DEBUG.print("\0magenta(\0:blue(----- | Script stdout & stderr follows ====>\0:)\0)");
scriptModule.main({
bootProgram: function(options)
{
if (typeof options.platformRequire == "undefined")
options.platformRequire = API.ENV.platformRequire;
return boot(options);
},
args: cliOptions.args.slice(1, cliOptions.args.length)
});
});
return;
}
// ######################################################################
// # Program assembly
// ######################################################################
if (!API.FILE.exists(path))
{
API.SYSTEM.print("\0red(No program descriptor found at: " + path + "\0)\n");
return;
}
// Assemble the program (making all code available on disk) by downloading all it's dependencies
assembler.assembleProgram(sandbox, path, function(program)
{
var engines = program.getEngines();
if (engines)
{
if (engines.indexOf(API.ENV.platform) === -1)
{
API.DEBUG.print("\0yellow(Spawning platform: " + engines[0] + "\0)");
spawnForPlatform(engines[0]);
return false;
}
}
return true;
},
function(program)
{
API.ENV.booting = false;
// TODO: Keep these references elsewhere so we can have nested sandboxes
API.ENV.program = program;
API.ENV.sandbox = sandbox;
if (!program.hasBootPackage())
{
return;
}
program.getBootPackages(assembler, function(dependencies)
{
if (dependencies.length > 1)
{
throw new Error("Only one program boot package allowed in: " + path);
}
// ######################################################################
// # Program Booting
// ######################################################################
API.ENV.booting = true;
if (API.DEBUG.enabled) {
API.DEBUG.print("Loading program's main packages:");
for (var i=0, ic=dependencies.length ; i<ic ; i++ )
{
if (typeof dependencies[i]["_package-" + i] != "undefined")
API.DEBUG.print(" " + dependencies[i]["_package-" + i].location);
}
}
timers.load = new Date().getTime()
var env = options.env || {};
env.args = env.args || options.args || cliOptions.args.slice(1, cliOptions.args.length) || [];
env.programDescriptorPath = path;
env.bootPackagePath = dependencies[0]["_package-0"].location;
sandbox.declare(dependencies, function(require, exports, module)
{
timers.run = new Date().getTime()
// ######################################################################
// # Program Script
// ######################################################################
if (cliOptions.script)
{
var pkg = sandbox.packageForId(dependencies[0]['_package-0'].location);
if (typeof pkg.normalizedDescriptor.json.scripts == "undefined")
throw new Error("No 'scripts' defined in package descriptor: " + pkg.normalizedDescriptor.path);
if (typeof pkg.normalizedDescriptor.json.scripts[cliOptions.script] == "undefined")
throw new Error("Script '" + cliOptions.script + "' not found in 'scripts' defined in package descriptor: " + pkg.normalizedDescriptor.path);
if (typeof pkg.normalizedDescriptor.json.scripts[cliOptions.script] == "object")
{
assembler.addPackageToProgram(sandbox, sandbox.program, pkg.normalizedDescriptor.json.scripts[cliOptions.script], function(pkg)
{
module.load(pkg.getMainId(pkg.normalizedDescriptor.json.scripts[cliOptions.script]), function(id)
{
var script = require(id);
if (typeof script.main == "undefined")
throw new Error("Script does not export main() in " + id);
API.ENV.booting = false;
API.DEBUG.print("\0magenta(\0:blue(----- | Program script stdout & stderr follows ====>\0:)\0)");
script.main(env);
});
}, {
"discover-packages": cliOptions["discover-packages"] || false,
sourceDescriptors: API.ENV.loadSourceDescriptorsForProgram(path)
});
}
else
throw new Error("NYI - Non-locator based script pointers");
}
else
// ######################################################################
// # Program Boot Packages
// ######################################################################
{
API.DEBUG.print("Booting program. Output for boot package follows in green between ==> ... <==");
// Run the program by calling main() on each packages' main module
var pkg,
hl;
// TODO: Refactor as there is only ever one boot package
for (var i=0, ic=dependencies.length ; i<ic ; i++ )
{
var pkg = require("_package-" + i);
if (typeof pkg.main === "undefined")
throw new Error("Package's main module does not export main() in package: " + dependencies[i]["_package-" + i].location);
if (API.DEBUG.enabled)
{
var h = "----- " + dependencies[i]["_package-" + i].location + " -> [package.json].main -> main() -----";
hl = h.length;
API.DEBUG.print("\0magenta(\0:blue(" + h + "\0:)");
API.SYSTEM.print("\0:blue(=====>\0:)\0)\0green(\0bold(", false, true);
}
pkg.main(env);
if (API.DEBUG.enabled)
{
API.SYSTEM.print("\0)\0)\0magenta(\0:blue(<=====\0:)\0)\n");
var f = "";
for (var i=0 ; i<hl-8 ; i++) f += "-";
API.DEBUG.print("\0magenta(\0:blue(----- ^ " + f + "\0:)\0)");
}
}
API.ENV.booting = false;
}
timers.end = new Date().getTime()
API.DEBUG.print("Program Booted ~ Timing (Assembly: "+(timers.load-timers.start)/1000+", Load: "+(timers.run-timers.load)/1000+", Boot: "+(timers.end-timers.run-timers.loadAdditional)/1000+", Additional Load: "+(timers.loadAdditional)/1000+")");
var f = "";
for (var i=0 ; i<hl ; i++) f += "|";
API.DEBUG.print("\0magenta(\0:blue(----- | Program stdout & stderr follows (if not already terminated) ====>\0:)\0)");
if (typeof options.callback != "undefined")
{
options.callback(sandbox, require);
}
});
});
}, {
"discover-packages": cliOptions["discover-packages"] || false,
sourceDescriptors: API.ENV.loadSourceDescriptorsForProgram(path)
});
} // init()
if (/^https?:\/\//.test(cliOptions.args[0]))
{
API.DEBUG.print("Boot cache directory: " + downloader.basePath);
assembler.provisonProgramForURL(cliOptions.args[0], init, {
sourceDescriptors: API.ENV.loadSourceDescriptorsForProgram(API.SYSTEM.pwd + "/")
});
}
else
init(cliOptions.args[0]);
} // run()
if (cliOptions.pidfile) {
function preRun()
{
API.FILE.write(cliOptions.pidfile, API.SYSTEM.pid);
API.SYSTEM.on("exit", function()
{
API.FILE.remove(cliOptions.pidfile);
});
// TODO: Move this further down so we only daemonize if the program started successfully
if (cliOptions.daemonize) {
API.SYSTEM.daemonize(cliOptions.pidfile, function()
{
run();
});
} else {
run();
}
}
if (API.FILE.exists(cliOptions.pidfile)) {
// check if process is still running
API.SYSTEM.exec("kill -0 " + API.FILE.read(cliOptions.pidfile), function (stdout, stderr, error) {
if (!stdout && !stderr) {
throw new Error("Program for pid file '" + cliOptions.pidfile + "' already running at process ID: " + API.FILE.read(cliOptions.pidfile));
} else {
// if (/No such process/.test(stderr)) {
API.FILE.remove(cliOptions.pidfile);
preRun();
}
});
} else {
preRun();
}
} else {
run();
}
}
catch(e)
{
if (typeof options.print != "undefined")
options.print("[pinf-loader] " + e + "\n\n " + (e.stack || "").split("\n").join("\n ") + "\n\n");
else
if (typeof API != "undefined" && typeof API.SYSTEM != "undefined" && typeof API.SYSTEM.print != "undefined")
API.SYSTEM.print("[pinf-loader] " + e + "\n\n " + (e.stack || "").split("\n").join("\n ") + "\n\n");
else
if (typeof console != "undefined")
console.log("[pinf-loader] " + e.stack);
else
if( typeof print != "undefined")
print("[pinf-loader] " + e.stack + "\n");
}
}