| 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 |
18x
18x
18x
18x
18x
24x
24x
24x
24x
24x
24x
24x
24x
24x
24x
24x
24x
24x
24x
24x
18x
18x
18x
18x
18x
9x
9x
9x
9x
9x
9x
9x
9x
9x
9x
9x
9x
9x
8x
9x
1x
1x
1x
8x
8x
8x
18x
6x
12x
3x
18x
18x
10x
10x
18x
18x
18x
18x
18x
18x
18x
18x
18x
18x
18x
25x
25x
25x
25x
25x
18x
18x
18x
17x
17x
17x
17x
17x
16x
16x
2x
2x
2x
2x
36x
36x
18x
18x
18x
18x
18x
18x
25x
18x
18x
25x
18x
18x
18x
17x
17x
24x
17x
17x
24x
24x
24x
24x
24x
23x
24x
36x
36x
24x
12x
5x
7x
7x
1x
6x
6x
23x
23x
23x
1x
1x
1x
5x
5x
5x
5x
5x
5x
5x
1x
1x
5x
16x
16x
19x
1x
| /**
* © 2014 Liferay, Inc. <https://liferay.com>
*
* SPDX-License-Identifier: LGPL-3.0-or-later
*/
import Config from './config';
import DependencyResolver from './dependency-resolver';
import ScriptLoader from './script-loader';
import URLBuilder from './url-builder';
import packageJson from '../../package.json';
/* eslint-disable no-console */
/**
*
*/
export default class Loader {
/**
* Creates an instance of Loader class.
* @namespace Loader
* @constructor
* @param {object=} config Configuration options (defaults to
* window.__CONFIG__)
* @param {object} document DOM document object to use (defaults to
* window.document)
*/
constructor(config = null, document = null) {
this._config = new Config(config || window.__CONFIG__);
this._dependencyResolver = new DependencyResolver(this._config);
this._urlBuilder = new URLBuilder(this._config);
this._scriptLoader = new ScriptLoader(
document || window.document,
this._config
);
this._requireCallId = 0;
}
/**
* Get loader version
* @return {String} the version number as specified in package.json
*/
version() {
return packageJson.version;
}
/**
* Defines a module in the system and fires
* @param {string} name the name of the module
* @param {array} dependencies list of module dependencies
* @param {function} factory the AMD factory function of the module
*/
define(...args) {
const config = this._config;
const name = args[0];
let module = config.getModule(name);
Iif (module && module.defined) {
if (config.showWarnings) {
console.warn(
`Liferay AMD Loader: Module '${name}' is being ` +
'redefined; only the first definition will be used'
);
}
return;
}
let dependencies = args[1];
let factory = args[2];
// Acccount for call polymorphism
Iif (args.length == 2) {
factory = dependencies;
dependencies = ['require', 'exports', 'module'];
}
// Normalize factory argument
Iif (typeof factory !== 'function') {
const exportedValue = factory;
factory = () => exportedValue;
}
// Do the things
module = config.getModule(name);
Iif (!module) {
throw new Error(
`Trying to define a module that was not registered: ${name}\n` +
'This usually means that someone is calling define() ' +
'for a module that has not been previously required.'
);
}
Iif (module.defined) {
throw new Error(
`Trying to define a module more than once: ${name}\n` +
'This usually means that someone is calling define() ' +
'more than once for the same module, which can lead to ' +
'unexpected results.'
);
}
Iif (config.explainResolutions) {
console.log('Liferay AMD Loader:', 'Defining', module.name);
}
module.factory = factory;
module.dependencies = dependencies;
module.define.resolve(args);
}
/**
* Requires list of modules. If a module is not yet registered, it will be
* ignored and its implementation in the provided success callback will be
* left undefined.
* @param {array|string[]} modules Modules can be specified as an array of
* strings or provided as multiple string
* parameters.
* @param {function} success Callback, which will be invoked in case of
* success. The provided parameters will be
* implementations of all required modules.
* @param {function} failure Callback, which will be invoked in case of
* failure. One parameter with information
* about the error will be provided.
*/
require(...args) {
const moduleLoader = this._scriptLoader;
const config = this._config;
const requireCallId = this._requireCallId++;
let moduleNames;
let success;
let failure;
// Account for call polymorphism
Iif (args.length == 1) {
moduleNames = args[0];
success = undefined;
failure = undefined;
} else if (args.length == 2) {
const lastArg = args[args.length - 1];
Eif (typeof lastArg === 'function') {
moduleNames = args[0];
success = lastArg;
failure = undefined;
} else if (lastArg == null) {
moduleNames = args[0];
success = undefined;
failure = undefined;
} else {
moduleNames = args;
success = undefined;
failure = undefined;
}
} else {
const lastArg = args[args.length - 1];
let successGiven = false;
Eif (typeof lastArg === 'function' || lastArg == null) {
successGiven = true;
}
Iif (!successGiven) {
moduleNames = args;
success = undefined;
failure = undefined;
} else {
const penultimateArg = args[args.length - 2];
let failureGiven = false;
if (
typeof penultimateArg === 'function' ||
penultimateArg == null
) {
failureGiven = true;
}
if (!failureGiven) {
moduleNames = args.slice(0, args.length - 1);
success = lastArg;
failure = undefined;
} else {
moduleNames = args.slice(0, args.length - 2);
success = penultimateArg;
failure = lastArg;
}
}
}
// Flatten moduleNames argument if necessary
if (typeof moduleNames === 'string') {
moduleNames = [moduleNames];
} else if (moduleNames.length == 1 && Array.isArray(moduleNames[0])) {
moduleNames = [].concat(...moduleNames);
}
// Provide default value for success
Iif (success === undefined) {
success = () => {};
}
// Provide default value for failure
if (failure === undefined) {
const stack = new Error(
'This is not a real error, but a fake one created to capture ' +
"require()'s caller stack trace"
);
failure = error => {
if (!config.explainResolutions) {
return;
}
console.log('---------------------------------------');
console.log('Liferay AMD Loader: Unhandled require failure:');
console.log(
'\nNOTE: You are seeing this message because you have\n' +
'invoked require() without a failure handler. It\n' +
'does not necessarily mean that the Loader is\n' +
'broken and may be caused by errors in your code or\n' +
'third party modules.\n\n' +
'If you want to avoid it make sure to provide a\n' +
'failure handler when calling require().\n\n'
);
console.log('A detailed report of what happened follows:');
console.log(' · Require call id:', requireCallId);
console.log(' · Required modules:', moduleNames);
console.log(' · Error cause:', error);
if (error.missingModules) {
console.log(' · Missing modules:', error.missingModules);
}
console.log(" · Caller's stack trace:", stack);
console.log('---------------------------------------');
};
}
// Intercept handlers to explain resolutions
success = this._interceptHandler(success, 'success', requireCallId);
failure = this._interceptHandler(failure, 'failure', requireCallId);
// Global closure variables
let resolvedModuleNames;
let unregisteredModuleNames;
let rejectTimeout;
let timeoutRejected = false;
// Do the things (note that each then() block contains a synchronous
// block of code, that means that between then() blocks may be
// interrupted by any parallel call)
this._dependencyResolver
.resolve(moduleNames)
.then(resolution => {
// Show extra information when explainResolutions is active
this._explainResolution(requireCallId, moduleNames, resolution);
// Fail if resolution errors present
this._throwOnResolutionErrors(resolution);
// Merge global maps from resolution into config
config.addMappings(resolution.configMap);
// Merge global paths from resolution into config
config.addPaths(resolution.pathMap);
// Store resolved module names
resolvedModuleNames = resolution.resolvedModules;
// Grab unregistered module names (some of the resolved modules
// may have been registered by a parallel require() call, so we
// are not responsible for loading them).
unregisteredModuleNames = this._getUnregisteredModuleNames(
resolvedModuleNames
);
// Register the modules
unregisteredModuleNames.forEach(moduleName => {
const moduleProperties = {
map: resolution.moduleMap[moduleName],
};
let moduleFlags = resolution.moduleFlags
? resolution.moduleFlags[moduleName]
: {};
moduleFlags = moduleFlags || {};
Iif (moduleFlags.esModule) {
moduleProperties.esModule = true;
}
config.addModule(moduleName, moduleProperties);
});
// Prepare load timeout
rejectTimeout = this._setRejectTimeout(
moduleNames,
resolution,
(...args) => {
timeoutRejected = true;
failure(...args);
}
);
// Load the modules we are responsible for
Iif (config.explainResolutions) {
console.log(
'Liferay AMD Loader:',
'Fetching',
unregisteredModuleNames,
'from require call',
requireCallId
);
}
return moduleLoader.loadModules(unregisteredModuleNames);
})
.then(() => {
// If reject timeout was hit don't do anything else
Iif (timeoutRejected) return;
// Wait for all unregistered modules to be defined
return this._waitForModuleDefinitions(resolvedModuleNames);
})
.then(() => {
// If reject timeout was hit don't do anything else
Iif (timeoutRejected) return;
// Everything went well so we can clear the timeout
clearTimeout(rejectTimeout);
// Set the implementations of all needed modules. Note that we
// set the implementation of modules not loaded by this
// require() call but it is necessary in case the require()
// call that loaded them aborted because of an error in the
// implementation of some module.
this._setModuleImplementations(
requireCallId,
resolvedModuleNames
);
// Now get all needed modules implementations
const implementations = this._getModuleImplementations(
moduleNames
);
// And invoke the sucess handler
success(...implementations);
})
.catch(err => {
// If reject timeout was hit don't do anything else
Iif (timeoutRejected) return;
Eif (rejectTimeout) {
clearTimeout(rejectTimeout);
}
failure(err);
});
}
/**
* Intercept a require success or failure handler to show information to
* explain resolutions.
* @param {function} handler
* @param {string} type
* @param {number} requireCallId
*/
_interceptHandler(handler, type, requireCallId) {
const config = this._config;
return (...args) => {
Iif (config.explainResolutions) {
console.log(
'Liferay AMD Loader: Invoking',
type,
'handler for',
'require call',
requireCallId
);
}
try {
handler(...args);
} catch (err) {
console.error(err);
}
};
}
/**
* Explain resolution if flag is active
* @param {number} requireCallId
* @param {Array<string>} moduleNames
* @param {object} resolution
*/
_explainResolution(requireCallId, moduleNames, resolution) {
const config = this._config;
Iif (config.explainResolutions) {
console.log(
'Liferay AMD Loader:',
'Require call',
requireCallId,
'resolved modules',
moduleNames,
'to',
resolution
);
}
}
/**
* Traverse a resolved dependencies array looking for server sent errors and
* throw an Error if any is found.
* @param {object} resolution the resolution object
* @throws {Error} if a resolution error is found
*/
_throwOnResolutionErrors(resolution) {
const resolutionErrors = resolution.resolvedModules
.filter(dep => dep.indexOf(':ERROR:') === 0)
.map(dep => dep.substr(7));
Iif (resolutionErrors.length > 0) {
throw Object.assign(
new Error(
'The following problems where detected while ' +
'resolving modules:\n' +
resolutionErrors.map(line => ` · ${line}`).join('\n')
),
{resolutionErrors}
);
}
}
/**
* Filters a list of modules and returns only those which are not yet
* registered.
* @param {array} moduleNames list of module names to be tested
* @return {array} list of modules matching the specified filter
*/
_getUnregisteredModuleNames(moduleNames) {
const config = this._config;
return moduleNames.filter(moduleName => !config.getModule(moduleName));
}
/**
* Set a timeout (only if allowed by configuration) to reject a Promise if
* a certain set of modules has not been successfully loaded.
* @param {Array} modules the modules to be loaded
* @param {object} resolution the resolution object associated to the
* modules
* @param {function} reject the promise reject function
* @return {int} a timeout id or undefined if configuration disabled timeout
*/
_setRejectTimeout(modules, resolution, reject) {
const config = this._config;
Iif (config.waitTimeout === 0) {
return undefined;
}
return setTimeout(() => {
const resolvedModuleNames = resolution.resolvedModules;
const missingModules = resolvedModuleNames.filter(moduleName => {
const module = config.getModule(moduleName);
return !module || !module.implemented;
});
const error = Object.assign(
new Error('Load timeout for modules: ' + modules),
{
modules,
resolution,
missingModules,
}
);
reject(error);
}, config.waitTimeout);
}
/**
* Resolves a Promise as soon as all provided modules are defined.
* @param {array} moduleNames list of module names for which to wait
* @return {Promise}
*/
_waitForModuleDefinitions(moduleNames) {
const config = this._config;
return Promise.all(
config.getModules(moduleNames).map(module => module.define)
);
}
/**
* Resolves a Promise as soon as all provided modules are implemented.
* @param {array} moduleNames list of module names for which to wait
* @return {Promise}
*/
_waitForModuleImplementations(moduleNames) {
const config = this._config;
return Promise.all(
config.getModules(moduleNames).map(module => module.implement)
);
}
/**
* Invokes the implementation method of modules passing the implementations
* of its dependencies.
* @throws {Error} as soon as any factory fails
* @param {number} requireCallId
* @param {array} moduleNames list of modules to invoke
*/
_setModuleImplementations(requireCallId, moduleNames) {
const config = this._config;
config.getModules(moduleNames).forEach(module => {
// Skip already implemented modules
Iif (module.implemented) {
return;
}
// Fail for already rejected implementations
Iif (module.implement.rejected) {
throw module.implement.rejection;
}
// Show info about resolution
Iif (config.explainResolutions) {
console.log(
'Liferay AMD Loader:',
'Implementing',
module.name,
'from require call',
requireCallId
);
}
try {
// Prepare CommonJS module implementation object
const moduleImpl = {
get exports() {
return module.implementation;
},
set exports(exports) {
module.implementation = exports;
},
};
// Prepare arguments for the AMD factory function
const dependencyImplementations = module.dependencies.map(
dependency => {
Iif (dependency === 'exports') {
return moduleImpl.exports;
} else if (dependency === 'module') {
return moduleImpl;
} else if (dependency === 'require') {
return this._createLocalRequire(module);
} else {
const dependencyModule = config.getDependency(
module.name,
dependency
);
if (!dependencyModule) {
throw new Error(
`Unsatisfied dependency: ${dependency} ` +
`found in module ${module.name}`
);
}
Iif (
!dependencyModule.implementation &&
!dependencyModule.implemented
) {
throw new Error(
'Module "' +
dependencyModule.name +
'" has not been loaded yet for context: ' +
module.name
);
}
return dependencyModule.implementation;
}
}
);
// Invoke AMD factory function
const result = module.factory(...dependencyImplementations);
// Resolve the implementation
Iif (result !== undefined) {
module.implementation = result;
}
module.implement.resolve(module.implementation);
} catch (err) {
Eif (!module.implement.fulfilled) {
module.implement.reject(err);
}
throw err;
}
});
}
/**
* Create a function implementing the local require method of the AMD
* specification.
* @param {Object} module a module descriptor
* @return {function} the local require implementation for the given module
*/
_createLocalRequire(module) {
const config = this._config;
const localRequire = (moduleName, ...rest) => {
Iif (rest.length > 0) {
return this.require(moduleName, ...rest);
} else {
const dependencyModule = config.getDependency(
module.name,
moduleName
);
Iif (
!dependencyModule ||
!('implementation' in dependencyModule)
) {
throw new Error(
'Module "' +
moduleName +
'" has not been loaded yet for context: ' +
module.name
);
}
return dependencyModule.implementation;
}
};
localRequire.toUrl = moduleName => {
const moduleURLs = this._urlBuilder.build([moduleName]);
return moduleURLs[0].url;
};
return localRequire;
}
/**
* Retrieves module implementations to an array.
* @param {array} moduleNames list of modules, which implementations
* will be collected
* @return {array} list of modules implementations.
*/
_getModuleImplementations(moduleNames) {
const config = this._config;
return config
.getModules(moduleNames)
.map(module => module.implementation);
}
}
Loader.prototype.define.amd = {};
|