# reduxjs/redux-devtools architecture

> Architecture diagram of the GitHub repository reduxjs/redux-devtools, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/reduxjs/redux-devtools
- Repository: https://github.com/reduxjs/redux-devtools

## Overview

##### Project Type and Purpose
- This is a large monorepo (pnpm workspace) hosting the Redux DevTools ecosystem:
- A browser extension (Chrome, Edge, Firefox)
- A standalone Electron‐based DevTools app
- A React‐component library (for in‐app manual integration)
- A CLI (remote monitoring and server injection)
- Over 40 supporting npm packages (core, monitors, utilities, charting, styling, etc.)
- The README confirms it powers up Redux (or any state‐change architecture) by instrumenting the store, capturing actions/state, and rendering UIs or relaying remotely.

##### File Structure Analysis
- Top‐level directories:
- extension/ – the browser extension code, with subdirectories for chrome/, edge/, firefox/, background, contentScript, devpanel, devtools, options, pageScript, remote
- packages/ – individual npm packages grouped by domain (e.g., redux-devtools-extension, redux-devtools-instrument, redux-devtools-app-core, monitors, ui components, utils, serialize, cli, chart monitors, etc.)
- docs/ – markdown documentation and walkthroughs
- root config files – pnpm-workspace.yaml, tsconfig.base.json, eslint and jest configs
- Build & deploy tooling: build.mjs scripts, babel.config, webpack.config.ts files, CI workflows in .github/workflows, change sets, patches.

##### Key Insights from README
- Highlights three main delivery targets: browser extension, standalone app, React component.
- Remote monitoring integration guide.

a. Main Components
- Monorepo Workspace & Build System (pnpm, root configs, CI/CD)
- Core Instrumentation Library (redux-devtools-instrument)
- Browser Extension
– Background script
– Content script
– Devtools panel (UI)
– Options page
– Remote messaging bridge
- Standalone Electron App (packages/redux-devtools-app, redux-devtools-app-core)
- React Component Library (packages/redux-devtools)
- CLI & Remote Server (packages/redux-devtools-cli)
- Monitors & UI Packages (chart, dock, log, inspector, slider, rtk-query monitor, ui primitives)
- Utilities (serialize, utils, styling, d3 visualizers)
- External Redux Store(s) being instrumented
b. Relationships & Data Flows
1. Application’s Redux store loads the instrumentation enhancer (injected via manual integration, CLI injection server, or extension’s content script).
2. Instrumentation library intercepts actions/state changes, serializes them (redux-devtools-serialize), and dispatches to a messaging channel.
3. Browser extension:
– Content script injects into the page, communicates with background script.
– Background script forwards messages to the DevTools panel or remote endpoints.
4. Standalone app: connects over WebSocket or other transport to the instrumented store (via remote monitor).
5. React component: can be embedded in the app directly to display the DevTools UI.
6. CLI: can spin up an injection server or serve a web UI, connecting to the instrumented app via GraphQL/socket.
7. UI is composed of core app components (packages/redux-devtools-app-core) and monitors (e.g., chart monitor, inspector monitor).
c. Architectural Patterns & Design Principles
- Monorepo modularization: one package per feature, shared core & UI libraries
- Publish‐per‐package with independent build scripts (babel, webpack, tsconfig)
- Decoupled transports: messaging adapters for extension, WebSocket for remote, direct embedding for React library
- Plugin‐style DevTools monitors (each monitor is a self‐contained package)
- Clear separation between instrumentation (data capture) and presentation (UI components)
d. Key Technologies & Frameworks
- TypeScript & JavaScript (mixed codebase)
- React for UIs (DevTools panels, standalone App, component library)
- Redux for state management & instrumentation enhancer
- pnpm workspaces for monorepo management
- Babel & Webpack for transpilation and bundling
- Electron for standalone DevTools app
- GraphQL/REST/WebSocket for remote monitoring (CLI package)
- D3 for state visualizations (d3-state-visualizer)
- Jest for testing

##### Details to Capture
- Monorepo/workspace boundary and build graph (dependencies between packages)
- The four primary transports (extension messaging, WebSocket, GraphQL/HTTP, direct embedding)
- The instrumentation enhancer module and serialize steps
- The DevTools UI layering: core + monitors
- CLI injection server route and Electron app route

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Monorepo Workspace & Build System
    subgraph "Monorepo Workspace & Build System"
        direction TB
        MW1["pnpm-workspace.yaml"]:::tool
        MW2["tsconfig.base.json"]:::tool
        MW3[".github/workflows/CI.yml"]:::tool
        MW4[".github/workflows/release.yml"]:::tool
    end

    %% Core Instrumentation Library
    subgraph "Core Instrumentation Library" 
        direction TB
        CI1["instrument.ts"]:::core
        CI2["getSymbolObservable.ts"]:::core
    end

    %% External Redux Store
    ER["External Redux Store"]:::external

    %% Instrumentation
    ER -->|"uses enhancer"| CI1
    CI1 -->|"serializes via"| CI2

    %% Serialization & Utilities
    subgraph "Serialization & Utilities"
        direction TB
        SU1["serialize/index.ts"]:::tool
        SU2["utils/index.ts"]:::tool
        SU3["react-base16-styling/src/index.ts"]:::tool
    end
    CI2 -->|"serializes data"| SU1

    %% Plugin-style Monitors
    subgraph "Plugin Monitors" 
        direction TB
        M1["ChartMonitor.tsx"]:::monitor
        M2["DockMonitor.tsx"]:::monitor
        M3["LogMonitor.tsx"]:::monitor
        M4["DevtoolsInspector.tsx"]:::monitor
        M5["SliderMonitor.tsx"]:::monitor
        M6["RtkQueryMonitor.tsx"]:::monitor
    end

    %% Core UI Primitives
    subgraph "Core UI Primitives"
        direction TB
        UI1["Button.tsx"]:::monitor
        UI2["Container/index.tsx"]:::monitor
        UI3["Dialog.tsx"]:::monitor
    end

    SU1 -->|"provides data to"| M1
    SU1 --> M2
    SU1 --> M3
    SU1 --> M4
    SU1 --> M5
    SU1 --> M6

    SU1 --> UI1
    SU1 --> UI2
    SU1 --> UI3

    %% Browser Extension
    subgraph "Browser Extension" 
        direction TB
        subgraph Background
            direction TB
            BE1["index.ts"]:::ext
            BE2["contextMenus.ts"]:::ext
            BE3["openWindow.ts"]:::ext
        end
        Content["contentScript/index.ts"]:::ext
        DevTools["devtools/index.ts"]:::ext
        DevPanel["devpanel/index.tsx"]:::ext
        subgraph Options
            direction TB
            Opt1["index.tsx"]:::ext
            Opt2["FilterGroup.tsx"]:::ext
        end
        PageScript["pageScript/index.ts"]:::ext
        RemoteBridge["remote/index.tsx"]:::ext
    end

    CI2 -->|"sends data via pageScript"| PageScript
    PageScript -->|"to background"| BE1
    BE1 -->|"to DevTools UI"| DevTools
    BE1 -->|"to DevPanel"| DevPanel
    BE1 -->|"to Remote"| RemoteBridge

    %% Standalone Electron App
    subgraph "Standalone Electron App"
        direction TB
        subgraph "Electron Wrapper"
            direction TB
            EA1["index.tsx"]:::app
            EA2["middlewares/api.ts"]:::app
            EA3["store/configureStore.ts"]:::app
        end
        subgraph "App Core UI"
            direction TB
            AC1["DevTools.tsx"]:::app
            AC2["InstanceSelector.tsx"]:::app
            AC3["MonitorSelector.tsx"]:::app
        end
    end

    RemoteBridge -->|"WebSocket/HTTP"| EA1
    EA1 --> AC1
    AC1 --> M1
    AC1 --> M2
    AC1 --> M3
    AC1 --> M4
    AC1 --> M5
    AC1 --> M6

    %% React Component Library
    subgraph "React Component Library"
        direction TB
        RC1["createDevTools.tsx"]:::app
        RC2["index.ts"]:::app
    end

    CI2 -->|"direct embedding"| RC1
    RC1 --> AC1

    %% CLI & Remote Server
    subgraph "CLI & Remote Server"
        direction TB
        CLI1["bin/injectServer.ts"]:::tool
        CLI2["bin/openApp.ts"]:::tool
        CLI3["routes.ts"]:::tool
        CLI4["api/schema.ts"]:::tool
        CLI5["store.ts"]:::tool
    end

    CI2 -->|"via CLI"| CLI1
    CLI1 -->|"serves data"| CLI3
    CLI2 --> EA1

    %% Monorepo build edges
    MW1 --> CI1
    MW1 --> SU1
    MW1 --> M1
    MW1 --> EA1
    MW1 --> RC1
    MW1 --> CLI1

    %% Classes
    classDef core fill:#cce5ff,stroke:#004085,color:#004085;
    classDef monitor fill:#d4edda,stroke:#155724,color:#155724;
    classDef ext fill:#fff3cd,stroke:#856404,color:#856404;
    classDef app fill:#f8d7da,stroke:#721c24,color:#721c24;
    classDef tool fill:#e2e3e5,stroke:#6c757d,color:#6c757d;
    classDef external fill:#f0f0f0,stroke:#888888,color:#333333;

    %% Click Events
    click MW1 "https://github.com/reduxjs/redux-devtools/blob/main/pnpm-workspace.yaml"
    click MW2 "https://github.com/reduxjs/redux-devtools/blob/main/tsconfig.base.json"
    click MW3 "https://github.com/reduxjs/redux-devtools/blob/main/.github/workflows/CI.yml"
    click MW4 "https://github.com/reduxjs/redux-devtools/blob/main/.github/workflows/release.yml"
    click CI1 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-instrument/src/instrument.ts"
    click CI2 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-instrument/src/getSymbolObservable.ts"
    click PageScript "https://github.com/reduxjs/redux-devtools/blob/main/extension/src/pageScript/index.ts"
    click BE1 "https://github.com/reduxjs/redux-devtools/blob/main/extension/src/background/index.ts"
    click BE2 "https://github.com/reduxjs/redux-devtools/blob/main/extension/src/background/contextMenus.ts"
    click BE3 "https://github.com/reduxjs/redux-devtools/blob/main/extension/src/background/openWindow.ts"
    click Content "https://github.com/reduxjs/redux-devtools/blob/main/extension/src/contentScript/index.ts"
    click DevTools "https://github.com/reduxjs/redux-devtools/blob/main/extension/src/devtools/index.ts"
    click DevPanel "https://github.com/reduxjs/redux-devtools/blob/main/extension/src/devpanel/index.tsx"
    click Opt1 "https://github.com/reduxjs/redux-devtools/blob/main/extension/src/options/index.tsx"
    click Opt2 "https://github.com/reduxjs/redux-devtools/blob/main/extension/src/options/FilterGroup.tsx"
    click RemoteBridge "https://github.com/reduxjs/redux-devtools/blob/main/extension/src/remote/index.tsx"
    click EA1 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-app/src/index.tsx"
    click EA2 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-app/src/middlewares/api.ts"
    click EA3 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-app/src/store/configureStore.ts"
    click AC1 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-app-core/src/containers/DevTools.tsx"
    click AC2 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-app-core/src/components/InstanceSelector.tsx"
    click AC3 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-app-core/src/components/MonitorSelector.tsx"
    click RC1 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools/src/createDevTools.tsx"
    click RC2 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools/src/index.ts"
    click CLI1 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-cli/src/bin/injectServer.ts"
    click CLI2 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-cli/src/bin/openApp.ts"
    click CLI3 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-cli/src/routes.ts"
    click CLI4 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-cli/src/api/schema.ts"
    click CLI5 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-cli/src/store.ts"
    click SU1 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-serialize/src/index.ts"
    click SU2 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-utils/src/index.ts"
    click SU3 "https://github.com/reduxjs/redux-devtools/blob/main/packages/react-base16-styling/src/index.ts"
    click M1 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-chart-monitor/src/ChartMonitor.tsx"
    click M2 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-dock-monitor/src/DockMonitor.tsx"
    click M3 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-log-monitor/src/LogMonitor.tsx"
    click M4 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-inspector-monitor/src/DevtoolsInspector.tsx"
    click M5 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-slider-monitor/src/SliderMonitor.tsx"
    click M6 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-rtk-query-monitor/src/containers/RtkQueryMonitor.tsx"
    click UI1 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-ui/src/Button/Button.tsx"
    click UI2 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-ui/src/Container/index.tsx"
    click UI3 "https://github.com/reduxjs/redux-devtools/blob/main/packages/redux-devtools-ui/src/Dialog/Dialog.tsx"
```
