Skip to content
This repository has been archived by the owner on Feb 23, 2024. It is now read-only.

Decode HTML entities when formatting Store API error messages #5870

Merged
merged 6 commits into from
Apr 11, 2022
Merged

Decode HTML entities when formatting Store API error messages #5870

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
505b4df
Decode HTML entities when formatting Store API error messages
Feb 16, 2022
618f1d8
Merge branch 'trunk' into fix/issue-5869
PanosSynetos Mar 3, 2022
e6d1945
👌IMPROVE: Code formatting to avoid linting issues - #5869
PanosSynetos Mar 3, 2022
1a64867
👌IMPROVE: Decode entities directly on the store notices container - #…
PanosSynetos Mar 3, 2022
e5a0a1a
⏪ REVERT: Revert decode entities directly on the store notices contai…
PanosSynetos Mar 8, 2022
7cac80b
⏪ REVERT: Revert decode entities directly on the store notices contai…
PanosSynetos Mar 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion assets/js/base/context/providers/store-notices/components/store-notices-container.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import PropTypes from 'prop-types';
import classnames from 'classnames';
import { Notice } from 'wordpress-components';
import { decodeEntities } from '@wordpress/html-entities';

/**
* Internal dependencies
Expand Down Expand Up @@ -50,7 +51,7 @@ const StoreNoticesContainer = ( { className, notices, removeNotice } ) => {
}
} }
>
{ props.content }
{ decodeEntities( props.content ) }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @manospsyx - I discussed briefly with @xristos3490 and he suggested using decodeEntities in one place (here - the store notices container) rather than everywhere else we call createNotice

What do you think?

I tested it locally and it works as expected (with decodeEntities in assets/js/base/utils/errors.js removed). If you agree, we can revert errors.js and just keep the change in the container.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I remember there's at least one instance where decodeEntities is used outside -- I wasn't sure if that's intentional. I agree with Chris, but let's make sure that we're not double-decoding in other places. Can you check usage of decodeEntities in other locations to make sure?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed with @senadir over slack

My personal preference is to not call something unless needed seeing that you can't opt out of it in a clean way, I think decoding all server returned stings makes more sense than decoding at the createNotice level.

</Notice>
) ) }
</div>
Expand Down
14 changes: 7 additions & 7 deletions assets/js/base/utils/errors.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
* External dependencies
*/
import { __ } from '@wordpress/i18n';
import { decodeEntities } from '@wordpress/html-entities';

/**
* Given a JS error or a fetch response error, parse and format it so it can be displayed to the user.
Expand Down Expand Up @@ -48,11 +49,10 @@ export const formatStoreApiErrorMessage = ( response ) => {
}
}

return (
response?.message ||
__(
'Something went wrong. Please contact us to get assistance.',
'woo-gutenberg-products-block'
)
);
return response?.message
? decodeEntities( response.message )
: __(
'Something went wrong. Please contact us to get assistance.',
'woo-gutenberg-products-block'
);
};