feat: [#358] Add connection method for DB

[hwbrzzl]

📑 Description

goravel/goravel#358

Summary by CodeRabbit

• New Features

  • Enabled flexible database connectivity with support for named connections and groundwork for enhanced transaction handling.

• Refactor

  • Improved configuration management, connection caching, and error logging, resulting in a more stable and resilient database module.

• Tests

  • Expanded testing coverage to validate connection behavior across multiple database systems with context-aware operations.

✅ Checks

• Added test cases for my code

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.01%. Comparing base (d607bf6) to head (4672ffe).
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #909   +/-   ##
=======================================
  Coverage   68.01%   68.01%           
=======================================
  Files         154      154           
  Lines       10192    10192           
=======================================
  Hits         6932     6932           
  Misses       2934     2934           
  Partials      326      326           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request updates the database interface and implementation to enhance connection handling and introduce groundwork for transaction management. A new Connection(name string) DB method is added to the DB interface and implemented in the DB struct, with related support in mocks and tests. Additionally, constructor function signatures are revised to incorporate configuration management and context parameters, and test cases are updated to validate connection behavior across different databases.

Changes

File(s)	Change Summary
contracts/.../db.go	Updated DB and Query interfaces: added new method Connection(string) DB and commented-out transaction-related methods (e.g., Transaction, commit, rollBack).
database/db/db.go, database/service_provider.go	Revised DB struct to include a config field and use log instead of logger. Updated NewDB and BuildDB to accept a context and configuration, added the Connection method, and adjusted related method calls (e.g., Table, WithContext).
mocks/.../DB.go	Introduced a new Connection method in the mock DB implementation along with a specialized type (DB_Connection_Call) and helper methods (Run, Return, RunAndReturn) for mock expectations.
database/db/db_test.go, tests/db_test.go, tests/query.go	Added and updated test functions (TestConnection, TestDB_Connection) to validate connection logic, adjusted BuildDB calls to include a context, and removed outdated logger integration.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant DB
    participant BuildDB
    participant Log

    Client->>DB: Call Connection(name)
    alt Connection exists in cache
        DB-->>Client: Return cached connection
    else Connection does not exist
        DB->>BuildDB: Invoke BuildDB(ctx, config, log, connection)
        BuildDB-->>DB: Return new connection instance
        alt Error Occurs
            DB->>Log: Log panic message
        end
        DB-->>Client: Return new connection
    end

Loading

Possibly related PRs

• chore: [#540] Add test cases #845: Introduces a similar Connection method in the DB interface and mocks, aligning with the connection handling enhancements in this PR.
• feat: [#358] Add Update Delete methods for DB #904: Modifies the Query interface by adding transaction-related methods, which complements the transaction method placeholders added in this PR.
• chore: optimize testing.Docker.Database #656: Focuses on refining database connection handling and interface changes, directly paralleling the connection method enhancements introduced here.

Suggested reviewers

• devhaozi

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.

🔧 golangci-lint (1.62.2)

Error: can't load config: the Go language version (go1.23) used to build golangci-lint is lower than the targeted Go version (1.24.0)
Failed executing command with error: can't load config: the Go language version (go1.23) used to build golangci-lint is lower than the targeted Go version (1.24.0)

---

📜 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 d607bf6 and 4672ffe.

📒 Files selected for processing (7)

• contracts/database/db/db.go (2 hunks)
• database/db/db.go (2 hunks)
• database/db/db_test.go (3 hunks)
• database/service_provider.go (1 hunks)
• mocks/database/db/DB.go (1 hunks)
• tests/db_test.go (2 hunks)
• tests/query.go (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

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 generate docstrings to generate docstrings for this PR. (Beta)
• @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.