feat: add telescope style

2026-07-05 21:55:12 +03:30
parent ac6e8695b1
commit a72cf582d0
4 changed files with 250 additions and 69 deletions
@@ -1,7 +1,7 @@
 // Package telescope یک بازرسِ سبکِ درخواست‌ها است (شبیهِ Laravel Telescope).
 // آخرین N درخواست را در یک رینگ‌بافرِ حافظه نگه می‌دارد: متد، مسیر، وضعیت،
-// مدت‌زمان، IP و در صورتِ خطا (>=۴۰۰) بدنه‌ی درخواست. بدونِ هیچ وابستگیِ خارجی
-// و با سرباری ناچیز؛ برای پایشِ سریع روی سرورِ کم‌منابع مناسب است.
+// مدت‌زمان، IP، هدرها، payloadِ درخواست، پاسخ و شماره‌ی موبایلِ کاربر. بدونِ
+// وابستگیِ خارجی و با سرباری ناچیز؛ برای پایشِ سریع روی سرورِ کم‌منابع مناسب است.
 package telescope

 import (
@@ -11,11 +11,18 @@ import (
 	"io"
 	"net"
 	"net/http"
+	"regexp"
+	"sort"
 	"strings"
 	"sync"
 	"time"
 )

+const (
+	maxReqBody  = 8 << 10  // ۸ کیلوبایت از payloadِ درخواست
+	maxRespBody = 16 << 10 // ۱۶ کیلوبایت از پاسخ
+)
+
 // Entry یک درخواستِ ثبت‌شده را نگه می‌دارد.
 type Entry struct {
 	ID       int64     `json:"id"`
@@ -26,7 +33,11 @@ type Entry struct {
 	Duration int64     `json:"duration_ms"`
 	IP       string    `json:"ip"`
 	Bytes    int       `json:"bytes"`
-	Body     string    `json:"body,omitempty"` // فقط برای خطاها (>=۴۰۰) و POST/PUT
+	UserID   int64     `json:"user_id,omitempty"`
+	Mobile   string    `json:"mobile,omitempty"` // در زمانِ نمایش resolve می‌شود
+	Headers  string    `json:"headers,omitempty"`
+	ReqBody  string    `json:"req_body,omitempty"`  // payloadِ درخواست
+	RespBody string    `json:"resp_body,omitempty"` // بدنه‌ی پاسخ
 }

 // Telescope رینگ‌بافرِ هم‌زمان‌امنِ درخواست‌ها.
@@ -37,14 +48,27 @@ type Telescope struct {
 	next int64 // شناسه‌ی افزایشی
 	full bool
 	head int // اندیسِ نوشتنِ بعدی
+
+	// decodeUID شناسه‌ی کاربر را از توکنِ درخواست (بدونِ DB، فقط HMAC) درمی‌آورد.
+	decodeUID func(*http.Request) int64
+	// resolveMobile شماره‌ی موبایل را از شناسه (با DB) می‌گیرد؛ فقط در زمانِ نمایش.
+	resolveMobile func(int64) string
+	mobileCache   map[int64]string
 }

-// New یک بازرس با ظرفیتِ size می‌سازد (حداقل ۱).
-func New(size int) *Telescope {
+// New یک بازرس با ظرفیتِ size می‌سازد (حداقل ۱). decodeUID و resolveMobile
+// می‌توانند nil باشند (مثلاً در تست‌ها).
+func New(size int, decodeUID func(*http.Request) int64, resolveMobile func(int64) string) *Telescope {
 	if size < 1 {
 		size = 200
 	}
-	return &Telescope{buf: make([]Entry, size), size: size}
+	return &Telescope{
+		buf:           make([]Entry, size),
+		size:          size,
+		decodeUID:     decodeUID,
+		resolveMobile: resolveMobile,
+		mobileCache:   map[int64]string{},
+	}
 }

 func (t *Telescope) add(e Entry) {
@@ -59,28 +83,55 @@ func (t *Telescope) add(e Entry) {
 	t.mu.Unlock()
 }

-// Entries آخرین درخواست‌ها را به‌ترتیبِ جدید-به-قدیم برمی‌گرداند.
+// Entries آخرین درخواست‌ها را به‌ترتیبِ جدید-به-قدیم برمی‌گرداند و در همین‌جا
+// شماره‌ی موبایلِ هر کاربر را (با کش) resolve می‌کند.
 func (t *Telescope) Entries() []Entry {
 	t.mu.Lock()
-	defer t.mu.Unlock()
 	n := t.head
 	if t.full {
 		n = t.size
 	}
 	out := make([]Entry, 0, n)
-	// از جدیدترین (درست قبلِ head) عقب می‌رویم.
 	for i := 0; i < n; i++ {
 		idx := (t.head - 1 - i + t.size*2) % t.size
 		out = append(out, t.buf[idx])
 	}
+	t.mu.Unlock()
+
+	// resolveِ موبایل بیرون از قفلِ اصلی (ممکن است به DB بزند).
+	for i := range out {
+		out[i].Mobile = t.mobileFor(out[i].UserID)
+		// درخواست‌های ورود (بدونِ توکن) شماره را در payload دارند.
+		if out[i].Mobile == "" {
+			out[i].Mobile = mobileFromBody(out[i].ReqBody)
+		}
+	}
 	return out
 }

-// statusRecorder کدِ وضعیت و حجمِ پاسخ را می‌گیرد.
+func (t *Telescope) mobileFor(id int64) string {
+	if id == 0 || t.resolveMobile == nil {
+		return ""
+	}
+	t.mu.Lock()
+	if m, ok := t.mobileCache[id]; ok {
+		t.mu.Unlock()
+		return m
+	}
+	t.mu.Unlock()
+	m := t.resolveMobile(id)
+	t.mu.Lock()
+	t.mobileCache[id] = m
+	t.mu.Unlock()
+	return m
+}
+
+// statusRecorder کدِ وضعیت، حجم و بخشی از بدنه‌ی پاسخ را می‌گیرد.
 type statusRecorder struct {
 	http.ResponseWriter
 	status int
 	bytes  int
+	buf    *bytes.Buffer
 }

 func (r *statusRecorder) WriteHeader(code int) {
@@ -92,6 +143,14 @@ func (r *statusRecorder) Write(b []byte) (int, error) {
 	if r.status == 0 {
 		r.status = http.StatusOK
 	}
+	if r.buf != nil && r.buf.Len() < maxRespBody {
+		remain := maxRespBody - r.buf.Len()
+		if remain >= len(b) {
+			r.buf.Write(b)
+		} else {
+			r.buf.Write(b[:remain])
+		}
+	}
 	n, err := r.ResponseWriter.Write(b)
 	r.bytes += n
 	return n, err
@@ -105,7 +164,8 @@ func (r *statusRecorder) Hijack() (net.Conn, *bufio.ReadWriter, error) {
 	return nil, nil, http.ErrNotSupported
 }

-// Middleware هر درخواستِ /api و /admin را ثبت می‌کند (به‌جز خودِ صفحه‌ی تلسکوپ).
+// Middleware هر درخواستِ /api و /admin را ثبت می‌کند (به‌جز خودِ صفحه‌ی تلسکوپ،
+// WebSocket و فایل‌های استاتیک).
 func (t *Telescope) Middleware(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 		p := req.URL.Path
@@ -115,19 +175,24 @@ func (t *Telescope) Middleware(next http.Handler) http.Handler {
 			return
 		}

-		var body string
-		if (req.Method == http.MethodPost || req.Method == http.MethodPut) && req.Body != nil {
-			b, _ := io.ReadAll(io.LimitReader(req.Body, 4096))
+		var reqBody string
+		if req.Body != nil && req.Method != http.MethodGet {
+			b, _ := io.ReadAll(io.LimitReader(req.Body, maxReqBody))
 			req.Body = io.NopCloser(bytes.NewReader(b))
-			body = maskSecrets(string(b))
+			reqBody = maskSecrets(string(b))
 		}

-		rec := &statusRecorder{ResponseWriter: w}
+		var uid int64
+		if t.decodeUID != nil {
+			uid = t.decodeUID(req) // فقط HMAC، بدون DB
+		}
+
+		rec := &statusRecorder{ResponseWriter: w, buf: &bytes.Buffer{}}
 		start := time.Now()
 		next.ServeHTTP(rec, req)
 		dur := time.Since(start)

-		e := Entry{
+		t.add(Entry{
 			Time:     start,
 			Method:   req.Method,
 			Path:     p,
@@ -135,18 +200,49 @@ func (t *Telescope) Middleware(next http.Handler) http.Handler {
 			Duration: dur.Milliseconds(),
 			IP:       req.RemoteAddr,
 			Bytes:    rec.bytes,
-		}
-		// بدنه را فقط برای خطاها نگه می‌داریم تا حافظه/حریمِ خصوصی حفظ شود.
-		if rec.status >= 400 {
-			e.Body = body
-		}
-		t.add(e)
+			UserID:   uid,
+			Headers:  formatHeaders(req.Header),
+			ReqBody:  reqBody,
+			RespBody: maskSecrets(rec.buf.String()),
+		})
 	})
 }

-// maskSecrets مقادیرِ حساس (توکن، کد، پسورد) را در بدنه‌ی JSON پنهان می‌کند.
+// formatHeaders هدرهای درخواست را (با پنهان‌کردنِ مقادیرِ حساس) به رشته تبدیل می‌کند.
+func formatHeaders(h http.Header) string {
+	keys := make([]string, 0, len(h))
+	for k := range h {
+		keys = append(keys, k)
+	}
+	sort.Strings(keys)
+	var sb strings.Builder
+	for _, k := range keys {
+		val := strings.Join(h[k], ", ")
+		switch strings.ToLower(k) {
+		case "authorization", "cookie", "x-access-token":
+			val = "***"
+		}
+		sb.WriteString(k)
+		sb.WriteString(": ")
+		sb.WriteString(val)
+		sb.WriteString("\n")
+	}
+	return sb.String()
+}
+
+var mobileRe = regexp.MustCompile(`"mobile"\s*:\s*"([^"]+)"`)
+
+// mobileFromBody شماره‌ی موبایل را از payloadِ درخواست (مثلِ ورود) درمی‌آورد.
+func mobileFromBody(body string) string {
+	if m := mobileRe.FindStringSubmatch(body); len(m) == 2 {
+		return m[1]
+	}
+	return ""
+}
+
+// maskSecrets مقادیرِ حساس (توکن، کد، پسورد، امضا) را در JSON پنهان می‌کند.
 func maskSecrets(s string) string {
-	for _, k := range []string{"password", "token", "code", "otp", "signature"} {
+	for _, k := range []string{"password", "token", "code", "otp", "signature", "purchase_data"} {
 		s = maskField(s, k)
 	}
 	return s
@@ -158,7 +254,6 @@ func maskField(s, key string) string {
 	if i < 0 {
 		return s
 	}
-	// دنبالِ ": " و سپس مقدار می‌گردیم.
 	j := strings.Index(s[i:], ":")
 	if j < 0 {
 		return s
@@ -168,8 +263,7 @@ func maskField(s, key string) string {
 	if strings.HasPrefix(rest, `"`) {
 		end := strings.Index(rest[1:], `"`)
 		if end >= 0 {
-			masked := s[:i+j+1] + `"***"` + rest[end+2:]
-			return masked
+			return s[:i+j+1] + `"***"` + rest[end+2:]
 		}
 	}
 	return s