Update README

Author: rowanseymour

README.md

@@ -7,7 +7,7 @@ Webchat server that talks to [Courier](https://github.com/nyaruka/courier/).
 To start chat session as new user:
 
 ```javascript
-sock = new WebSocket("ws://localhost:8070/start/a204047b-5224-4b8b-a328-08a538f1b3cb/");
+sock = new WebSocket("ws://localhost:8070/connect/7d62d551-3030-4100-a260-2d7c4e9693e7/");
 
 sock.onclose = function (event) {
     console.log("bye!");
@@ -17,60 +17,60 @@ sock.onmessage = function (event) {
 };
 ```
 
-## Server Events
+## Client Commands
 
-The first message the client will receive will contain the new chat ID: 
+### `start_chat`
+
+Can be used to start a new chat session as a new contact:
 
 ```json
 {
-    "type": "chat_started",
-    "chat_id": "65vbbDAQCdPdEWlEhDGy4utO"
+    "type": "start_chat"
 }
 ```
 
-The client can store that identifier to reconnect as the same contact in future. Pass it as a param to the start endpoint:
-
-```javascript
-sock = new WebSocket("ws://localhost:8070/start/a204047b-5224-4b8b-a328-08a538f1b3cb/?chat_id=65vbbDAQCdPdEWlEhDGy4utO")
+```json
+{
+    "type": "chat_started",
+    "chat_id": "65vbbDAQCdPdEWlEhDGy4utO"
+}
 ```
 
-And in this case the first message the client will receive will be:
+Or resume a chat session as an existing contact:
 
 ```json
 {
-    "type": "chat_resumed",
-    "chat_id": "65vbbDAQCdPdEWlEhDGy4utO",
-    "email": ""
+    "type": "start_chat",
+    "chat_id": "65vbbDAQCdPdEWlEhDGy4utO"
 }
 ```
 
-Messages from courier are sent to the client as events that look like:
-
 ```json
 {
-    "type": "msg_out",
-    "text": "Hello there!",
-    "origin": "flow"
+    "type": "chat_resumed",
+    "chat_id": "65vbbDAQCdPdEWlEhDGy4utO",
+    "email": ""
 }
 ```
 
-## Client Events
+### `create_msg`
 
-To send a message from the client, send a `msg_in` event to the socket, e.g.
+Creates a new message from the client:
 
 ```json
 {
-    "type": "msg_in", 
-    "text": "Thanks!"
+    "type": "create_msg",
+    "text": "I need help!"
 }
 ```
 
-The client can collect an email address by sending a `email_added` event, e.g.
+### `set_email`
+
+Updates the email address for the current contact:
 
 ```json
 {
-    "type": "email_added", 
+    "type": "set_email",
     "email": "bob@nyaruka.com"
 }
 ```
-

service.go

@@ -102,7 +102,7 @@ func (s *Service) sender() {
 
 	for {
 		// TODO panic recovery
-		// s.send()
+		s.send()
 
 		select {
 		case <-s.senderStop:

web/client.go

@@ -18,11 +18,11 @@ import (
 )
 
 type Client struct {
-	clientID string
-	server   *Server
-	socket   httpx.WebSocket
-	channel  models.Channel
-	contact  *models.Contact
+	id      string
+	server  *Server
+	socket  httpx.WebSocket
+	channel models.Channel
+	contact *models.Contact
 
 	send     chan events.Event
 	sendStop chan bool
@@ -31,10 +31,10 @@ type Client struct {
 
 func NewClient(s *Server, sock httpx.WebSocket, channel models.Channel) *Client {
 	c := &Client{
-		clientID: string(uuids.New()),
-		server:   s,
-		socket:   sock,
-		channel:  channel,
+		id:      string(uuids.New()),
+		server:  s,
+		socket:  sock,
+		channel: channel,
 
 		send:     make(chan events.Event, 16),
 		sendStop: make(chan bool),
@@ -49,10 +49,6 @@ func NewClient(s *Server, sock httpx.WebSocket, channel models.Channel) *Client
 	return c
 }
 
-func (c *Client) Channel() models.Channel {
-	return c.channel
-}
-
 func (c *Client) onMessage(msg []byte) {
 	log := c.log()
 
@@ -130,6 +126,8 @@ func (c *Client) onCommand(cmd commands.Command) error {
 		if err := c.contact.UpdateEmail(ctx, c.server.rt, typed.Email); err != nil {
 			return errors.Wrap(err, "error updating email")
 		}
+	default:
+		log.Debug("unknown command", "type", cmd.Type())
 	}
 
 	return nil
@@ -175,5 +173,5 @@ func (c *Client) chatID() models.ChatID {
 }
 
 func (c *Client) log() *slog.Logger {
-	return slog.With("client_id", c.clientID, "channel", c.channel.UUID(), "chat_id", c.chatID())
+	return slog.With("client_id", c.id, "channel", c.channel.UUID(), "chat_id", c.chatID())
 }

web/server.go

@@ -125,12 +125,12 @@ func (s *Server) handleConnect(ctx context.Context, r *http.Request, w http.Resp
 	client := NewClient(s, sock, ch)
 
 	s.clientMutex.Lock()
-	s.clients[client.clientID] = client
+	s.clients[client.id] = client
 	total := len(s.clients)
 	s.clientMutex.Unlock()
 	s.wg.Add(1)
 
-	slog.Info("client connected", "channel", ch.UUID(), "client_id", client.clientID, "total", total)
+	slog.Info("client connected", "channel", ch.UUID(), "client_id", client.id, "total", total)
 }
 
 type sendRequest struct {
@@ -188,7 +188,7 @@ func (s *Server) GetClient(chatID models.ChatID) *Client {
 
 func (s *Server) OnDisconnect(c *Client) {
 	s.clientMutex.Lock()
-	delete(s.clients, c.clientID)
+	delete(s.clients, c.id)
 	total := len(s.clients)
 	s.clientMutex.Unlock()
 	s.wg.Done()