Avoid showing sales banner to user without the proper role

[Crabcyborg]

This is to prevent it from appearing for users who can't really act on the sale.

[coderabbitai]

Walkthrough

A permission check was introduced at the beginning of the maybe_show_banner() static method within the FrmSalesApi class. This check ensures that only users with the 'frm_change_settings' capability can proceed with the banner display logic. If the user lacks this capability, the method returns false immediately, halting further execution. No changes were made to the method's signature or to any other public interfaces.

Changes

File(s)	Change Summary
classes/models/FrmSalesApi.php	Added a permission check at the start of maybe_show_banner() to restrict banner visibility to users with the 'frm_change_settings' capability.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FrmSalesApi

    User->>FrmSalesApi: maybe_show_banner()
    FrmSalesApi->>FrmSalesApi: Check 'frm_change_settings' capability
    alt User has capability
        FrmSalesApi->>FrmSalesApi: Continue banner logic
    else User lacks capability
        FrmSalesApi-->>User: Return false
    end

Loading

Possibly related PRs

• Sales API Phase 2 #2318: Introduced and heavily modified the maybe_show_banner() method in FrmSalesApi, related due to shared method changes involving permission checks.

---

📜 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 6e13667 and bdebd25.

📒 Files selected for processing (1)

• classes/models/FrmSalesApi.php (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• classes/models/FrmSalesApi.php

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Cypress
• GitHub Check: PHP 8 tests in WP trunk
• GitHub Check: PHP 7.4 tests in WP trunk

✨ 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

• 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.
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

classes/models/FrmSalesApi.php (1)

251-253: Good addition of permission check to restrict banner visibility.

Adding this check ensures that only users with the capability to change settings will see the sales banner, which aligns with the PR objective. This prevents displaying the banner to users who cannot take any action on the sale.

I do notice that current_user_can() is used directly here, while FrmAppHelper::permission_check() is used in the dismiss_banner() method (line 355). Both approaches work, but for consistency, consider using the same pattern across the codebase.

-		if ( ! current_user_can( 'frm_change_settings' ) ) {
+		if ( ! FrmAppHelper::current_user_can( 'frm_change_settings' ) ) {

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b690ee5 and 6e13667.

📒 Files selected for processing (1)

• classes/models/FrmSalesApi.php (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

classes/models/FrmSalesApi.php (1)

classes/helpers/FrmAppHelper.php (1)

• current_user_can (2052-2074)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: Cypress
• GitHub Check: PHP 7.4 tests in WP trunk
• GitHub Check: PHP 8 tests in WP trunk
• GitHub Check: PHP 8 tests in WP trunk
• GitHub Check: PHP 7.4 tests in WP trunk
• GitHub Check: Cypress