Remote Configuration

Remote Configuration Overview

At its core, remote configuration is about doing one thing well inside your Module Federation project. Once you understand the pattern, you can apply it consistently across features and teams.

Good remote configuration pays off across the whole codebase: fewer surprises, easier testing, and smoother onboarding. The snippet below is a solid starting point.

// remote (webpack.config.js)
const { ModuleFederationPlugin } = require('webpack').container;

module.exports = {
  plugins: [
    new ModuleFederationPlugin({
      name: 'catalog',
      filename: 'remoteEntry.js',
      exposes: {
        './ProductList': './src/ProductList',
      },
      shared: ['react', 'react-dom'],
    }),
  ],
};

A remote exposes modules through remoteEntry.js so hosts can load them at runtime.

Remote Configuration Example

new ModuleFederationPlugin({
  name: 'app',
  filename: 'remoteEntry.js',
  exposes: { './Widget': './src/Widget' },
  remotes: { other: 'other@http://host/remoteEntry.js' },
  shared: { react: { singleton: true } },
});

• Start from a minimal Remote Configuration example and grow it only as needed.
• Keep configuration explicit so Remote Configuration behaves the same in every environment.
• Name things clearly so teammates understand your Remote Configuration at a glance.
• Add tests around Remote Configuration early to lock in expected behaviour.

Module Federation Cheatsheet

Key Module Federation settings related to remote configuration.

How Remote Configuration Works in Module Federation

Remote Configuration builds on Module Federation's ability to load code from another independently built and deployed application at runtime. Each app can be a host, a remote, or both.

A remote exposes modules through remoteEntry.js so hosts can load them at runtime.

• Remotes expose modules through a remoteEntry.js manifest.
• Hosts declare remotes and import exposed modules dynamically.
• Shared dependencies are deduplicated, ideally as singletons.
• Each micro frontend builds and deploys on its own schedule.

Practical Guidance for Remote Configuration

In production, remote configuration needs careful version management and graceful failure handling. Align shared dependency versions and always render a fallback when a remote cannot load.

Common Mistakes

• Skipping error handling and edge cases when wiring up remote configuration.
• Leaving remote configuration untested, so regressions slip into production.
• Over-engineering remote configuration before you actually need the extra flexibility.
• Ignoring documentation, which makes remote configuration hard for the next developer to change.

Key Takeaways

• Remote Configuration is a core part of working effectively with Module Federation.
• Start small and keep remote configuration focused on a single responsibility.
• Apply consistent patterns so remote configuration scales across your project.
• Test and document remote configuration to keep it maintainable over time.