9b330280b7
SocketIO clients can now send a message with `/subscription` event type in order to subscribe to or unsubscribe from job-related updates. These job-related updates themselves aren't sent yet, so this is a change that's impossible to really test. The socketIO code for joining/leaving rooms is called, though.
80 lines
2.4 KiB
Go
80 lines
2.4 KiB
Go
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
package webupdates
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"git.blender.org/flamenco/pkg/api"
|
|
"github.com/google/uuid"
|
|
gosocketio "github.com/graarh/golang-socketio"
|
|
)
|
|
|
|
type SocketIORoomName string
|
|
|
|
const (
|
|
// Predefined SocketIO rooms.
|
|
SocketIORoomChat SocketIORoomName = "Chat" // For chat messages.
|
|
SocketIORoomJobs SocketIORoomName = "Jobs" // For job updates.
|
|
)
|
|
|
|
type SocketIOEventType string
|
|
|
|
const (
|
|
// Predefined SocketIO event types.
|
|
SIOEventChatMessageRcv SocketIOEventType = "/chat" // clients send chat messages here
|
|
SIOEventChatMessageSend SocketIOEventType = "/message" // chat messages are broadcasted here
|
|
SIOEventJobUpdate SocketIOEventType = "/jobs" // sends api.JobUpdate
|
|
SIOEventSubscription SocketIOEventType = "/subscription" // clients send api.SocketIOSubscription
|
|
)
|
|
|
|
func (b *BiDirComms) BroadcastTo(room SocketIORoomName, eventType SocketIOEventType, payload interface{}) {
|
|
b.sockserv.BroadcastTo(string(room), string(eventType), payload)
|
|
}
|
|
|
|
func (b *BiDirComms) registerRoomEventHandlers() {
|
|
_ = b.sockserv.On(string(SIOEventSubscription), b.handleRoomSubscription)
|
|
}
|
|
|
|
func (b *BiDirComms) handleRoomSubscription(c *gosocketio.Channel, subs api.SocketIOSubscription) string {
|
|
logger := sioLogger(c)
|
|
logger = logger.With().
|
|
Str("op", string(subs.Op)).
|
|
Str("type", string(subs.Type)).
|
|
Str("uuid", string(subs.Uuid)).
|
|
Logger()
|
|
|
|
// Make sure the UUID is actually a valid one.
|
|
uuid, err := uuid.Parse(subs.Uuid)
|
|
if err != nil {
|
|
logger.Warn().Msg("socketIO: invalid UUID, ignoring subscription request")
|
|
return "invalid UUID, ignoring request"
|
|
}
|
|
|
|
var sioRoom SocketIORoomName
|
|
switch subs.Type {
|
|
case api.SocketIOSubscriptionTypeJob:
|
|
sioRoom = roomForJob(uuid.String())
|
|
default:
|
|
logger.Warn().Msg("socketIO: invalid subscription type, ignoring")
|
|
return "invalid subscription type, ignoring request"
|
|
}
|
|
|
|
switch subs.Op {
|
|
case api.SocketIOSubscriptionOperationSubscribe:
|
|
err = c.Join(string(sioRoom))
|
|
case api.SocketIOSubscriptionOperationUnsubscribe:
|
|
err = c.Leave(string(sioRoom))
|
|
default:
|
|
logger.Warn().Msg("socketIO: invalid subscription operation, ignoring")
|
|
return "invalid subscription operation, ignoring request"
|
|
}
|
|
|
|
if err != nil {
|
|
logger.Warn().Err(err).Msg("socketIO: performing subscription operation")
|
|
return fmt.Sprintf("unable to perform subscription operation: %v", err)
|
|
}
|
|
|
|
logger.Info().Msg("socketIO: subscription")
|
|
return "ok"
|
|
}
|