aerc/worker/types/worker.go
Simon Ser 9ef2a57b51 worker/types: fix Worker.Callbacks race condition
Worker.Process* functions were called in different goroutines than
Worker.Post*. Protect the map with a mutex. Also make the map unexported to
prevent external unprotected accesses.

Worker.Process* functions used to delete items from the map. However they
didn't delete the element they retrieved: callbacks[msg.InResponseTo()] was
read while callbacks[msg] was deleted. I'm not sure I understand why. I tried
to delete the element that was accessed - but this broke everything (UI froze
at "Connecting..."). I don't believe any elements were actually removed from
the map, so the new code just doesn't remove anything.
2019-04-27 14:28:26 -04:00

100 lines
2.1 KiB
Go

package types
import (
"log"
"sync"
)
type Backend interface {
Run()
}
type Worker struct {
Backend Backend
Actions chan WorkerMessage
Messages chan WorkerMessage
Logger *log.Logger
callbacks map[WorkerMessage]func(msg WorkerMessage) // protected by mutex
mutex sync.Mutex
}
func NewWorker(logger *log.Logger) *Worker {
return &Worker{
Actions: make(chan WorkerMessage, 50),
Messages: make(chan WorkerMessage, 50),
Logger: logger,
callbacks: make(map[WorkerMessage]func(msg WorkerMessage)),
}
}
func (worker *Worker) setCallback(msg WorkerMessage,
cb func(msg WorkerMessage)) {
if cb != nil {
worker.mutex.Lock()
worker.callbacks[msg] = cb
worker.mutex.Unlock()
}
}
func (worker *Worker) getCallback(msg WorkerMessage) (func(msg WorkerMessage),
bool) {
worker.mutex.Lock()
cb, ok := worker.callbacks[msg]
worker.mutex.Unlock()
return cb, ok
}
func (worker *Worker) PostAction(msg WorkerMessage,
cb func(msg WorkerMessage)) {
if resp := msg.InResponseTo(); resp != nil {
worker.Logger.Printf("(ui)=> %T:%T\n", msg, resp)
} else {
worker.Logger.Printf("(ui)=> %T\n", msg)
}
worker.Actions <- msg
worker.setCallback(msg, cb)
}
func (worker *Worker) PostMessage(msg WorkerMessage,
cb func(msg WorkerMessage)) {
if resp := msg.InResponseTo(); resp != nil {
worker.Logger.Printf("->(ui) %T:%T\n", msg, resp)
} else {
worker.Logger.Printf("->(ui) %T\n", msg)
}
worker.Messages <- msg
worker.setCallback(msg, cb)
}
func (worker *Worker) ProcessMessage(msg WorkerMessage) WorkerMessage {
if resp := msg.InResponseTo(); resp != nil {
worker.Logger.Printf("(ui)<= %T:%T\n", msg, resp)
} else {
worker.Logger.Printf("(ui)<= %T\n", msg)
}
if cb, ok := worker.getCallback(msg.InResponseTo()); ok {
cb(msg)
}
return msg
}
func (worker *Worker) ProcessAction(msg WorkerMessage) WorkerMessage {
if resp := msg.InResponseTo(); resp != nil {
worker.Logger.Printf("<-(ui) %T:%T\n", msg, resp)
} else {
worker.Logger.Printf("<-(ui) %T\n", msg)
}
if cb, ok := worker.getCallback(msg.InResponseTo()); ok {
cb(msg)
}
return msg
}