9bfb53a7f6
SocketIO has 'rooms' and 'event types'. The 'event type' is set via reflection of the OpenAPI type of the event payload. This has to be set up in a mapping, though, and if that mapping is incomplete, an error will now be logged.
43 lines
1.8 KiB
Go
43 lines
1.8 KiB
Go
package eventbus
|
|
|
|
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
import "fmt"
|
|
|
|
const (
|
|
// Topics on which events are published.
|
|
// NOTE: when adding here, also add to socketIOEventTypes in socketio.go.
|
|
TopicLifeCycle EventTopic = "/lifecycle" // sends api.EventLifeCycle
|
|
TopicFarmStatus EventTopic = "/status" // sends api.EventFarmStatus
|
|
TopicJobUpdate EventTopic = "/jobs" // sends api.EventJobUpdate
|
|
TopicLastRenderedImage EventTopic = "/last-rendered" // sends api.EventLastRenderedUpdate
|
|
TopicTaskUpdate EventTopic = "/task" // sends api.EventTaskUpdate
|
|
TopicWorkerUpdate EventTopic = "/workers" // sends api.EventWorkerUpdate
|
|
TopicWorkerTagUpdate EventTopic = "/workertags" // sends api.EventWorkerTagUpdate
|
|
TopicSubscription EventTopic = "/subscription" // clients send api.EventSubscription
|
|
|
|
// Parameterised topics.
|
|
TopicJobSpecific EventTopic = "/jobs/%s" // %s = job UUID
|
|
TopicJobLastRendered EventTopic = "/jobs/%s/last-rendered" // %s = job UUID
|
|
TopicTaskLog EventTopic = "/tasklog/%s" // %s = task UUID
|
|
)
|
|
|
|
// topicForJob will return the event topic for the given job. Clients subscribed
|
|
// to this topic receive info scoped to this job, so for example updates to all
|
|
// tasks of this job.
|
|
func topicForJob(jobUUID string) EventTopic {
|
|
return EventTopic(fmt.Sprintf(string(TopicJobSpecific), jobUUID))
|
|
}
|
|
func topicForJobLastRendered(jobUUID string) EventTopic {
|
|
return EventTopic(fmt.Sprintf(string(TopicJobLastRendered), jobUUID))
|
|
}
|
|
|
|
// topicForTaskLog will return the event topic for receiving task logs of
|
|
// the the given task.
|
|
//
|
|
// Note that general task updates are sent to their job's topic, and not to this
|
|
// one.
|
|
func topicForTaskLog(taskUUID string) EventTopic {
|
|
return EventTopic(fmt.Sprintf(string(TopicTaskLog), taskUUID))
|
|
}
|