HP-2831: Fix failing phpunit-rcp tests on HiApi CI due to incorrect RedashMigrationGenerator constructor dependency

[VadymHrechukha]

Summary by CodeRabbit

• Refactor

  • Updated repository interface structure to align with base interface standards, improving consistency across the codebase.

• Tests

  • Extended test support repository with additional query methods to support specification-based test scenarios.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

This change refactors PlanRepositoryInterface to extend a base RepositoryInterface and adds four Specification-based query method stubs to the SimplePlanRepository test support class to align with the new interface contract requirements.

Changes

Cohort / File(s)	Change Summary
Interface Inheritance src/plan/PlanRepositoryInterface.php	Added import for RepositoryInterface and extended the interface to inherit from it, updating the interface contract.
Test Support Stubs tests/support/plan/SimplePlanRepository.php	Added four new Specification-based query methods (count, findAll, findOne, findOneOrFail) with "not implemented" placeholders to match the updated interface.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• The interface change is straightforward inheritance addition
• The test stub methods follow a consistent, repetitive pattern with no complex logic
• Both files are focused on interface alignment with minimal behavioral impact

Suggested reviewers

• SilverFire

Poem

🐰 A repository extends its reach so wide,
With specifications as its trusty guide,
Four stubborn methods wait to be refined,
The interface contracts now beautifully aligned!
✨

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Title check	⚠️ Warning	The PR title mentions RedashMigrationGenerator constructor dependency issues, but the actual changes involve adding RepositoryInterface extension and Specification-based query methods to plan-related classes.	Update the title to accurately reflect the actual changes: something like 'Implement RepositoryInterface for PlanRepositoryInterface and add Specification-based query methods'.
Docstring Coverage	⚠️ Warning	Docstring coverage is 20.00% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 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 7cccf4b and b756012.

📒 Files selected for processing (2)

• src/plan/PlanRepositoryInterface.php (1 hunks)
• tests/support/plan/SimplePlanRepository.php (2 hunks)

🧰 Additional context used

🧬 Code graph analysis (1)

src/plan/PlanRepositoryInterface.php (1)

src/Exception/EntityNotFoundException.php (1)

• EntityNotFoundException (16-18)

🪛 PHPMD (2.15.0)

tests/support/plan/SimplePlanRepository.php

56-56: Avoid unused parameters such as '$specification'. (undefined)

(UnusedFormalParameter)

---

61-61: Avoid unused parameters such as '$specification'. (undefined)

(UnusedFormalParameter)

---

66-66: Avoid unused parameters such as '$specification'. (undefined)

(UnusedFormalParameter)

---

71-71: Avoid unused parameters such as '$specification'. (undefined)

(UnusedFormalParameter)

🔇 Additional comments (3)

src/plan/PlanRepositoryInterface.php (1)

13-13: LGTM! Interface extension aligns with DataMapper pattern.

Extending RepositoryInterface establishes a consistent base contract for repository implementations and enables Specification-based query support.

Also applies to: 21-21

tests/support/plan/SimplePlanRepository.php (2)

13-13: LGTM! Import supports Specification-based methods.

---

56-74: Verify return type declarations match parent interface.

The four stub methods lack return type declarations. Confirm that RepositoryInterface defines specific return types for count(), findAll(), findOne(), and findOneOrFail() and ensure the stub implementations match those signatures.

Minor: Consider using a more specific exception type.

Replace generic \Exception with \RuntimeException or \LogicException for clarity:

-        throw new \Exception('not implemented');
+        throw new \RuntimeException('not implemented');

Note: The static analysis warnings about unused $specification parameters are false positives—these stubs satisfy the interface contract and don't need implementation.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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