8000 fix: the loading order issue in multi-module mode by akitaSummer · Pull Request #324 · eggjs/tegg · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

fix: the loading order issue in multi-module mode #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 28, 2025

Conversation

akitaSummer
Copy link
Contributor
@akitaSummer akitaSummer commented May 28, 2025
Checklist
  • npm test passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)
Description of change

Summary by CodeRabbit

  • Bug Fixes

    • Improved the process for collecting matching items, ensuring all relevant matches are included rather than stopping at the first match. This results in more comprehensive results for users.
  • New Features

    • Introduced multiple new test modules and classes with context-aware prototypes and greeting methods.
    • Added crosscutting advice classes to support advanced aspect-oriented programming scenarios.
    • Included new test suites to verify multi-module integration and behavior.

Copy link
coderabbitai bot commented May 28, 2025

Walkthrough

The change updates the nested loop logic in CrossCutGraphHook.ts by removing a labeled break statement, allowing the collection of all matching protoNodes for each crosscutInfo entry. Additionally, multiple new test fixtures, classes, and packages related to multi-module AOP scenarios were added, including a new test suite validating module loading with crosscut and pointcut hooks.

Changes

File(s) Change Summary
core/aop-runtime/src/CrossCutGraphHook.ts Removed labeled loop and break; now collects all matching protoNodes for each crosscutInfo entry without early exit.
core/aop-runtime/test/aop-runtime.test.ts Added new test suite "mutil aop" testing multi-module loading with crossCutGraphHook and pointCutGraphHook.
core/aop-runtime/test/fixtures/mutli/a/A.ts, core/aop-runtime/test/fixtures/mutli/b/B.ts Added classes A and B decorated with @ContextProto(), each with id property and async hello method.
core/aop-runtime/test/fixtures/mutli/c/Base.ts Added base class Base with @ContextProto(), id property, and async hello method.
core/aop-runtime/test/fixtures/mutli/cross/Cross.ts Added BaseAdvice class with @Crosscut and @Advice decorators implementing empty async AOP advice lifecycle methods.
core/aop-runtime/test/fixtures/mutli/a/package.json, core/aop-runtime/test/fixtures/mutli/b/package.json, core/aop-runtime/test/fixtures/mutli/c/package.json, core/aop-runtime/test/fixtures/mutli/cross/package.json Added new package.json files defining eggModule names for respective fixture modules and cross module.

Possibly related PRs

Poem

In the garden of code where the crosscuts grow,
Loops once stopped early, but now freely flow.
Each protoNode found, none left behind,
The search is complete, with results well-aligned.
A hop and a skip, the logic refined—
Hooray for the code that’s now redefined! 🐇

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

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

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-eggache".

(The package "eslint-plugin-eggache" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-eggache@latest --save-dev

The plugin "eslint-plugin-eggache" was referenced from the config file in ".eslintrc » eslint-config-egg/typescript » ./index.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

core/aop-runtime/test/fixtures/mutli/a/A.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-eggache".

(The package "eslint-plugin-eggache" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-eggache@latest --save-dev

The plugin "eslint-plugin-eggache" was referenced from the config file in ".eslintrc » eslint-config-egg/typescript » ./index.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

core/aop-runtime/test/fixtures/mutli/b/B.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-eggache".

(The package "eslint-plugin-eggache" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-eggache@latest --save-dev

The plugin "eslint-plugin-eggache" was referenced from the config file in ".eslintrc » eslint-config-egg/typescript » ./index.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

  • 2 others
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@akitaSummer akitaSummer changed the title fix: findCrossCuttedClazz break fix: the loading order issue in multi-module mode May 28, 2025
Copy link
@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (4)
core/aop-runtime/test/aop-runtime.test.ts (3)

262-262: Fix typo in test suite name.

The test suite name contains a typo: "mutil aop" should be "multi aop".

-  describe('mutil aop', () => {
+  describe('multi aop', () => {

266-269: Fix typos in fixture directory paths.

The fixture paths contain typos: "mutli" should be "multi" in all directory references.

-        path.join(__dirname, 'fixtures/mutli/a'),
-        path.join(__dirname, 'fixtures/mutli/b'),
-        path.join(__dirname, 'fixtures/mutli/c'),
-        path.join(__dirname, 'fixtures/mutli/cross'),
+        path.join(__dirname, 'fixtures/multi/a'),
+        path.join(__dirname, 'fixtures/multi/b'),
+        path.join(__dirname, 'fixtures/multi/c'),
+        path.join(__dirname, 'fixtures/multi/cross'),

263-281: Add cleanup logic for consistent test practices.

This test suite lacks cleanup logic (afterEach) that other test suites in this file implement. For consistency and to prevent potential resource leaks, consider adding module cleanup.

   describe('multi aop', () => {
+    let modules: Array<LoadUnitInstance>;
+
     it('should work', async () => {
-      const modules = await CoreTestHelper.prepareModules([
+      modules = await CoreTestHelper.prepareModules([
         // ... paths
       ]);
       // ... assertions
     });
+
+    afterEach(async () => {
+      if (modules) {
+        for (const module of modules) {
+          await LoadUnitFactory.destroyLoadUnit(module.loadUnit);
+          await LoadUnitInstanceFactory.destroyLoadUnitInstance(module);
+        }
+      }
+    });
   });
core/aop-runtime/test/fixtures/mutli/cross/Cross.ts (1)

21-34: Document the purpose of empty advice method implementations.

All advice methods are empty implementations. While this might be intentional for testing the AOP framework itself, consider adding comments to clarify the purpose.

 export class BaseAdvice implements IAdvice<Base> {

+  // Empty implementations for testing multi-module AOP loading
   async beforeCall(_ctx: AdviceContext<Base>): Promise<void> {
+    // Intentionally empty for test purposes
   }

   async afterReturn(_ctx: AdviceContext<Base>, _result: any): Promise<void> {
+    // Intentionally empty for test purposes
   }

   async afterThrow(_ctx: AdviceContext<Base>, _error: Error): Promise<void> {
+    // Intentionally empty for test purposes
   }

   async afterFinally(_ctx: AdviceContext<Base>): Promise<void> {
+    // Intentionally empty for test purposes
   }

   async around(_ctx: AdviceContext<Base>, _next: () => Promise<any>): Promise<any> {
+    // Intentionally empty for test purposes
   }
 }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b013d2a and 929e3a1.

📒 Files selected for processing (9)
  • core/aop-runtime/test/aop-runtime.test.ts (1 hunks)
  • core/aop-runtime/test/fixtures/mutli/a/A.ts (1 hunks)
  • core/aop-runtime/test/fixtures/mutli/a/package.json (1 hunks)
  • core/aop-runtime/test/fixtures/mutli/b/B.ts (1 hunks)
  • core/aop-runtime/test/fixtures/mutli/b/package.json (1 hunks)
  • core/aop-runtime/test/fixtures/mutli/c/Base.ts (1 hunks)
  • core/aop-runtime/test/fixtures/mutli/c/package.json (1 hunks)
  • core/aop-runtime/test/fixtures/mutli/cross/Cross.ts (1 hunks)
  • core/aop-runtime/test/fixtures/mutli/cross/package.json (1 hunks)
✅ Files skipped from review due to trivial changes (7)
  • core/aop-runtime/test/fixtures/mutli/c/package.json
  • core/aop-runtime/test/fixtures/mutli/cross/package.json
  • core/aop-runtime/test/fixtures/mutli/a/package.json
  • core/aop-runtime/test/fixtures/mutli/b/package.json
  • core/aop-runtime/test/fixtures/mutli/b/B.ts
  • core/aop-runtime/test/fixtures/mutli/c/Base.ts
  • core/aop-runtime/test/fixtures/mutli/a/A.ts
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: Runner-ubuntu (16)
  • GitHub Check: Runner-ubuntu (22)
  • GitHub Check: Runner-macos (18)
  • GitHub Check: Runner-macos (16)
  • GitHub Check: Runner-ubuntu (20)
  • GitHub Check: Runner-macos (20)
  • GitHub Check: Runner-ubuntu (18)
  • GitHub Check: Analyze (typescript)
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (3)
core/aop-runtime/test/aop-runtime.test.ts (1)

274-280: Verify the expected module loading order.

The test validates specific module IDs and their order. Ensure this expected order is correct and reflects the actual module dependency resolution logic.

The test expects modules to load in this specific order. Please verify this matches the intended module loading behavior for the multi-module AOP scenario.

core/aop-runtime/test/fixtures/mutli/cross/Cross.ts (2)

11-18: LGTM! Proper AOP configuration.

The crosscut configuration correctly targets the Base class and its hello method using PointcutType.CLASS. The advice is properly configured with public access level.


4-4:

✅ Verification successful

Verify the Base class import path consistency.

The import references ../c/Base which should align with the directory structure. Ensure this path is correct after fixing the "mutli" typo in the directory structure.


🏁 Script executed:

#!/bin/bash
# Description: Verify the Base class exists at the expected location and check directory structure consistency

# Check if Base.ts exists in the expected location
fd -t f "Base.ts" core/aop-runtime/test/fixtures/ --exec echo "Found Base.ts at: {}"

# Check the actual directory structure under fixtures
fd -t d -d 2 "." core/aop-runtime/test/fixtures/ --exec echo "Directory: {}"

Length of output: 860


Import path is consistent with directory structure

The import in core/aop-runtime/test/fixtures/mutli/cross/Cross.ts

import { Base } from '../c/Base';

correctly resolves to core/aop-runtime/test/fixtures/mutli/c/Base.ts per the current layout. No changes required.

Copy link
Contributor
@killagu killagu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@akitaSummer akitaSummer merged commit c9610bd into eggjs:master May 28, 2025
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants
0