Skip to content
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

feat: use expected type for Connection::__construct() to bypass phpstan errors #255

Merged
merged 2 commits into from
Jan 7, 2025

Conversation

taka-oyama
Copy link
Collaborator

@taka-oyama taka-oyama commented Jan 7, 2025

Summary by CodeRabbit

  • Refactor

    • Updated connection initialization method with a static closure
    • Prepared for potential future error handling improvements
  • Bug Fixes

    • Removed specific error message from PHPStan configuration to enhance type compatibility checks

Note: The changes appear to be internal and do not directly impact end-user functionality.

@taka-oyama taka-oyama added enhancement New feature or request waiting for review labels Jan 7, 2025
@taka-oyama taka-oyama requested a review from a team January 7, 2025 06:24
@taka-oyama taka-oyama self-assigned this Jan 7, 2025
Copy link

coderabbitai bot commented Jan 7, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request involves a modification to the Connection class constructor in the src/Connection.php file. The change specifically alters how the parent constructor is called, replacing a null argument with a static closure that returns null. This adjustment appears to be related to connection initialization and potentially sets the groundwork for future error handling or versioning strategies. The method signature remains unchanged, indicating a subtle implementation change rather than a structural modification. Additionally, the phpstan.neon configuration file was updated to remove an error message related to this constructor.

Changes

File Change Summary
src/Connection.php Modified constructor implementation, replacing direct null argument with a static closure static fn() => null while maintaining the original method signature.
phpstan.neon Removed error message from ignoreErrors related to the __construct() method of the Illuminate\Database\Connection class.

Possibly related PRs

  • chore: phpstan errors #247: The changes in phpstan.neon involve removing an error message related to the __construct() method of the Illuminate\Database\Connection class, which is directly related to the modifications made in the Connection class constructor in the main PR.

Suggested reviewers

  • zeriyoshi

📜 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 dd7abad and 93f137a.

📒 Files selected for processing (1)
  • phpstan.neon (0 hunks)

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.

@taka-oyama taka-oyama changed the title feat: use expected type for Connection::__construct() to bypass phpsta… feat: use expected type for Connection::__construct() to bypass phpstan errors Jan 7, 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: 0

🧹 Nitpick comments (1)
src/Connection.php (1)

111-117: LGTM! Consider documenting the closure usage.

The change from null to static fn() => null improves type safety for phpstan. Consider adding a brief comment explaining why a closure is required here for future maintainers.

I notice there's a TODO comment about throwing an error after v9. Would you like me to create a GitHub issue to track this future breaking change?

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between afbf238 and dd7abad.

📒 Files selected for processing (1)
  • src/Connection.php (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Run-PHPUnit

Copy link
Contributor

@zeriyoshi zeriyoshi left a comment

Choose a reason for hiding this comment

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

I didn't know that $pdo now accepts \Closure, LGTM

@zeriyoshi zeriyoshi mentioned this pull request Jan 7, 2025
@taka-oyama taka-oyama merged commit fd45164 into master Jan 7, 2025
1 check passed
@taka-oyama taka-oyama deleted the fix/connection-const branch January 7, 2025 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request waiting for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants