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
62 stars 31 forks source link

Content Helper: Implement AI feature permissions #2604

Closed acicovic closed 1 month ago

acicovic commented 1 month ago

Description

With this PR, we're implementing Content Helper AI feature permissions in the back-end and front-end, as the continuation of the work introduced in #2554.

The default settings will be different based on whether the plugin installation is new or existing. For new installations, PCH AI features will be auto-enabled solely for users with the administrator User Role. For existing installations, the features will be auto-enabled for all User Roles who have the edit_posts capability, as done for all plugin versions before 3.16.0. This is done to prevent unexpected behavior changes while upgrading to 3.16.0. In both cases, administrators will be then able to adjust the related settings from the plugin's Settings page, under the Content Helper tab.

After the upgrade to 3.16.0, any newly added User Roles will need to be manually allowed access to the PCH AI features. This means that we're switching from an "on by default" to an "off by default" approach.

Motivation and context

Allow website administrator to control which Content Helper AI features are available to users, based on their User Role.

How has this been tested?

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

[!WARNING]

Rate limit exceeded

@acicovic has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 13 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between a71f4fd2f8ebed110d177ccf7407a76c42851364 and 59301df8e1d9a4d17c5d72632a62aa692dfd9bc7.

Walkthrough

The changes introduce a comprehensive permissions system for Content Helper features, allowing more granular control over user access to features like smart linking and title suggestions. Core modifications include adding permissions checks, importing necessary classes, and updating method implementations across various files. Additionally, new utility functions and definitions for handling permissions in the frontend and backend were added.

Changes

Files/Groups Change Summary
src/@types/assets/window.d.ts Added global variable wpParselyContentHelperPermissions declaration.
src/Endpoints/ Updated to check user permissions before accessing features using Permissions::current_user_can_use_pch_feature.
src/UI/class-settings-page.php Changed allowed_user_roles to key-value pairs with strings/booleans.
src/class-parsely.php Adjusted properties and methods to handle default values and permissions for roles.
src/class-permissions.php Expanded Permissions class to validate user permissions, converting settings to JSON, and generating settings arrays.
src/content-helper/ Added and integrated new permissions-related imports, methods, and checks. Specifically added permission handling in common utils, editor-sidebar, excerpt generator, and error handling components.
tests/Integration/UI/SettingsPageTest.php Enhanced to use transform_pch_options_for_validation for transforming and validating options.

Sequence Diagram(s)

sequenceDiagram
    participant User as User
    participant UI as User Interface (UI)
    participant API as API Endpoint
    participant Perm as Permissions Class

    User ->> UI: Request Access to Feature
    UI ->> API: Validate Access (smart linking, title suggestions)
    API ->> Perm: Validate Permissions for User
    Perm -->> API: Access Allowed / Denied
    API -->> UI: Response with Validation Result
    UI -->> User: Render Feature Based on Permissions

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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
acicovic commented 1 month ago

The SonarCloud failure is a code duplication warning, which can be ignored.