chore: refactor DataSource with construct inject

[killagu]

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

• New Features
  • The generateSql method is now publicly accessible, enhancing SQL hinting capabilities.
  • The DataSourceDelegate class has been restructured to extend the DataSource class, simplifying its implementation.
• Bug Fixes
  • Removed redundant methods for executing SQL commands, improving code clarity.
• Documentation
  • Updated comments and annotations to reflect changes in method visibility and class structure.

[coderabbitai]

Walkthrough

This pull request introduces significant modifications to the DataSource and DataSourceDelegate classes across two files. The generateSql method in the DataSource class is changed from private to public to support aspect-oriented programming for SQL hint appending. In DataSourceDelegate, the class now extends DataSource<T> instead of implementing IDataSource<T>, with updates to the constructor and removal of several methods, streamlining its structure by leveraging the superclass's functionality.

Changes

File	Change Summary
core/dal-runtime/src/DataSource.ts	- Changed generateSql method from private to public.
plugin/dal/lib/DataSource.ts	- Changed DataSourceDelegate from implementing IDataSource<T> to extending DataSource<T>.
	- Updated constructor to accept transactionalAOP and objInfo parameters.
	- Removed private dataSource property and several SQL execution methods.
	- Updated import statements to include LoadUnitNameQualifierAttribute and MultiInstanceInfo.

Possibly related PRs

• fix: fix DataSourceQualifier #238: The changes in the DataSourceQualifier function may relate to the DataSource class modifications, as both involve the DataSource concept and could impact how SQL generation and qualifiers are handled in the overall architecture.

Poem

In the land of code where rabbits play,
A method turned public, hip-hip-hooray!
With AOP hints, our SQL will shine,
DataSourceDelegate now feels just fine.
Hopping through changes, we leap with glee,
For every new feature, there's joy, you see! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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

[coderabbitai]

Actionable comments posted: 2

🧹 Outside diff range and nitpick comments (1)

plugin/dal/lib/DataSource.ts (1)

63-63: Specify Access Modifier for objInfo

The objInfo property is declared without an access modifier, which defaults to public. If this property is intended for internal use within the class, consider specifying an appropriate access level to encapsulate it properly.

Apply this diff to specify the access modifier:

- objInfo: ObjectInfo;
+ private objInfo: ObjectInfo;

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ccff567 and abf6f78.

📒 Files selected for processing (2)

• core/dal-runtime/src/DataSource.ts (1 hunks)
• plugin/dal/lib/DataSource.ts (3 hunks)

🧰 Additional context used

🔇 Additional comments (4)

core/dal-runtime/src/DataSource.ts (1)

26-31: Approved change, but consider documentation and design alternatives

The change to make generateSql public serves a specific purpose for aspect-oriented programming (AOP) to implement SQL hint appending. This is a valid use case, and the added comment explains the reason for the change, which is good for maintainability.

However, I have a few suggestions to improve this change:

1. Consider adding more detailed documentation about the AOP use case. This could include examples of how it should be used and any potential risks or considerations when using this method externally.

2. Evaluate if there are alternative designs that could achieve the same goal while maintaining better encapsulation. For example, you could use the Template Method pattern or introduce a protected method that AOP can target without exposing the entire generateSql method.

3. Ensure that this change doesn't break the principle of least privilege. If only certain aspects of the system should be able to use this method, consider using TypeScript's access modifiers more granularly (e.g., protected instead of public) if possible.

To verify the impact of this change on the rest of the codebase, please run the following script:

This script will help identify any potential misuse of the newly public method and confirm its intended usage in AOP contexts.

plugin/dal/lib/DataSource.ts (3)

3-4: Imports Updated for New Dependencies

The additions of Inject and LoadUnitNameQualifierAttribute to the imports are appropriate and necessary for the dependency injection and annotations used in the updated class.

---

59-59: Class Now Extends DataSource<T> Instead of Implementing IDataSource<T>

Changing DataSourceDelegate to extend DataSource<T> simplifies the class by inheriting methods directly from the superclass. This refactoring enhances code maintainability by leveraging existing implementations.

---

66-69: Proper Use of Dependency Injection in Constructor

The constructor correctly utilizes @Inject and @MultiInstanceInfo annotations for dependency injection. This adheres to the framework's conventions and ensures that transactionalAOP and objInfo are properly injected.