Optimize for PHP 8.2 readonly classes by koriym · Pull Request #166 · bearsunday/BEAR.QueryRepository

koriym · 2025-11-10T04:11:30Z

Summary

Convert classes with all readonly properties to use PHP 8.2's readonly class feature
Simplify property declarations by removing individual readonly modifiers when the entire class is readonly
Update rector.php configuration for PHP 8.2 optimizations

Changes

This refactoring leverages PHP 8.2's readonly class feature, which allows marking an entire class as readonly instead of individual properties. This results in:

Cleaner, more concise code
Better performance (minor optimization)
Leveraging modern PHP features now that minimum requirement is 8.2

Example

Before:

final class CacheInterceptor implements MethodInterceptor
{
    public function __construct(
        private readonly QueryRepositoryInterface $repository,
    ) {}
}

After:

final readonly class CacheInterceptor implements MethodInterceptor
{
    public function __construct(
        private QueryRepositoryInterface $repository,
    ) {}
}

Test plan

All tests pass (102 tests, 198 assertions)
Static analysis passes (PHPStan + Psalm)
Applied via Rector for consistency

Summary by Sourcery

Convert classes with exclusively readonly properties to PHP 8.2 readonly classes, remove redundant property modifiers, streamline attribute constructors, and update Rector configuration for PHP 8.2 compliance.

Enhancements:

Mark eligible classes as readonly classes and eliminate individual readonly property modifiers
Simplify attribute and constructor property declarations across annotation and source code
Refine Rector configuration to use PHP 8.2 rule sets and adjust type coverage, dead code, and code quality levels

Build:

Replace custom RectorConfig closure with a fluent configuration using withPaths and PHP version sets

Tests:

Update test classes to match readonly constructor signatures and adjust bootstrap cleanup call

- Convert classes with all readonly properties to readonly classes - Simplify property declarations by using class-level readonly modifier - Update rector.php configuration for PHP 8.2 optimizations

sourcery-ai · 2025-11-10T04:11:39Z

Reviewer's Guide

This PR refactors the codebase to leverage PHP 8.2 readonly classes by converting existing classes with all readonly properties to readonly class, simplifies property declarations, updates the Rector configuration to the new fluent API for PHP 8.2 support, and applies minor code cleanups across source and test files.

Class diagram for updated readonly classes

classDiagram
    class DonutRepository {
        <<readonly>>
        +QueryRepositoryInterface queryRepository
        +HeaderSetter headerSetter
        +ResourceStorageInterface resourceStorage
        +ResourceInterface resource
        +CdnCacheControlHeaderSetterInterface cdnCacheControlHeaderSetter
        +RepositoryLoggerInterface logger
        +DonutRendererInterface renderer
    }
    class QueryRepository {
        <<readonly>>
        +RepositoryLoggerInterface logger
        +HeaderSetter headerSetter
        +ResourceStorageInterface storage
        +Expiry expiry
    }
    class DonutRequest {
        <<readonly>>
        +AbstractRequest request
        +DonutRendererInterface donutStorage
        +SurrogateKeys etags
    }
    class CommandsProvider {
        <<readonly>>
        +RefreshSameCommand refreshSameCommand
        +RefreshAnnotatedCommand refreshAnnotatedCommand
    }
    class DonutCommandInterceptor {
        <<readonly>>
        +DonutRepositoryInterface repository
        +MatchQueryInterface matchQuery
    }
    class RefreshAnnotatedCommand {
        <<readonly>>
        +QueryRepositoryInterface repository
        +ResourceInterface resource
    }
    class RefreshSameCommand {
        <<readonly>>
        +QueryRepositoryInterface repository
        +MatchQueryInterface matchQuery
    }
    class CacheDependency {
        <<readonly>>
        +UriTagInterface uriTag
    }
    class CacheInterceptor {
        <<readonly>>
        +QueryRepositoryInterface repository
    }
    class FastlyCachePurger {
        <<readonly>>
        +FastlyCachePurgerInterface fastlyCachePurger
    }
    class CliHttpCache {
        <<readonly>>
        +ResourceStorageInterface storage
    }
    class CommandInterceptor {
        <<readonly>>
        +array commands
    }
    class DevEtagSetter {
        <<readonly>>
        +CacheDependencyInterface cacheDeperency
    }
    class EtagSetter {
        <<readonly>>
        +CacheDependencyInterface cacheDeperency
    }
    class Expiry {
        <<readonly>>
        +array time
    }
    class HeaderSetter {
        <<readonly>>
        +EtagSetterInterface etagSetter
    }
    class HttpCache {
        <<readonly>>
        +ResourceStorageInterface storage
    }
    class MarshallerProvider {
        <<readonly>>
        +array options
    }
    class RefreshInterceptor {
        <<readonly>>
        +RefreshAnnotatedCommand command
    }
    class RedisDsnProvider {
        <<readonly>>
    }
    DonutRepository --|> DonutRepositoryInterface
    QueryRepository --|> QueryRepositoryInterface
    DonutRequest --|> Stringable
    CommandsProvider --|> ProviderInterface
    DonutCommandInterceptor --|> MethodInterceptor
    RefreshAnnotatedCommand --|> CommandInterface
    RefreshSameCommand --|> CommandInterface
    CacheDependency --|> CacheDependencyInterface
    CacheInterceptor --|> MethodInterceptor
    FastlyCachePurger --|> PurgerInterface
    CliHttpCache --|> HttpCacheInterface
    CommandInterceptor --|> MethodInterceptor
    DevEtagSetter --|> EtagSetterInterface
    EtagSetter --|> EtagSetterInterface
    HttpCache --|> HttpCacheInterface
    HttpCache --|> DeprecatedHttpCacheInterface
    MarshallerProvider --|> ProviderInterface
    RefreshInterceptor --|> MethodInterceptor
    RedisDsnProvider --|> ProviderInterface

Class diagram for CacheVersion attribute class update

classDiagram
    class CacheVersion {
        +string value
        CacheVersion(string value)
    }

File-Level Changes

Change	Details	Files
Adopt PHP 8.2 readonly class syntax and simplify property declarations	Mark many final classes as `readonly class` where all constructor properties were readonly Remove individual `readonly` modifiers from promoted constructor parameters Use constructor property promotion consistently for simple properties	`src/DonutRepository.php` `src/QueryRepository.php` `src/DonutRequest.php` `src/CommandsProvider.php` `src/DonutCommandInterceptor.php` `src/RefreshAnnotatedCommand.php` `src/RefreshSameCommand.php` `src/CacheDependency.php` `src/CacheInterceptor.php` `src/Cdn/FastlyCachePurger.php` `src/CliHttpCache.php` `src/CommandInterceptor.php` `src/DevEtagSetter.php` `src/EtagSetter.php` `src/Expiry.php` `src/HeaderSetter.php` `src/HttpCache.php` `src/MarshallerProvider.php` `src/RefreshInterceptor.php` `src-annotation-deprecated/CacheVersion.php` `src-annotation/RefreshCache.php`
Update Rector configuration to use the new fluent API	Replace closure-based setup with `RectorConfig::configure()` fluent calls Switch from `paths()` to `withPaths()` and add directories for new PHP8 tests Enable PHP sets and define coverage, dead code, and code quality levels	`rector.php`
Apply miscellaneous code cleanups and shorthand optimizations	Switch environment var fallback to null coalescing operator (`?:`) Use argument unpacking (`unlink(...)`) in test bootstrap cleanup Condense docblocks and remove extraneous annotations	`tests-pecl-ext/StorageRedisDsnModuleTest.php` `tests/bootstrap.php`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

coderabbitai · 2025-11-10T04:11:56Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

Systematic codebase refactoring introducing final readonly class declarations across 25+ files while removing individual readonly modifiers from promoted constructor parameters. Updates Rector configuration to fluent API syntax, expands scanned directories, and configures PHP-level attributes. Cleans up PHPDoc annotations and applies constructor property promotion modernizations.

Changes

Cohort / File(s)	Summary
Rector configuration `rector.php`	Updated from closure-based to fluent RectorConfig API with expanded directory paths (demo, src, src-annotation, src-annotation-deprecated, tests, tests-pecl-ext); replaced explicit rule registrations with PHP-level attribute sets
Annotation/documentation cleanup `src-annotation-deprecated/CacheVersion.php`, `src-annotation/Commands.php`, `src-annotation/RefreshCache.php`	Converted to constructor property promotion (CacheVersion) and removed/reformatted PHPDoc blocks (Commands, RefreshCache)
Core immutability refactoring `src/CacheDependency.php`, `src/CacheInterceptor.php`, `src/Cdn/FastlyCachePurger.php`, `src/CliHttpCache.php`, `src/CommandInterceptor.php`, `src/CommandsProvider.php`, `src/DevEtagSetter.php`, `src/DonutCommandInterceptor.php`, `src/DonutRepository.php`, `src/DonutRequest.php`, `src/EtagSetter.php`, `src/Expiry.php`, `src/HeaderSetter.php`, `src/HttpCache.php`, `src/MarshallerProvider.php`, `src/QueryRepository.php`, `src/RedisDsnProvider.php`, `src/RefreshAnnotatedCommand.php`, `src/RefreshInterceptor.php`, `src/RefreshSameCommand.php`	Added `final readonly` class declarations; removed `readonly` modifiers from promoted constructor properties, shifting immutability semantics from per-property to class-level
Test updates `tests-pecl-ext/StorageRedisDsnModuleTest.php`	Simplified null-coalescing syntax using `?:` operator
Test fixture/helper modifications `tests/Fake/FakeMobileEtagSetter.php`, `tests/Fake/fake-app/src/Resource/Page/Html/BlogPostingCacheControl.php`, `tests/ResourceRepositoryTest.php`, `tests/ResourceStorageTest.php`, `tests/bootstrap.php`	Added `readonly` to selected promoted constructor properties; updated array callback syntax from string to variadic unpacking

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Rationale: Changes follow a highly consistent, mechanical pattern applied across files (adding class-level readonly while removing property-level readonly declarations). Most edits are modifier adjustments with no logic changes or control-flow modifications. Low cognitive load per file due to repetition and predictability.

Possibly related PRs

Bump dependencies #143: Upgrades rector/rector dependency to ^1.2.4, directly enabling the fluent RectorConfig API introduced in rector.php changes.
Migrate from doctrine/annotations to PHP 8 Attributes #165: Modifies src-annotation and src-annotation-deprecated files for PHP 8 attribute migration and annotation cleanup, overlapping with documentation/annotation changes in this PR.
Optimize for better Windows compatibility #161: Applies similar readonly immutability changes across CacheDependency, CacheInterceptor, DonutRepository, and other shared classes.

Suggested reviewers

NaokiTsuchiya
jingu

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 6.67% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Optimize for PHP 8.2 readonly classes' directly and clearly summarizes the main change: converting classes to use PHP 8.2's readonly feature.
Description check	✅ Passed	The description is comprehensive and clearly related to the changeset, providing summary, changes, examples, test plan, and verification details about the PHP 8.2 readonly class optimization.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

sourcery-ai

Hey there - I've reviewed your changes - here's some feedback:

Double-check that converting to readonly classes doesn’t inadvertently allow property mutation in methods or via reflection, since individual readonly modifiers are removed.
Verify that the new RectorConfig fluent setup still registers all the intended rule sets and custom rules—removing explicit sets may change your transformation coverage.
Review the bootstrap change from array_map('unlink', …) to array_map(unlink(...), …) to ensure the unlink callback is applied correctly and won’t cause unexpected failures.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- Double-check that converting to readonly classes doesn’t inadvertently allow property mutation in methods or via reflection, since individual readonly modifiers are removed.
- Verify that the new RectorConfig fluent setup still registers all the intended rule sets and custom rules—removing explicit sets may change your transformation coverage.
- Review the bootstrap change from array_map('unlink', …) to array_map(unlink(...), …) to ensure the unlink callback is applied correctly and won’t cause unexpected failures.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

codecov · 2025-11-10T04:12:51Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (5ef5a69) to head (f6cc5e9).

Additional details and impacted files

@@             Coverage Diff             @@
##                 1.x      #166   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity       243       243           
===========================================
  Files             52        52           
  Lines            734       734           
===========================================
  Hits             734       734

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

koriym · 2025-11-10T04:15:48Z

@coderabbitai review

coderabbitai · 2025-11-10T04:15:57Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (4)

src-annotation-deprecated/CacheVersion.php (1)
18-20: Constructor property promotion correctly applied.

The use of constructor property promotion is correct and simplifies the code. However, consider making the property readonly for immutability and consistency with the broader PR pattern of converting classes to use readonly properties.

Since this class is deprecated, this refactor is lower priority.

Apply this diff if you wish to make the property readonly:
-    public function __construct(public string $value)
+    public function __construct(public readonly string $value)
     {
     }
tests/Fake/fake-app/src/Resource/Page/Html/BlogPostingCacheControl.php (1)
24-25: Remove empty PHPDoc comment.

The empty PHPDoc block provides no value. Modern PHP with type hints and attributes makes this unnecessary.

Apply this diff to remove it:
-    /**
-     */
     #[Embed(rel: "comment", src: "page://self/html/comment")]
     public function onGet()
src/EtagSetter.php (2)
21-26: LGTM! Readonly class optimization correctly applied.

The conversion to final readonly class with removal of the explicit readonly modifier from the constructor property is correct. In PHP 8.2, declaring a class as readonly makes all properties implicitly readonly, so the explicit modifier is redundant.

Optional: Fix typo in property name.

The property is named $cacheDeperency (line 24) but should be $cacheDependency. This typo is also present on line 82 where the property is used. While this doesn't affect functionality, fixing it would improve code maintainability.

Apply this diff to fix the typo:
-        private CacheDependencyInterface $cacheDeperency,
+        private CacheDependencyInterface $cacheDependency,
And update the usage on line 82:
-                $this->cacheDeperency->depends($ro, $body->resourceObject);
+                $this->cacheDependency->depends($ro, $body->resourceObject);
45-45: Optional: Fix additional typos in method and parameter names.

Two additional pre-existing typos could be corrected:

Line 45: Parameter name $httpCacche should be $httpCache

Line 58: Method name getEtagByEitireView should be getEtagByEntireView

Apply this diff to fix these typos:
-    public function getEtagByPartialBody(HttpCache $httpCacche, ResourceObject $ro): string
+    public function getEtagByPartialBody(HttpCache $httpCache, ResourceObject $ro): string
     {
         $etag = '';
         assert(is_array($ro->body));
-        foreach ($httpCacche->etag as $bodyEtag) {
+        foreach ($httpCache->etag as $bodyEtag) {
             if (isset($ro->body[$bodyEtag]) && is_string($ro->body[$bodyEtag])) {
                 $etag .= $ro->body[$bodyEtag];
             }
         }

         return $etag;
     }

-    public function getEtagByEitireView(ResourceObject $ro): string
+    public function getEtagByEntireView(ResourceObject $ro): string
     {
         return $ro::class . serialize($ro->view);
     }
And update the call site on line 72:
-        $etag = $httpCache instanceof HttpCache && $httpCache->etag ? $this->getEtagByPartialBody($httpCache, $ro) : $this->getEtagByEitireView($ro);
+        $etag = $httpCache instanceof HttpCache && $httpCache->etag ? $this->getEtagByPartialBody($httpCache, $ro) : $this->getEtagByEntireView($ro);
Also applies to: 58-58

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5ef5a69 and 7445f17.

📒 Files selected for processing (30)

rector.php (1 hunks)
src-annotation-deprecated/CacheVersion.php (1 hunks)
src-annotation/Commands.php (0 hunks)
src-annotation/RefreshCache.php (1 hunks)
src/CacheDependency.php (1 hunks)
src/CacheInterceptor.php (1 hunks)
src/Cdn/FastlyCachePurger.php (1 hunks)
src/CliHttpCache.php (1 hunks)
src/CommandInterceptor.php (1 hunks)
src/CommandsProvider.php (1 hunks)
src/DevEtagSetter.php (1 hunks)
src/DonutCommandInterceptor.php (1 hunks)
src/DonutRepository.php (1 hunks)
src/DonutRequest.php (1 hunks)
src/EtagSetter.php (1 hunks)
src/Expiry.php (1 hunks)
src/HeaderSetter.php (1 hunks)
src/HttpCache.php (1 hunks)
src/MarshallerProvider.php (1 hunks)
src/QueryRepository.php (1 hunks)
src/RedisDsnProvider.php (1 hunks)
src/RefreshAnnotatedCommand.php (1 hunks)
src/RefreshInterceptor.php (1 hunks)
src/RefreshSameCommand.php (1 hunks)
tests-pecl-ext/StorageRedisDsnModuleTest.php (1 hunks)
tests/Fake/FakeMobileEtagSetter.php (1 hunks)
tests/Fake/fake-app/src/Resource/Page/Html/BlogPostingCacheControl.php (1 hunks)
tests/ResourceRepositoryTest.php (2 hunks)
tests/ResourceStorageTest.php (1 hunks)
tests/bootstrap.php (1 hunks)

💤 Files with no reviewable changes (1)

src-annotation/Commands.php

🧰 Additional context used

📓 Path-based instructions (6)

**/*.php