Refactor log (#3446)

* Refactor log

* Add new log methods

* Fix logger test

* Change all logging code

* Clean up pathObj

* Rebase to latest main

* Remove invoking method name after the dot

common/errors/errorgen/main.go

@@ -1,37 +0,0 @@
-package main
-
-import (
-	"fmt"
-	"os"
-	"path/filepath"
-)
-
-func main() {
-	pwd, err := os.Getwd()
-	if err != nil {
-		fmt.Println("can not get current working directory")
-		os.Exit(1)
-	}
-	pkg := filepath.Base(pwd)
-	if pkg == "xray-core" {
-		pkg = "core"
-	}
-
-	file, err := os.OpenFile("errors.generated.go", os.O_WRONLY|os.O_TRUNC|os.O_CREATE, 0o644)
-	if err != nil {
-		fmt.Printf("Failed to generate errors.generated.go: %v", err)
-		os.Exit(1)
-	}
-	defer file.Close()
-
-	fmt.Fprintf(file, `package %s
-
-import "github.com/xtls/xray-core/common/errors"
-
-type errPathObjHolder struct{}
-
-func newError(values ...interface{}) *errors.Error {
-	return errors.New(values...).WithPathObj(errPathObjHolder{})
-}
-`, pkg)
-}

common/errors/errors.go

@@ -2,9 +2,11 @@
 package errors // import "github.com/xtls/xray-core/common/errors"
 
 import (
-	"reflect"
+	"context"
+	"runtime"
 	"strings"
 
+	c "github.com/xtls/xray-core/common/ctx"
 	"github.com/xtls/xray-core/common/log"
 	"github.com/xtls/xray-core/common/serial"
 )
@@ -22,29 +24,13 @@ type hasSeverity interface {
 
 // Error is an error object with underlying error.
 type Error struct {
-	pathObj  interface{}
 	prefix   []interface{}
 	message  []interface{}
+	caller   string
 	inner    error
 	severity log.Severity
 }
 
-func (err *Error) WithPathObj(obj interface{}) *Error {
-	err.pathObj = obj
-	return err
-}
-
-func (err *Error) pkgPath() string {
-	if err.pathObj == nil {
-		return ""
-	}
-	path := reflect.TypeOf(err.pathObj).PkgPath()
-	if len(path) >= trim {
-		return path[trim:]
-	}
-	return path
-}
-
 // Error implements error.Error().
 func (err *Error) Error() string {
 	builder := strings.Builder{}
@@ -54,9 +40,8 @@ func (err *Error) Error() string {
 		builder.WriteString("] ")
 	}
 
-	path := err.pkgPath()
-	if len(path) > 0 {
-		builder.WriteString(path)
+	if len(err.caller) > 0 {
+		builder.WriteString(err.caller)
 		builder.WriteString(": ")
 	}
 
@@ -129,24 +114,6 @@ func (err *Error) String() string {
 	return err.Error()
 }
 
-// WriteToLog writes current error into log.
-func (err *Error) WriteToLog(opts ...ExportOption) {
-	var holder ExportOptionHolder
-
-	for _, opt := range opts {
-		opt(&holder)
-	}
-
-	if holder.SessionID > 0 {
-		err.prefix = append(err.prefix, holder.SessionID)
-	}
-
-	log.Record(&log.GeneralMessage{
-		Severity: GetSeverity(err),
-		Content:  err,
-	})
-}
-
 type ExportOptionHolder struct {
 	SessionID uint32
 }
@@ -155,12 +122,82 @@ type ExportOption func(*ExportOptionHolder)
 
 // New returns a new error object with message formed from given arguments.
 func New(msg ...interface{}) *Error {
+	pc, _, _, _ := runtime.Caller(1)
+	details := runtime.FuncForPC(pc).Name()
+	if len(details) >= trim {
+		details = details[trim:]
+	}
+	i := strings.Index(details, ".")
+	if i > 0 {
+		details = details[:i]
+	}
 	return &Error{
 		message:  msg,
 		severity: log.Severity_Info,
+		caller:   details,
 	}
 }
 
+func LogDebug(ctx context.Context, msg ...interface{}) {
+	doLog(ctx, nil, log.Severity_Debug, msg...)
+}
+
+func LogDebugInner(ctx context.Context, inner error, msg ...interface{}) {
+	doLog(ctx, inner, log.Severity_Debug, msg...)
+}
+
+func LogInfo(ctx context.Context, msg ...interface{}) {
+	doLog(ctx, nil, log.Severity_Info, msg...)
+}
+
+func LogInfoInner(ctx context.Context, inner error, msg ...interface{}) {
+	doLog(ctx, inner, log.Severity_Debug, msg...)
+}
+
+func LogWarning(ctx context.Context, msg ...interface{}) {
+	doLog(ctx, nil, log.Severity_Warning, msg...)
+}
+
+func LogWarningInner(ctx context.Context, inner error, msg ...interface{}) {
+	doLog(ctx, inner, log.Severity_Debug, msg...)
+}
+
+func LogError(ctx context.Context, msg ...interface{}) {
+	doLog(ctx, nil, log.Severity_Error, msg...)
+}
+
+func LogErrorInner(ctx context.Context, inner error, msg ...interface{}) {
+	doLog(ctx, inner, log.Severity_Debug, msg...)
+}
+
+func doLog(ctx context.Context, inner error, severity log.Severity, msg ...interface{}) {
+	pc, _, _, _ := runtime.Caller(2)
+	details := runtime.FuncForPC(pc).Name()
+	if len(details) >= trim {
+		details = details[trim:]
+	}
+	i := strings.Index(details, ".")
+	if i > 0 {
+		details = details[:i]
+	}
+	err := &Error{
+		message:  msg,
+		severity: severity,
+		caller:   details,
+		inner:    inner,
+	}
+	if ctx != nil && ctx != context.Background() {
+		id := uint32(c.IDFromContext(ctx))
+		if id > 0 {
+			err.prefix = append(err.prefix, id)
+		}
+	}
+	log.Record(&log.GeneralMessage{
+		Severity: GetSeverity(err),
+		Content:  err,
+	})
+}
+
 // Cause returns the root cause of this error.
 func Cause(err error) error {
 	if err == nil {

common/errors/errors_test.go

@@ -36,20 +36,14 @@ func TestError(t *testing.T) {
 	}
 }
 
-type e struct{}
-
 func TestErrorMessage(t *testing.T) {
 	data := []struct {
 		err error
 		msg string
 	}{
 		{
-			err: New("a").Base(New("b")).WithPathObj(e{}),
-			msg: "common/errors_test: a > b",
-		},
-		{
-			err: New("a").Base(New("b").WithPathObj(e{})),
-			msg: "a > common/errors_test: b",
+			err: New("a").Base(New("b")),
+			msg: "common/errors_test: a > common/errors_test: b",
 		},
 	}