fix(tegg): address review follow-ups

Author: gxkl

tegg/core/aop-runtime/src/LoadUnitAopHook.ts

@@ -17,7 +17,7 @@ export class LoadUnitAopHook implements LifecycleHook<LoadUnitLifecycleContext,
   private readonly crosscutAdviceFactory: CrosscutAdviceFactory;
 
   @Inject()
-  private readonly aopContextAdviceRegistry: AopContextAdviceRegistry = new AopContextAdviceRegistry();
+  private readonly aopContextAdviceRegistry: AopContextAdviceRegistry;
 
   async postCreate(_: LoadUnitLifecycleContext, loadUnit: LoadUnit): Promise<void> {
     for (const proto of loadUnit.iterateEggPrototype()) {

tegg/core/aop-runtime/test/aop-runtime.test.ts

@@ -13,6 +13,7 @@ import { describe, beforeEach, afterEach, it } from 'vitest';
 import { Hello } from './fixtures/modules/hello_succeed/Hello.js';
 
 import { crossCutGraphHook } from '../src/CrossCutGraphHook.js';
+import { AopContextAdviceRegistry } from '../src/AopContextAdviceRegistry.js';
 import { EggObjectAopHook } from '../src/EggObjectAopHook.js';
 import { EggPrototypeCrossCutHook } from '../src/EggPrototypeCrossCutHook.js';
 import { LoadUnitAopHook } from '../src/LoadUnitAopHook.js';
@@ -22,6 +23,13 @@ import { CallTrace } from './fixtures/modules/hello_cross_cut/CallTrace.js';
 import { crosscutAdviceParams } from './fixtures/modules/hello_cross_cut/HelloCrossCut.js';
 import { pointcutAdviceParams } from './fixtures/modules/hello_point_cut/HelloPointCut.js';
 
+function createLoadUnitAopHook(crosscutAdviceFactory: CrosscutAdviceFactory): LoadUnitAopHook {
+  const loadUnitAopHook = new LoadUnitAopHook();
+  Reflect.set(loadUnitAopHook, 'crosscutAdviceFactory', crosscutAdviceFactory);
+  Reflect.set(loadUnitAopHook, 'aopContextAdviceRegistry', new AopContextAdviceRegistry());
+  return loadUnitAopHook;
+}
+
 describe('test/aop-runtime.test.ts', () => {
   afterEach(() => {
     mock.reset();
@@ -37,8 +45,7 @@ describe('test/aop-runtime.test.ts', () => {
     beforeEach(async () => {
       crosscutAdviceFactory = new CrosscutAdviceFactory();
       eggObjectAopHook = new EggObjectAopHook();
-      loadUnitAopHook = new LoadUnitAopHook();
-      Reflect.set(loadUnitAopHook, 'crosscutAdviceFactory', crosscutAdviceFactory);
+      loadUnitAopHook = createLoadUnitAopHook(crosscutAdviceFactory);
       eggPrototypeCrossCutHook = new EggPrototypeCrossCutHook();
       Reflect.set(eggPrototypeCrossCutHook, 'crosscutAdviceFactory', crosscutAdviceFactory);
       EggPrototypeLifecycleUtil.registerLifecycle(eggPrototypeCrossCutHook);
@@ -167,8 +174,7 @@ describe('test/aop-runtime.test.ts', () => {
     beforeEach(async () => {
       crosscutAdviceFactory = new CrosscutAdviceFactory();
       eggObjectAopHook = new EggObjectAopHook();
-      loadUnitAopHook = new LoadUnitAopHook();
-      Reflect.set(loadUnitAopHook, 'crosscutAdviceFactory', crosscutAdviceFactory);
+      loadUnitAopHook = createLoadUnitAopHook(crosscutAdviceFactory);
       eggPrototypeCrossCutHook = new EggPrototypeCrossCutHook();
       Reflect.set(eggPrototypeCrossCutHook, 'crosscutAdviceFactory', crosscutAdviceFactory);
       EggPrototypeLifecycleUtil.registerLifecycle(eggPrototypeCrossCutHook);
@@ -195,8 +201,7 @@ describe('test/aop-runtime.test.ts', () => {
     beforeEach(async () => {
       crosscutAdviceFactory = new CrosscutAdviceFactory();
       eggObjectAopHook = new EggObjectAopHook();
-      loadUnitAopHook = new LoadUnitAopHook();
-      Reflect.set(loadUnitAopHook, 'crosscutAdviceFactory', crosscutAdviceFactory);
+      loadUnitAopHook = createLoadUnitAopHook(crosscutAdviceFactory);
       eggPrototypeCrossCutHook = new EggPrototypeCrossCutHook();
       Reflect.set(eggPrototypeCrossCutHook, 'crosscutAdviceFactory', crosscutAdviceFactory);
       EggPrototypeLifecycleUtil.registerLifecycle(eggPrototypeCrossCutHook);

tegg/core/common-util/src/ModuleConfig.ts

@@ -91,6 +91,7 @@ export class ModuleConfigUtil {
           path: modulePath,
           name: ModuleConfigUtil.getModuleName(pkg),
           package: ModuleConfigUtil.getPackageName(pkg),
+          ...(moduleReferenceConfig.optional === undefined ? {} : { optional: moduleReferenceConfig.optional }),
         };
       } else if (ModuleReferenceConfigHelp.isInlineModuleReference(moduleReferenceConfig)) {
         const modulePath = path.join(configDir, moduleReferenceConfig.path);
@@ -99,6 +100,7 @@ export class ModuleConfigUtil {
           path: modulePath,
           name: ModuleConfigUtil.getModuleName(pkg),
           package: ModuleConfigUtil.getPackageName(pkg),
+          ...(moduleReferenceConfig.optional === undefined ? {} : { optional: moduleReferenceConfig.optional }),
         };
       } else {
         throw new Error('unknown type of module reference config: ' + JSON.stringify(moduleReferenceConfig));

tegg/core/common-util/test/ModuleConfig.test.ts

@@ -137,7 +137,7 @@ describe('test/ModuleConfig.test.ts', () => {
         const ref = ModuleConfigUtil.readModuleReference(fixturesPath);
         assert.deepStrictEqual(ref, [
           { path: path.join(fixturesPath, 'app/module-a'), name: 'moduleA', package: 'module-a' },
-          { path: path.join(fixturesPath, 'app/module-b'), name: 'moduleB', package: 'module-b' },
+          { path: path.join(fixturesPath, 'app/module-b'), name: 'moduleB', package: 'module-b', optional: true },
         ]);
       });
     });
@@ -153,6 +153,7 @@ describe('test/ModuleConfig.test.ts', () => {
             path: path.join(fixturesPath, 'node_modules/module-a'),
             name: 'moduleA',
             package: 'module-a',
+            optional: true,
           },
         ]);
       });

tegg/core/common-util/test/fixtures/apps/app-with-module-json/config/module.json

@@ -1 +1 @@
-[{ "path": "../app/module-a" }, { "path": "../app/module-b" }]
+[{ "path": "../app/module-a" }, { "path": "../app/module-b", "optional": true }]

tegg/core/common-util/test/fixtures/apps/app-with-module-pkg-json/config/module.json

@@ -1 +1 @@
-[{ "package": "module-a" }]
+[{ "package": "module-a", "optional": true }]

tegg/core/loader/test/__snapshots__/index.test.ts.snap

@@ -6,5 +6,6 @@ exports[`should export stable 1`] = `
   "LoaderUtil": [Function],
   "ModuleLoader": [Function],
   "TEGG_MANIFEST_KEY": "tegg",
+  "buildTeggManifestData": [Function],
 }
 `;

tegg/core/metadata/src/errors.ts

@@ -2,6 +2,10 @@ import { FrameworkBaseError } from '@eggjs/errors';
 import { ErrorCodes } from '@eggjs/tegg-types';
 import type { EggPrototypeName, QualifierInfo } from '@eggjs/tegg-types';
 
+function formatQualifiers(qualifiers: readonly QualifierInfo[]): string {
+  return `[${qualifiers.map((qualifier) => `${String(qualifier.attribute)}=${String(qualifier.value)}`).join(',')}]`;
+}
+
 export class TeggError extends FrameworkBaseError {
   get module() {
     return 'TEGG';
@@ -19,7 +23,7 @@ export class EggPrototypeNotFound extends TeggError {
 
 export class MultiPrototypeFound extends TeggError {
   constructor(name: EggPrototypeName, qualifier: QualifierInfo[], result?: string) {
-    const msg = `multi proto found for name:${String(name)} and qualifiers ${JSON.stringify(qualifier)}${
+    const msg = `multi proto found for name:${String(name)} and qualifiers ${formatQualifiers(qualifier)}${
       result ? `, result is ${result}` : ''
     }`;
     super(msg, ErrorCodes.MULTI_PROTO_FOUND);

tegg/core/metadata/src/factory/EggPrototypeFactory.ts

@@ -1,7 +1,7 @@
 import { PrototypeUtil } from '@eggjs/core-decorator';
 import { FrameworkErrorFormatter } from '@eggjs/errors';
 import { MapUtil } from '@eggjs/tegg-common-util';
-import { AccessLevel, TeggScope } from '@eggjs/tegg-types';
+import { AccessLevel, DefineModuleQualifierAttribute, TeggScope } from '@eggjs/tegg-types';
 import type {
   EggProtoImplClass,
   EggPrototypeName,
@@ -98,7 +98,9 @@ export class EggPrototypeFactory {
     if (protos.length === 1) {
       return protos[0];
     }
-    throw FrameworkErrorFormatter.formatError(new MultiPrototypeFound(name, qualifiers));
+    throw FrameworkErrorFormatter.formatError(
+      new MultiPrototypeFound(name, qualifiers, JSON.stringify(protos.map(EggPrototypeFactory.formatPrototype))),
+    );
   }
 
   private doGetPrototype(name: EggPrototypeName, qualifiers: QualifierInfo[], loadUnit?: LoadUnit): EggPrototype[] {
@@ -114,4 +116,13 @@ export class EggPrototypeFactory {
     const protos = this.publicProtoMap.get(name);
     return protos?.filter((proto) => proto.verifyQualifiers(qualifiers)) || [];
   }
+
+  private static formatPrototype(proto: EggPrototype): string {
+    return (
+      `${String(proto.name)}@${proto.loadUnitId}` +
+      ` define:${String(proto.defineModuleName ?? proto.getQualifier(DefineModuleQualifierAttribute))}` +
+      `@${String(proto.defineUnitPath ?? proto.loadUnitId)}` +
+      ` qualifiers:[${String(DefineModuleQualifierAttribute)}=${String(proto.getQualifier(DefineModuleQualifierAttribute))}]`
+    );
+  }
 }

tegg/core/metadata/src/factory/LoadUnitFactory.ts

@@ -45,13 +45,19 @@ export class LoadUnitFactory {
     return await creator(ctx);
   }
 
-  static async createLoadUnit(unitPath: string, type: EggLoadUnitTypeLike, loader: Loader): Promise<LoadUnit> {
+  static async createLoadUnit(
+    unitPath: string,
+    type: EggLoadUnitTypeLike,
+    loader: Loader,
+    unitName?: string,
+  ): Promise<LoadUnit> {
     const loadUnitMap = LoadUnitFactory.loadUnitMap;
     if (loadUnitMap.has(unitPath)) {
       return loadUnitMap.get(unitPath)!.loadUnit;
     }
     const ctx: LoadUnitLifecycleContext = {
       unitPath,
+      unitName,
       loader,
     };
     const loadUnit = await LoadUnitFactory.getLoanUnit(ctx, type);
@@ -65,9 +71,15 @@ export class LoadUnitFactory {
     return loadUnit;
   }
 
-  static async createPreloadLoadUnit(unitPath: string, type: EggLoadUnitTypeLike, loader: Loader): Promise<LoadUnit> {
+  static async createPreloadLoadUnit(
+    unitPath: string,
+    type: EggLoadUnitTypeLike,
+    loader: Loader,
+    unitName?: string,
+  ): Promise<LoadUnit> {
     const ctx: LoadUnitLifecycleContext = {
       unitPath,
+      unitName,
       loader,
     };
     return await LoadUnitFactory.getLoanUnit(ctx, type);