styled-components: Conflict with Webpack's 5 Federated Modules (Invalid hook call)

When trying to consume a federated module that uses styled-components, React throws the “Invalid hook call” error.

Environment

System

  • OS: macOS Mojave 10.14.6
  • CPU: (12) x64 Intel® Core™ i7-8750H CPU @ 2.20GHz
  • Memory: 1.13 GB / 16.00 GB
  • Shell: 3.2.57 - /bin/bash

Binaries

  • Node: 12.16.1 - /usr/local/bin/node
  • npm: 6.13.4 - /usr/local/bin/npm

Dependencies

  • react@16.13.1
  • styled-components@5.2.0

Reproduction

See this repository for reproduction code:

It contains 2 npm projects. Do npm install on both and start them in order (first foo then shell). Once everything is running, if you navigate to /foo you should see that the app crashes.

Steps to reproduce

  1. Create an npm project which exposes a component that uses styled-components.
  2. Create another npm project that consumes and renders the federated module.

Expected Behavior

React should be able to render the styled component.

Actual Behavior

React throws a Invalid hook call error on the console when trying to render the styled component.

About this issue

  • Original URL
  • State: closed
  • Created 6 years ago
  • Comments: 17

Most upvoted comments

Hey Guys, I know it’s more Webpack than styled components related, but this seems the only issue I found on the Internet so far about the invalid hook call which I’m struggling with.

I’ve got 2 webpack bundles, first is for the components library, the second is the host, the app that uses it.

Components library:

  plugins: [
    new CleanWebpackPlugin(),
    new ESLintWebpackPlugin({
      extensions: ['ts', 'tsx'],
    }),
    new ModuleFederationPlugin({
      name: 'figuraSettings',
      library: { type: 'var', name: 'figuraSettings' },
      filename: 'remoteEntry.js',
      exposes: {
        './Panel': 'src/components/Panel',
        './Folder': 'src/components/Folder',
        './TextControl': 'src/components/controls/TextControl',
        './NumberControl': 'src/components/controls/NumberControl',
        './SelectControl': 'src/components/controls/SelectControl',
        './ColorControl': 'src/components/controls/ColorControl',
        './MultiColorControl': 'src/components/controls/MultiColorControl',
        './Vector2dControl': 'src/components/controls/Vector2dControl',
        './ButtonControl': 'src/components/controls/ButtonControl',
        './CheckboxControl': 'src/components/controls/CheckboxControl',
        './RangeControl': 'src/components/controls/RangeControl',
      },
      shared: {
        ...dependencies,
        react: {
          singleton: true,
          requiredVersion: peerDeps.react,
        },
        'react-dom': {
          singleton: true,
          requiredVersion: peerDeps['react-dom'],
        },
      },
    }),
  ],
};

And the host app:

  plugins: [
    new CleanWebpackPlugin(),
    new HTMLWebpackPlugin({
      template: path.resolve(__dirname, '../public/index.html'),
    }),
    new ESLintWebpackPlugin({
      extensions: ['ts', 'tsx'],
    }),
    new ModuleFederationPlugin({
      name: 'figuraUI',
      remotes: {
        figuraSettings: `figuraSettings@http//localhost:3001/remoteEntry.js`,
      },
    }),
  ],
  resolve: {
    extensions: ['.tsx', '.ts', '.js'],
    plugins: [
      new TsconfigPathsPlugin({
        configFile: path.resolve(__dirname, '../tsconfig.json'),
      }),
    ],
  },
  module: {
    rules: [
      {
        test: /\.worker\.ts$/,
        use: ['worker-loader'],
      },
      {
        test: /\.tsx?$/,
        use: 'ts-loader',
        exclude: path.resolve(process.cwd(), 'node_modules'),
        include: path.resolve(process.cwd(), 'src'),
      },
      {
        test: /\.css$/,
        use: ['style-loader', 'css-loader'],
      },
      {
        test: /\.scss$/i,
        use: [
          'style-loader',
          'css-loader?modules=true',
          {
            loader: 'postcss-loader',
            options: {
              postcssOptions: {
                plugins: [require('autoprefixer')],
              },
            },
          },
          'sass-loader',
        ],
      },
      {
        test: /\.html$/,
        use: ['html-loader'],
      },
      {
        test: /\.(png|svg|jpg|gif)$/,
        use: ['file-loader'],
      },
      {
        test: /\.(woff|woff2|eot|ttf|otf)$/,
        use: ['file-loader'],
      },
    ],
  },
};

When I try to use the Panel component in my host like that:

const FiguraPanel = React.lazy(() => import('figuraSettings/Panel'));

const Editor: React.FC = () => (
  <>
    <React.Suspense fallback="Loading...">
      <FiguraPanel rootId="settings-root" />
    </React.Suspense>

I get the same invalid hook error. I think there might be somehow 2 React instances loading but after comparing the configurations posted above, I didn’t see the difference. 😞

I’m seeing this issue too. I really would like to use module federation. I’m on

“react”: “16.13.1”, “react-dom”: “16.13.1”,

Using styled components is ok for me, but when I use ant design, it crashes with

react.development.js:1465 Uncaught Error: Invalid hook call. Hooks can only be called inside of the body of a function component. This could happen for one of the following reasons:
1. You might have mismatching versions of React and the renderer (such as React DOM)
2. You might be breaking the Rules of Hooks
3. You might have more than one copy of React in the same app
See https://fb.me/react-invalid-hook-call for tips about how to debug and fix this problem.
    at resolveDispatcher (react.development.js:1465)
    at Object.useState (react.development.js:1496)
    at Alert (index.js:96)
    at renderWithHooks (react-dom.development.js:14803)
    at mountIndeterminateComponent (react-dom.development.js:17482)
    at beginWork (react-dom.development.js:18596)
    at HTMLUnknownElement.callCallback (react-dom.development.js:188)
    at Object.invokeGuardedCallbackDev (react-dom.development.js:237)
    at invokeGuardedCallback (react-dom.development.js:292)
    at beginWork$1 (react-dom.development.js:23203)
resolveDispatcher @ react.development.js:1465
useState @ react.development.js:1496
Alert @ index.js:96
renderWithHooks @ react-dom.development.js:14803
mountIndeterminateComponent @ react-dom.development.js:17482
beginWork @ react-dom.development.js:18596
callCallback @ react-dom.development.js:188
invokeGuardedCallbackDev @ react-dom.development.js:237
invokeGuardedCallback @ react-dom.development.js:292
beginWork$1 @ react-dom.development.js:23203
performUnitOfWork @ react-dom.development.js:22154
workLoopSync @ react-dom.development.js:22130
performSyncWorkOnRoot @ react-dom.development.js:21756
(anonymous) @ react-dom.development.js:11089
unstable_runWithPriority @ scheduler.development.js:653
runWithPriority$1 @ react-dom.development.js:11039
flushSyncCallbackQueueImpl @ react-dom.development.js:11084
flushSyncCallbackQueue @ react-dom.development.js:11072
batchedUpdates$1 @ react-dom.development.js:21862
notify @ Subscription.js:19
notifyNestedSubs @ Subscription.js:92
handleChangeWrapper @ Subscription.js:97
dispatch @ redux.js:222
dispatch @ VM17625:3856
(anonymous) @ redux-saga-core.esm.js:1410
dispatch @ redux.js:638
(anonymous) @ io-6de156f3.js:133
(anonymous) @ redux-saga-core.esm.js:472
exec @ redux-saga-core.esm.js:31
flush @ redux-saga-core.esm.js:87
asap @ redux-saga-core.esm.js:46
runPutEffect @ redux-saga-core.esm.js:468
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
currCb @ redux-saga-core.esm.js:1251
Promise.then (async)
resolvePromise @ redux-saga-core.esm.js:395
runCallEffect @ redux-saga-core.esm.js:527
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
proc @ redux-saga-core.esm.js:1108
runCallEffect @ redux-saga-core.esm.js:533
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
currCb @ redux-saga-core.esm.js:1251
runGetContextEffect @ redux-saga-core.esm.js:773
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
proc @ redux-saga-core.esm.js:1108
(anonymous) @ redux-saga-core.esm.js:585
immediately @ redux-saga-core.esm.js:56
runForkEffect @ redux-saga-core.esm.js:584
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
currCb @ redux-saga-core.esm.js:1251
chCbAtKey @ redux-saga-core.esm.js:698
currCb @ redux-saga-core.esm.js:1251
takeCb @ redux-saga-core.esm.js:503
put @ redux-saga-core.esm.js:339
chan.put @ redux-saga-core.esm.js:371
(anonymous) @ redux-saga-core.esm.js:1412
dispatch @ redux.js:638
(anonymous) @ io-6de156f3.js:133
(anonymous) @ redux-saga-core.esm.js:472
exec @ redux-saga-core.esm.js:31
flush @ redux-saga-core.esm.js:87
asap @ redux-saga-core.esm.js:46
runPutEffect @ redux-saga-core.esm.js:468
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
currCb @ redux-saga-core.esm.js:1251
Promise.then (async)
resolvePromise @ redux-saga-core.esm.js:395
runCallEffect @ redux-saga-core.esm.js:527
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
proc @ redux-saga-core.esm.js:1108
runCallEffect @ redux-saga-core.esm.js:533
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
currCb @ redux-saga-core.esm.js:1251
runGetContextEffect @ redux-saga-core.esm.js:773
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
proc @ redux-saga-core.esm.js:1108
(anonymous) @ redux-saga-core.esm.js:585
immediately @ redux-saga-core.esm.js:56
runForkEffect @ redux-saga-core.esm.js:584
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
currCb @ redux-saga-core.esm.js:1251
chCbAtKey @ redux-saga-core.esm.js:698
currCb @ redux-saga-core.esm.js:1251
takeCb @ redux-saga-core.esm.js:503
put @ redux-saga-core.esm.js:339
chan.put @ redux-saga-core.esm.js:371
(anonymous) @ redux-saga-core.esm.js:1412
dispatch @ redux.js:638
(anonymous) @ io-6de156f3.js:133
(anonymous) @ redux-saga-core.esm.js:472
exec @ redux-saga-core.esm.js:31
flush @ redux-saga-core.esm.js:87
immediately @ redux-saga-core.esm.js:58
runForkEffect @ redux-saga-core.esm.js:584
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
currCb @ redux-saga-core.esm.js:1251
end @ redux-saga-core.esm.js:1012
task.cont @ redux-saga-core.esm.js:836
next @ redux-saga-core.esm.js:1170
currCb @ redux-saga-core.esm.js:1251
Promise.then (async)
resolvePromise @ redux-saga-core.esm.js:395
runCallEffect @ redux-saga-core.esm.js:527
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
proc @ redux-saga-core.esm.js:1108
runCallEffect @ redux-saga-core.esm.js:533
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
currCb @ redux-saga-core.esm.js:1251
end @ redux-saga-core.esm.js:1012
task.cont @ redux-saga-core.esm.js:836
next @ redux-saga-core.esm.js:1170
currCb @ redux-saga-core.esm.js:1251
runSelectEffect @ redux-saga-core.esm.js:731
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
currCb @ redux-saga-core.esm.js:1251
(anonymous) @ redux-saga-core.esm.js:481
exec @ redux-saga-core.esm.js:31
flush @ redux-saga-core.esm.js:87
asap @ redux-saga-core.esm.js:46
runPutEffect @ redux-saga-core.esm.js:468
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
currCb @ redux-saga-core.esm.js:1251
checkEnd @ io-6de156f3.js:165
chCbAtKey @ io-6de156f3.js:181
currCb @ redux-saga-core.esm.js:1251
Promise.then (async)
resolvePromise @ redux-saga-core.esm.js:395
runCallEffect @ redux-saga-core.esm.js:527
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
(anonymous) @ redux-saga-core.esm.js:673
runAllEffect @ redux-saga-core.esm.js:672
runEffect @ redux-saga-core.esm.js:1204
digestEffect @ redux-saga-core.esm.js:1271
next @ redux-saga-core.esm.js:1161
currCb @ redux-saga-core.esm.js:1251
(anonymous) @ redux-saga-core.esm.js:481
exec @ redux-saga-core.esm.js:31
flush @ redux-saga-core.esm.js:87
asap @ redux-saga-core.esm.js:46
chan.put @ redux-saga-core.esm.js:375
(anonymous) @ redux-saga-core.esm.js:1412
dispatch @ VM17625:14608
createApp @ createApp.tsx:41
./src/pages/index.tsx @ index.tsx:25
__webpack_require__ @ bootstrap:19
(anonymous) @ startup:5
(anonymous) @ startup:6
Show 122 more frames
react_devtools_backend.js:2560 The above error occurred in the <Alert> component:
    in Alert
    in span
    in StyledComponent

new ModuleFederationPlugin({
      name: "shell",
      filename: "remoteEntry.js",
      remotes: {
        order: "order@http://localhost:3002/remoteEntry.js",
        dashboard: "dashboard@http://localhost:3001/remoteEntry.js",
        profile: "profile@http://localhost:3004/remoteEntry.js",
        shell: "shell@http://localhost:3000/remoteEntry.js",
      },
      exposes: {
        "./Shell": "./src/Shell",
        "./Service": "./src/Service",
      },
      shared: [
        {
          ...deps,
          react: {
            singleton: true,
            requiredVersion: deps.react,
          },
          "react-dom": {
            singleton: true,
            requiredVersion: deps["react-dom"],
          },
        },
        // Workaround explaination: https://www.youtube.com/watch?v=-LNcpralkjM&t=540
        "./src/Service",
      ],
    }),

You probably need to share react, or some context dependency of styled components. Make sure that these things are registered as singletons. If you post a repo somewhere I can take a look. Pretty sure we’ve seen this one before already at webpack.

Check all the relevant repos, hosts and remote are sharing react and react dom, singletons.

Make sure they share styled components. If you’re using dynamic imports, that’s best. If this is a static import it’s sub-optimal.

What it sounds like is either another copy of react is being pulled across, or there’s two separately theme or context providers being created.

You need to remove scripts from html if you have them. Also make sure to share react dom as well. Don’t want multiple react instances loading.

If you don’t share it though then remotes will download their own copy. Trust me you want to share it if it’s installed on anything else. If it’s not. Then you’re good