asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore: Backend HMR (expriemental) (#14074)

Browse Source 
**What**

 This PR introduces experimental Hot Module Replacement (HMR) for the Medusa backend, enabling developers to see code changes reflected immediately without restarting the server. This significantly improves the development experience by reducing iteration time.

### Key Features

  - Hot reload support for:
    - API Routes
    - Workflows & Steps
    - Scheduled Jobs
    - Event Subscribers
    - Modules
  - IPC-based architecture: The dev server runs in a child process, communicating with the parent watcher via IPC. When HMR fails, the child process is killed and restarted, ensuring
  clean resource cleanup.
  - Recovery mechanism: Automatically recovers from broken module states without manual intervention.
  - Graceful fallback: When HMR cannot handle a change (e.g., medusa-config.ts, .env), the server restarts completely.


### Architecture
```mermaid
  flowchart TB
      subgraph Parent["develop.ts (File Watcher)"]
          W[Watch Files]
      end

      subgraph Child["start.ts (HTTP Server)"]
          R[reloadResources]
          R --> MR[ModuleReloader]
          R --> WR[WorkflowReloader]
          R --> RR[RouteReloader]
          R --> SR[SubscriberReloader]
          R --> JR[JobReloader]
      end

      W -->|"hmr-reload"| R
      R -->|"hmr-result"| W
```

### How to enable it

Backend HMR is behind a feature flag. Enable it by setting:

```ts
  // medusa-config.ts
  module.exports = defineConfig({
    featureFlags: {
      backend_hmr: true
    }
  })
```

or

```bash
export MEDUSA_FF_BACKEND_HMR=true
```

or

```
// .env
MEDUSA_FF_BACKEND_HMR=true
```

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Carlos R. L. Rodrigues <37986729+carlos-r-l-rodrigues@users.noreply.github.com>
This commit is contained in:
Adrien de Peretti
2025-12-08 09:48:36 +01:00
committed by GitHub
parent 4de555b546
commit fe49b567d6
38 changed files with 2222 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
yarn.lock
View File

@@ -3603,7 +3603,6 @@ __metadata:
"@medusajs/cli": 2.12.1
connect-dynamodb: ^3.0.5
ioredis: ^5.4.1
vite: ^5.4.21
peerDependenciesMeta:
"@aws-sdk/client-dynamodb":
optional: true
@@ -3805,7 +3804,7 @@ __metadata:
"@medusajs/workflow-engine-redis": 2.12.1
boxen: ^5.0.1
chalk: ^4.1.2
chokidar: ^3.5.3
chokidar: ^4.0.3
compression: ^1.8.0
express: ^4.21.0
fs-exists-cached: ^1.0.0