Skip to content

Improve Content Helper error handling #3477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
acicovic merged 3 commits into from
Jul 3, 2025
Merged

Improve Content Helper error handling #3477

acicovic merged 3 commits into from
Jul 3, 2025

Conversation

@acicovic
Copy link
Collaborator

@acicovic acicovic commented Jun 20, 2025 •
edited by coderabbitai bot
Loading

Description

Until now, all Content Helper errors occurring while we were fetching data were considered soft errors, meaning that we would retry fetching the data. The noRetryFetchErrors constant was used to specify which errors weren't retryable (our so-called hard errors).

With this PR we're inverting our approach. All errors are considered hard errors (stopping execution by not retrying), unless they are of known error code and exist in our softErrors constant.

Motivation and context

  • Prevent needless fetch retries for errors that we aren't handling and/or are unknown to us.
  • Have a more controlled environment and a better grasp of which errors are retryable by being more restrictive.
  • Related to Stop fetch retries when ParselyAborted errors occur #3455 which this work complements.

How has this been tested?

  • We modified our tests for the new approach.
  • We also introduced a new test to make sure that we're testing all the error codes that exist within the ContentHelperError class.

Summary by CodeRabbit

  • Bug Fixes
    • Improved consistency in error handling for content helper errors, ensuring more accurate retry behavior for fetch operations.
  • Tests
    • Enhanced and consolidated test coverage for error handling, improving reliability and maintainability of related tests.

@acicovic acicovic added this to the 3.21.0 milestone Jun 20, 2025
@acicovic acicovic self-assigned this Jun 20, 2025
@acicovic acicovic added Maintenance & Fixes Ticket/PR related to codebase maintenance tasks Feature: PCI Ticket/PR related to Content Intelligence labels Jun 20, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 20, 2025 •
edited
Loading

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (6)
  • build/admin-settings.asset.php is excluded by !build/**
  • build/admin-settings.js is excluded by !build/**
  • build/content-helper/dashboard-page.asset.php is excluded by !build/**
  • build/content-helper/dashboard-page.js is excluded by !build/**
  • build/content-helper/editor-sidebar.asset.php is excluded by !build/**
  • build/content-helper/editor-sidebar.js is excluded by !build/**

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

"""

Walkthrough

The changes update the error handling logic in the content helper module by modifying the error code enum, adjusting how error codes are typed, and redefining the retry logic for fetch operations. The associated test suite is refactored for improved coverage and maintainability, consolidating repetitive tests and adding explicit checks for unknown error codes.

Changes

File(s) Change Summary
src/content-helper/common/content-helper-error.tsx Removed two enum members, changed an enum member's type, updated constructor for consistent typing, and redefined fetch retry logic to use a "soft errors" allowlist.
tests/js/content-helper/content-helper-error.test.ts Refactored tests to use data-driven iteration, consolidated repetitive tests, and added a test for unknown error codes.

Suggested labels

Changelog: Fixed

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
🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.

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.

@acicovic acicovic mentioned this pull request Jun 20, 2025
Closed
@acicovic acicovic marked this pull request as ready for review June 20, 2025 14:02
@acicovic acicovic requested a review from a team as a code owner June 20, 2025 14:02
@acicovic acicovic modified the milestones: 3.21.0, 3.20.4 Jul 3, 2025
@acicovic acicovic merged commit 16719c6 into develop Jul 3, 2025
33 checks passed
@acicovic acicovic deleted the update/content-helper-error-handling branch July 3, 2025 09:45
github-actions bot added a commit that referenced this pull request Jul 3, 2025
@github-actions
Build "Merge pull request #3477 from Parsely/update/content-helper-er…
c2eb0a7 
…ror-handling" (16719c6)
@acicovic acicovic added the Changelog: Fixed PR to be added under the changelog's "Fixed" section label Jul 8, 2025
@github-actions github-actions bot mentioned this pull request Jul 8, 2025
Merged
@coderabbitai coderabbitai bot mentioned this pull request Sep 23, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] approved these changes

Assignees

@acicovic acicovic

Labels

Changelog: Fixed PR to be added under the changelog's "Fixed" section Feature: PCI Ticket/PR related to Content Intelligence Maintenance & Fixes Ticket/PR related to codebase maintenance tasks

Projects

None yet

Milestone

3.20.4

Development

Successfully merging this pull request may close these issues.

2 participants

@acicovic