Something went wrong. Try again.
Monorepo for Tangled tangled.org
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182package models
import ( "bytes" "encoding/json" "fmt" "io" "os" "path/filepath" "strings")
type WorkflowLogger interface { Close() error DataWriter(idx int, stream string) io.Writer ControlWriter(idx int, step Step, stepStatus StepStatus) io.Writer EndWriter(idx int, step Step, outcome StepOutcome) io.Writer}
type NullLogger struct{}
func (l NullLogger) Close() error { return nil }func (l NullLogger) DataWriter(idx int, stream string) io.Writer { return io.Discard }func (l NullLogger) ControlWriter(idx int, step Step, stepStatus StepStatus) io.Writer { return io.Discard}func (l NullLogger) EndWriter(idx int, step Step, outcome StepOutcome) io.Writer { return io.Discard}
type FileWorkflowLogger struct { file *os.File encoder *json.Encoder mask *SecretMask secretValues []string dataWriters []*dataWriter}
func NewFileWorkflowLogger(baseDir string, wid WorkflowId, secretValues []string) (WorkflowLogger, error) { path := LogFilePath(baseDir, wid) file, err := os.OpenFile(path, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0644) if err != nil { return nil, fmt.Errorf("creating log file: %w", err) } return &FileWorkflowLogger{ file: file, encoder: json.NewEncoder(file), mask: NewSecretMask(secretValues), secretValues: append([]string(nil), secretValues...), }, nil}
// AddSecretValues registers values that only became known after the log was// opened, e.g. a credential minted once the workflow held its slot. Call it// before the first write so nothing reaches the file unmasked.func (l *FileWorkflowLogger) AddSecretValues(values ...string) { l.secretValues = append(l.secretValues, values...) l.mask = NewSecretMask(l.secretValues)}
func LogFilePath(baseDir string, workflowID WorkflowId) string { logFilePath := filepath.Join(baseDir, fmt.Sprintf("%s.log", workflowID.String())) return logFilePath}
func LegacyLogFilePath(baseDir, knot string, pipelineID PipelineId, workflow string) string { return filepath.Join(baseDir, fmt.Sprintf("%s-%s-%s.log", normalize(knot), pipelineID, normalize(workflow)))}
func (l *FileWorkflowLogger) Close() error { for _, w := range l.dataWriters { if err := w.flush(); err != nil { return err } } return l.file.Close()}
func (l *FileWorkflowLogger) DataWriter(idx int, stream string) io.Writer { w := &dataWriter{ logger: l, idx: idx, stream: stream, } l.dataWriters = append(l.dataWriters, w) return w}
func (l *FileWorkflowLogger) ControlWriter(idx int, step Step, stepStatus StepStatus) io.Writer { return &controlWriter{ logger: l, idx: idx, step: step, stepStatus: stepStatus, }}
func (l *FileWorkflowLogger) EndWriter(idx int, step Step, outcome StepOutcome) io.Writer { return &controlWriter{ logger: l, idx: idx, step: step, stepStatus: StepStatusEnd, outcome: outcome, }}
type dataWriter struct { logger *FileWorkflowLogger idx int stream string // trailing bytes held back so a secret split across writes still // matches, flushed on Close or once enough data arrives pending []byte}
func (w *dataWriter) Write(p []byte) (int, error) { w.pending = append(w.pending, p...) if err := w.flushCompleteLines(); err != nil { return 0, err } return len(p), nil}
func (w *dataWriter) flushCompleteLines() error { limit := len(w.pending) - w.logger.mask.Window() if limit <= 0 { return nil }
for { lineEnd := bytes.IndexByte(w.pending[:limit], '\n') if lineEnd < 0 { return nil } lineEnd++ line := append([]byte(nil), w.pending[:lineEnd]...) w.pending = w.pending[lineEnd:] limit -= lineEnd if err := w.emit(line); err != nil { return err } }}
// the writer is done, so a buffered tail can no longer grow into a full// secret and goes out as-isfunc (w *dataWriter) flush() error { if len(w.pending) == 0 { return nil } pending := w.pending w.pending = nil return w.emit(pending)}
func (w *dataWriter) emit(p []byte) error { line := strings.TrimRight(string(p), "\r\n") if w.logger.mask != nil { line = w.logger.mask.Mask(line) } entry := NewDataLogLine(w.idx, line, w.stream) return w.logger.encoder.Encode(entry)}
type controlWriter struct { logger *FileWorkflowLogger idx int step Step stepStatus StepStatus outcome StepOutcome}
func (w *controlWriter) Write(_ []byte) (int, error) { entry := NewControlLogLine(w.idx, w.step, w.stepStatus) entry.StepOutcome = w.outcome if err := w.logger.encoder.Encode(entry); err != nil { return 0, err } return len(w.step.Name()), nil}