woodpecker/server/logging/logging.go
Anbraten 556607b525
Rework log streaming and related functions (#1802)
closes #1801
closes #1815 
closes #1144
closes  #983
closes  #557
closes #1827
regression of #1791

# TODO
- [x] adjust log model
- [x] add migration for logs
- [x] send log line via grpc using step-id
- [x] save log-line to db
- [x] stream log-lines to UI
- [x] use less structs for log-data
- [x] make web UI work
  - [x] display logs loaded from db
  - [x] display streaming logs
- [ ] ~~make migration work~~ -> dedicated pull (#1828)

# TESTED
- [x] new logs are stored in database
- [x] log retrieval via cli (of new logs) works
- [x] log streaming works (tested via curl & webui)
- [x] log retrieval via web (of new logs) works

---------

Co-authored-by: 6543 <6543@obermui.de>
2023-06-06 09:52:08 +02:00

29 lines
709 B
Go

package logging
import (
"context"
"errors"
"github.com/woodpecker-ci/woodpecker/server/model"
)
// ErrNotFound is returned when the log does not exist.
var ErrNotFound = errors.New("stream: not found")
// Handler defines a callback function for handling log entries.
type Handler func(...*model.LogEntry)
// Log defines a log multiplexer.
type Log interface {
// Open opens the log.
Open(c context.Context, stepID int64) error
// Write writes the entry to the log.
Write(c context.Context, stepID int64, entry *model.LogEntry) error
// Tail tails the log.
Tail(c context.Context, stepID int64, handler Handler) error
// Close closes the log.
Close(c context.Context, stepID int64) error
}