fix - update return type in getCacheKeys method to ensure non-null st…

[shimonewman]

Summary by CodeRabbit

• Refactor
  • Refined cache key generation logic to ensure consistent behavior across all scenarios.

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

[coderabbitai]

Walkthrough

The getCacheKeys method in the Database class was updated to enforce stricter type safety. The return type annotation now specifies that all array elements are non-nullable strings instead of nullable strings, with empty strings used as placeholder values when documentId or selects are unavailable.

Changes

Cohort / File(s)	Summary
Cache Key Type Refinement src/Database/Database.php	Updated getCacheKeys return type annotation from array{0: ?string, 1: ?string, 2: ?string} to array{0: string, 1: string, 2: string}. Method now returns empty strings ('') instead of null when documentId is absent or selects are not provided. Public method signature unchanged.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

• Verify that all invocations of getCacheKeys handle empty string values correctly instead of null checks
• Confirm cache key construction logic properly accommodates empty string values in place of nulls
• Check for any downstream code depending on null values from this method that may need adjustment

Poem

A rabbit hops through types so neat,
Where strings now dance where nulls retreat,
Cache keys gleam with certainty,
No more the question "could it be?" 🐰✨

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 title clearly and specifically describes the main change: updating the return type annotation in the getCacheKeys method to ensure non-null values.
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 refactor-get-cache-keys

---

📜 Recent 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 5e634a7 and 6c7cde1.

📒 Files selected for processing (1)

• src/Database/Database.php (2 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

🔇 Additional comments (1)

src/Database/Database.php (1)

8583-8621: getCacheKeys now guarantees non-null string values for all return elements

The phpdoc (array{0: string, 1: string, 2: string}) correctly reflects the implementation: $collectionKey is always a string, and $documentKey / $documentHashKey now default to '' when $documentId is not provided via the null-coalescing operator. All internal callers in this file are compatible with this contract—purgeCachedCollection only destructures element 0, while purgeCachedDocumentInternal guards $id === null before calling the method, ensuring non-null document keys are only accessed when values are actually set.

---

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