ci: enhance and modernize Scrutinizer configuration

[martin-georgiev]

• Update PHP version to 8.3 to match project recommendations
• Add PostgreSQL environment support
• Configure detailed code quality checks
• Set up proper test coverage integration
• Add security and SQL injection checks
• Configure proper path exclusions

Summary by CodeRabbit

• Chores
  • Updated system configuration to support the latest environment settings.
  • Enhanced internal quality and security validations for improved stability.
  • Refined testing procedures with expanded coverage reporting.
  • Streamlined consistency and naming guidelines to maintain a robust application experience.

[coderabbitai]

Walkthrough

The pull request updates the .scrutinizer.yml configuration file. The PHP version is revised from 8.2 to 8.3.16, and environment settings are adjusted to enable PostgreSQL support while disabling Node.js. The analysis node now includes a command for test execution with Clover coverage reporting. Additionally, the file introduces a comprehensive set of new checks for PHP code quality, security, and naming conventions, along with coding style rules for braces, control structures, and casing, as well as filters to exclude specific paths. External tool configurations have also been refined.

Changes

File

Summary of Changes

.scrutinizer.yml

- PHP version updated to 8.3.16. - Environment changes: PostgreSQL enabled, Node.js disabled. - Analysis node command for tests with Clover coverage added. - Extensive new PHP code quality and security checks including duplication, unused code, and naming conventions. - New coding style rules for braces, control structures, keywords, and constants. - Filter section added to exclude CI, fixtures, tests; external tool settings updated.

Poem

Oh, what hops of joy I feel today,
Updating configs in a mighty way.
PHP 8.3 now leads the chase,
With tests and checks setting the pace.
CodeRabbit cheers with a fluffy smile,
Hopping through changes in elegant style!
🐇✨ Enjoy the new configuration mile!

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aca5ff6 and 6b4f92f.

📒 Files selected for processing (1)

• .scrutinizer.yml (2 hunks)

🔇 Additional comments (6)

.scrutinizer.yml (6)

1-15: Environment and Build Settings Configuration

This segment successfully updates the build environment to use PHP 8.3.16, enables PostgreSQL support, and disables Node.js. The test override under the analysis node is now set to run composer run-tests-with-clover with proper Clover coverage reporting. These changes are well aligned with the PR objective of modernizing and enhancing CI configuration.

---

16-19: Dependencies Override Update

The dependencies override command is updated to:

- composer update --no-interaction --prefer-dist

This ensures that dependencies are updated consistently during the build process. The configuration looks correct and fits with our objective.

---

20-62: Comprehensive PHP Checks Configuration

This section introduces an extensive set of PHP quality and security checks. Notably, it includes checks for code rating, duplication, documentation fixes, unused code, and critical security vulnerabilities (like SQL injection and security vulnerabilities). The addition of naming convention rules—such as minimum lengths for variable and method names—adds further rigor. Ensure that these checks are supported by your current version of Scrutinizer and that they do not lead to false positives in legacy or third-party code.

---

63-91: Coding Style Standards Setup

The coding style configuration clearly specifies rules for spaces, braces, and the casing of keywords and constants. The decision to enforce a newline for braces in classes and functions, as well as for control structures (if, for, while, do-while, switch, try), helps enforce consistency. This configuration is in line with modern PHP coding best practices.

---

92-99: Filter Configuration and Path Exclusions

The filter section effectively excludes directories such as ci/*, fixtures/*, and tests/* from analysis, and appropriately specifies dependency paths (e.g., vendor/*). This ensures that the analysis focuses on the core source code without being bogged down by configuration, test fixtures, or external dependencies.

---

100-104: External Code Coverage Tool Configuration

The tools section configures external code coverage with a timeout of 600 seconds and a single run. This should be sufficient for most test suites, but consider monitoring the coverage tool’s performance across different builds to ensure that the timeout is generous enough.

---

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

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.

[coveralls]

coverage: 95.578%. remained the same
when pulling 4813540 on scrutinizer
into 59a8cb9 on main.