Move conditional useInsertionEffect declarations into separate package (#2867)

* Move conditional `useInsertionEffect` declarations into separate package

* add missing dependecies

* regenerate lockfile

* Add missing peer dep

* regenerate lockfile

* add missing dev dep for a peer dep

* regenerate lockfile

* add changesets

Author: Andarist

.changeset/blue-pears-explode.md

@@ -0,0 +1,8 @@
+---
+'@emotion/react': patch
+'@emotion/styled': patch
+---
+
+Externalized code referencing `React.useInsertionEffect` to a separate `@emotion/use-insertion-effect-with-fallbacks` package. This package should be used in your defined externals if you bundle Emotion for whatever reason. It references `useInsertionEffect` in a very specific way that allows us to use it conditionally. However, if the code consuming Emotion is bundled as a library with Emotion in it then some bundlers might change the way in which we reference `useInsertionEffect` and that might create problems for bundlers used to consume the said library code. By externalizing this new package you can still bundle Emotion if you want to without running into this problem as you won't "destroy" the carefully crafted reference to `useInsertionEffect` in the process.
+
+Note that we don't recommend bundling Emotion. You should have very specific reasons to do so.

.changeset/lemon-emus-applaud.md

@@ -0,0 +1,5 @@
+---
+'@emotion/use-insertion-effect-with-fallbacks': major
+---
+
+A wrapper package that uses `useInsertionEffect` or a specific fallback for it. It comes with two exports: `useInsertionEffectAlwaysWithSyncFallback` and `useInsertionEffectWithLayoutFallback`.

packages/react/package.json

@@ -66,6 +66,7 @@
     "@emotion/babel-plugin": "^11.10.0",
     "@emotion/cache": "^11.10.0",
     "@emotion/serialize": "^1.1.0",
+    "@emotion/use-insertion-effect-with-fallbacks": "^0.0.0",
     "@emotion/utils": "^1.2.0",
     "@emotion/weak-memoize": "^0.3.0",
     "hoist-non-react-statics": "^3.3.1"

packages/react/src/class-names.js

@@ -8,7 +8,7 @@ import {
 import { serializeStyles } from '@emotion/serialize'
 import { withEmotionCache } from './context'
 import { ThemeContext } from './theming'
-import useInsertionEffectMaybe from './useInsertionEffectMaybe'
+import { useInsertionEffectAlwaysWithSyncFallback } from '@emotion/use-insertion-effect-with-fallbacks'
 import { isBrowser } from './utils'
 
 type ClassNameArg =
@@ -94,7 +94,7 @@ type Props = {
 }
 
 const Insertion = ({ cache, serializedArr }) => {
-  let rules = useInsertionEffectMaybe(() => {
+  let rules = useInsertionEffectAlwaysWithSyncFallback(() => {
     let rules = ''
     for (let i = 0; i < serializedArr.length; i++) {
       let res = insertStyles(cache, serializedArr[i], false)

packages/react/src/emotion-element.js

@@ -10,7 +10,7 @@ import {
 import { hasOwnProperty, isBrowser } from './utils'
 import { serializeStyles } from '@emotion/serialize'
 import { getLabelFromStackTrace } from './get-label-from-stack-trace'
-import useInsertionEffectMaybe from './useInsertionEffectMaybe'
+import { useInsertionEffectAlwaysWithSyncFallback } from '@emotion/use-insertion-effect-with-fallbacks'
 
 let typePropName = '__EMOTION_TYPE_PLEASE_DO_NOT_USE__'
 
@@ -57,7 +57,7 @@ export const createEmotionProps = (type: React.ElementType, props: Object) => {
 const Insertion = ({ cache, serialized, isStringTag }) => {
   registerStyles(cache, serialized, isStringTag)
 
-  const rules = useInsertionEffectMaybe(() =>
+  const rules = useInsertionEffectAlwaysWithSyncFallback(() =>
     insertStyles(cache, serialized, isStringTag)
   )
 

packages/react/src/global.js

@@ -4,6 +4,7 @@ import { withEmotionCache } from './context'
 import { ThemeContext } from './theming'
 import { insertStyles } from '@emotion/utils'
 import { isBrowser } from './utils'
+import { useInsertionEffectWithLayoutFallback } from '@emotion/use-insertion-effect-with-fallbacks'
 
 import { serializeStyles } from '@emotion/serialize'
 
@@ -13,10 +14,6 @@ type GlobalProps = {
   +styles: Styles | (Object => Styles)
 }
 
-const useInsertionEffect = React['useInsertion' + 'Effect']
-  ? React['useInsertion' + 'Effect']
-  : React.useLayoutEffect
-
 let warnedAboutCssPropForGlobal = false
 
 // maintain place over rerenders.
@@ -87,7 +84,7 @@ export let Global: React.AbstractComponent<GlobalProps> =
 
     let sheetRef = React.useRef()
 
-    useInsertionEffect(() => {
+    useInsertionEffectWithLayoutFallback(() => {
       const key = `${cache.key}-global`
 
       // use case of https://github.com/emotion-js/emotion/issues/2675
@@ -117,7 +114,7 @@ export let Global: React.AbstractComponent<GlobalProps> =
       }
     }, [cache])
 
-    useInsertionEffect(() => {
+    useInsertionEffectWithLayoutFallback(() => {
       let sheetRefCurrent = (sheetRef.current: any)
       let [sheet, rehydrating] = sheetRefCurrent
       if (rehydrating) {

packages/react/src/useInsertionEffectMaybe.js

@@ -15,6 +15,7 @@
     "@emotion/babel-plugin": "^11.10.0",
     "@emotion/is-prop-valid": "^1.2.0",
     "@emotion/serialize": "^1.1.0",
+    "@emotion/use-insertion-effect-with-fallbacks": "^0.0.0",
     "@emotion/utils": "^1.2.0"
   },
   "peerDependencies": {

packages/styled/package.json

@@ -15,7 +15,7 @@ import {
   registerStyles
 } from '@emotion/utils'
 import { serializeStyles } from '@emotion/serialize'
-import useInsertionEffectMaybe from './useInsertionEffectMaybe'
+import { useInsertionEffectAlwaysWithSyncFallback } from '@emotion/use-insertion-effect-with-fallbacks'
 
 const ILLEGAL_ESCAPE_SEQUENCE_ERROR = `You have illegal escape sequence in your template literal, most likely inside content's property value.
 Because you write your CSS inside a JavaScript string you actually have to do double escaping, so for example "content: '\\00d7';" should become "content: '\\\\00d7';".
@@ -27,7 +27,7 @@ let isBrowser = typeof document !== 'undefined'
 const Insertion = ({ cache, serialized, isStringTag }) => {
   registerStyles(cache, serialized, isStringTag)
 
-  const rules = useInsertionEffectMaybe(() =>
+  const rules = useInsertionEffectAlwaysWithSyncFallback(() =>
     insertStyles(cache, serialized, isStringTag)
   )