jsii-reflect 1.91.0 → 1.93.0

package/lib/_memoized.d.ts

@@ -1,3 +1,4 @@
+import { TypeSystem } from './type-system';
 /**
  * Decorates property readers for readonly properties so that their results are
  * memoized in a `WeakMap`-based cache. Those properties will consequently be
@@ -5,6 +6,13 @@
  *
  * This can only be applied to property accessors (`public get foo(): any`), and not to
  * property declarations (`public readonly foo: any`).
+ *
+ * This should not be applied to any computations relying on a typesystem.
+ * The typesystem can be changed and thus change the result of the call.
+ * Use `memoizedWhenLocked` instead.
  */
 export declare function memoized(_prototype: unknown, propertyKey: string, descriptor: PropertyDescriptor): void;
+export declare function memoizedWhenLocked<T extends {
+    system: TypeSystem;
+}>(_prototype: T, propertyKey: string, descriptor: PropertyDescriptor): void;
 //# sourceMappingURL=_memoized.d.ts.map

package/lib/_memoized.js

@@ -1,25 +1,10 @@
 "use strict";
-/* eslint-disable @typescript-eslint/ban-types -- WeakMap<T, _> demands T extends object */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.memoized = void 0;
+exports.memoizedWhenLocked = exports.memoized = void 0;
+/* eslint-disable @typescript-eslint/ban-types -- WeakMap<T, _> demands T extends object */
 const CACHE = new WeakMap();
-/**
- * Decorates property readers for readonly properties so that their results are
- * memoized in a `WeakMap`-based cache. Those properties will consequently be
- * computed exactly once.
- *
- * This can only be applied to property accessors (`public get foo(): any`), and not to
- * property declarations (`public readonly foo: any`).
- */
-function memoized(_prototype, propertyKey, descriptor) {
-    if (!descriptor.get) {
-        throw new Error(`@memoized can only be applied to property getters!`);
-    }
-    if (descriptor.set) {
-        throw new Error(`@memoized can only be applied to readonly properties!`);
-    }
-    const original = descriptor.get;
-    descriptor.get = function memoizedGet() {
+function memoizedGet(original, propertyKey) {
+    return function () {
         let cache = CACHE.get(this);
         if (cache == null) {
             cache = new Map();
@@ -39,5 +24,43 @@ function memoized(_prototype, propertyKey, descriptor) {
         return result;
     };
 }
+/**
+ * Decorates property readers for readonly properties so that their results are
+ * memoized in a `WeakMap`-based cache. Those properties will consequently be
+ * computed exactly once.
+ *
+ * This can only be applied to property accessors (`public get foo(): any`), and not to
+ * property declarations (`public readonly foo: any`).
+ *
+ * This should not be applied to any computations relying on a typesystem.
+ * The typesystem can be changed and thus change the result of the call.
+ * Use `memoizedWhenLocked` instead.
+ */
+function memoized(_prototype, propertyKey, descriptor) {
+    if (!descriptor.get) {
+        throw new Error(`@memoized can only be applied to property getters!`);
+    }
+    if (descriptor.set) {
+        throw new Error(`@memoized can only be applied to readonly properties!`);
+    }
+    const original = descriptor.get;
+    descriptor.get = memoizedGet(original, propertyKey);
+}
 exports.memoized = memoized;
+function memoizedWhenLocked(_prototype, propertyKey, descriptor) {
+    if (!descriptor.get) {
+        throw new Error(`@memoized can only be applied to property getters!`);
+    }
+    if (descriptor.set) {
+        throw new Error(`@memoized can only be applied to readonly properties!`);
+    }
+    const original = descriptor.get;
+    descriptor.get = function () {
+        if (this.system.isLocked) {
+            return memoizedGet(original, propertyKey).call(this);
+        }
+        return original.call(this);
+    };
+}
+exports.memoizedWhenLocked = memoizedWhenLocked;
 //# sourceMappingURL=_memoized.js.map

package/lib/class.d.ts

@@ -25,8 +25,14 @@ export declare class ClassType extends ReferenceType {
     get abstract(): boolean;
     /**
      * Returns list of all base classes (first is the direct base and last is the top-most).
+     *
+     * @deprecated use ClassType.ancestors instead
      */
     getAncestors(): ClassType[];
+    /**
+     * Returns list of all base classes (first is the direct base and last is the top-most).
+     */
+    get ancestors(): ClassType[];
     /**
      * Lists all properties in this class.
      * @param inherited include all properties inherited from base classes (default: false)

package/lib/class.js

@@ -1,6 +1,13 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClassType = void 0;
+const _memoized_1 = require("./_memoized");
 const initializer_1 = require("./initializer");
 const method_1 = require("./method");
 const property_1 = require("./property");
@@ -42,12 +49,20 @@ class ClassType extends reference_type_1.ReferenceType {
     }
     /**
      * Returns list of all base classes (first is the direct base and last is the top-most).
+     *
+     * @deprecated use ClassType.ancestors instead
      */
     getAncestors() {
+        return this.ancestors;
+    }
+    /**
+     * Returns list of all base classes (first is the direct base and last is the top-most).
+     */
+    get ancestors() {
         const out = new Array();
         if (this.base) {
             out.push(this.base);
-            out.push(...this.base.getAncestors());
+            out.push(...this.base.ancestors);
         }
         return out;
     }
@@ -106,6 +121,12 @@ class ClassType extends reference_type_1.ReferenceType {
         return result;
     }
 }
+__decorate([
+    _memoized_1.memoizedWhenLocked
+], ClassType.prototype, "base", null);
+__decorate([
+    _memoized_1.memoizedWhenLocked
+], ClassType.prototype, "ancestors", null);
 exports.ClassType = ClassType;
 function flatten(xs) {
     return Array.prototype.concat([], ...xs);

package/lib/method.js

@@ -1,6 +1,13 @@
 "use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Method = exports.INITIALIZER_NAME = void 0;
+const _memoized_1 = require("./_memoized");
 const callable_1 = require("./callable");
 const optional_value_1 = require("./optional-value");
 const type_member_1 = require("./type-member");
@@ -55,5 +62,8 @@ class Method extends callable_1.Callable {
         return !!this.spec.static;
     }
 }
+__decorate([
+    _memoized_1.memoizedWhenLocked
+], Method.prototype, "overrides", null);
 exports.Method = Method;
 //# sourceMappingURL=method.js.map

package/lib/type-system.d.ts

@@ -12,10 +12,19 @@ export declare class TypeSystem {
     readonly roots: Assembly[];
     private readonly _assemblyLookup;
     private readonly _cachedClasses;
+    private _locked;
+    get isLocked(): boolean;
     /**
      * All assemblies in this type system.
      */
     get assemblies(): readonly Assembly[];
+    /**
+     * Locks the TypeSystem from further changes
+     *
+     * Call this once all assemblies have been loaded.
+     * This allows the reflection to optimize and cache certain expensive calls.
+     */
+    lock(): void;
     /**
      * Load all JSII dependencies of the given NPM package directory.
      *

package/lib/type-system.js

@@ -17,6 +17,10 @@ class TypeSystem {
         this.roots = new Array();
         this._assemblyLookup = new Map();
         this._cachedClasses = new Map();
+        this._locked = false;
+    }
+    get isLocked() {
+        return this._locked;
     }
     /**
      * All assemblies in this type system.
@@ -24,6 +28,15 @@ class TypeSystem {
     get assemblies() {
         return Array.from(this._assemblyLookup.values());
     }
+    /**
+     * Locks the TypeSystem from further changes
+     *
+     * Call this once all assemblies have been loaded.
+     * This allows the reflection to optimize and cache certain expensive calls.
+     */
+    lock() {
+        this._locked = true;
+    }
     /**
      * Load all JSII dependencies of the given NPM package directory.
      *
@@ -120,6 +133,9 @@ class TypeSystem {
         return this.addAssembly(assembly, options);
     }
     addAssembly(asm, options = {}) {
+        if (this.isLocked) {
+            throw new Error('The typesystem has been locked from further changes');
+        }
         if (asm.system !== this) {
             throw new Error('Assembly has been created for different typesystem');
         }

package/lib/type.js

@@ -105,7 +105,7 @@ class Type {
             return this.getInterfaces(true).some((iface) => iface === base);
         }
         if (this.isClassType() && base.isClassType()) {
-            return this.getAncestors().some((clazz) => clazz === base);
+            return this.ancestors.some((clazz) => clazz === base);
         }
         return false;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsii-reflect",
-  "version": "1.91.0",
+  "version": "1.93.0",
   "description": "strongly-typed reflection library and tools for jsii",
   "license": "Apache-2.0",
   "author": {
@@ -34,18 +34,18 @@
     "package": "package-js"
   },
   "dependencies": {
-    "@jsii/check-node": "1.91.0",
-    "@jsii/spec": "^1.91.0",
+    "@jsii/check-node": "1.93.0",
+    "@jsii/spec": "^1.93.0",
     "chalk": "^4",
     "fs-extra": "^10.1.0",
-    "oo-ascii-tree": "^1.91.0",
+    "oo-ascii-tree": "^1.93.0",
     "yargs": "^16.2.0"
   },
   "devDependencies": {
-    "@scope/jsii-calc-lib": "^1.91.0",
+    "@scope/jsii-calc-lib": "^1.93.0",
     "@types/fs-extra": "^9.0.13",
-    "jsii": "^1.91.0",
-    "jsii-build-tools": "^1.91.0",
+    "jsii": "^1.93.0",
+    "jsii-build-tools": "^1.93.0",
     "jsii-calc": "^3.20.120"
   }
 }

package/test/_memoized.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=_memoized.test.d.ts.map

package/test/_memoized.test.js

@@ -0,0 +1,77 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lib_1 = require("../lib");
+const _memoized_1 = require("../lib/_memoized");
+const accessorSpy = jest.fn(() => 'foobar');
+class TestClass {
+    constructor(system) {
+        this.system = system;
+    }
+    get uncached() {
+        return accessorSpy();
+    }
+    get cached() {
+        return accessorSpy();
+    }
+    get cachedWhenLocked() {
+        return accessorSpy();
+    }
+}
+__decorate([
+    _memoized_1.memoized
+], TestClass.prototype, "cached", null);
+__decorate([
+    _memoized_1.memoizedWhenLocked
+], TestClass.prototype, "cachedWhenLocked", null);
+// eslint-disable-next-line @typescript-eslint/no-empty-function
+function noop(_val) { }
+describe('memoized', () => {
+    beforeEach(() => {
+        accessorSpy.mockClear();
+    });
+    const subject = new TestClass(new lib_1.TypeSystem());
+    test('cached property is memoized', () => {
+        // Access the property twice
+        noop(subject.cached);
+        noop(subject.cached);
+        expect(accessorSpy).toHaveBeenCalledTimes(1);
+        expect(subject.cached).toBe('foobar');
+    });
+    test('uncached property is not memoized', () => {
+        // Access the property twice
+        noop(subject.uncached);
+        noop(subject.uncached);
+        expect(accessorSpy).toHaveBeenCalledTimes(2);
+        expect(subject.uncached).toBe('foobar');
+    });
+});
+describe('memoizedWhenLocked', () => {
+    let subject;
+    beforeEach(() => {
+        accessorSpy.mockClear();
+        subject = new TestClass(new lib_1.TypeSystem());
+    });
+    test('property is memoized when the typesystem is locked', () => {
+        // Lock the typesystem to enable memoizing
+        subject.system.lock();
+        // Access the property twice
+        noop(subject.cachedWhenLocked);
+        noop(subject.cachedWhenLocked);
+        expect(accessorSpy).toHaveBeenCalledTimes(1);
+        expect(subject.cachedWhenLocked).toBe('foobar');
+    });
+    test('property is not memoized when the typesystem is not locked', () => {
+        // Access the property twice
+        noop(subject.cachedWhenLocked);
+        noop(subject.cachedWhenLocked);
+        expect(accessorSpy).toHaveBeenCalledTimes(2);
+        expect(subject.cachedWhenLocked).toBe('foobar');
+    });
+});
+//# sourceMappingURL=_memoized.test.js.map