Fix broken e2e tests

[Crabcyborg]

The issue is that the hooks are not getting added properly when there are inbox items.

[coderabbitai]

Walkthrough

The pull request introduces modifications to two controller classes, FrmAppController and FrmEntriesController, related to handling inbox notifications. The changes involve creating a new FrmInbox instance to retrieve and display unread message counts in the menu and entries page. The modifications alter how unread notifications are fetched and incorporated into menu and page identifiers, potentially improving the visibility of unread messages in the admin interface.

Changes

File	Change Summary
classes/controllers/FrmAppController.php	Modified menu method to use FrmInbox instance for generating unread HTML instead of previous static method
classes/controllers/FrmEntriesController.php	Updated base_column_key method to include unread message count in the page identifier

Sequence Diagram

sequenceDiagram
    participant AppController as FrmAppController
    participant Inbox as FrmInbox
    participant EntriesController as FrmEntriesController

    AppController->>Inbox: Create new instance
    Inbox-->>AppController: Generate unread HTML
    
    EntriesController->>Inbox: Count unread messages
    Inbox-->>EntriesController: Return unread count
    EntriesController->>EntriesController: Append unread count to page identifier

Loading

The sequence diagram illustrates how the FrmInbox class is now being used to retrieve unread message information in both the app and entries controllers, with the unread count being incorporated into the menu and page identification processes.

---

📜 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 a0fa59b and 04a38a2.

📒 Files selected for processing (2)

• classes/controllers/FrmAppController.php (1 hunks)
• classes/controllers/FrmEntriesController.php (1 hunks)

🔇 Additional comments (2)

classes/controllers/FrmEntriesController.php (1)

336-339: Ensure unread() always returns a countable type.
It's good practice to confirm that unread() reliably returns an array or an object implementing Countable to avoid potential PHP warnings. Otherwise, calling count() may trigger errors if a null or non-countable type is returned.

You can run the following script to locate the definition of unread() and confirm it returns a countable type:

✅ Verification successful

Let me try a different search strategy to locate the unread() method definition.

---

Let me check the implementation of get_messages() to ensure it returns an array.

---

Let me check one more thing about the static messages property and its initialization.

---

Based on the code analysis, I can now provide the final response:

The unread() method safely returns a countable array type

The implementation shows that:

• unread() returns $messages which is initialized from get_messages('filter')
• get_messages() returns the static $messages property
• The messages are loaded from WordPress options and explicitly checked to be an array in set_messages()
• The filter_messages() method operates on the array by reference and maintains its array type
• The final return value is always an array, even if empty after filtering

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# This script searches for the definition of the `unread` method in the entire repository and displays relevant lines of code.
ast-grep --pattern $'function unread($_) {\n  $$$\n}' 

Length of output: 52

---

Script:

#!/bin/bash
# Search for files containing "class FrmInbox" to locate the class definition
rg "class FrmInbox" -l

# Then search for the unread method implementation
rg "function unread" -A 10

Length of output: 1338

---

Script:

#!/bin/bash
# Search for get_messages method implementation
ast-grep --pattern 'function get_messages($_) {
  $$$
}'

# Also search with ripgrep for better context
rg "function get_messages" -A 15

Length of output: 2861

---

Script:

#!/bin/bash
# Search for the static messages property declaration and initialization
rg "static \$messages" -A 5 classes/models/FrmInbox.php

# Also check the filter_messages method
rg "function filter_messages" -A 10 classes/models/FrmInbox.php

Length of output: 646

classes/controllers/FrmAppController.php (1)

20-21: Well-implemented HTML sanitization.
Appending HTML via unread_html( false ) and sanitizing with wp_kses_post() is a good security practice. If the returned string ever changes to contain more complex HTML, consider verifying the list of allowed tags/attributes in wp_kses_post() or using a stricter sanitizer if necessary.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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. (Beta)
• @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.