Fix #272: Add `hasStatusSupport()` to `AdapterInterface` by WarLikeLaux · Pull Request #299 · yiisoft/queue

WarLikeLaux · 2026-06-05T15:46:35Z

Q	A
Is bugfix?	❌
New feature?	✔️
Tests added?	✔️
Tests pass?	✔️
Breaks BC?	✔️
Fixed issues	#272

What does this PR do?

Adds AdapterInterface::hasStatusSupport(): bool so callers can tell an adapter that does not track status apart from a missing message ID, since both cases return MessageStatus::NOT_FOUND from status().

InMemoryAdapter returns true; the test stubs FakeAdapter and VoidAdapter return false. Since those stubs declare no status support, their status() now returns MessageStatus::NOT_FOUND instead of throwing, which is what AdapterInterface::status() documents for adapters without status tracking.

BC

The new method on AdapterInterface requires every implementation to declare it. The package is 1.0.0 under development and the signature was proposed by @samdark in the issue.

Summary by CodeRabbit

New Features
- Message adapters can now indicate whether they support message status tracking functionality.
Documentation
- Enhanced documentation clarifying status tracking behavior and adapter capability reporting.
Tests
- Added test coverage for status tracking capability detection.

Driver adaptation

codecov · 2026-06-05T15:48:44Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 0.00%. Comparing base (7bcbc2c) to head (fff6f97).
⚠️ Report is 14 commits behind head on master.

Additional details and impacted files

@@ Coverage Diff @@## master #299 +/- ##
========================================
Coverage 0.00% 0.00% Complexity 330 330 ========================================
Files 49 49 Lines 910 910 ========================================
Misses 910 910

☔ View full report in Codecov by Harness.
📢 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.

WarLikeLaux · 2026-06-05T16:38:25Z

@coderabbitai full review

coderabbitai · 2026-06-05T16:38:31Z

✅ Action performed

Full review finished.

coderabbitai · 2026-06-05T16:44:02Z

📝 Walkthrough

Walkthrough

This PR adds a hasStatusSupport(): bool method to AdapterInterface to disambiguate whether adapters support message status tracking or simply cannot find a requested message. Production and test adapters implement the method, and test coverage validates the behavior.

Changes

Status tracking capability reporting

Layer / File(s)	Summary
Interface contract and documentation `src/Adapter/AdapterInterface.php`	`hasStatusSupport(): bool` is added to the interface with docblock clarification that when status support is unavailable, `status()` yields `MessageStatus::NOT_FOUND`.
Adapter implementations and test coverage `stubs/InMemoryAdapter.php`, `tests/App/FakeAdapter.php`, `tests/Benchmark/Support/VoidAdapter.php`, `tests/Unit/Stubs/InMemoryAdapterTest.php`	`InMemoryAdapter` reports status support as `true`; test doubles `FakeAdapter` and `VoidAdapter` report `false`. A test verifies `InMemoryAdapter` correctly reports capability.
Changelog entry `CHANGELOG.md`	Changelog documents the addition of `hasStatusSupport()` for issue `#299`.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A rabbit hops through status queues,
Now knowing which adapters hold the clues—
Does this one support the tracking dance?
Or just return NOT_FOUND by chance?
A simple flag to set things right! 🎯

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 15.38% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and specifically describes the main change: adding a `hasStatusSupport()` method to `AdapterInterface` to address issue `#272`.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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

coderabbitai

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)

tests/Benchmark/Support/VoidAdapter.php (1)
29-32: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
Fix VoidAdapter::status() to respect hasStatusSupport() contract.
tests/Benchmark/Support/VoidAdapter.php returns false from hasStatusSupport(), but status() currently throws InvalidArgumentException, contradicting AdapterInterface’s contract that status() must always return MessageStatus::NOT_FOUND when status tracking isn’t supported. Benchmarks don’t call ->status(...) (and VoidAdapter is only used by QueueBench), so this likely doesn’t affect current benchmark runs, but it should still be corrected for contract compliance.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@tests/Benchmark/Support/VoidAdapter.php` around lines 29 - 32,
VoidAdapter::status() currently throws InvalidArgumentException even though
hasStatusSupport() returns false; update the status(int|string $id):
MessageStatus implementation to return MessageStatus::NOT_FOUND when status
tracking is not supported (i.e., when hasStatusSupport() is false) instead of
throwing. Locate the VoidAdapter class and modify the status method to respect
hasStatusSupport(), returning MessageStatus::NOT_FOUND for unsupported adapters
in accordance with AdapterInterface, while still allowing a real status lookup
if hasStatusSupport() were true.
tests/App/FakeAdapter.php (1)
31-34: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win
Fix FakeAdapter::status() to satisfy the AdapterInterface contract when status isn’t supported
AdapterInterface expects status() to return MessageStatus::NOT_FOUND whenever hasStatusSupport() is false, but tests/App/FakeAdapter.php currently throws an exception instead:
publicfunctionstatus(string|int$id): MessageStatus
{
thrownewException('`status()` method is not implemented yet.');
}
Even for a test double, this violates the interface contract/LSP. Implement status() to return MessageStatus::NOT_FOUND when hasStatusSupport() is false (and keep throwing only if you intentionally want to fail callers in supported scenarios). The test suite contains ->status() calls, but the grep results don’t show any FakeAdapter::status() usage.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@tests/App/FakeAdapter.php` around lines 31 - 34, FakeAdapter::status()
currently throws an exception which violates AdapterInterface; change it so that
it checks $this->hasStatusSupport() and returns MessageStatus::NOT_FOUND when
hasStatusSupport() is false, and only throw or perform real status logic when
status support is enabled—this ensures FakeAdapter::status() follows the
AdapterInterface contract and LSP.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@tests/App/FakeAdapter.php`:
- Around line 31-34: FakeAdapter::status() currently throws an exception which
violates AdapterInterface; change it so that it checks $this->hasStatusSupport()
and returns MessageStatus::NOT_FOUND when hasStatusSupport() is false, and only
throw or perform real status logic when status support is enabled—this ensures
FakeAdapter::status() follows the AdapterInterface contract and LSP.
In `@tests/Benchmark/Support/VoidAdapter.php`:
- Around line 29-32: VoidAdapter::status() currently throws
InvalidArgumentException even though hasStatusSupport() returns false; update
the status(int|string $id): MessageStatus implementation to return
MessageStatus::NOT_FOUND when status tracking is not supported (i.e., when
hasStatusSupport() is false) instead of throwing. Locate the VoidAdapter class
and modify the status method to respect hasStatusSupport(), returning
MessageStatus::NOT_FOUND for unsupported adapters in accordance with
AdapterInterface, while still allowing a real status lookup if
hasStatusSupport() were true.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: cb9429ca-b294-4dbf-b85b-fc3574b0aeda

📥 Commits

Reviewing files that changed from the base of the PR and between 9828d1c and 101a6ff.

📒 Files selected for processing (6)

CHANGELOG.md
src/Adapter/AdapterInterface.php
stubs/InMemoryAdapter.php
tests/App/FakeAdapter.php
tests/Benchmark/Support/VoidAdapter.php
tests/Unit/Stubs/InMemoryAdapterTest.php

samdark

Needs pull requests for yiisoft/queue-redis and yiisoft/queue-amqp before it can be merged.

vjik · 2026-06-07T11:51:21Z

What is new method planned to be used for?

samdark · 2026-06-07T20:11:04Z

@vjik Very good question. Usually that is meant for something like progress indicators and admin panels for a queue to look after tasks, etc. but it seems to be not enough for any functionality that is meaningful to the end user.

See the summarizer demo where I had to mark processing steps and save statuses in DB:

So since that's usually not enough anyway, we may get rid of the concept of message status overall.

vjik · 2026-06-07T20:16:55Z

What about adding new status "UNKNOWN" that means adapter don't track status?

samdark · 2026-06-07T20:38:36Z

I mean that likely we don't need status tracking at the adapter level at all.

…atusSupport # Conflicts: # tests/App/FakeAdapter.php

Fixyiisoft#272: AddhasStatusSupport()toAdapterInterface
101a6ff

coderabbitaiBot reviewed Jun 5, 2026
View reviewed changes

Return NOT_FOUND from stub adapters without status support
c589f82

samdark approved these changes Jun 5, 2026
View reviewed changes

Comment threadCHANGELOG.md Outdated

Update CHANGELOG.md
944b43f

This was referenced Jun 6, 2026
Add hasStatusSupport() to Adapteryiisoft/queue-amqp#129
Open
Add hasStatusSupport() to Adapteryiisoft/queue-redis#13
Open

Merge branch 'master' into add-adapter-hasStatusSupport
5060cc1

Merge remote-tracking branch 'upstream/master' into add-adapter-hasSt…
fff6f97
…atusSupport # Conflicts: # tests/App/FakeAdapter.php

Uh oh!

Uh oh!

Conversation

WarLikeLaux commented Jun 5, 2026• edited by vjik Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this PR do?

BC

Summary by CodeRabbit

Driver adaptation

Uh oh!

codecovBot commented Jun 5, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

WarLikeLaux commented Jun 5, 2026

Uh oh!

coderabbitaiBot commented Jun 5, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitaiBot commented Jun 5, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

❌ Failed checks (1 warning)

Uh oh!

coderabbitaiBot left a comment

Choose a reason for hiding this comment

Uh oh!

samdark left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vjik commented Jun 7, 2026

Uh oh!

samdark commented Jun 7, 2026

Uh oh!

vjik commented Jun 7, 2026

Uh oh!

samdark commented Jun 7, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

WarLikeLaux commented Jun 5, 2026•
edited by vjik
Loading

codecovBot commented Jun 5, 2026•
edited
Loading

coderabbitaiBot commented Jun 5, 2026•
edited
Loading

coderabbitaiBot commented Jun 5, 2026•
edited
Loading

samdark commented Jun 7, 2026•
edited
Loading