1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
|
package trace
import (
"errors"
"fmt"
"hash"
"hash/crc32"
"io"
"io/ioutil"
"os"
"sort"
"sync"
"unicode/utf8"
"golang.org/x/text/encoding"
"golang.org/x/text/transform"
"gitlab.com/gitlab-org/gitlab-runner/helpers"
)
const defaultBytesLimit = 4 * 1024 * 1024 // 4MB
var errLogLimitExceeded = errors.New("log limit exceeded")
type Buffer struct {
lock sync.RWMutex
lw *limitWriter
w io.WriteCloser
logFile *os.File
checksum hash.Hash32
}
type inverseLengthSort []string
func (s inverseLengthSort) Len() int {
return len(s)
}
func (s inverseLengthSort) Swap(i, j int) {
s[i], s[j] = s[j], s[i]
}
func (s inverseLengthSort) Less(i, j int) bool {
return len(s[i]) > len(s[j])
}
func (b *Buffer) SetMasked(values []string) {
b.lock.Lock()
defer b.lock.Unlock()
// close existing writer to flush data
if b.w != nil {
b.w.Close()
}
defaultTransformers := []transform.Transformer{
encoding.Replacement.NewEncoder(),
}
transformers := make([]transform.Transformer, 0, len(values)+len(defaultTransformers))
sort.Sort(inverseLengthSort(values))
seen := make(map[string]struct{})
for _, value := range values {
if _, ok := seen[value]; ok {
continue
}
seen[value] = struct{}{}
transformers = append(transformers, newPhraseTransform(value))
}
transformers = append(transformers, defaultTransformers...)
b.w = transform.NewWriter(b.lw, transform.Chain(transformers...))
}
func (b *Buffer) SetLimit(size int) {
b.lock.Lock()
defer b.lock.Unlock()
b.lw.limit = int64(size)
}
func (b *Buffer) Size() int {
b.lock.RLock()
defer b.lock.RUnlock()
if b.lw == nil {
return 0
}
return int(b.lw.written)
}
func (b *Buffer) Bytes(offset, n int) ([]byte, error) {
return ioutil.ReadAll(io.NewSectionReader(b.logFile, int64(offset), int64(n)))
}
func (b *Buffer) Write(p []byte) (int, error) {
b.lock.Lock()
defer b.lock.Unlock()
src := p
var n int
for len(src) > 0 {
written, err := b.w.Write(src)
// if we get a log limit exceeded error, we've written the log limit
// notice out to the log and will now silently not write any additional
// data: we return len(p), nil so the caller continues as normal.
if err == errLogLimitExceeded {
return len(p), nil
}
if err != nil {
return n, err
}
// the text/transformer implementation can return n < len(p) without an
// error. For this reason, we continue writing whatever data is left
// unless nothing was written (therefore zero progress) on our call to
// Write().
if written == 0 {
return n, io.ErrShortWrite
}
src = src[written:]
n += written
}
return n, nil
}
func (b *Buffer) Finish() {
b.lock.RLock()
defer b.lock.RUnlock()
if b.w != nil {
_ = b.w.Close()
}
}
func (b *Buffer) Close() {
_ = b.logFile.Close()
_ = os.Remove(b.logFile.Name())
}
func (b *Buffer) Checksum() string {
b.lock.RLock()
defer b.lock.RUnlock()
return fmt.Sprintf("crc32:%08x", b.checksum.Sum32())
}
type limitWriter struct {
w io.Writer
written int64
limit int64
}
func (w *limitWriter) Write(p []byte) (int, error) {
capacity := w.limit - w.written
if capacity <= 0 {
return 0, errLogLimitExceeded
}
if int64(len(p)) >= capacity {
p = truncateSafeUTF8(p, capacity)
n, err := w.w.Write(p)
if err == nil {
err = errLogLimitExceeded
}
if n < 0 {
n = 0
}
w.written += int64(n)
w.writeLimitExceededMessage()
return n, err
}
n, err := w.w.Write(p)
if n < 0 {
n = 0
}
w.written += int64(n)
return n, err
}
func (w *limitWriter) writeLimitExceededMessage() {
n, _ := fmt.Fprintf(
w.w,
"\n%sJob's log exceeded limit of %v bytes.\n"+
"Job execution will continue but no more output will be collected.%s\n",
helpers.ANSI_BOLD_YELLOW,
w.limit,
helpers.ANSI_RESET,
)
w.written += int64(n)
}
func New() (*Buffer, error) {
logFile, err := newLogFile()
if err != nil {
return nil, err
}
buffer := &Buffer{
logFile: logFile,
checksum: crc32.NewIEEE(),
}
buffer.lw = &limitWriter{
w: io.MultiWriter(buffer.logFile, buffer.checksum),
written: 0,
limit: defaultBytesLimit,
}
buffer.SetMasked(nil)
return buffer, nil
}
func newLogFile() (*os.File, error) {
return ioutil.TempFile("", "trace")
}
// truncateSafeUTF8 truncates a job log at the capacity but avoids
// breaking up a multi-byte UTF-8 character.
func truncateSafeUTF8(p []byte, capacity int64) []byte {
for i := 0; i < 4; i++ {
r, s := utf8.DecodeLastRune(p[:capacity])
if r == utf8.RuneError && s == 1 {
capacity--
continue
}
break
}
return p[:capacity]
}
|