feat: [#540] Remove contracts/database/config.go::Driver by hwbrzzl · Pull Request #823 · goravel/framework

hwbrzzl · 2025-01-18T14:43:33Z

📑 Description

Summary by CodeRabbit

Based on the comprehensive summary of changes, here are the concise release notes:

GitHub Actions
- Added a new workflow to check PR titles
- Added a new external testing workflow for Go versions 1.22 and 1.23
Database Enhancements
- Introduced a new GormQuery interface for more flexible database query handling
- Updated method signatures to use string-based driver representations
- Removed database-specific schema and grammar implementations
Testing Improvements
- Updated mock implementations for database drivers
- Enhanced test suite configurations
- Simplified database connection and driver handling
Dependency Management
- Cleaned up and updated module dependencies
- Removed several database-specific driver dependencies
Code Refactoring
- Streamlined database schema and query management
- Removed deprecated and redundant code structures

✅ Checks

Added test cases for my code

coderabbitai · 2025-01-18T14:43:39Z

Caution

Review failed

The pull request is closed.

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)

level=warning msg="[runner] Can't run linter goanalysis_metalinter: buildir: failed to load package : could not load export data: no export data for "github.com/goravel/framework/database/schema/constants""
level=error msg="Running error: can't run linter goanalysis_metalinter\nbuildir: failed to load package : could not load export data: no export data for "github.com/goravel/framework/database/schema/constants""

Walkthrough

This pull request introduces significant changes to the Goravel framework's database and schema management infrastructure. The changes primarily involve removing multiple database-specific implementations for MySQL, SQLite, and SQL Server, simplifying the driver handling, and updating various components to use string-based driver representations. Additionally, new GitHub Actions workflows have been added for PR title checking and external testing.

Changes

File	Change Summary
`.github/workflows/`	Added `check_pr_title.yml` and `test_external.yml`, removed `pr-check-title.yml`
`contracts/database/driver/driver.go`	Added new `GormQuery` interface with methods for lock and random order
`contracts/database/orm/orm.go`	Updated `Driver` method to return a string instead of a `database.Driver`
`database/gorm/query.go`	Modified to use new `gormQuery` interface and string-based driver handling
`database/schema/`	Removed multiple implementation files for different database types (MySQL, SQLite, SQL Server)
`support/docker/`	Deleted implementation files for MySQL, SQLite, and SQL Server Docker containers
`tests/`	Updated test files to use string-based driver handling and new configuration methods

Sequence Diagram

sequenceDiagram
    participant Client
    participant GormQuery
    participant Driver
    participant Query

    Client->>Driver: Gorm()
    Driver-->>Client: db, gormQuery, error
    Client->>Query: Initialize with gormQuery
    Query->>GormQuery: Use methods like LockForUpdate()
    GormQuery-->>Query: Return query expression

Possibly related PRs

feat: [#280] Implement Create and DropIfExists methods of Schema #646: Introduces new methods to the Blueprint interface
feat: [#280] Manage migrations table #664: Adds methods for managing migrations
feat: [#280] The migartion feature of v1.15 doesn't support change field #709: Discusses changes to the Blueprint interface
fix: [#280] add wrap for sql #719: Modifies the Grammar interface
feat: [#280] Implement Mysql driver #725: Implements a MySQL driver
feat: [#280] Add integer methods #727: Adds integer methods to the Blueprint interface
feat: sqlserver driver supports setting schema #786: Enhances SQL Server driver to support schema settings

Suggested reviewers

kkumar-gcc

📜 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 cdd2b8b and bca1922.

⛔ Files ignored due to path filters (2)

go.sum is excluded by !**/*.sum
tests/go.sum is excluded by !**/*.sum

📒 Files selected for processing (56)

.github/workflows/check_pr_title.yml.yml (1 hunks)
.github/workflows/pr-check-title.yml (0 hunks)
.github/workflows/test_external.yml (1 hunks)
contracts/database/driver/driver.go (2 hunks)
contracts/database/orm/orm.go (1 hunks)
database/console/show_command.go (1 hunks)
database/console/show_command_test.go (3 hunks)
database/gorm/event.go (1 hunks)
database/gorm/hints/with_hint.go (0 hunks)
database/gorm/query.go (10 hunks)
database/migration/test_utils.go (0 hunks)
database/schema/blueprint.go (16 hunks)
database/schema/blueprint_test.go (6 hunks)
database/schema/common_schema.go (0 hunks)
database/schema/constants/constants.go (0 hunks)
database/schema/grammars/mysql.go (0 hunks)
database/schema/grammars/mysql_test.go (0 hunks)
database/schema/grammars/sqlite.go (0 hunks)
database/schema/grammars/sqlite_test.go (0 hunks)
database/schema/grammars/sqlserver.go (0 hunks)
database/schema/grammars/sqlserver_test.go (0 hunks)
database/schema/grammars/utils.go (0 hunks)
database/schema/grammars/utils_test.go (0 hunks)
database/schema/grammars/wrap.go (0 hunks)
database/schema/grammars/wrap_test.go (0 hunks)
database/schema/mysql_schema.go (0 hunks)
database/schema/processors/mysql.go (0 hunks)
database/schema/processors/mysql_test.go (0 hunks)
database/schema/processors/sqlite.go (0 hunks)
database/schema/processors/sqlite_test.go (0 hunks)
database/schema/processors/sqlserver.go (0 hunks)
database/schema/processors/sqlserver_test.go (0 hunks)
database/schema/processors/utils.go (0 hunks)
database/schema/processors/utils_test.go (0 hunks)
database/schema/sqlite_schema.go (0 hunks)
database/schema/sqlserver_schema.go (0 hunks)
go.mod (1 hunks)
mocks/database/driver/Driver.go (4 hunks)
mocks/database/driver/GormQuery.go (1 hunks)
mocks/database/orm/Query.go (3 hunks)
support/docker/container_test.go (1 hunks)
support/docker/mysql.go (0 hunks)
support/docker/mysql_test.go (0 hunks)
support/docker/sqlite.go (0 hunks)
support/docker/sqlite_test.go (0 hunks)
support/docker/sqlserver.go (0 hunks)
support/docker/sqlserver_test.go (0 hunks)
tests/factory_test.go (1 hunks)
tests/go.mod (2 hunks)
tests/orm_test.go (1 hunks)
tests/query.go (3 hunks)
tests/query_test.go (1 hunks)
tests/schema_test.go (27 hunks)
tests/table.go (51 hunks)
tests/to_sql_test.go (1 hunks)
tests/utils.go (2 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

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

codecov · 2025-01-18T14:47:59Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.06%. Comparing base (cdd2b8b) to head (bca1922).
Report is 1 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #823      +/-   ##
==========================================
+ Coverage   65.19%   67.06%   +1.86%     
==========================================
  Files         150      147       -3     
  Lines       10694    10396     -298     
==========================================
  Hits         6972     6972              
+ Misses       3349     3051     -298     
  Partials      373      373

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

github-actions

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.50.

Benchmark suite	Current: `bca1922`	Previous: `cdd2b8b`	Ratio
`Benchmark_DecryptString`	`5665` ns/op 1592 B/op 17 allocs/op	`3091` ns/op 1592 B/op 17 allocs/op	`1.83`
`Benchmark_DecryptString - ns/op`	`5665` ns/op	`3091` ns/op	`1.83`

This comment was automatically generated by workflow using github-action-benchmark.

hwbrzzl · 2025-01-21T08:43:37Z

Because it's blocking my another PR and there is no logic change, only replacing Driver with String, so I merged this PR first, please let me know if you have any concerns. cc @goravel/core-developers

hwbrzzl added 2 commits January 18, 2025 22:05

update tests mod

87b73aa

feat: [#540] Remove config.go::Driver

217e6d0

hwbrzzl added 4 commits January 20, 2025 08:32

add test

5288494

rename

49e3d2f

rename

a82e350

fix test

f1534ce

github-actions bot reviewed Jan 20, 2025

View reviewed changes

hwbrzzl and others added 6 commits January 20, 2025 19:11

remove files

1a4c6b6

chore: update mocks

108dd0d

fix test

d4481bb

fix test

1d886dd

remove hint

45ccca9

fix test

bca1922

hwbrzzl marked this pull request as ready for review January 21, 2025 08:13

hwbrzzl requested a review from a team as a code owner January 21, 2025 08:13

hwbrzzl added the 🚀 Review Ready label Jan 21, 2025

hwbrzzl merged commit 29c6fd4 into master Jan 21, 2025
10 of 14 checks passed

hwbrzzl deleted the bowen/#540-1 branch January 21, 2025 08:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: [#540] Remove contracts/database/config.go::Driver#823

feat: [#540] Remove contracts/database/config.go::Driver#823
hwbrzzl merged 12 commits intomasterfrom
bowen/#540-1

hwbrzzl commented Jan 18, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jan 18, 2025 •

edited

Loading

Review failed

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented Jan 18, 2025 •

edited

Loading

Uh oh!

github-actions bot left a comment •

edited

Loading

Uh oh!

hwbrzzl commented Jan 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

hwbrzzl commented Jan 18, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📑 Description

Summary by CodeRabbit

✅ Checks

Uh oh!

coderabbitai bot commented Jan 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Sequence Diagram

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Jan 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

⚠️ Performance Alert ⚠️

Uh oh!

hwbrzzl commented Jan 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

hwbrzzl commented Jan 18, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 18, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Jan 18, 2025 •

edited

Loading

github-actions bot left a comment •

edited

Loading