|
| 1 | +# Hot reload |
| 2 | + |
| 3 | +FrankenPHP incluye una función de **hot reload** integrada diseñada para mejorar significativamente la experiencia del desarrollador. |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | +Esta función proporciona un flujo de trabajo similar a **Hot Module Replacement (HMR)** encontrado en herramientas modernas de JavaScript (como Vite o webpack). |
| 8 | +En lugar de actualizar manualmente el navegador después de cada cambio de archivo (código PHP, plantillas, archivos JavaScript y CSS...), |
| 9 | +FrankenPHP actualiza el contenido en tiempo real. |
| 10 | + |
| 11 | +La Hot Reload funciona de forma nativa con WordPress, Laravel, Symfony y cualquier otra aplicación o framework PHP. |
| 12 | + |
| 13 | +Cuando está activada, FrankenPHP vigila el directorio de trabajo actual en busca de cambios en el sistema de archivos. |
| 14 | +Cuando se modifica un archivo, envía una actualización [Mercure](mercure.md) al navegador. |
| 15 | + |
| 16 | +Dependiendo de la configuración, el navegador: |
| 17 | + |
| 18 | +- **Transformará el DOM** (preservando la posición de desplazamiento y el estado de los inputs) si [Idiomorph](https://github.com/bigskysoftware/idiomorph) está cargado. |
| 19 | +- **Recargará la página** (recarga en vivo estándar) si Idiomorph no está presente. |
| 20 | + |
| 21 | +## Configuración |
| 22 | + |
| 23 | +Para habilitar la Hot Reload, active Mercure y luego agregue la subdirectiva `hot_reload` a la directiva `php_server` en su `Caddyfile`. |
| 24 | + |
| 25 | +> [!WARNING] |
| 26 | +> Esta función está destinada **únicamente a entornos de desarrollo**. |
| 27 | +> No active `hot_reload` en producción, ya que vigilar el sistema de archivos implica una sobrecarga de rendimiento y expone endpoints internos. |
| 28 | +
|
| 29 | +```caddyfile |
| 30 | +localhost |
| 31 | +
|
| 32 | +mercure { |
| 33 | + anonymous |
| 34 | +} |
| 35 | +
|
| 36 | +root public/ |
| 37 | +php_server { |
| 38 | + hot_reload |
| 39 | +} |
| 40 | +``` |
| 41 | + |
| 42 | +Por omisión, FrankenPHP vigilará todos los archivos en el directorio de trabajo actual que coincidan con este patrón glob: `./**/*.{css,env,gif,htm,html,jpg,jpeg,js,mjs,php,png,svg,twig,webp,xml,yaml,yml}` |
| 43 | + |
| 44 | +Es posible establecer explícitamente los archivos a vigilar usando la sintaxis glob: |
| 45 | + |
| 46 | +```caddyfile |
| 47 | +localhost |
| 48 | +
|
| 49 | +mercure { |
| 50 | + anonymous |
| 51 | +} |
| 52 | +
|
| 53 | +root public/ |
| 54 | +php_server { |
| 55 | + hot_reload src/**/*{.php,.js} config/**/*.yaml |
| 56 | +} |
| 57 | +``` |
| 58 | + |
| 59 | +Use la forma larga para especificar el tema de Mercure a utilizar, así como qué directorios o archivos vigilar, proporcionando rutas a la opción `hot_reload`: |
| 60 | + |
| 61 | +```caddyfile |
| 62 | +localhost |
| 63 | +
|
| 64 | +mercure { |
| 65 | + anonymous |
| 66 | +} |
| 67 | +
|
| 68 | +root public/ |
| 69 | +php_server { |
| 70 | + hot_reload { |
| 71 | + topic hot-reload-topic |
| 72 | + watch src/**/*.php |
| 73 | + watch assets/**/*.{ts,json} |
| 74 | + watch templates/ |
| 75 | + watch public/css/ |
| 76 | + } |
| 77 | +} |
| 78 | +``` |
| 79 | + |
| 80 | +## Integración Lado-Cliente |
| 81 | + |
| 82 | +Mientras el servidor detecta los cambios, el navegador necesita suscribirse a estos eventos para actualizar la página. |
| 83 | +FrankenPHP expone la URL del Mercure Hub a utilizar para suscribirse a los cambios de archivos a través de la variable de entorno `$_SERVER['FRANKENPHP_HOT_RELOAD']`. |
| 84 | + |
| 85 | +Una biblioteca JavaScript de conveniencia, [frankenphp-hot-reload](https://www.npmjs.com/package/frankenphp-hot-reload), también está disponible para manejar la lógica lado-cliente. |
| 86 | +Para usarla, agregue lo siguiente a su diseño principal: |
| 87 | + |
| 88 | +```php |
| 89 | +<!DOCTYPE html> |
| 90 | +<title>FrankenPHP Hot Reload</title> |
| 91 | +<?php if (isset($_SERVER['FRANKENPHP_HOT_RELOAD'])): ?> |
| 92 | +<meta name="frankenphp-hot-reload:url" content="<?=$_SERVER['FRANKENPHP_HOT_RELOAD']?>"> |
| 93 | +<script src="https://cdn.jsdelivr.net/npm/idiomorph"></script> |
| 94 | +<script src="https://cdn.jsdelivr.net/npm/frankenphp-hot-reload/+esm" type="module"></script> |
| 95 | +<?php endif ?> |
| 96 | +``` |
| 97 | + |
| 98 | +La biblioteca se suscribirá automáticamente al hub de Mercure, obtendrá la URL actual en segundo plano cuando se detecte un cambio en un archivo y transformará el DOM. |
| 99 | +Está disponible como un paquete [npm](https://www.npmjs.com/package/frankenphp-hot-reload) y en [GitHub](https://github.com/dunglas/frankenphp-hot-reload). |
| 100 | + |
| 101 | +Alternativamente, puede implementar su propia lógica lado-cliente suscribiéndose directamente al hub de Mercure usando la clase nativa de JavaScript `EventSource`. |
| 102 | + |
| 103 | +### Modo Worker |
| 104 | + |
| 105 | +Si está ejecutando su aplicación en [Modo Worker](https://frankenphp.dev/docs/worker/), el script de su aplicación permanece en memoria. |
| 106 | +Esto significa que los cambios en su código PHP no se reflejarán inmediatamente, incluso si el navegador se recarga. |
| 107 | + |
| 108 | +Para la mejor experiencia de desarrollador, debe combinar `hot_reload` con [la subdirectiva `watch` en la directiva `worker`](config.md#watching-for-file-changes). |
| 109 | + |
| 110 | +- `hot_reload`: actualiza el **navegador** cuando los archivos cambian |
| 111 | +- `worker.watch`: reinicia el worker cuando los archivos cambian |
| 112 | + |
| 113 | +```caddy |
| 114 | +localhost |
| 115 | +
|
| 116 | +mercure { |
| 117 | + anonymous |
| 118 | +} |
| 119 | +
|
| 120 | +root public/ |
| 121 | +php_server { |
| 122 | + hot_reload |
| 123 | + worker { |
| 124 | + file /path/to/my_worker.php |
| 125 | + watch |
| 126 | + } |
| 127 | +} |
| 128 | +``` |
| 129 | + |
| 130 | +### Funcionamiento |
| 131 | + |
| 132 | +1. **Vigilancia**: FrankenPHP monitorea el sistema de archivos en busca de modificaciones usando [la biblioteca `e-dant/watcher`](https://github.com/e-dant/watcher) internamente (contribuimos con el binding de Go). |
| 133 | +2. **Reinicio (Modo Worker)**: si `watch` está habilitado en la configuración del worker, el worker de PHP se reinicia para cargar el nuevo código. |
| 134 | +3. **Envío**: se envía una carga útil JSON que contiene la lista de archivos modificados al [hub de Mercure](https://mercure.rocks) integrado. |
| 135 | +4. **Recepción**: El navegador, escuchando a través de la biblioteca JavaScript, recibe el evento de Mercure. |
| 136 | +5. **Actualización**: |
| 137 | + |
| 138 | +- Si se detecta **Idiomorph**, obtiene el contenido actualizado y transforma el HTML actual para que coincida con el nuevo estado, aplicando los cambios al instante sin perder el estado. |
| 139 | +- De lo contrario, se llama a `window.location.reload()` para recargar la página. |
0 commit comments