Conveniently disable auto tagging proposal

[jan888adams]

Summary by CodeRabbit

• Documentation

  • Added comprehensive guide for suppressing automatic cache tagging behavior with usage examples and state restoration guarantees.

• New Features

  • Enhanced cache control to allow disabling automatic tagging with selective manual tag management during request processing.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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.

Use the checkbox below for a quick retry:

• ✅ Review completed - (🔄 Check again to review again)

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch conveniently-disable-auto-tagging-proposal

---

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

[Copilot]

Pull request overview

This PR refines the CacheActivator::withoutAutomaticTagging() behavior to avoid partial tag application on generator failure, fixes a PHPDoc generator key type, aligns file header formatting with project conventions, and expands unit test coverage for withoutAutomaticTagging().

Changes:

• Prevent partial tag application by accumulating yielded tags and applying them only after successful generator iteration.
• Fix PHPDoc generator key type from int to array-key and simplify the invalid-yield error message.
• Add/extend unit tests for withoutAutomaticTagging() and adjust test naming.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
src/CacheActivator.php	Accumulates generator yields before applying tags; updates PHPDoc and error message.
tests/Unit/CacheActivatorTest.php	Adds unit coverage for withoutAutomaticTagging() including invalid-yield scenarios.
tests/Unit/Cache/ResponseTagger/TraceableResponseTaggerTest.php	Renames the test subject property (but currently inconsistently applied).
src/Cache/ResponseTagger/TraceableResponseTagger.php	Adjusts header formatting to <?php declare(strict_types=1); on one line.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@doc/8-disable-caching-behavior.md`:
- Line 55: The sentence describing state restoration uses "afterwards" but
should use US English "afterward"; update the wording in the doc sentence that
mentions the caching state being restored after the block completes (the line
referencing withoutAutomaticTagging()) to replace "afterwards" with "afterward"
so the sentence reads "...it remains disabled afterward."

---

ℹ️ Review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 12bc556 and f1c9e9b.

📒 Files selected for processing (8)

• doc/8-disable-caching-behavior.md
• src/Cache/ResponseTagger/TraceableResponseTagger.php
• src/CacheActivator.php
• tests/Integration/Fixtures/without_automatic_tagging_route.php
• tests/Integration/Tagging/WithoutAutomaticTaggingTest.php
• tests/Unit/Cache/ResponseTagger/TraceableResponseTaggerTest.php
• tests/Unit/CacheActivatorTest.php
• tests/app/src/Controller/WithoutAutomaticTaggingController.php

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Use “afterward” for US English consistency.

Replace “afterwards” with “afterward”.

✏️ Proposed wording fix

-...it remains disabled afterwards.
+...it remains disabled afterward.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	The previous caching state is always restored after the block completes, even if an exception is thrown. If caching was already disabled before calling `withoutAutomaticTagging()`, it remains disabled afterwards.
	The previous caching state is always restored after the block completes, even if an exception is thrown. If caching was already disabled before calling `withoutAutomaticTagging()`, it remains disabled afterward.

🧰 Tools

🪛 LanguageTool

[locale-violation] ~55-~55: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...utomaticTagging()`, it remains disabled afterwards.

(AFTERWARDS_US)

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@doc/8-disable-caching-behavior.md` at line 55, The sentence describing state
restoration uses "afterwards" but should use US English "afterward"; update the
wording in the doc sentence that mentions the caching state being restored after
the block completes (the line referencing withoutAutomaticTagging()) to replace
"afterwards" with "afterward" so the sentence reads "...it remains disabled
afterward."

[jan888adams]

I guess this isn’t the best example..