Parsely / wp-parsely

The official WordPress plugin for Parse.ly - makes it a snap to add the required tracking code to enable Parse.ly on your WordPress site.
https://wordpress.org/plugins/wp-parsely/
GNU General Public License v2.0
64 stars 32 forks source link

Add Traffic Boost permissions infrastructure #2939

Closed acicovic closed 2 weeks ago

acicovic commented 2 weeks ago

Description

This PR adds the Traffic Boost permissions infrastructure.

Permissions can be changed in the plugin's settings page, and (to facilitate manual testing) the Traffic Boost enabled status is currently shown in our dashboard page.

Motivation and context

Being able to set permissions for Traffic Boost, like for other PCH features.

How has this been tested?

Screenshots

image image

Summary by CodeRabbit

coderabbitai[bot] commented 2 weeks ago
📝 Walkthrough ## Walkthrough The changes in this pull request introduce a new feature called `traffic_boost` across multiple components of the application. This includes updates to the `Dashboard_Page` and `Settings_Page` classes to manage user permissions and settings for the feature. The `Parsely` class is modified to integrate the `traffic_boost` option into its configuration, while the `Permissions` class is enhanced to check user access for this feature. Additionally, JavaScript and test files are updated to support the new functionality and ensure proper validation and permissions testing. ## Changes | File | Change Summary | |------------------------------------|-------------------------------------------------------------------------------------------------------------| | `src/UI/class-dashboard-page.php` | Added private property `$parsely` and constructor to accept `Parsely` instance; modified `add_dashboard_page_placeholder` for `traffic_boost` permission check. | | `src/UI/class-settings-page.php` | Added `traffic_boost` to `Parsely_Settings_Options_Content_Helper`; registered new settings field in `initialize_content_helper_section`. | | `src/class-parsely.php` | Updated `Parsely_Options_Content_Helper` to include `traffic_boost` option; modified `option_defaults` to initialize this option. | | `src/class-permissions.php` | Enhanced `get_pch_permissions_json` and `build_pch_permissions_settings_array` methods to include `TrafficBoost` feature. | | `src/js/admin-settings.ts` | Added checkbox for `traffic_boost` in feature management; updated event handlers to include this checkbox. | | `tests/Integration/PermissionsTest.php` | Added `traffic_boost` to `$features_to_test` array for permission validation. | | `tests/Integration/UI/SettingsPageTest.php` | Updated `transform_pch_options_for_validation` to include `traffic_boost` in validation process. | | `wp-parsely.php` | Updated instantiation of `Dashboard_Page` to accept `$GLOBALS['parsely']` as a parameter. | ## Possibly related PRs - **#2554**: Adds a new configurable feature called `traffic_boost` to the settings page, related to user permissions functionality. - **#2604**: Implements permissions for AI features, including `traffic_boost`, aligning with the permission checks introduced. - **#2671**: Adds integration tests for the `Excerpt Suggestions` feature, relevant to user permissions changes. - **#2672**: Enhances the testing framework for Content Helper options, including permission settings related to this PR. - **#2895**: Modifies permissions logic for Super Admins, relevant to user permissions enhancements. ## Suggested labels `Changelog: Added` ## Suggested reviewers - vaurdan

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
acicovic commented 2 weeks ago

Yes, we'll see how we handle TB disablement once we have more elements.