feat: add className property to EggPrototypeInfo (#158)

eggjs · Sep 20, 2023 · bddac97 · bddac97
1 parent a775d34
commit bddac97
Show file tree

Hide file tree

Showing 11 changed files with 66 additions and 4 deletions.
diff --git a/core/core-decorator/src/decorator/MultiInstanceProto.ts b/core/core-decorator/src/decorator/MultiInstanceProto.ts
@@ -52,17 +52,18 @@ export function MultiInstanceProto(param: MultiInstancePrototypeParams) {
       const property: EggMultiInstancePrototypeInfo = {
         ...DEFAULT_PARAMS,
         ...param as MultiInstancePrototypeStaticParams,
+        className: clazz.name,
       };
       PrototypeUtil.setMultiInstanceStaticProperty(clazz, property);
     } else if ((param as MultiInstancePrototypeCallbackParams).getObjects) {
       const property: EggMultiInstanceCallbackPrototypeInfo = {
         ...DEFAULT_PARAMS,
         ...param as MultiInstancePrototypeCallbackParams,
+        className: clazz.name,
       };
       PrototypeUtil.setMultiInstanceCallbackProperty(clazz, property);
     }
 
-
     // './tegg/core/common-util/src/StackUtil.ts',
     // './tegg/core/core-decorator/src/decorator/Prototype.ts',
     // './tegg/core/core-decorator/node_modules/[email protected]@reflect-metadata/Reflect.js',

diff --git a/core/core-decorator/src/decorator/Prototype.ts b/core/core-decorator/src/decorator/Prototype.ts
@@ -26,6 +26,7 @@ export function Prototype(param?: PrototypeParams) {
     const property: Partial<EggPrototypeInfo> = {
       ...DEFAULT_PARAMS,
       ...param,
+      className: clazz.name,
     };
     if (!property.name) {
       property.name = NameUtil.getClassName(clazz);

diff --git a/core/core-decorator/src/model/EggMultiInstancePrototypeInfo.ts b/core/core-decorator/src/model/EggMultiInstancePrototypeInfo.ts
@@ -13,6 +13,10 @@ export interface MultiInstancePrototypeGetObjectsContext {
 }
 
 export interface EggMultiInstancePrototypeInfo {
+  /**
+   * The class name of the object
+   */
+  className?: string;
   /**
    * obj init type
    */
@@ -33,6 +37,10 @@ export interface EggMultiInstancePrototypeInfo {
 }
 
 export interface EggMultiInstanceCallbackPrototypeInfo {
+  /**
+   * The class name of the object
+   */
+  className?: string;
   /**
    * obj init type
    */

diff --git a/core/core-decorator/src/model/EggPrototypeInfo.ts b/core/core-decorator/src/model/EggPrototypeInfo.ts
@@ -10,6 +10,10 @@ export interface EggPrototypeInfo {
    * egg object name
    */
   name: EggPrototypeName;
+  /**
+   * The class name of the object
+   */
+  className?: string;
   /**
    * obj init type
    */

diff --git a/core/core-decorator/test/decorators.test.ts b/core/core-decorator/test/decorators.test.ts
@@ -28,6 +28,7 @@ describe('test/decorator.test.ts', () => {
         initType: ObjectInitType.CONTEXT,
         accessLevel: AccessLevel.PUBLIC,
         protoImplType: DEFAULT_PROTO_IMPL_TYPE,
+        className: 'ContextCache',
       };
       assert.deepStrictEqual(PrototypeUtil.getProperty(ContextCache), expectObjectProperty);
     });
@@ -41,6 +42,7 @@ describe('test/decorator.test.ts', () => {
         initType: ObjectInitType.SINGLETON,
         accessLevel: AccessLevel.PUBLIC,
         protoImplType: DEFAULT_PROTO_IMPL_TYPE,
+        className: 'SingletonCache',
       };
       assert.deepStrictEqual(PrototypeUtil.getProperty(SingletonCache), expectObjectProperty);
     });
@@ -112,6 +114,7 @@ describe('test/decorator.test.ts', () => {
             value: 'foo2',
           }],
         }],
+        className: 'FooLogger',
       };
       assert.deepStrictEqual(PrototypeUtil.getMultiInstanceProperty(FooLogger, {
         unitPath: 'foo',

diff --git a/core/metadata/src/factory/EggPrototypeCreatorFactory.ts b/core/metadata/src/factory/EggPrototypeCreatorFactory.ts
@@ -28,6 +28,7 @@ export class EggPrototypeCreatorFactory {
           initType: multiInstanceProtoInfo.initType,
           accessLevel: multiInstanceProtoInfo.accessLevel,
           qualifiers: obj.qualifiers,
+          className: multiInstanceProtoInfo.className,
         });
       }
     } else {

diff --git a/core/metadata/src/impl/EggPrototypeBuilder.ts b/core/metadata/src/impl/EggPrototypeBuilder.ts
@@ -40,6 +40,7 @@ export class EggPrototypeBuilder {
   private injectObjects: Array<InjectObject> = [];
   private loadUnit: LoadUnit;
   private qualifiers: QualifierInfo[] = [];
+  private className?: string;
 
   static create(ctx: EggPrototypeLifecycleContext): EggPrototype {
     const { clazz, loadUnit } = ctx;
@@ -48,6 +49,7 @@ export class EggPrototypeBuilder {
     const builder = new EggPrototypeBuilder();
     builder.clazz = clazz;
     builder.name = ctx.prototypeInfo.name;
+    builder.className = ctx.prototypeInfo.className;
     builder.initType = ctx.prototypeInfo.initType;
     builder.accessLevel = ctx.prototypeInfo.accessLevel;
     builder.filepath = filepath!;
@@ -131,6 +133,7 @@ export class EggPrototypeBuilder {
       injectObjectProtos,
       this.loadUnit.id,
       this.qualifiers,
+      this.className,
     );
   }
 }

diff --git a/core/metadata/src/impl/EggPrototypeImpl.ts b/core/metadata/src/impl/EggPrototypeImpl.ts
@@ -20,6 +20,7 @@ export class EggPrototypeImpl implements EggPrototype {
   readonly accessLevel: AccessLevel;
   readonly injectObjects: InjectObjectProto[];
   readonly loadUnitId: Id;
+  readonly className?: string;
 
   constructor(
     id: string,
@@ -31,6 +32,7 @@ export class EggPrototypeImpl implements EggPrototype {
     injectObjectMap: InjectObjectProto[],
     loadUnitId: Id,
     qualifiers: QualifierInfo[],
+    className?: string,
   ) {
     this.id = id;
     this.clazz = clazz;
@@ -41,6 +43,7 @@ export class EggPrototypeImpl implements EggPrototype {
     this.injectObjects = injectObjectMap;
     this.loadUnitId = loadUnitId;
     this.qualifiers = qualifiers;
+    this.className = className;
   }
 
   verifyQualifiers(qualifiers: QualifierInfo[]): boolean {

diff --git a/core/metadata/src/model/EggPrototype.ts b/core/metadata/src/model/EggPrototype.ts
@@ -45,6 +45,7 @@ export interface EggPrototype extends LifecycleObject<EggPrototypeLifecycleConte
   readonly accessLevel: AccessLevel;
   readonly loadUnitId: string;
   readonly injectObjects: InjectObjectProto[];
+  readonly className?: string;
 
   /**
    * get metedata for key

diff --git a/core/metadata/test/LoadUnit.test.ts b/core/metadata/test/LoadUnit.test.ts
@@ -17,9 +17,10 @@ describe('test/LoadUnit/LoadUnit.test.ts', () => {
       const appRepoProto = loadUnit.getEggPrototype('appRepo', [{ attribute: InitTypeQualifierAttribute, value: ObjectInitType.SINGLETON }]);
       const sprintRepoProto = loadUnit.getEggPrototype('sprintRepo', [{ attribute: InitTypeQualifierAttribute, value: ObjectInitType.SINGLETON }]);
       const userRepoProto = loadUnit.getEggPrototype('userRepo', [{ attribute: InitTypeQualifierAttribute, value: ObjectInitType.SINGLETON }]);
-      assert(appRepoProto);
-      assert(sprintRepoProto);
-      assert(userRepoProto);
+      assert.strictEqual(appRepoProto.length, 1);
+      assert.strictEqual(appRepoProto[0].className, 'AppRepo');
+      assert.strictEqual(sprintRepoProto.length, 1);
+      assert.strictEqual(userRepoProto.length, 1);
       await LoadUnitFactory.destroyLoadUnit(loadUnit);
     });
 
@@ -92,6 +93,7 @@ describe('test/LoadUnit/LoadUnit.test.ts', () => {
       const foo2Prototype = loadUnit.getEggPrototype('foo', [{ attribute: FOO_ATTRIBUTE, value: 'foo2' }]);
       assert(foo1Prototype);
       assert(foo1Prototype.length === 1);
+      assert.strictEqual(foo1Prototype[0].className, 'FooLogger');
       assert(foo2Prototype);
       assert(foo2Prototype.length === 1);
       await LoadUnitFactory.destroyLoadUnit(loadUnit);

diff --git a/standalone/standalone/test/index.test.ts b/standalone/standalone/test/index.test.ts
@@ -161,4 +161,39 @@ describe('test/index.test.ts', () => {
         `withCrossAroundResult(withPointAroundResult(hello withPointAroundParam(withCrosscutAroundParam(aop))${JSON.stringify(pointcutAdviceParams)})${JSON.stringify(crosscutAdviceParams)})`);
     });
   });
+
+  describe('load', () => {
+    let runner: Runner;
+    afterEach(async () => {
+      if (runner) await runner.destroy();
+    });
+
+    it('should work', async () => {
+      runner = new Runner(path.join(__dirname, './fixtures/simple'));
+      const loadunits = await runner.load();
+      for (const loadunit of loadunits) {
+        for (const proto of loadunit.iterateEggPrototype()) {
+          if (proto.id.match(/:hello$/)) {
+            assert.strictEqual(proto.className, 'Hello');
+          } else if (proto.id.match(/:moduleConfigs$/)) {
+            assert.strictEqual(proto.className, undefined);
+          } else if (proto.id.match(/:moduleConfig$/)) {
+            assert.strictEqual(proto.className, undefined);
+          }
+        }
+      }
+    });
+
+    it('should work with multi', async () => {
+      runner = new Runner(path.join(__dirname, './fixtures/multi-callback-instance-module'));
+      const loadunits = await runner.load();
+      for (const loadunit of loadunits) {
+        for (const proto of loadunit.iterateEggPrototype()) {
+          if (proto.id.match(/:dynamicLogger$/)) {
+            assert.strictEqual(proto.className, 'DynamicLogger');
+          }
+        }
+      }
+    });
+  });
 });