Track when message settings changed

[truongwp]

This was reported by Mike via private message in Slack.

In Lite and Pro plugins, we send the Message Defaults settings to the usage endpoint. But in the new usage tracking endpoint, I skipped those settings because they are long and I didn't think we wanted to track them.
Our purpose is to track when those settings are changed. So I created this PR. I will send changed-{$message_key} to the endpoint. It has the value 0 (not changed) or 1 (changed).

In the usage endpoint, I removed the code that skips the messages: https://github.com/Strategy11/ff-usage-2/pull/2

The similar PR in Pro: https://github.com/Strategy11/formidable-pro/pull/5603

[coderabbitai]

Walkthrough

The pull request modifies the messages method in the FrmUsage class, enhancing the tracking of message settings. The change introduces a mechanism to compare each message setting against its default value. When a setting matches its default, it's assigned a 0, indicating no change; otherwise, it's assigned a 1, signaling a modification. This approach provides a more nuanced way of tracking whether message settings have been altered from their original state.

Changes

File	Change Summary
classes/models/FrmUsage.php	Updated messages() method to compare message settings with default options and track changes

Possibly related PRs

• Usage tracking v2 #2049: Modifications to the FrmUsage class related to the messages method
• Add more global settings to usage tracking #2142: Added new settings to the pass_settings array in FrmUsage class
• Unschedule send usage event if it is disabled #2143: Updated tracking_allowed method in FrmUsage class

Suggested labels

run analysis, run tests

---

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

classes/models/FrmUsage.php (1)

261-261: Consider improving readability of the comparison logic.

While the current implementation is correct, the ternary operator could be made more readable.

Consider this alternative:

-			$message_settings[ 'changed-' . $message ] = $settings_list->$message === $default[ $message ] ? 0 : 1;
+			$is_changed = $settings_list->$message !== $default[ $message ];
+			$message_settings[ 'changed-' . $message ] = $is_changed ? 1 : 0;

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1f7f865 and 28db5db.

📒 Files selected for processing (1)

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

🔇 Additional comments (1)

classes/models/FrmUsage.php (1)

257-261: LGTM! Implementation aligns well with tracking objectives.

The changes effectively track message setting modifications by comparing against default values. This implementation cleanly addresses the PR's goal of tracking when message settings are changed.

[Crabcyborg]

Thanks @truongwp!

🚀