Component Versioning

Component Versioning Overview

Component Versioning lets you structure Module Federation work so it stays readable, testable, and easy to scale. Instead of ad-hoc code, you follow a clear pattern that other developers can recognise immediately.

The key is to keep component versioning focused and predictable. Start from the minimal example here, then layer in only the complexity your feature actually needs.

new ModuleFederationPlugin({
  name: 'shell',
  shared: {
    react: { singleton: true, requiredVersion: '^18.2.0' },
    'react-dom': { singleton: true, requiredVersion: '^18.2.0' },
  },
});

Marking shared libraries as singletons ensures one React instance is used across all micro frontends.

Component Versioning 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 Component Versioning example and grow it only as needed.
• Keep configuration explicit so Component Versioning behaves the same in every environment.
• Name things clearly so teammates understand your Component Versioning at a glance.
• Add tests around Component Versioning early to lock in expected behaviour.

Module Federation Cheatsheet

Key Module Federation settings related to component versioning.

How Component Versioning Works in Module Federation

Component Versioning 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.

Marking shared libraries as singletons ensures one React instance is used across all micro frontends.

• 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 Component Versioning

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

Common Mistakes

• Copying component versioning snippets without understanding what each line does.
• Skipping error handling and edge cases when wiring up component versioning.
• Leaving component versioning untested, so regressions slip into production.
• Over-engineering component versioning before you actually need the extra flexibility.

Key Takeaways

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