Changing both the Handler API and the Socket API, for better consistency

Author: jfyne

CONTRIBUTING.md

@@ -13,7 +13,7 @@ I am very open to discussing the design of the API and what can be made better.
 
 ## TODO List
 
-- Change the handlers to have proper context from the request.
+- Make the javascript interop better than the Phoenix design.
 - Missing events, throttle, debounce etc.
 - File uploads
 - Tests... Lots of tests

README.md

@@ -104,7 +104,7 @@ func NewGreeter(ID string, h *live.Handler, s *live.Socket, name string) (Compon
 		ID,
 		h,
 		s,
-		WithMount(func(ctx context.Context, c *Component, r *http.Request, connected bool) error {
+		WithMount(func(ctx context.Context, c *Component, r *http.Request) error {
 			c.State = name
 			return nil
 		}),

example_test.go

@@ -55,9 +55,9 @@ func Example_temperature() {
 
 	// Mount function is called on initial HTTP load and then initial web
 	// socket connection. This should be used to create the initial state,
-	// the connected variable will be true if the mount call is on a web
+	// the socket Connectedi func will be true if the mount call is on a web
 	// socket connection.
-	h.Mount = func(ctx context.Context, h *Handler, r *http.Request, s *Socket, connected bool) (interface{}, error) {
+	h.Mount = func(ctx context.Context, r *http.Request, s *Socket) (interface{}, error) {
 		return NewThermoModel(s), nil
 	}
 

handler.go

@@ -21,7 +21,7 @@ import (
 // MountHandler the func that is called by a handler to gather data to
 // be rendered in a template. This is called on first GET and then later when
 // the web socket first connects.
-type MountHandler func(ctx context.Context, h *Handler, r *http.Request, c *Socket, connected bool) (interface{}, error)
+type MountHandler func(ctx context.Context, r *http.Request, c *Socket) (interface{}, error)
 
 // RenderHandler the func that is called to render the current state of the
 // data for the socket.
@@ -77,7 +77,7 @@ func NewHandler(store SessionStore, configs ...HandlerConfig) (*Handler, error)
 		broadcastLimiter: rate.NewLimiter(rate.Every(time.Millisecond*100), 8),
 		eventHandlers:    make(map[string]EventHandler),
 		selfHandlers:     make(map[string]EventHandler),
-		Mount: func(ctx context.Context, hd *Handler, r *http.Request, c *Socket, connected bool) (interface{}, error) {
+		Mount: func(ctx context.Context, r *http.Request, c *Socket) (interface{}, error) {
 			return nil, nil
 		},
 		Render: func(ctx context.Context, data interface{}) (io.Reader, error) {
@@ -122,11 +122,6 @@ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	return
 }
 
-// Self sends a message to the socket on this view.
-func (h *Handler) Self(ctx context.Context, sock *Socket, msg Event) {
-	handleEmittedEvent(ctx, h, sock, msg)
-}
-
 // Broadcast send a message to all sockets connected to this view.
 func (h *Handler) Broadcast(msg Event) {
 	ctx := context.Background()
@@ -140,7 +135,7 @@ func (h *Handler) HandleEvent(t string, handler EventHandler) {
 	h.eventHandlers[t] = handler
 }
 
-// HandleSelf handles an event that comes from the view. For example calling
+// HandleSelf handles an event that comes from the server side socket. For example calling
 // h.Self(socket, msg) will be handled here.
 func (h *Handler) HandleSelf(t string, handler EventHandler) {
 	h.selfHandlers[t] = handler
@@ -152,6 +147,11 @@ func (h *Handler) HandleParams(handler EventHandler) {
 	h.paramsHandlers = append(h.paramsHandlers, handler)
 }
 
+// self sends a message to the socket on this view.
+func (h *Handler) self(ctx context.Context, sock *Socket, msg Event) {
+	handleEmittedEvent(ctx, h, sock, msg)
+}
+
 // serveHTTP serve an http request to the view.
 func (h *Handler) serveHTTP(w http.ResponseWriter, r *http.Request) {
 	// Get session.
@@ -162,16 +162,16 @@ func (h *Handler) serveHTTP(w http.ResponseWriter, r *http.Request) {
 	}
 
 	// Get socket.
-	sock := NewSocket(session)
+	sock := NewSocket(session, h, false)
 
 	// Run mount, this generates the data for the page we are on.
-	if err := sock.mount(r.Context(), h, r, false); err != nil {
+	if err := sock.mount(r.Context(), h, r); err != nil {
 		h.Error(r.Context(), w, r, err)
 		return
 	}
 
 	// Handle any query parameters that are on the page.
-	if err := sock.params(r.Context(), h, r, false); err != nil {
+	if err := sock.params(r.Context(), h, r); err != nil {
 		h.Error(r.Context(), w, r, err)
 		return
 	}
@@ -236,7 +236,7 @@ type eventError struct {
 func (h *Handler) _serveWS(r *http.Request, session Session, c *websocket.Conn) error {
 	ctx := r.Context()
 	// Get the sessions socket and register it with the server.
-	sock := NewSocket(session)
+	sock := NewSocket(session, h, true)
 	sock.assignWS(c)
 	h.addSocket(sock)
 	defer h.deleteSocket(sock)
@@ -296,12 +296,12 @@ func (h *Handler) _serveWS(r *http.Request, session Session, c *websocket.Conn)
 
 	// Run mount again now that eh socket is connected, passing true indicating
 	// a connection has been made.
-	if err := sock.mount(ctx, h, r, true); err != nil {
+	if err := sock.mount(ctx, h, r); err != nil {
 		return fmt.Errorf("socket mount error: %w", err)
 	}
 
 	// Run params again now that the socket is connected.
-	if err := sock.params(r.Context(), h, r, true); err != nil {
+	if err := sock.params(r.Context(), h, r); err != nil {
 		return fmt.Errorf("socket params error: %w", err)
 	}
 

page/component.go

@@ -14,7 +14,7 @@ import (
 type RegisterHandler func(c *Component) error
 
 // MountHandler the components mount function called on first GET request and again when the socket connects.
-type MountHandler func(ctx context.Context, c *Component, r *http.Request, connected bool) error
+type MountHandler func(ctx context.Context, c *Component, r *http.Request) error
 
 // RenderHandler ths component.
 type RenderHandler func(w io.Writer, c *Component) error
@@ -80,7 +80,7 @@ func Init(ctx context.Context, construct func() (Component, error)) (Component,
 	if err := comp.Register(&comp); err != nil {
 		return Component{}, fmt.Errorf("could not install component on register: %w", err)
 	}
-	if err := comp.Mount(ctx, &comp, nil, true); err != nil {
+	if err := comp.Mount(ctx, &comp, nil); err != nil {
 		return Component{}, fmt.Errorf("could not install component on mount: %w", err)
 	}
 	return comp, nil
@@ -90,7 +90,7 @@ func Init(ctx context.Context, construct func() (Component, error)) (Component,
 // components sharing the same ID.
 func (c *Component) Self(ctx context.Context, s *live.Socket, event live.Event) {
 	event.T = c.Event(event.T)
-	c.Handler.Self(ctx, s, event)
+	s.Self(ctx, event)
 }
 
 // HandleSelf handles scoped incoming events send by a components Self function.
@@ -141,7 +141,7 @@ func defaultRegister(c *Component) error {
 }
 
 // defaultMount is the default mount handler which does nothing.
-func defaultMount(ctx context.Context, c *Component, r *http.Request, connected bool) error {
+func defaultMount(ctx context.Context, c *Component, r *http.Request) error {
 	return nil
 }
 

page/configuration.go

@@ -40,17 +40,17 @@ func WithRender(fn RenderHandler) ComponentConfig {
 // WithComponentMount set the live.Handler to mount the root component.
 func WithComponentMount(construct ComponentConstructor) live.HandlerConfig {
 	return func(h *live.Handler) error {
-		h.Mount = func(ctx context.Context, h *live.Handler, r *http.Request, s *live.Socket, connected bool) (interface{}, error) {
+		h.Mount = func(ctx context.Context, r *http.Request, s *live.Socket) (interface{}, error) {
 			root, err := construct(ctx, h, r, s)
 			if err != nil {
 				return nil, fmt.Errorf("failed to construct root component: %w", err)
 			}
-			if connected {
+			if s.Connected() {
 				if err := root.Register(&root); err != nil {
 					return nil, err
 				}
 			}
-			if err := root.Mount(ctx, &root, r, connected); err != nil {
+			if err := root.Mount(ctx, &root, r); err != nil {
 				return nil, err
 			}
 			return root, nil

page/example_test.go

@@ -15,7 +15,7 @@ func NewGreeter(ID string, h *live.Handler, s *live.Socket, name string) (Compon
 		ID,
 		h,
 		s,
-		WithMount(func(ctx context.Context, c *Component, r *http.Request, connected bool) error {
+		WithMount(func(ctx context.Context, c *Component, r *http.Request) error {
 			c.State = name
 			return nil
 		}),

socket.go

@@ -18,8 +18,11 @@ const (
 
 // Socket describes a socket from the outside.
 type Socket struct {
+	// The session for this socket.
 	Session Session
 
+	handler       *Handler
+	connected     bool
 	currentRender *html.Node
 	msgs          chan Event
 	closeSlow     func()
@@ -29,10 +32,12 @@ type Socket struct {
 }
 
 // NewSocket creates a new socket.
-func NewSocket(s Session) *Socket {
+func NewSocket(s Session, h *Handler, connected bool) *Socket {
 	return &Socket{
-		Session: s,
-		msgs:    make(chan Event, maxMessageBufferSize),
+		Session:   s,
+		handler:   h,
+		connected: connected,
+		msgs:      make(chan Event, maxMessageBufferSize),
 	}
 }
 
@@ -52,7 +57,23 @@ func (s *Socket) Assign(data interface{}) {
 	s.data = data
 }
 
-// Send an event to this socket.
+// Connected returns if this socket is connected via the websocket.
+func (s *Socket) Connected() bool {
+	return s.connected
+}
+
+// Self send an event to this socket itself. Will be handled in the
+// handlers HandleSelf function.
+func (s *Socket) Self(ctx context.Context, msg Event) {
+	s.handler.self(ctx, s, msg)
+}
+
+// Broadcast send an event to all sockets on this same handler.
+func (s *Socket) Broadcast(msg Event) {
+	s.handler.Broadcast(msg)
+}
+
+// Send an event to this socket's client, to be handled there.
 func (s *Socket) Send(msg Event) {
 	select {
 	case s.msgs <- msg:
@@ -77,8 +98,8 @@ func (s *Socket) Redirect(u *url.URL) {
 
 // mount passes this socket to the handlers mount func. This returns data
 // which we then set to the socket to store.
-func (s *Socket) mount(ctx context.Context, h *Handler, r *http.Request, connected bool) error {
-	data, err := h.Mount(ctx, h, r, s, connected)
+func (s *Socket) mount(ctx context.Context, h *Handler, r *http.Request) error {
+	data, err := h.Mount(ctx, r, s)
 	if err != nil {
 		return fmt.Errorf("mount error: %w", err)
 	}
@@ -88,7 +109,7 @@ func (s *Socket) mount(ctx context.Context, h *Handler, r *http.Request, connect
 
 // params passes this socket to the handlers params func. This returns data
 // which we then set to the socket to store.
-func (s *Socket) params(ctx context.Context, h *Handler, r *http.Request, connected bool) error {
+func (s *Socket) params(ctx context.Context, h *Handler, r *http.Request) error {
 	for _, ph := range h.paramsHandlers {
 		data, err := ph(ctx, s, ParamsFromRequest(r))
 		if err != nil {