Merge pull request #3701 from Parsely/update/include-more-errors-to-content-helper-error-tsx

Author: acicovic

build/admin-settings.asset.php

@@ -1 +1 @@
-<?php return array('dependencies' => array('react', 'wp-api-fetch', 'wp-data', 'wp-escape-html', 'wp-i18n', 'wp-url'), 'version' => '66f2b3e882defbfd9d95');
+<?php return array('dependencies' => array('react', 'wp-api-fetch', 'wp-data', 'wp-escape-html', 'wp-i18n', 'wp-url'), 'version' => '2241911e2fdfed629bf6');

build/admin-settings.js

@@ -1 +1 @@
-<?php return array('dependencies' => array('react', 'wp-api-fetch', 'wp-components', 'wp-compose', 'wp-data', 'wp-dom-ready', 'wp-element', 'wp-escape-html', 'wp-i18n', 'wp-notices', 'wp-primitives', 'wp-url'), 'version' => '620219ec63d477a4c918');
+<?php return array('dependencies' => array('react', 'wp-api-fetch', 'wp-components', 'wp-compose', 'wp-data', 'wp-dom-ready', 'wp-element', 'wp-escape-html', 'wp-i18n', 'wp-notices', 'wp-primitives', 'wp-url'), 'version' => '8acfeb018da81a942e25');

build/content-helper/dashboard-page.asset.php

@@ -1 +1 @@
-<?php return array('dependencies' => array('react', 'wp-api-fetch', 'wp-components', 'wp-data', 'wp-element', 'wp-i18n', 'wp-url'), 'version' => '9dd4e7d94d11e6d6f594');
+<?php return array('dependencies' => array('react', 'wp-api-fetch', 'wp-components', 'wp-data', 'wp-element', 'wp-i18n', 'wp-url'), 'version' => '880b3ef462175993e9b1');

build/content-helper/dashboard-page.js

@@ -1 +1 @@
-<?php return array('dependencies' => array('react', 'wp-api-fetch', 'wp-block-editor', 'wp-blocks', 'wp-components', 'wp-compose', 'wp-core-data', 'wp-data', 'wp-dom-ready', 'wp-editor', 'wp-element', 'wp-hooks', 'wp-i18n', 'wp-plugins', 'wp-primitives', 'wp-url', 'wp-wordcount'), 'version' => '3aca3610bec0d7b11473');
+<?php return array('dependencies' => array('react', 'wp-api-fetch', 'wp-block-editor', 'wp-blocks', 'wp-components', 'wp-compose', 'wp-core-data', 'wp-data', 'wp-dom-ready', 'wp-editor', 'wp-element', 'wp-hooks', 'wp-i18n', 'wp-plugins', 'wp-primitives', 'wp-url', 'wp-wordcount'), 'version' => '84075f31925e3bed158a');

build/content-helper/dashboard-widget.asset.php

@@ -38,10 +38,13 @@ export enum ContentHelperErrorCode {
 	ParselySuggestionsApiNoAuthentication = 'NO_AUTHENTICATION', // HTTP Code 401.
 	ParselySuggestionsApiNoAuthorization = 'NO_AUTHORIZATION', // HTTP Code 403.
 	ParselySuggestionsApiNoData = 'NO_DATA', // HTTP Code 507.
+	ParselySuggestionsApiNoDataManualLinking = 'NO_DATA_MANUAL_LINKING', // HTTP Code 507.
 	ParselySuggestionsApiOpenAiError = 'OPENAI_ERROR', // HTTP Code 500.
 	ParselySuggestionsApiOpenAiSchema = 'OPENAI_SCHEMA', // HTTP Code 507.
 	ParselySuggestionsApiOpenAiUnavailable = 'OPENAI_UNAVAILABLE', // HTTP Code 500.
+	ParselySuggestionsApiResponseValidationError = 'RESPONSE_VALIDATION_ERROR', // HTTP Code 500.
 	ParselySuggestionsApiSchemaError = 'SCHEMA_ERROR', // HTTP Code 422.
+	ParselySuggestionsInvalidRequest = 'INVALID_REQUEST', // HTTP Code 400.
 }
 
 /**
@@ -95,6 +98,18 @@ export class ContentHelperError extends Error {
 		// Set the prototype explicitly.
 		Object.setPrototypeOf( this, ContentHelperError.prototype );
 
+		this.CustomizeErrorMessaging();
+	}
+
+	/**
+	 * Customizes error messages and hints for clarity, or to provide tailored
+	 * messages when specific errors occur.
+	 *
+	 * This also allows for the internationalization of errors/hints.
+	 *
+	 * @since 3.20.8
+	 */
+	protected CustomizeErrorMessaging(): void {
 		// Errors that need rephrasing.
 		if ( this.code === ContentHelperErrorCode.AccessToFeatureDisabled ) {
 			this.message = __(
@@ -119,19 +134,25 @@ export class ContentHelperError extends Error {
 				'The Parse.ly API did not respond in a timely manner. Please try again later.',
 				'wp-parsely'
 			);
-		} else if ( this.code === ContentHelperErrorCode.ParselySuggestionsApiSchemaError ) {
+		} else if ( this.code === ContentHelperErrorCode.ParselySuggestionsApiSchemaError ||
+			this.code === ContentHelperErrorCode.ParselySuggestionsInvalidRequest
+		) {
 			this.message = __(
 				'The Parse.ly API returned a validation error. Please try again with different parameters.',
 				'wp-parsely'
 			);
-		} else if ( this.code === ContentHelperErrorCode.ParselySuggestionsApiNoData ) {
+		} else if ( this.code === ContentHelperErrorCode.ParselySuggestionsApiNoData ||
+			this.code === ContentHelperErrorCode.ParselySuggestionsApiNoDataManualLinking
+		) {
 			this.message = __(
-				'The Parse.ly API couldn\'t find any relevant data to fulfill the request. Please retry with a different input.',
+				'The Parse.ly API couldn\'t find any relevant data to fulfill the request.',
 				'wp-parsely'
 			);
-		} else if ( this.code === ContentHelperErrorCode.ParselySuggestionsApiOpenAiSchema ) {
+		} else if ( this.code === ContentHelperErrorCode.ParselySuggestionsApiOpenAiSchema ||
+			this.code === ContentHelperErrorCode.ParselySuggestionsApiResponseValidationError
+		) {
 			this.message = __(
-				'The Parse.ly API returned an incorrect response. Please try again later.',
+				'The Parse.ly API returned an incorrect response.',
 				'wp-parsely'
 			);
 		} else if ( this.code === ContentHelperErrorCode.ParselySuggestionsApiAuthUnavailable ) {
@@ -140,25 +161,6 @@ export class ContentHelperError extends Error {
 				'wp-parsely'
 			);
 		}
-	}
-
-	/**
-	 * Renders the error's message.
-	 *
-	 * @param {ContentHelperErrorMessageProps|null} props The props needed for the function.
-	 *
-	 * @return {import('react').JSX.Element} The resulting JSX Element.
-	 */
-	public Message( props: ContentHelperErrorMessageProps|null = null ): React.JSX.Element {
-		// Handle cases where credentials are not set.
-		const CredentialsNotSetErrorCodes = [
-			ContentHelperErrorCode.PluginCredentialsNotSetMessageDetected,
-			ContentHelperErrorCode.PluginSettingsSiteIdNotSet,
-			ContentHelperErrorCode.PluginSettingsApiSecretNotSet,
-		];
-		if ( CredentialsNotSetErrorCodes.includes( this.code ) ) {
-			return EmptyCredentialsMessage( props );
-		}
 
 		// Errors that need a hint.
 		if ( this.code === ContentHelperErrorCode.FetchError ) {
@@ -180,14 +182,6 @@ export class ContentHelperError extends Error {
 				'wp-parsely'
 			) );
 		}
-
-		return (
-			<ContentHelperErrorMessage
-				className={ props?.className }
-				testId="error">
-				{ `<p>${ this.message }</p>${ this.hint ? this.hint : '' }` }
-			</ContentHelperErrorMessage>
-		);
 	}
 
 	/**
@@ -199,6 +193,33 @@ export class ContentHelperError extends Error {
 		return `<p className="content-helper-error-message-hint" data-testid="content-helper-error-message-hint"><strong>${ __( 'Hint:', 'wp-parsely' ) }</strong> ${ hint }</p>`;
 	}
 
+	/**
+	 * Renders the error's message.
+	 *
+	 * @param {ContentHelperErrorMessageProps|null} props The props needed for the function.
+	 *
+	 * @return {import('react').JSX.Element} The resulting JSX Element.
+	 */
+	public Message( props: ContentHelperErrorMessageProps|null = null ): React.JSX.Element {
+		// Handle cases where credentials are not set.
+		const CredentialsNotSetErrorCodes = [
+			ContentHelperErrorCode.PluginCredentialsNotSetMessageDetected,
+			ContentHelperErrorCode.PluginSettingsSiteIdNotSet,
+			ContentHelperErrorCode.PluginSettingsApiSecretNotSet,
+		];
+		if ( CredentialsNotSetErrorCodes.includes( this.code ) ) {
+			return EmptyCredentialsMessage( props );
+		}
+
+		return (
+			<ContentHelperErrorMessage
+				className={ props?.className }
+				testId="error">
+				{ `<p>${ this.message }</p>${ this.hint ? this.hint : '' }` }
+			</ContentHelperErrorMessage>
+		);
+	}
+
 	/**
 	 * Creates an error Snackbar Notice, unless the error message contains links.
 	 *

build/content-helper/dashboard-widget.js

@@ -29,10 +29,13 @@ const errorCodes = [
 	ContentHelperErrorCode.ParselySuggestionsApiNoAuthentication,
 	ContentHelperErrorCode.ParselySuggestionsApiNoAuthorization,
 	ContentHelperErrorCode.ParselySuggestionsApiNoData,
+	ContentHelperErrorCode.ParselySuggestionsApiNoDataManualLinking,
 	ContentHelperErrorCode.ParselySuggestionsApiOpenAiError,
 	ContentHelperErrorCode.ParselySuggestionsApiOpenAiSchema,
 	ContentHelperErrorCode.ParselySuggestionsApiOpenAiUnavailable,
+	ContentHelperErrorCode.ParselySuggestionsApiResponseValidationError,
 	ContentHelperErrorCode.ParselySuggestionsApiSchemaError,
+	ContentHelperErrorCode.ParselySuggestionsInvalidRequest,
 ];
 
 /**