mirror of
https://github.com/php/frankenphp.git
synced 2026-03-24 00:52:11 +01:00
225ca409d3
This patch brings hot reloading capabilities to PHP apps: in development, the browser will automatically refresh the page when any source file changes! It's similar to HMR in JavaScript. It is built on top of [the watcher mechanism](https://frankenphp.dev/docs/config/#watching-for-file-changes) and of the [Mercure](https://frankenphp.dev/docs/mercure/) integration. Each time a watched file is modified, a Mercure update is sent, giving the ability to the client to reload the page, or part of the page (assets, images...). Here is an example implementation: ```caddyfile root ./public mercure { subscriber_jwt {env.MERCURE_SUBSCRIBER_JWT_KEY} anonymous } php_server { hot_reload } ``` ```php <?php header('Content-Type: text/html'); ?> <!DOCTYPE html> <html lang="en"> <head> <title>Test</title> <script> const es = new EventSource('<?=$_SERVER['FRANKENPHP_HOT_RELOAD']?>'); es.onmessage = () => location.reload(); </script> </head> <body> Hello ``` I plan to create a helper JS library to handle more advanced cases (reloading CSS, JS, etc), similar to [HotWire Spark](https://github.com/hotwired/spark). Be sure to attend my SymfonyCon to learn more! There is still room for improvement: - Provide an option to only trigger the update without reloading the worker for some files (ex, images, JS, CSS...) - Support classic mode (currently, only the worker mode is supported) - Don't reload all workers when only the files used by one change However, this PR is working as-is and can be merged as a first step. This patch heavily refactors the watcher module. Maybe it will be possible to extract it as a standalone library at some point (would be useful to add a similar feature but not tight to PHP as a Caddy module). --------- Signed-off-by: Kévin Dunglas <kevin@dunglas.fr> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
112 lines
2.4 KiB
Go
112 lines
2.4 KiB
Go
//go:build !nowatcher && !nomercure
|
|
|
|
package caddy
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/gob"
|
|
"errors"
|
|
"fmt"
|
|
"hash/fnv"
|
|
"net/url"
|
|
|
|
"github.com/caddyserver/caddy/v2/caddyconfig/caddyfile"
|
|
"github.com/dunglas/frankenphp"
|
|
)
|
|
|
|
const defaultHotReloadPattern = "./**/*.{css,env,gif,htm,html,jpg,jpeg,js,mjs,php,png,svg,twig,webp,xml,yaml,yml}"
|
|
|
|
type hotReloadContext struct {
|
|
// HotReload specifies files to watch for file changes to trigger hot reloads updates. Supports the glob syntax.
|
|
HotReload *hotReloadConfig `json:"hot_reload,omitempty"`
|
|
}
|
|
|
|
type hotReloadConfig struct {
|
|
Topic string `json:"topic"`
|
|
Watch []string `json:"watch"`
|
|
}
|
|
|
|
func (f *FrankenPHPModule) configureHotReload(app *FrankenPHPApp) error {
|
|
if f.HotReload == nil {
|
|
return nil
|
|
}
|
|
|
|
if f.mercureHub == nil {
|
|
return errors.New("unable to enable hot reloading: no Mercure hub configured")
|
|
}
|
|
|
|
if len(f.HotReload.Watch) == 0 {
|
|
f.HotReload.Watch = []string{defaultHotReloadPattern}
|
|
}
|
|
|
|
if f.HotReload.Topic == "" {
|
|
uid, err := uniqueID(f)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
f.HotReload.Topic = "https://frankenphp.dev/hot-reload/" + uid
|
|
}
|
|
|
|
app.opts = append(app.opts, frankenphp.WithHotReload(f.HotReload.Topic, f.mercureHub, f.HotReload.Watch))
|
|
f.preparedEnv["FRANKENPHP_HOT_RELOAD\x00"] = "/.well-known/mercure?topic=" + url.QueryEscape(f.HotReload.Topic)
|
|
|
|
return nil
|
|
}
|
|
|
|
func (f *FrankenPHPModule) unmarshalHotReload(d *caddyfile.Dispenser) error {
|
|
patterns := d.RemainingArgs()
|
|
if len(patterns) > 0 {
|
|
f.HotReload = &hotReloadConfig{
|
|
Watch: patterns,
|
|
}
|
|
}
|
|
|
|
for d.NextBlock(1) {
|
|
switch v := d.Val(); v {
|
|
case "topic":
|
|
if !d.NextArg() {
|
|
return d.ArgErr()
|
|
}
|
|
|
|
if f.HotReload == nil {
|
|
f.HotReload = &hotReloadConfig{}
|
|
}
|
|
|
|
f.HotReload.Topic = d.Val()
|
|
|
|
case "watch":
|
|
patterns := d.RemainingArgs()
|
|
if len(patterns) == 0 {
|
|
return d.ArgErr()
|
|
}
|
|
|
|
if f.HotReload == nil {
|
|
f.HotReload = &hotReloadConfig{}
|
|
}
|
|
|
|
f.HotReload.Watch = append(f.HotReload.Watch, patterns...)
|
|
|
|
default:
|
|
return wrongSubDirectiveError("hot_reload", "topic, watch", v)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func uniqueID(s any) (string, error) {
|
|
var b bytes.Buffer
|
|
|
|
if err := gob.NewEncoder(&b).Encode(s); err != nil {
|
|
return "", fmt.Errorf("unable to generate unique name: %w", err)
|
|
}
|
|
|
|
h := fnv.New64a()
|
|
if _, err := h.Write(b.Bytes()); err != nil {
|
|
return "", fmt.Errorf("unable to generate unique name: %w", err)
|
|
}
|
|
|
|
return fmt.Sprintf("%016x", h.Sum64()), nil
|
|
}
|