content-helper-error.tsx: Include more errors #3701
+76
−52
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
📝 WalkthroughWalkthroughAdds three new public error codes to ContentHelperErrorCode, introduces a protected CustomizeErrorMessaging hook, and updates ContentHelperError message/hint rendering to group certain codes under shared messages and to render credential-related errors via EmptyCredentialsMessage. Tests updated to include the new error codes as hard errors. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor UI as UI
participant CHE as ContentHelperError
participant Msg as ContentHelperErrorMessage
participant Ecm as EmptyCredentialsMessage
UI->>CHE: Message(props?)
alt Credential-related code
CHE-->>Ecm: Render EmptyCredentialsMessage
Ecm-->>UI: React element
else Non-credential code
CHE->>CHE: Select message + optional hint (incl. new codes)
CHE-->>Msg: Render ContentHelperErrorMessage(message, hint)
Msg-->>UI: React element
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches
🧪 Generate unit tests
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
src/content-helper/common/content-helper-error.tsx (4)
101-102: Prefer camelCase for method names (WordPress JS standards).Use camelCase for class methods. Rename for consistency.
Apply these diffs:
- this.CustomizeErrorMessaging(); + this.customizeErrorMessaging();And update the method definition:
-protected CustomizeErrorMessaging(): void { +protected customizeErrorMessaging(): void {Also applies to: 112-112
104-185: Consolidate the if/else chain into a map for clarity.A mapping object (code → message) will reduce branching and ease future additions.
Example approach:
const MESSAGE_MAP: Partial<Record<ContentHelperErrorCode, string>> = { [ContentHelperErrorCode.AccessToFeatureDisabled]: __( 'Access to this feature is disabled by the site\'s administration.', 'wp-parsely' ), [ContentHelperErrorCode.ParselySuggestionsApiNoAuthorization]: __( 'This AI-powered feature is opt-in. To gain access, please submit a request <a href="https://wpvip.com/content-helper/#content-helper-form" target="_blank" rel="noopener">here</a>.', 'wp-parsely' ), [ContentHelperErrorCode.ParselySuggestionsApiOpenAiError]: __( 'The Parse.ly API returned an internal server error. Please retry with a different input, or try again later.', 'wp-parsely' ), [ContentHelperErrorCode.ParselySuggestionsApiOpenAiUnavailable]: __( 'The Parse.ly API returned an internal server error. Please retry with a different input, or try again later.', 'wp-parsely' ), [ContentHelperErrorCode.ParselySuggestionsApiSchemaError]: __( 'The Parse.ly API returned a validation error. Please try again with different parameters.', 'wp-parsely' ), [ContentHelperErrorCode.ParselySuggestionsInvalidRequest]: __( 'The Parse.ly API returned a validation error. Please try again with different parameters.', 'wp-parsely' ), [ContentHelperErrorCode.ParselySuggestionsApiNoData]: __( 'The Parse.ly API couldn\'t find any relevant data to fulfill the request.', 'wp-parsely' ), [ContentHelperErrorCode.ParselySuggestionsApiNoDataManualLinking]: __( 'The Parse.ly API couldn\'t find any relevant data to fulfill the request.', 'wp-parsely' ), [ContentHelperErrorCode.ParselySuggestionsApiOpenAiSchema]: __( 'The Parse.ly API returned an incorrect response.', 'wp-parsely' ), [ContentHelperErrorCode.ParselySuggestionsApiResponseValidationError]: __( 'The Parse.ly API returned an incorrect response.', 'wp-parsely' ), [ContentHelperErrorCode.ParselySuggestionsApiAuthUnavailable]: __( 'The Parse.ly API is currently unavailable. Please try again later.', 'wp-parsely' ), }; // Then in customizeErrorMessaging(): this.message = MESSAGE_MAP[this.code] ?? this.message; if (this.code === ContentHelperErrorCode.HttpRequestFailed && this.message.includes('cURL error 28')) { this.message = __('The Parse.ly API did not respond in a timely manner. Please try again later.', 'wp-parsely'); }
190-194: Fix HTML attribute and complete JSDoc.Use class instead of className inside raw HTML, and add @SInCE to the JSDoc. Also end the @param description with a period.
Apply this diff:
/** * Shows a hint in order to provide clarity in regards to the error. * - * @param {string} hint The hint to display + * @param {string} hint The hint to display. + * @since 3.21.0 */ protected Hint( hint: string ): string { - return `<p className="content-helper-error-message-hint" data-testid="content-helper-error-message-hint"><strong>${ __( 'Hint:', 'wp-parsely' ) }</strong> ${ hint }</p>`; + return `<p class="content-helper-error-message-hint" data-testid="content-helper-error-message-hint"><strong>${ __( 'Hint:', 'wp-parsely' ) }</strong> ${ hint }</p>`; }
196-203: Add @SInCE to Message() JSDoc.Required by the coding guidelines.
Apply this diff:
/** * Renders the error's message. * * @param {ContentHelperErrorMessageProps|null} props The props needed for the function. * * @return {import('react').JSX.Element} The resulting JSX Element. + * @since 3.21.0 */
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (8)
build/admin-settings.asset.phpis excluded by!build/**build/admin-settings.jsis excluded by!build/**build/content-helper/dashboard-page.asset.phpis excluded by!build/**build/content-helper/dashboard-page.jsis excluded by!build/**build/content-helper/dashboard-widget.asset.phpis excluded by!build/**build/content-helper/dashboard-widget.jsis excluded by!build/**build/content-helper/editor-sidebar.asset.phpis excluded by!build/**build/content-helper/editor-sidebar.jsis excluded by!build/**
📒 Files selected for processing (2)
src/content-helper/common/content-helper-error.tsx(4 hunks)tests/js/content-helper/content-helper-error.test.ts(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{js,ts,tsx,jsx}
⚙️ CodeRabbit configuration file
**/*.{js,ts,tsx,jsx}: "Perform a detailed review of the provided code with following key aspects in mind:
- Review the code to ensure it is well-structured and adheres to best practices.
- Verify compliance with WordPress coding standards.
- Ensure the code is well-documented.
- Check for security vulnerabilities and confirm the code is secure.
- Optimize the code for performance, removing any unnecessary elements.
- Validate JSDoc comments for accuracy, currency, and adherence to WordPress coding standards.
- Ensure each line comment concludes with a period.
- Confirm every JSDoc comment includes a @SInCE tag indicating the next version of the plugin to include the code.
- Guarantee compatibility with the latest version of WordPress, avoiding deprecated functions or features."
Files:
src/content-helper/common/content-helper-error.tsxtests/js/content-helper/content-helper-error.test.ts
🧬 Code graph analysis (1)
src/content-helper/common/content-helper-error.tsx (1)
src/content-helper/common/content-helper-error-message.tsx (3)
ContentHelperErrorMessageProps(11-15)EmptyCredentialsMessage(59-72)ContentHelperErrorMessage(28-47)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: E2E against WordPress latest
🔇 Additional comments (3)
tests/js/content-helper/content-helper-error.test.ts (1)
32-39: New Suggestions API error codes covered as hard errors — LGTM.The additions align with the enum changes and the intended hard/soft error split.
src/content-helper/common/content-helper-error.tsx (2)
41-48: Enum additions are sensible and consistent.The new error codes are clearly named, documented with HTTP status comments, and correctly excluded from soft errors.
214-220: Validate trusted HTML sources for dangerouslySetInnerHTML.Message/hint are injected as HTML. Ensure all call sites and upstream error messages are controlled or sanitized to avoid XSS.
Can you confirm that values passed to the constructor’s message parameter are not derived from untrusted remote input? If any are, consider restricting to a safe subset (e.g., only links) or moving to React nodes with createInterpolateElement for links instead of raw HTML.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
With this PR, we're including a few additional errors that exist in the Suggestions API but weren't being captured in our error handling class. We're also unifying the customization of error messages and hints under a single function, for greater simplicity and separation of concerns.
Motivation and context
Closes #3700.
How has this been tested?
The related E2E test was updated, to verify that the newly added errors are categorized as "hard errors"
Summary by CodeRabbit
New Features
Refactor
Tests