fix: plugin loading order by petermasking · Pull Request #661 · MaskingTechnology/jitar

petermasking · 2025-07-04T21:13:53Z

Fixes #660

Changes proposed in this pull request:

Loads all middleware before adding them in the correct order
Applied same strategy to the health checks

@MaskingTechnology/jitar

Summary by CodeRabbit

Refactor
- Improved the loading process for health checks and middleware, resulting in more efficient internal handling and future maintainability. No changes to user-facing features or behavior.

… to respect the configured order at execution

coderabbitai · 2025-07-04T21:13:59Z

Walkthrough

The code refactors the loading logic for both health checks and middleware by introducing new private methods to handle module imports and extraction of default exports. Batch loading functions now collect all modules first, then add them in order, ensuring the configured sequence is maintained.

Changes

File(s)	Change Summary
packages/health/src/HealthManager.ts	Refactored to add private method for module import; batch loading now collects and adds in order.
packages/middleware/src/MiddlewareManager.ts	Refactored to add private method for module import; batch loading now collects and adds in order.

Sequence Diagram(s)

sequenceDiagram
    participant Config as Configuration
    participant Manager as MiddlewareManager
    participant Module as Middleware Module

    Config->>Manager: get middleware filenames
    loop for each filename (in order)
        Manager->>Module: import module
        Module-->>Manager: default export (Middleware)
        Manager->>Manager: collect Middleware instance
    end
    loop for each Middleware (in order)
        Manager->>Manager: addMiddleware(Middleware)
    end

Assessment against linked issues

Objective (Issue #)	Addressed	Explanation
Ensure middleware is loaded and added in configured order (#660)	✅

Poem

In lines of code, a rabbit hops,
Refactoring modules, it never stops.
Now order is kept, no more delay,
Middleware and health checks line up and play.
With private helpers, the work is neat—
Hopping forward, code’s complete!
🐇✨

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.

npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-07-04T21_14_41_165Z-debug-0.log

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ac81b3f and be88d06.

📒 Files selected for processing (2)

packages/health/src/HealthManager.ts (2 hunks)
packages/middleware/src/MiddlewareManager.ts (2 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

packages/health/src/HealthManager.ts (1)

packages/middleware/src/MiddlewareManager.ts (1)

filename (75-80)

🔇 Additional comments (6)

packages/middleware/src/MiddlewareManager.ts (3)

32-37: LGTM! Clean separation of concerns.

The refactoring successfully separates module loading from middleware addition, improving code clarity and maintainability.

68-73: Excellent fix for the loading order issue.

The new implementation correctly addresses the plugin loading order problem by:

Loading all middleware concurrently using Promise.all()

Adding them sequentially to maintain the configured order

This ensures that the middleware execution order matches the configuration order, which was the core issue being addressed.

75-80: Well-implemented helper method.

The private helper method properly encapsulates the module loading logic and maintains consistent type casting across the codebase.

packages/health/src/HealthManager.ts (3)

36-41: LGTM! Consistent with middleware refactoring.

The refactoring maintains consistency with the MiddlewareManager pattern, ensuring uniform code structure across the codebase.

94-99: Excellent consistency in addressing the loading order issue.

The implementation mirrors the middleware loading strategy perfectly, ensuring health checks are also loaded in the correct order. This consistent approach across both managers is excellent for maintainability.

101-106: Perfect implementation of the helper method pattern.

The private helper method follows the exact same pattern as the middleware equivalent, maintaining code consistency and reusability.

✨ 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.

sonarqubecloud · 2025-07-04T21:14:45Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

#660: refactored loading strategy of the middleware and health checks…

be88d06

… to respect the configured order at execution

petermasking requested a review from basmasking as a code owner July 4, 2025 21:13

petermasking linked an issue Jul 4, 2025 that may be closed by this pull request

Load middleware in configured order #660

Closed

basmasking approved these changes Jul 4, 2025

View reviewed changes

basmasking merged commit c5f8fbf into main Jul 4, 2025
23 checks passed

basmasking deleted the 660-load-middleware-in-configured-order branch July 4, 2025 21:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: plugin loading order#661

fix: plugin loading order#661
basmasking merged 1 commit intomainfrom
660-load-middleware-in-configured-order

petermasking commented Jul 4, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Jul 4, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

sonarqubecloud Bot commented Jul 4, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

petermasking commented Jul 4, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Jul 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

sonarqubecloud Bot commented Jul 4, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

petermasking commented Jul 4, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Jul 4, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)