search

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

PCH Excerpt Suggestions: Improve error handling #2609

Closed vaurdan closed 1 month ago

vaurdan commented 1 month ago

Description

This PR improves the error handling of the Excerpt Suggestions feature, and updates it to extend the provider from the BaseProvider. The Generate button will also be disabled when the post content is empty. On the other hand, if the title is empty, since it's still possible to generate an excerpt, it will use the 'Untitled' as a title placeholder.

As a note, the CS API returns the error message as an array if there is an validation error, for example:

{
    "code": "SCHEMA_ERROR",
    "message": [
        {
            "type": "string_too_short",
            "loc": [
                "body",
                "text"
            ],
            "msg": "String should have at least 1 character",
            "input": "",
            "ctx": {
                "min_length": 1
            }
        }
    ],
    "data": null
}

The BaseProvider will test if the message is an object, and if so, it will use the first entry of the message object as the one to create the ContentHelperError object.

Motivation and context

Improve the reliability of the Excerpt Suggestions feature, preventing the block editor from crashing on unexpected errors.

How has this been tested?

Tested locally with an empty post, and a regular post.

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago
Walkthrough ## Walkthrough The updates enhance the error handling logic in the `BaseProvider` class, introduce singleton pattern in `ExcerptGeneratorProvider`, and improve error management and UI interactivity within the `excerpt-panel.tsx` component. ## Changes | File/Path | Change Summary | |-----------|----------------| | `src/.../base-provider.tsx` | Updated error handling to check if error message is an object and extract the first message if available. | | `src/.../excerpt-panel.tsx` | Imported `ContentHelperError` and `ContentHelperErrorCode`, modified error handling in the `catch` block, updated disabled condition, and removed direct instantiation of `excerptGeneratorProvider`. | | `src/.../provider.ts` | Added a static method `getInstance()` for singleton pattern, replaced direct API call with a `fetch` method for generating excerpts, handled empty `title` by setting it to 'Untitled'. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant ExcerptPanel participant ExcerptGeneratorProvider participant BaseProvider User->>+ExcerptPanel: Request excerpt generation ExcerptPanel->>+ExcerptGeneratorProvider: getInstance() ExcerptGeneratorProvider-->>-ExcerptPanel: Provide instance ExcerptPanel->>+ExcerptGeneratorProvider: Generate excerpt ExcerptGeneratorProvider->>+BaseProvider: fetchExcerpt(title, content) BaseProvider-->>ExcerptGeneratorProvider: Return error message or excerpt ExcerptGeneratorProvider-->>-ExcerptPanel: Return result or error ExcerptPanel-->>-User: Display result or error ``` This diagram demonstrates the new control flow for generating an excerpt, including the enhanced error handling and singleton pattern for the `ExcerptGeneratorProvider`.

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.