mirror of
https://github.com/dunglas/frankenphp.git
synced 2025-12-24 13:38:11 +08: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>
102 lines
2.4 KiB
Go
102 lines
2.4 KiB
Go
//go:build !nomercure
|
|
|
|
package frankenphp
|
|
|
|
// #include <stdint.h>
|
|
// #include <php.h>
|
|
import "C"
|
|
import (
|
|
"log/slog"
|
|
"unsafe"
|
|
|
|
"github.com/dunglas/mercure"
|
|
)
|
|
|
|
type mercureContext struct {
|
|
mercureHub *mercure.Hub
|
|
}
|
|
|
|
//export go_mercure_publish
|
|
func go_mercure_publish(threadIndex C.uintptr_t, topics *C.struct__zval_struct, data *C.zend_string, private bool, id, typ *C.zend_string, retry uint64) (generatedID *C.zend_string, error C.short) {
|
|
thread := phpThreads[threadIndex]
|
|
ctx := thread.context()
|
|
fc := thread.frankenPHPContext()
|
|
|
|
if fc.mercureHub == nil {
|
|
if fc.logger.Enabled(ctx, slog.LevelError) {
|
|
fc.logger.LogAttrs(ctx, slog.LevelError, "No Mercure hub configured")
|
|
}
|
|
|
|
return nil, 1
|
|
}
|
|
|
|
u := &mercure.Update{
|
|
Event: mercure.Event{
|
|
Data: GoString(unsafe.Pointer(data)),
|
|
ID: GoString(unsafe.Pointer(id)),
|
|
Retry: retry,
|
|
Type: GoString(unsafe.Pointer(typ)),
|
|
},
|
|
Private: private,
|
|
Debug: fc.logger.Enabled(ctx, slog.LevelDebug),
|
|
}
|
|
|
|
zvalType := C.zval_get_type(topics)
|
|
switch zvalType {
|
|
case C.IS_STRING:
|
|
u.Topics = []string{GoString(unsafe.Pointer(*(**C.zend_string)(unsafe.Pointer(&topics.value[0]))))}
|
|
case C.IS_ARRAY:
|
|
ts, err := GoPackedArray[string](unsafe.Pointer(topics))
|
|
if err != nil {
|
|
if fc.logger.Enabled(ctx, slog.LevelError) {
|
|
fc.logger.LogAttrs(ctx, slog.LevelError, "invalid topics type", slog.Any("error", err))
|
|
}
|
|
|
|
return nil, 1
|
|
}
|
|
|
|
u.Topics = ts
|
|
default:
|
|
// Never happens as the function is called from C with proper types
|
|
panic("invalid topics type")
|
|
}
|
|
|
|
if err := fc.mercureHub.Publish(ctx, u); err != nil {
|
|
if fc.logger.Enabled(ctx, slog.LevelError) {
|
|
fc.logger.LogAttrs(ctx, slog.LevelError, "Unable to publish Mercure update", slog.Any("error", err))
|
|
}
|
|
|
|
return nil, 2
|
|
}
|
|
|
|
return (*C.zend_string)(PHPString(u.ID, false)), 0
|
|
}
|
|
|
|
func (w *worker) configureMercure(o *workerOpt) {
|
|
if o.mercureHub == nil {
|
|
return
|
|
}
|
|
|
|
w.mercureHub = o.mercureHub
|
|
}
|
|
|
|
// WithMercureHub sets the mercure.Hub to use to publish updates
|
|
func WithMercureHub(hub *mercure.Hub) RequestOption {
|
|
return func(o *frankenPHPContext) error {
|
|
o.mercureHub = hub
|
|
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// WithWorkerMercureHub sets the mercure.Hub in the worker script and used to dispatch hot reloading-related mercure.Update.
|
|
func WithWorkerMercureHub(hub *mercure.Hub) WorkerOption {
|
|
return func(w *workerOpt) error {
|
|
w.mercureHub = hub
|
|
|
|
w.requestOptions = append(w.requestOptions, WithMercureHub(hub))
|
|
|
|
return nil
|
|
}
|
|
}
|