Skip to content

Application Communication

Application Communication is an important part of building production-ready single-spa systems. This lesson explains what application communication means, how it works, and how to apply it with practical examples you can reuse.

Application Communication Overview

Application Communication is a building block you will reach for often in single-spa. It keeps related logic together and makes your intent obvious to reviewers and future maintainers.

When you learn application communication properly, you avoid the guesswork that leads to bugs and rework. The example below shows the shape you will use in most real single-spa projects.

// shared utility module exposed via the import map
export const authService = {
  getToken: () => localStorage.getItem('token'),
};

// consumed by any micro frontend
import { authService } from '@org/utils';

Shared utility modules provide cross-app services like auth without tight coupling.

Application Communication Example

registerApplication({
  name: '@org/app',
  app: () => System.import('@org/app'),
  activeWhen: ['/app'],
});
start();
  • Start from a minimal Application Communication example and grow it only as needed.
  • Keep configuration explicit so Application Communication behaves the same in every environment.
  • Name things clearly so teammates understand your Application Communication at a glance.
  • Add tests around Application Communication early to lock in expected behaviour.

Single-SPA Cheatsheet

Core single-spa APIs related to application communication.

API Example Purpose
registerApplication registerApplication({ name, app, activeWhen }) Register a micro frontend
activeWhen activeWhen: ['/checkout'] Route ownership
start start() Begin routing
bootstrap export async function bootstrap() One-time setup
mount export async function mount(props) Render the app
unmount export async function unmount(props) Clean up the app
import map systemjs-importmap Locate app bundles

How Application Communication Works in Single-SPA

Application Communication is part of how single-spa lets multiple applications — even in different frameworks — coexist on one page. A root config registers each app and controls when it is active.

Shared utility modules provide cross-app services like auth without tight coupling.

  • A root config registers apps and calls start().
  • Each app exports bootstrap, mount, and unmount lifecycles.
  • activeWhen decides which routes each app owns.
  • Import maps resolve each app's bundle at runtime.

Practical Guidance for Application Communication

For reliable micro frontends, application communication should isolate failures and keep shared state minimal. Let each team own its app end to end while agreeing on a few shared contracts.

Concern Recommendation
Isolation One app's crash should not break others
Shared state Prefer shared utility modules over globals
Routing Keep activeWhen rules explicit and non-overlapping
Deployment Release via import-map updates per app

Common Mistakes

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

Key Takeaways

  • Application Communication is a core part of working effectively with single-spa.
  • Start small and keep application communication focused on a single responsibility.
  • Apply consistent patterns so application communication scales across your project.
  • Test and document application communication to keep it maintainable over time.

Pro Tip

Pair application communication with automated tests from day one. It is far cheaper to catch single-spa regressions in CI than in production.