Skip null cache clear

[fogelito]

Summary by CodeRabbit

• Refactor
  • Enhanced cache management functionality to support optional document identifiers, allowing the system to gracefully handle cases where document IDs are not available.

[coderabbitai]

Walkthrough

The purgeCachedDocument method in Database.php is updated to accept a nullable document ID parameter. When a null ID is provided, the method returns true immediately; for non-null IDs, the existing cache purging and event emission behavior is preserved.

Changes

Cohort / File(s)	Summary
Nullable parameter handling src/Database/Database.php	Updated purgeCachedDocument method to accept nullable $id parameter (?string instead of string). Added early return when ID is null; non-null behavior unchanged. Parameter docblock updated to reflect string|null type.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A document null, once feared with dread,
Now gently handled—early return instead!
Short-circuit swift, no cache to clear,
When nothing's there, there's naught to fear. 🌿

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "Skip null cache clear" directly reflects the primary change in the changeset. The modification updates the purgeCachedDocument method to accept a nullable $id parameter and implements an early return when the ID is null, effectively skipping the cache purging operation. The title is concise, uses clear language without unnecessary noise, and is specific enough that a developer reviewing the commit history would understand the main behavioral change being introduced.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch skip-cache-clear-null-uid

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/Database/Database.php (1)

6802-6811: Null guard is safe; empty-string guard optional; BC change should be documented for library users

The null short-circuit is correctly implemented and no internal code passes null IDs, so the early return is safe. All 14 call sites pass non-null IDs from .getId() methods or explicit values.

Since this is a public library, the parameter type change from string to ?string carries a backward-compatibility risk: any external users who override this method with a narrower string $id signature will encounter a type mismatch. No overrides were found in the current codebase, but this should be documented in release notes as a breaking change if not already noted.

The suggested empty-string guard ($id === '') is reasonable hygiene to prevent malformed cache keys, but no current call sites trigger it—it's optional.

For robustness, consider guarding empty strings as well:

     if ($id === null) {
+        return true;
+    }
+    if ($id === '') {
         return true;
     }

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d8fc1bb and 64aab3d.

📒 Files selected for processing (1)

• src/Database/Database.php (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Setup & Build Docker Image