Skip to content

Stop returning false from cache#2418

Merged
Crabcyborg merged 1 commit into
masterfrom
stop_returning_false_from_cache
Jul 10, 2025
Merged

Stop returning false from cache#2418
Crabcyborg merged 1 commit into
masterfrom
stop_returning_false_from_cache

Conversation

@Crabcyborg
Copy link
Copy Markdown
Contributor

@Crabcyborg Crabcyborg commented Jul 10, 2025

This is happening on a customer's site on WP Engine.

It appears that the false isn't an empty array, but just some sort of error in the cache.

This update ignores false now instead of trying to treat it as an empty array.

An empty array should still work as expected.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 10, 2025

Walkthrough

The check_cache method in FrmDb.php was updated to return cached results only when the cache is explicitly found and the results are not false, or if the query is empty. The previous fallback to returning an empty array for specific query types was removed.

Changes

File(s) Change Summary
classes/models/FrmDb.php Tightened cache hit logic in check_cache to require both cache presence and valid results; removed fallback to empty array for certain query types.

Possibly related PRs

Suggested labels

run analysis, run tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 PHPStan (2.1.15)

Note: Using configuration file /phpstan.neon.
Invalid configuration:
Unexpected item 'parameters › strictRules'.


📜 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 1a86d4b and cc07b63.

📒 Files selected for processing (1)
  • classes/models/FrmDb.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). (15)
  • GitHub Check: Run Rector inspection
  • GitHub Check: Cypress
  • GitHub Check: Run PHP Syntax inspection (8.3)
  • GitHub Check: Run PHP Syntax inspection (7)
  • GitHub Check: Run PHP Syntax inspection (8.3)
  • GitHub Check: PHP 7.4 tests in WP trunk
  • GitHub Check: Run PHPCS inspection
  • GitHub Check: PHP 8 tests in WP trunk
  • GitHub Check: Cypress
  • GitHub Check: PHP 8 tests in WP trunk
  • GitHub Check: PHP 7.4 tests in WP trunk
  • GitHub Check: Run Rector inspection
  • GitHub Check: Run PHPCS inspection
  • GitHub Check: Run ESLint
  • GitHub Check: Psalm
🔇 Additional comments (3)
classes/models/FrmDb.php (3)

661-661: Cache condition logic is correctly improved.

The updated condition ( $found === true && $results !== false ) properly addresses the issue where cached false values were being treated as valid data. This change ensures that only legitimate cached results are returned, while false values from cache are correctly ignored and trigger a fresh database query.


661-661: AI summary inconsistency detected.

The AI summary mentions removal of fallback logic for returning empty arrays for certain query types (get_col, get_results, etc.), but this removal is not visible in the provided code changes. Only the cache condition on line 661 has been modified.

Likely an incorrect or invalid review comment.


661-661: No Action Required: stricter cache condition only affects error cases

After reviewing all check_cache usages across the codebase and inspecting the updated condition:

  • All data-retrieval calls pass a non-empty $query, so the empty($query) branch (cache-only methods) remains unchanged.
  • WordPress’s DB methods return null, empty arrays, or 0 (for counts) when no results are found—not false—so these “no-data” cases still short-circuit the cache.
  • The new check ($results !== false) only blocks pure false values, which occur on DB errors, not normal empty results.
  • In error scenarios, it’ll reissue the query (and re-cache the error), but these are rare and won’t degrade overall performance.

No further changes are needed.

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Crabcyborg Crabcyborg merged commit 095c2aa into master Jul 10, 2025
34 checks passed
@Crabcyborg Crabcyborg deleted the stop_returning_false_from_cache branch July 10, 2025 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant