-
Notifications
You must be signed in to change notification settings - Fork 244
/
kernel.ts
1136 lines (941 loc) · 39.5 KB
/
kernel.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
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
import * as fs from 'fs-extra';
import * as spec from 'jsii-spec';
import * as path from 'path';
import { SourceMapConsumer } from 'source-map';
import * as tar from 'tar';
import * as vm from 'vm';
import * as api from './api';
import { TOKEN_DATE, TOKEN_ENUM, TOKEN_REF } from './api';
/**
* Added to objects and contains the objid (the object reference).
* Used to find the object id from an object.
*/
const OBJID_PROP = '$__jsii__objid__$';
const FQN_PROP = '$__jsii__fqn__$';
/**
* A special FQN that can be used to create empty javascript objects.
*/
const EMPTY_OBJECT_FQN = 'Object';
export class Kernel {
/**
* Set to true for verbose debugging.
*/
public traceEnabled = false;
private assemblies: { [name: string]: Assembly } = { };
private objects: { [objid: string]: any } = { };
private cbs: { [cbid: string]: Callback } = { };
private waiting: { [cbid: string]: Callback } = { };
private promises: { [prid: string]: AsyncInvocation } = { };
private nextid = 10000; // incrementing counter for objid, cbid, promiseid
private syncInProgress?: string; // forbids async calls (begin) while processing sync calls (get/set/invoke)
private installDir?: string;
private readonly sandbox: vm.Context;
private readonly sourceMaps: { [assm: string]: SourceMapConsumer } = {};
/**
* Creates a jsii kernel object.
*
* @param callbackHandler This handler is invoked when a synchronous callback is called.
* It's responsibility is to execute the callback and return it's
* result (or throw an error).
*/
constructor(public callbackHandler: (callback: api.Callback) => any) {
// `setImmediate` is required for tests to pass (it is otherwise
// impossible to wait for in-VM promises to complete)
// `Buffer` is required when using simple-resource-bundler.
// HACK: when we webpack jsii-runtime, all "require" statements get transpiled,
// so modules can be resolved within the pack. However, here we actually want to
// let loaded modules to use the native node "require" method.
// I wonder if webpack has some pragma that allows opting-out at certain points
// in the code.
const moduleLoad = require('module').Module._load;
const nodeRequire = (p: string) => moduleLoad(p, module, false);
this.sandbox = vm.createContext({
Buffer, // to use simple-resource-bundler
setImmediate, // async tests
require: nodeRequire // modules need to "require"
});
}
public async load(req: api.LoadRequest): Promise<api.LoadResponse> {
this._debug('load', req);
if ('assembly' in req) {
throw new Error('`assembly` field is deprecated for "load", use `name`, `version` and `tarball` instead');
}
if (!this.installDir) {
this.installDir = await fs.mkdtemp('/tmp/jsii-kernel-');
await fs.mkdirp(path.join(this.installDir, 'node_modules'));
this._debug('creating jsii-kernel modules workdir:', this.installDir);
process.on('exit', () => {
if (this.installDir) {
this._debug('removing install dir', this.installDir);
fs.removeSync(this.installDir); // can't use async version during exit
}
});
}
const pkgname = req.name;
const pkgver = req.version;
// check if we already have such a module
const packageDir = path.join(this.installDir, 'node_modules', pkgname);
if (await fs.pathExists(packageDir)) {
// module exists, verify version
const epkg = await fs.readJson(path.join(packageDir, 'package.json'));
if (epkg.version !== pkgver) {
throw new Error(`Multiple versions ${pkgver} and ${epkg.version} of the `
+ `package '${pkgname}' cannot be loaded together since this is unsupported by `
+ `some runtime environments`);
}
// same version, no-op
this._debug('look up already-loaded assembly', pkgname);
const assm = this.assemblies[pkgname];
return {
assembly: assm.metadata.name,
types: Object.keys(assm.metadata.types || {}).length,
};
} else {
// untar the archive to a staging directory, read the jsii spec from it
// and then move it to the node_modules directory of the kernel.
const staging = await fs.mkdtemp('/tmp/jsii-kernel-install-staging-');
try {
await tar.extract({ strict: true, file: req.tarball, cwd: staging });
// read .jsii metadata from the root of the package
const jsiiMetadataFile = path.join(staging, 'package', spec.SPEC_FILE_NAME);
if (!(await fs.pathExists(jsiiMetadataFile))) {
throw new Error(`Package tarball ${req.tarball} must have a file named ${spec.SPEC_FILE_NAME} at the root`);
}
const assmSpec = await fs.readJson(jsiiMetadataFile) as spec.Assembly;
// "install" to "node_modules" directory
await fs.move(path.join(staging, 'package'), packageDir);
// load the module and capture it's closure
const closure = this._execute(`require("${packageDir}")`, packageDir);
const assm = new Assembly(assmSpec, closure);
this._addAssembly(assm);
return {
assembly: assmSpec.name,
types: Object.keys(assmSpec.types || {}).length,
};
} finally {
this._debug('removing staging directory:', staging);
await fs.remove(staging);
}
}
}
public create(req: api.CreateRequest): api.CreateResponse {
return this._create(req);
}
public del(req: api.DelRequest): api.DelResponse {
const { objref } = req;
this._debug('del', objref);
this._findObject(objref); // make sure object exists
delete this.objects[objref[TOKEN_REF]];
return { };
}
public sget(req: api.StaticGetRequest): api.GetResponse {
const { fqn, property } = req;
const symbol = `${fqn}.${property}`;
this._debug('sget', symbol);
const ti = this._typeInfoForProperty(fqn, property);
if (!ti.static) {
throw new Error(`property ${symbol} is not static`);
}
const prototype = this._findSymbol(fqn);
const value = this._ensureSync(`property ${property}`, () =>
this._wrapSandboxCode(() => prototype[property]));
this._debug('value:', value);
const ret = this._fromSandbox(value, ti.type);
this._debug('ret', ret);
return { value: ret };
}
public sset(req: api.StaticSetRequest): api.SetResponse {
const { fqn, property, value } = req;
const symbol = `${fqn}.${property}`;
this._debug('sset', symbol);
const ti = this._typeInfoForProperty(fqn, property);
if (!ti.static) {
throw new Error(`property ${symbol} is not static`);
}
if (ti.immutable) {
throw new Error(`static property ${symbol} is readonly`);
}
const prototype = this._findSymbol(fqn);
this._ensureSync(`property ${property}`, () =>
this._wrapSandboxCode(() => prototype[property] = this._toSandbox(value)));
return {};
}
public get(req: api.GetRequest): api.GetResponse {
const { objref, property } = req;
this._debug('get', objref, property);
const obj = this._findObject(objref);
const fqn = this._fqnForObject(obj);
const ti = this._typeInfoForProperty(fqn, property);
// if the property is overridden by the native code and "get" is called on the object, it
// means that the native code is trying to access the "super" property. in order to enable
// that, we actually keep a copy of the original property descriptor when we override,
// so `findPropertyTarget` will return either the original property name ("property") or
// the "super" property name (somehing like "$jsii$super$<property>$").
const propertyToGet = this._findPropertyTarget(obj, property);
// make the actual "get", and block any async calls that might be performed
// by jsii overrides.
const value = this._ensureSync(`property '${objref[TOKEN_REF]}.${propertyToGet}'`,
() => this._wrapSandboxCode(() => obj[propertyToGet]));
this._debug('value:', value);
const ret = this._fromSandbox(value, ti.type);
this._debug('ret:', ret);
return { value: ret };
}
public set(req: api.SetRequest): api.SetResponse {
const { objref, property, value } = req;
this._debug('set', objref, property, value);
const obj = this._findObject(objref);
const fqn = this._fqnForObject(obj);
const propInfo = this._typeInfoForProperty(fqn, req.property);
if (propInfo.immutable) {
throw new Error(`Cannot set value of immutable property ${req.property} to ${req.value}`);
}
const propertyToSet = this._findPropertyTarget(obj, property);
this._ensureSync(`property '${objref[TOKEN_REF]}.${propertyToSet}'`,
() => this._wrapSandboxCode(() => obj[propertyToSet] = this._toSandbox(value)));
return { };
}
public invoke(req: api.InvokeRequest): api.InvokeResponse {
const { objref, method } = req;
const args = req.args || [ ];
this._debug('invoke', objref, method, args);
const { ti, obj, fn } = this._findInvokeTarget(objref, method, args);
// verify this is not an async method
if (ti.returns && ti.returns.promise) {
throw new Error(`${method} is an async method, use "begin" instead`);
}
const ret = this._ensureSync(`method '${objref[TOKEN_REF]}.${method}'`, () => {
return this._wrapSandboxCode(() => fn.apply(obj, this._toSandboxValues(args)));
});
return { result: this._fromSandbox(ret, ti.returns) };
}
public sinvoke(req: api.StaticInvokeRequest): api.InvokeResponse {
const { fqn, method } = req;
const args = req.args || [ ];
this._debug('sinvoke', fqn, method, args);
const ti = this._typeInfoForMethod(fqn, method);
if (!ti.static) {
throw new Error(`${fqn}.${method} is not a static method`);
}
// verify this is not an async method
if (ti.returns && ti.returns.promise) {
throw new Error(`${method} is an async method, use "begin" instead`);
}
const prototype = this._findSymbol(fqn);
const fn = prototype[method];
const ret = this._ensureSync(`method '${fqn}.${method}'`, () => {
return this._wrapSandboxCode(() => fn.apply(null, this._toSandboxValues(args)));
});
this._debug('method returned:', ret);
return { result: this._fromSandbox(ret, ti.returns) };
}
public begin(req: api.BeginRequest): api.BeginResponse {
const { objref, method } = req;
const args = req.args || [ ];
this._debug('begin', objref, method, args);
if (this.syncInProgress) {
// tslint:disable-next-line:max-line-length
throw new Error(`Cannot invoke async method '${req.objref[TOKEN_REF]}.${req.method}' while sync ${this.syncInProgress} is being processed`);
}
const { ti, obj, fn } = this._findInvokeTarget(objref, method, args);
// verify this is indeed an async method
if (!ti.returns || !ti.returns.promise) {
throw new Error(`Method ${method} is expected to be an async method`);
}
const promise = this._wrapSandboxCode(() => fn.apply(obj, this._toSandboxValues(args))) as Promise<any>;
// since we are planning to resolve this promise in a different scope
// we need to handle rejections here [1]
// [1]: https://stackoverflow.com/questions/40920179/should-i-refrain-from-handling-promise-rejection-asynchronously/40921505
promise.catch(_ => undefined);
const prid = this._makeprid();
this.promises[prid] = {
promise,
method: ti
};
return { promiseid: prid };
}
public async end(req: api.EndRequest): Promise<api.EndResponse> {
const { promiseid } = req;
this._debug('end', promiseid);
const { promise, method } = this.promises[promiseid];
if (!promise) {
throw new Error(`Cannot find promise with ID: ${promiseid}`);
}
let result;
try {
result = await promise;
this._debug('promise result:', result);
} catch (e) {
this._debug('promise error:', e);
throw mapSource(e, this.sourceMaps);
}
return { result: this._fromSandbox(result, method.returns) };
}
public callbacks(_req?: api.CallbacksRequest): api.CallbacksResponse {
this._debug('callbacks');
const ret = Object.keys(this.cbs).map(cbid => {
const cb = this.cbs[cbid];
this.waiting[cbid] = cb; // move to waiting
const callback: api.Callback = {
cbid,
cookie: cb.override.cookie,
invoke: {
objref: cb.objref,
method: cb.override.method!,
args: cb.args
},
};
return callback;
});
// move all callbacks to the wait queue and clean the callback queue.
this.cbs = { };
return { callbacks: ret };
}
public complete(req: api.CompleteRequest): api.CompleteResponse {
const { cbid, err, result } = req;
this._debug('complete', cbid, err, result);
if (!(cbid in this.waiting)) {
throw new Error(`Callback ${cbid} not found`);
}
const cb = this.waiting[cbid];
if (err) {
this._debug('completed with error:', err);
cb.fail(new Error(err));
} else {
const sandoxResult = this._toSandbox(result);
this._debug('completed with result:', sandoxResult);
cb.succeed(sandoxResult);
}
delete this.waiting[cbid];
return { cbid };
}
/**
* Returns the language-specific names for a jsii module.
* @param assemblyName The name of the jsii module (i.e. jsii$jsii_calculator_lib$)
*/
public naming(req: api.NamingRequest): api.NamingResponse {
const assemblyName = req.assembly;
this._debug('naming', assemblyName);
const assembly = this._assemblyFor(assemblyName);
const targets = assembly.metadata.targets;
if (!targets) {
throw new Error(`Unexpected - "targets" for ${assemblyName} is missing!`);
}
return { naming: targets };
}
public stats(_req?: api.StatsRequest): api.StatsResponse {
return {
objectCount: Object.keys(this.objects).length
};
}
private _addAssembly(assm: Assembly) {
this.assemblies[assm.metadata.name] = assm;
// add the __jsii__.fqn property on every constructor. this allows
// traversing between the javascript and jsii worlds given any object.
for (const fqn of Object.keys(assm.metadata.types || {})) {
const typedef = assm.metadata.types![fqn];
switch (typedef.kind) {
case spec.TypeKind.Interface:
continue; // interfaces don't really exist
case spec.TypeKind.Class:
case spec.TypeKind.Enum:
const constructor = this._findSymbol(fqn);
constructor.__jsii__ = { fqn };
}
}
}
// find the javascript constructor function for a jsii FQN.
private _findCtor(fqn: string, args: any[]) {
if (fqn === EMPTY_OBJECT_FQN) {
return Object;
}
const typeinfo = this._typeInfoForFqn(fqn);
switch (typeinfo.kind) {
case spec.TypeKind.Class:
const classType = typeinfo as spec.ClassType;
this._validateMethodArguments(classType.initializer, args);
return this._findSymbol(fqn);
case spec.TypeKind.Interface:
return Object;
default:
throw new Error(`Unexpected FQN kind: ${fqn}`);
}
}
// prefixed with _ to allow calling this method internally without
// getting it recorded for testing.
private _create(req: api.CreateRequest): api.CreateResponse {
const { fqn, overrides } = req;
const requestArgs = req.args || [];
const ctor = this._findCtor(fqn, requestArgs);
const obj = this._wrapSandboxCode(() => new ctor(...this._toSandboxValues(requestArgs)));
const objref = this._createObjref(obj, fqn);
// overrides: for each one of the override method names, installs a
// method on the newly created object which represents the remote
// override. Overrides are always async. When an override is called, it
// returns a promise which adds a callback to the pending callbacks
// list. This list is then retrieved by the client (using
// pendingCallbacks() and promises are fulfilled using
// completeCallback(), which in turn, fulfills the internal promise.
if (overrides) {
this._debug('overrides', overrides);
const overrideTypeErrorMessage = 'Override can either be "method" or "property"';
const methods = new Set<string>();
const properties = new Set<string>();
for (const override of overrides) {
if (override.method) {
if (override.property) { throw new Error(overrideTypeErrorMessage); }
if (methods.has(override.method)) { throw new Error(`Duplicate override for method '${override.method}'`); }
methods.add(override.method);
// check that the method being overridden actually exists on the
// class and is an async method.
let methodInfo;
if (fqn !== EMPTY_OBJECT_FQN) {
methodInfo = this._tryTypeInfoForMethod(fqn, override.method); // throws if method cannot be found
}
this._applyMethodOverride(obj, objref, override, methodInfo);
} else if (override.property) {
if (override.method) { throw new Error(overrideTypeErrorMessage); }
if (properties.has(override.property)) { throw Error(`Duplicate override for property '${override.property}'`); }
properties.add(override.property);
this._applyPropertyOverride(obj, objref, override);
} else {
throw new Error(overrideTypeErrorMessage);
}
}
}
return objref;
}
private _getSuperPropertyName(name: string) {
return `$jsii$super$${name}$`;
}
private _applyPropertyOverride(obj: any, objref: api.ObjRef, override: api.Override) {
const self = this;
const propertyName = override.property!;
this._debug('apply override', propertyName);
// save the old property under $jsii$super$<prop>$ so that property overrides
// can still access it via `super.<prop>`.
const prev = Object.getOwnPropertyDescriptor(obj, propertyName) || {
value: undefined,
writable: true,
enumerable: true,
configurable: true
};
const prevEnumerable = prev.enumerable;
prev.enumerable = false;
Object.defineProperty(obj, this._getSuperPropertyName(propertyName), prev);
// we add callbacks for both 'get' and 'set', even if the property
// is readonly. this is fine because if you try to set() a readonly
// property, it will fail.
Object.defineProperty(obj, propertyName, {
enumerable: prevEnumerable,
configurable: prev.configurable,
get: () => {
const result = self.callbackHandler({
cookie: override.cookie,
cbid: self._makecbid(),
get: { objref, property: propertyName }
});
this._debug('callback returned', result);
return this._toSandbox(result);
},
set: (value: any) => {
self._debug('virtual set', objref, propertyName, { cookie: override.cookie });
self.callbackHandler({
cookie: override.cookie,
cbid: self._makecbid(),
set: { objref, property: propertyName, value: self._fromSandbox(value) }
});
}
});
}
private _applyMethodOverride(obj: any, objref: api.ObjRef, override: api.Override, methodInfo?: spec.Method) {
const self = this;
const methodName = override.method!;
// note that we are applying the override even if the method doesn't exist
// on the type spec in order to allow native code to override methods from
// interfaces.
if (methodInfo && methodInfo.returns && methodInfo.returns.promise) {
// async method override
Object.defineProperty(obj, methodName, {
enumerable: false,
configurable: false,
writable: false,
value: (...methodArgs: any[]) => {
self._debug('invoked async override', override);
const args = self._toSandboxValues(methodArgs);
return new Promise<any>((succeed, fail) => {
const cbid = self._makecbid();
self._debug('adding callback to queue', cbid);
self.cbs[cbid] = {
objref,
override,
args,
succeed,
fail
};
});
}
});
} else {
// sync method override (method info is not required)
Object.defineProperty(obj, methodName, {
enumerable: false,
configurable: false,
writable: false,
value: (...methodArgs: any[]) => {
const result = self.callbackHandler({
cookie: override.cookie,
cbid: self._makecbid(),
invoke: {
objref,
method: methodName,
args: this._fromSandbox(methodArgs)
}
});
return this._toSandbox(result);
}
});
}
}
private _findInvokeTarget(objref: any, methodName: string, args: any[]) {
const obj = this._findObject(objref);
const fqn = this._fqnForObject(obj);
const ti = this._typeInfoForMethod(fqn, methodName);
this._validateMethodArguments(ti, args);
// always first look up the method in the prototype. this practically bypasses
// any methods overridden by derived classes (which are by definition native
// methods). this serves to allow native call to invoke "super.method()" when
// overriding the method.
// if we didn't find the method on the prototype, it could be a literal object
// that implements an interface, so we look if we have the method on the object
// itself. if we do, we invoke it.
let fn = obj.constructor.prototype[methodName];
if (!fn) {
fn = obj[methodName];
if (!fn) {
throw new Error(`Cannot find ${methodName} on object`);
}
}
return { ti, obj, fn };
}
private _formatTypeRef(typeRef: spec.TypeReference): string {
if (spec.isCollectionTypeReference(typeRef)) {
return `${typeRef.collection.kind}<${this._formatTypeRef(typeRef.collection.elementtype)}>`;
}
if (spec.isNamedTypeReference(typeRef)) {
return typeRef.fqn;
}
if (spec.isPrimitiveTypeReference(typeRef)) {
return typeRef.primitive;
}
if (spec.isUnionTypeReference(typeRef)) {
return typeRef.union.types.map(t => this._formatTypeRef(t)).join(' | ');
}
throw new Error(`Invalid type reference: ${JSON.stringify(typeRef)}`);
}
private _validateMethodArguments(method: spec.Method | undefined, args: any[]) {
const params: spec.Parameter[] = (method && method.parameters) || [];
// error if args > params
if (args.length > params.length && !(method && method.variadic)) {
throw new Error(`Too many arguments (method accepts ${params.length} parameters, got ${args.length} arguments)`);
}
for (let i = 0; i < params.length; ++i) {
const param = params[i];
const arg = args[i];
if (param.variadic) {
if (params.length <= i) { return; } // No vararg was provided
for (let j = i ; j < params.length ; j++) {
if (params[j] === undefined) {
// tslint:disable-next-line:max-line-length
throw new Error(`Unexpected 'undefined' value at index ${j - i} of variadic argument '${param.name}' of type '${this._formatTypeRef(param.type)}'`);
}
}
} else if (!param.type.optional && arg === undefined) {
// tslint:disable-next-line:max-line-length
throw new Error(`Not enough arguments. Missing argument for the required parameter '${param.name}' of type '${this._formatTypeRef(param.type)}'`);
}
}
}
private _assemblyFor(assemblyName: string) {
const assembly = this.assemblies[assemblyName];
if (!assembly) {
throw new Error(`Could not find assembly: ${assemblyName}`);
}
return assembly;
}
private _findSymbol(fqn: string) {
const [ assemblyName, ...parts ] = fqn.split('.');
const assembly = this._assemblyFor(assemblyName);
let curr = assembly.closure;
while (true) {
const name = parts.shift();
if (!name) {
break;
}
curr = curr[name];
}
if (!curr) {
throw new Error(`Could not find symbol ${fqn}`);
}
return curr;
}
private _createObjref(obj: any, fqn: string): api.ObjRef {
const objid = this._mkobjid(fqn);
Object.defineProperty(obj, OBJID_PROP, {
value: objid,
configurable: false,
enumerable: false,
writable: false
});
Object.defineProperty(obj, FQN_PROP, {
value: fqn,
configurable: false,
enumerable: false,
writable: false
});
this.objects[objid] = obj;
return { [TOKEN_REF]: objid };
}
private _findObject(objref: api.ObjRef) {
if (typeof(objref) !== 'object' || !(TOKEN_REF in objref)) {
throw new Error(`Malformed object reference: ${JSON.stringify(objref)}`);
}
const objid = objref[TOKEN_REF];
this._debug('findObject', objid);
const obj = this.objects[objid];
if (!obj) {
throw new Error(`Object ${objid} not found`);
}
return obj;
}
private _typeInfoForFqn(fqn: string): spec.Type {
const components = fqn.split('.');
const moduleName = components[0];
const assembly = this.assemblies[moduleName];
if (!assembly) {
throw new Error(`Module '${moduleName}' not found`);
}
const types = assembly.metadata.types || {};
const fqnInfo = types[fqn];
if (!fqnInfo) {
throw new Error(`Type '${fqn}' not found`);
}
return fqnInfo;
}
private _typeInfoForMethod(fqn: string, methodName: string): spec.Method {
const ti = this._tryTypeInfoForMethod(fqn, methodName);
if (!ti) {
throw new Error(`Class ${fqn} doesn't have a method '${methodName}'`);
}
return ti;
}
private _tryTypeInfoForMethod(fqn: string, methodName: string): spec.Method | undefined {
const typeinfo = this._typeInfoForFqn(fqn);
const methods = (typeinfo as (spec.ClassType | spec.InterfaceType)).methods || [];
const bases = [
(typeinfo as spec.ClassType).base,
...((typeinfo as spec.InterfaceType).interfaces || []) ];
for (const m of methods) {
if (m.name === methodName) {
return m;
}
}
// recursion to parent type (if exists)
for (const base of bases) {
if (!base) { continue; }
const found = this._tryTypeInfoForMethod(base.fqn!, methodName);
if (found) {
return found;
}
}
return undefined;
}
private _typeInfoForProperty(fqn: string, property: string): spec.Property {
if (!fqn) {
throw new Error('missing "fqn"');
}
const typeInfo = this._typeInfoForFqn(fqn);
let properties;
let bases;
if (spec.isClassType(typeInfo)) {
const classTypeInfo = typeInfo as spec.ClassType;
properties = classTypeInfo.properties;
bases = classTypeInfo.base ? [ classTypeInfo.base.fqn ] : [];
} else if (spec.isInterfaceType(typeInfo)) {
const interfaceTypeInfo = typeInfo as spec.InterfaceType;
properties = interfaceTypeInfo.properties;
bases = (interfaceTypeInfo.interfaces || []).map(x => x.fqn);
} else {
throw new Error(`Type of kind ${typeInfo.kind} does not have properties`);
}
for (const p of properties || []) {
if (p.name === property) {
return p;
}
}
// recurse to parent type (if exists)
for (const baseFqn of bases) {
return this._typeInfoForProperty(baseFqn, property);
}
throw new Error(`Type ${typeInfo.fqn} doesn't have a property '${property}'`);
}
private _toSandbox(v: any): any {
// undefined
if (typeof v === 'undefined') {
return undefined;
}
// null
if (v === null) {
return null;
}
// pointer
if (typeof v === 'object' && TOKEN_REF in v) {
return this._findObject(v);
}
// date
if (typeof v === 'object' && TOKEN_DATE in v) {
this._debug('Found date:', v);
return new Date(v[TOKEN_DATE]);
}
// enums
if (typeof v === 'object' && TOKEN_ENUM in v) {
this._debug('Enum:', v);
const value = v[TOKEN_ENUM] as string;
const sep = value.lastIndexOf('/');
if (sep === -1) {
throw new Error(`Malformed enum value: ${v[TOKEN_ENUM]}`);
}
const typeName = value.substr(0, sep);
const valueName = value.substr(sep + 1);
const enumValue = this._findSymbol(typeName)[valueName];
if (enumValue === undefined) {
throw new Error(`No enum member named ${valueName} in ${typeName}`);
}
this._debug('resolved enum value:', enumValue);
return enumValue;
}
// array
if (Array.isArray(v)) {
return v.map(x => this._toSandbox(x));
}
// map
if (typeof v === 'object') {
const out: any = { };
for (const k of Object.keys(v)) {
out[k] = this._toSandbox(v[k]);
}
return out;
}
// primitive
return v;
}
private _fromSandbox(v: any, targetType?: spec.TypeReference): any {
this._debug('fromSandbox', v, targetType);
// undefined is returned as null: true
if (typeof(v) === 'undefined') {
return undefined;
}
// existing object
const objid = v[OBJID_PROP];
if (objid) {
// object already has an objid, return it as a ref.
this._debug('objref exists', objid);
return { [TOKEN_REF]: objid };
}
// new object
if (typeof(v) === 'object' && v.constructor.__jsii__) {
// this is jsii object which was created inside the sandbox and still doesn't
// have an object id, so we need to allocate one for it.
this._debug('creating objref for', v);
const fqn = this._fqnForObject(v);
return this._createObjref(v, fqn);
}
// if the method/property returns an object literal and the return type
// is a class, we create a new object based on the fqn and assign all keys.
// so the client receives a real object.
if (typeof(v) === 'object' && targetType && spec.isNamedTypeReference(targetType)) {
this._debug('coalescing to', targetType);
const newObjRef = this._create({ fqn: targetType.fqn });
const newObj = this._findObject(newObjRef);
for (const k of Object.keys(v)) {
newObj[k] = v[k];
}
return newObjRef;
}
// date (https://stackoverflow.com/a/643827/737957)
if (typeof(v) === 'object' && Object.prototype.toString.call(v) === '[object Date]') {
this._debug('date', v);
return { [TOKEN_DATE]: v.toISOString() };
}
// array
if (Array.isArray(v)) {
this._debug('array', v);
return v.map(x => this._fromSandbox(x));
}
if (targetType && spec.isNamedTypeReference(targetType)) {
const propType = this._typeInfoForFqn(targetType.fqn);
// enum
if (propType.kind === spec.TypeKind.Enum) {
this._debug('enum', v);
const fqn = propType.fqn;
const valueName = this._findSymbol(fqn)[v];
return { [TOKEN_ENUM]: `${propType.fqn}/${valueName}` };
}
}
// map
if (typeof(v) === 'object') {
this._debug('map', v);
const out: any = { };
for (const k of Object.keys(v)) {
out[k] = this._fromSandbox(v[k]);
}
return out;
}
// primitive
this._debug('primitive', v);
return v;
}
private _toSandboxValues(args: any[]) {
return args.map(v => this._toSandbox(v));
}
private _debug(...args: any[]) {
if (this.traceEnabled) {
// tslint:disable-next-line:no-console
console.error.apply(console, [
'[jsii-kernel]',
args[0],
...args.slice(1)
]);
}
}
/**
* Ensures that `fn` is called and defends against beginning to invoke
* async methods until fn finishes (successfully or not).
*/
private _ensureSync<T>(desc: string, fn: () => T): T {
this.syncInProgress = desc;
try {
return fn();
} catch (e) {
throw e;
} finally {