use separate emotion 'cache' for pinboard (to avoid it fighting/racing the host application) #293
Conversation
This file contains 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
rebecca-thompson
approved these changes
Aug 7, 2023
mxdvl
reviewed
Aug 7, 2023
| @@ -16,7 +16,7 @@ | |||
| }, | |||
| "dependencies": { | |||
| "@apollo/client": "^3.6.5", | |||
| "@emotion/react": "^11.1.4", | |||
| "@emotion/react": "11.11.1", | |||
There was a problem hiding this comment.
There was a problem hiding this comment.
Indeed, it's been my preference for a good while!
There was a problem hiding this comment.
FYI – this script can use your package.json and yarn.lock to get the currently exact versions of all dependencies. There’s a similar, JS-only one in dotcom-rendering, that ensures this recommendation is followed.
Resolved dependencies in client/package.json
dependencies: {
"@apollo/client": "3.6.5"
"@emotion/react": "11.1.4"
"@guardian/source-foundations": "4.1.0"
"@guardian/source-react-components": "4.4.0"
"@guardian/user-telemetry-client": "1.1.0"
"@sentry/react": "6.18.1"
"@webscopeio/react-textarea-autocomplete": "4.9.2"
"apollo-link-debounce": "3.0.0"
"aws-appsync-auth-link": "3.0.7"
"aws-appsync-subscription-link": "3.0.9"
"date-fns": "2.19.0"
"graphql": "15.4.0"
"preact": "10.15.1"
"react-draggable": "4.4.5"
"react-joyride": "2.5.3"
"react-shadow": "19.0.2"
},
…g the host application if it uses emotion, e.g. prosemirror in Composer) Co-authored-by: Rebecca Thompson <33927854+rebecca-thompson@users.noreply.github.com>
…ev, which is the default)
twrichards
force-pushed
the
fix-conflicting-emotion-cache
branch
from
406a8ac
to
b4f1a03
Compare
|
Seen on PROD (merged by @twrichards 4 minutes and 24 seconds ago) Please check your changes! |
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.
https://trello.com/c/lDPWxVEu/1627-investigate-styling-bug-in-composer-elements
Co-authored-by: @rebecca-thompson
@rebecca-thompson observed (when testing https://github.com/guardian/flexible-content/pull/4374) that certain styles (defined in prosemirror-elements for Cartoon Element) were not being applied, yet the emotion style block in
<head>was empty.Turns out pinboard (which has all its styles actually defined within various shadow DOMs) was winning in the race/fight over the 'default emotion cache' (see https://emotion.sh/docs/@emotion/cache).
See emotion-js/emotion#2209, so bumped to latest and this looks to have fixed.
Whilst troubleshooting we made Pinboard use its own 'cache' (via https://emotion.sh/docs/cache-provider) which we've left in as it provides nicer separation (even though all meaningful Pinboard styles are actually in the various Shadow DOMs).
Lastly (to aid future debugging etc.) we've made sure all css class names generated by emotion include meaningful names, e.g.
