mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-11-16 10:05:00 +03:00
Test-quality audit: fix 2 prod bugs, strengthen weak tests, add mutation/fuzz/CI tooling (#5345)
* test(audit): add gremlins/rapid/coverage tooling + AUDIT.md scaffold * test(audit): hygiene sweep (race-clean except logger global; Finding #2) + smell inventory * test(audit): cover untested error/edge branches (TLS proxy+pin, migration tag cleanup=Finding #1) * test(audit): strengthen internal/sub link tests (dedup key, TLS/Reality mapping, clash well-formedness) * test(audit): property (rapid) + fuzz tests for joinHostPort/userinfo/pin/ParseLink * test(audit): tighten frontend subSortIndex rejection assertions + wire coverage * ci(audit): add shuffle gate + non-blocking race job (Finding #2) + fuzz-smoke; document mutation policy * chore(audit): gitignore frontend coverage output * test(audit): exhaustive whole-repo pass — strengthen 5 weak/fake tests (netproxy, CSP, modal per-protocol loops, schema coercions) * docs(contributing): add Testing section (conventions, race/shuffle, fuzz, mutation policy); drop AUDIT.md ledger * fix(logger,migration): guard logBuffer with mutex; execute legacy tag cleanup (tx.Exec); make CI race gate blocking * ci(mutation): add nightly scoped gremlins workflow (informational artifacts) * test(audit): strengthen runtime tests — baseURL scheme/port bounds, isNonEmptySlice, trafficReset * test(audit): strengthen clash tests — reality field mapping + tcp-header validation * test(audit): runtime — egress-proxy + content-type tests; drop redundant bp=='' branch * test(audit): strengthen link parser/helper tests (defaultPort, splitComma, base64, canonicalQuery, tls/reality/transport mapping) * test(audit): strengthen sub/xray/common/netsafe/mtproto/config/middleware tests (kill surviving mutants) * test(audit): raise timeout on protocol-iteration modal tests (heavy re-renders, slow on CI) * fix(logger): GetLogs returns at most c entries (off-by-one fix; addresses PR review) * perf(logger): snapshot logBuffer under lock so GetLogs doesn't block logging; clarify fuzz-seed docs (addresses PR review)
This commit is contained in:
@@ -7,6 +7,7 @@ import (
|
||||
"os"
|
||||
"path/filepath"
|
||||
"runtime"
|
||||
"sync"
|
||||
"time"
|
||||
|
||||
"github.com/mhsanaei/3x-ui/v3/internal/config"
|
||||
@@ -31,8 +32,10 @@ var (
|
||||
logger *logging.Logger
|
||||
fileRotate *lumberjack.Logger // nil when file backend disabled
|
||||
|
||||
// logBuffer maintains recent log entries in memory for web UI retrieval
|
||||
logBuffer []struct {
|
||||
// logBuffer maintains recent log entries in memory for web UI retrieval;
|
||||
// logBufferMu guards it — written from many goroutines, read by the web UI.
|
||||
logBufferMu sync.Mutex
|
||||
logBuffer []struct {
|
||||
time string
|
||||
level logging.Level
|
||||
log string
|
||||
@@ -193,6 +196,8 @@ func Errorf(format string, args ...any) {
|
||||
// addToBuffer adds a log entry to the in-memory ring buffer for web UI retrieval.
|
||||
func addToBuffer(level string, newLog string) {
|
||||
t := time.Now()
|
||||
logBufferMu.Lock()
|
||||
defer logBufferMu.Unlock()
|
||||
if len(logBuffer) >= maxLogBufferSize {
|
||||
logBuffer = logBuffer[1:]
|
||||
}
|
||||
@@ -214,9 +219,21 @@ func GetLogs(c int, level string) []string {
|
||||
var output []string
|
||||
logLevel, _ := logging.LogLevel(level)
|
||||
|
||||
for i := len(logBuffer) - 1; i >= 0 && len(output) <= c; i-- {
|
||||
if logBuffer[i].level <= logLevel {
|
||||
output = append(output, fmt.Sprintf("%s %s - %s", logBuffer[i].time, logBuffer[i].level, logBuffer[i].log))
|
||||
// Snapshot (copy) under the lock, then filter/format unlocked: a UI log fetch
|
||||
// must not block addToBuffer — and thus all logging — for the formatting loop.
|
||||
// A copy (not a reslice) is required, since addToBuffer can append in place.
|
||||
logBufferMu.Lock()
|
||||
snapshot := make([]struct {
|
||||
time string
|
||||
level logging.Level
|
||||
log string
|
||||
}, len(logBuffer))
|
||||
copy(snapshot, logBuffer)
|
||||
logBufferMu.Unlock()
|
||||
|
||||
for i := len(snapshot) - 1; i >= 0 && len(output) < c; i-- {
|
||||
if snapshot[i].level <= logLevel {
|
||||
output = append(output, fmt.Sprintf("%s %s - %s", snapshot[i].time, snapshot[i].level, snapshot[i].log))
|
||||
}
|
||||
}
|
||||
return output
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
package logger
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"testing"
|
||||
)
|
||||
|
||||
// TestGetLogs_ReturnsAtMostC guards the documented "up to c entries" contract.
|
||||
// The loop condition must cap output at c (ERROR entries are queried at "debug"
|
||||
// level so the level filter passes all of them, isolating the count).
|
||||
func TestGetLogs_ReturnsAtMostC(t *testing.T) {
|
||||
logBufferMu.Lock()
|
||||
logBuffer = nil
|
||||
logBufferMu.Unlock()
|
||||
for i := 0; i < 5; i++ {
|
||||
addToBuffer("ERROR", fmt.Sprintf("m%d", i))
|
||||
}
|
||||
|
||||
cases := []struct{ c, want int }{
|
||||
{0, 0},
|
||||
{2, 2},
|
||||
{5, 5},
|
||||
{10, 5}, // capped at what's available
|
||||
}
|
||||
for _, tc := range cases {
|
||||
if got := GetLogs(tc.c, "debug"); len(got) != tc.want {
|
||||
t.Errorf("GetLogs(%d) returned %d entries, want %d", tc.c, len(got), tc.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user