3e5f681321
Implement task log broadcasting via SocketIO. The logs aren't shown in the web interface yet, but do arrive there in a Pinia store. That store is capped at 1000 lines to keep memory requirements low-ish.
89 lines
3.1 KiB
Go
89 lines
3.1 KiB
Go
// SPDX-License-Identifier: GPL-3.0-or-later
|
|
package webupdates
|
|
|
|
import (
|
|
"github.com/rs/zerolog/log"
|
|
|
|
"git.blender.org/flamenco/internal/manager/persistence"
|
|
"git.blender.org/flamenco/pkg/api"
|
|
)
|
|
|
|
// NewJobUpdate returns a partial SocketIOJobUpdate struct for the given job.
|
|
// It only fills in the fields that represent the current state of the job. For
|
|
// example, it omits `PreviousStatus`. The ommitted fields can be filled in by
|
|
// the caller.
|
|
func NewJobUpdate(job *persistence.Job) api.SocketIOJobUpdate {
|
|
jobUpdate := api.SocketIOJobUpdate{
|
|
Id: job.UUID,
|
|
Name: &job.Name,
|
|
Updated: job.UpdatedAt,
|
|
Status: job.Status,
|
|
Type: job.JobType,
|
|
Priority: job.Priority,
|
|
}
|
|
return jobUpdate
|
|
}
|
|
|
|
// NewTaskUpdate returns a partial TaskUpdate struct for the given task. It only
|
|
// fills in the fields that represent the current state of the task. For
|
|
// example, it omits `PreviousStatus`. The omitted fields can be filled in by
|
|
// the caller.
|
|
//
|
|
// Assumes task.Job is not nil.
|
|
func NewTaskUpdate(task *persistence.Task) api.SocketIOTaskUpdate {
|
|
taskUpdate := api.SocketIOTaskUpdate{
|
|
Id: task.UUID,
|
|
JobId: task.Job.UUID,
|
|
Name: task.Name,
|
|
Updated: task.UpdatedAt,
|
|
Status: task.Status,
|
|
Activity: task.Activity,
|
|
}
|
|
return taskUpdate
|
|
}
|
|
|
|
// NewTaskLogUpdate returns a SocketIOTaskLogUpdate for the given task.
|
|
func NewTaskLogUpdate(taskUUID string, logchunk string) api.SocketIOTaskLogUpdate {
|
|
return api.SocketIOTaskLogUpdate{
|
|
TaskId: taskUUID,
|
|
Log: logchunk,
|
|
}
|
|
}
|
|
|
|
// BroadcastJobUpdate sends the job update to clients.
|
|
func (b *BiDirComms) BroadcastJobUpdate(jobUpdate api.SocketIOJobUpdate) {
|
|
log.Debug().Interface("jobUpdate", jobUpdate).Msg("socketIO: broadcasting job update")
|
|
b.BroadcastTo(SocketIORoomJobs, SIOEventJobUpdate, jobUpdate)
|
|
}
|
|
|
|
// BroadcastNewJob sends a "new job" notification to clients.
|
|
// This function should be called when the job has been completely created, so
|
|
// including its tasks.
|
|
func (b *BiDirComms) BroadcastNewJob(jobUpdate api.SocketIOJobUpdate) {
|
|
if jobUpdate.PreviousStatus != nil {
|
|
log.Warn().Interface("jobUpdate", jobUpdate).Msg("socketIO: new jobs should not have a previous state")
|
|
jobUpdate.PreviousStatus = nil
|
|
}
|
|
|
|
log.Debug().Interface("jobUpdate", jobUpdate).Msg("socketIO: broadcasting new job")
|
|
b.BroadcastTo(SocketIORoomJobs, SIOEventJobUpdate, jobUpdate)
|
|
}
|
|
|
|
// BroadcastTaskUpdate sends the task update to clients.
|
|
func (b *BiDirComms) BroadcastTaskUpdate(taskUpdate api.SocketIOTaskUpdate) {
|
|
log.Debug().Interface("taskUpdate", taskUpdate).Msg("socketIO: broadcasting task update")
|
|
room := roomForJob(taskUpdate.JobId)
|
|
b.BroadcastTo(room, SIOEventTaskUpdate, taskUpdate)
|
|
}
|
|
|
|
// BroadcastTaskLogUpdate sends the task log chunk to clients.
|
|
func (b *BiDirComms) BroadcastTaskLogUpdate(taskLogUpdate api.SocketIOTaskLogUpdate) {
|
|
// Don't log the contents here; logs can get big.
|
|
room := roomForTaskLog(taskLogUpdate.TaskId)
|
|
log.Debug().
|
|
Str("task", taskLogUpdate.TaskId).
|
|
Str("room", string(room)).
|
|
Msg("socketIO: broadcasting task log")
|
|
b.BroadcastTo(room, SIOEventTaskLogUpdate, taskLogUpdate)
|
|
}
|