Merge branch 'develop' into refactor/kitex_tool

Author: HeyJavaBean

tool/cmd/kitex/args/args.go

@@ -54,9 +54,8 @@ type ExtraFlag struct {
 // Arguments .
 type Arguments struct {
 	generator.Config
-	extends           []*ExtraFlag
-	queryVersion      bool
-	dependencyChecker *versions.DependencyChecker
+	extends      []*ExtraFlag
+	queryVersion bool
 }
 
 const (
@@ -98,7 +97,6 @@ func (a *Arguments) buildFlags(version string) *flag.FlagSet {
 		"Turn on verbose mode.")
 	f.BoolVar(&a.GenerateInvoker, "invoker", false,
 		"Generate invoker side codes when service name is specified.")
-	f.StringVar(&a.IDLType, "type", "unknown", "Specify the type of IDL: 'thrift' or 'protobuf'.")
 	f.Var(&a.Includes, "I", "Add an IDL search path for includes.")
 	f.Var(&a.ThriftOptions, "thrift", "Specify arguments for the thrift go compiler.")
 	f.Var(&a.Hessian2Options, "hessian2", "Specify arguments for the hessian2 codec.")
@@ -196,10 +194,20 @@ func (a *Arguments) ParseArgs(version, curpath string, kitexArgs []string) (err
 		a.ThriftOptions = append(a.ThriftOptions, "streamx")
 	}
 	if a.Record {
-		a.RecordCmd = os.Args
+		a.RecordCmd = append([]string{"kitex"}, kitexArgs...)
 	}
 	log.Verbose = a.Verbose
 
+	for i, inc := range a.Includes {
+		if util.IsGitURL(inc) {
+			localGitPath, gitErr := util.RunGitCommand(inc)
+			if gitErr != nil {
+				return fmt.Errorf("failed to pull IDL from git: %s, errMsg: %s\nYou can execute 'rm -rf ~/.kitex' to clean the git cache and try again", inc, gitErr.Error())
+			}
+			a.Includes[i] = localGitPath
+		}
+	}
+
 	// format -thrift xxx,xxx to -thrift xx -thrift xx
 	thriftOptions := make([]string, len(a.ThriftOptions))
 	for i := range a.ThriftOptions {
@@ -255,16 +263,11 @@ func (a *Arguments) checkIDL(files []string) error {
 	}
 	a.IDL = files[0]
 
-	switch a.IDLType {
-	case Thrift, Protobuf:
-	case Unknown:
-		if typ, ok := guessIDLType(a.IDL); ok {
-			a.IDLType = typ
-		} else {
-			return fmt.Errorf("can not guess an IDL type from %q (unknown suffix), please specify with the '-type' flag", a.IDL)
-		}
-	default:
-		return fmt.Errorf("unsupported IDL type: %s", a.IDLType)
+	if typ, ok := guessIDLType(a.IDL); ok {
+		a.IDLType = typ
+	} else {
+		return fmt.Errorf("the last parameter shoule be IDL filename (xxx.thrift or xxx.proto), for example: " +
+			"\"kitex -service demo idl.thrift\"")
 	}
 	return nil
 }
@@ -369,19 +372,6 @@ func (a *Arguments) BuildCmd(out io.Writer) (*exec.Cmd, error) {
 		return nil, fmt.Errorf("failed to detect current executable: %s", err.Error())
 	}
 
-	for i, inc := range a.Includes {
-		if strings.HasPrefix(inc, "git@") || strings.HasPrefix(inc, "http://") || strings.HasPrefix(inc, "https://") {
-			localGitPath, errMsg, gitErr := util.RunGitCommand(inc)
-			if gitErr != nil {
-				if errMsg == "" {
-					errMsg = gitErr.Error()
-				}
-				return nil, fmt.Errorf("failed to pull IDL from git:%s\nYou can execute 'rm -rf ~/.kitex' to clean the git cache and try again", errMsg)
-			}
-			a.Includes[i] = localGitPath
-		}
-	}
-
 	configkv := a.Config.Pack()
 	kas := strings.Join(configkv, ",")
 	cmd := &exec.Cmd{

tool/cmd/kitex/generator/generator.go

@@ -30,7 +30,7 @@ func RunKitexThriftgoGen(wd string, plugins []plugin.SDKPlugin, kitexOsArgs ...s
 	return t.RunKitexThriftgoGenFromArgs(wd, plugins, &args)
 }
 
-func RunKitexToolCmd(curpath string, osArgs []string, args *kargs.Arguments, toolVersion string) (err error, retCode code.ToolExitCode) {
+func RunKitexTool(curpath string, osArgs []string, args *kargs.Arguments, toolVersion string) (err error, retCode code.ToolExitCode) {
 	// try run as thriftgo/protoc plugin process
 	mode := os.Getenv(kargs.EnvPluginMode)
 	if len(osArgs) <= 1 && mode != "" {

tool/cmd/kitex/main.go

@@ -42,7 +42,7 @@ func main() {
 	// 2. parse user input to arguments
 	// 3. check dependency version ( details: versions/dependencies_v2.go)
 	// 4. execute code generation by choosing specific tool (thriftgo、prutal、protoc?)
-	err, retCode := generator.RunKitexToolCmd(curpath, os.Args, &args, kitex.Version)
+	err, retCode := generator.RunKitexTool(curpath, os.Args, &args, kitex.Version)
 	if err != nil || !code.Good(retCode) {
 		log.Errorf(err.Error())
 		os.Exit(int(retCode))

tool/cmd/kitex/utils/utils.go

@@ -15,26 +15,13 @@
 package utils
 
 import (
-	"os/exec"
-	"strings"
-
 	kargs "github.com/cloudwego/kitex/tool/cmd/kitex/args"
 	"github.com/cloudwego/kitex/tool/internal_pkg/log"
 	"github.com/cloudwego/kitex/tool/internal_pkg/pluginmode/thriftgo"
 )
 
 func OnKitexToolNormalExit(args kargs.Arguments) {
 	log.Info("Code Generation is Done!")
-
-	if args.IDLType == "thrift" {
-		cmd := "go mod edit -replace github.com/apache/thrift=github.com/apache/thrift@v0.13.0"
-		argv := strings.Split(cmd, " ")
-		err := exec.Command(argv[0], argv[1:]...).Run()
-		if err != nil {
-			log.Warnf("Tips: please execute the following command to fix apache thrift lib version.\n%s", cmd)
-		}
-	}
-
 	// If hessian option is java_extension, replace *java.Object to java.Object
 	if thriftgo.EnableJavaExtension(args.Config) {
 		if err := thriftgo.Hessian2PatchByReplace(args.Config, ""); err != nil {

tool/cmd/kitex/versions/dependencies_v2.go

@@ -85,7 +85,7 @@ func CheckVersion() (ok bool, err error) {
 	if !currentVersion.greatOrEqual(minDepRepoVersion) {
 		prompt := cr.promptFunc(cr.minDepRepoPath, currentVersionStr, kitex.Version)
 		log.Infof(prompt)
-		return false, fmt.Errorf("kitex cmd tool dependency compatibility check failed")
+		return false, ErrDependencyVersionNotCompatible
 	}
 
 	return true, nil

tool/internal_pkg/log/log.go

@@ -18,6 +18,8 @@ import (
 	"fmt"
 	"log"
 	"os"
+
+	"github.com/cloudwego/kitex/tool/internal_pkg/util"
 )
 
 // Verbose decides whether the informatc logs should be output.
@@ -48,24 +50,28 @@ func SetDefaultLogger(l Logger) {
 	defaultLogger = l
 }
 
+var errorPrefix = util.Bold + util.FgRed + "[ERROR] " + util.Reset
+
+var warningPrefix = util.Bold + util.FgYellow + "[WARN] " + util.Reset
+
 // Error ...
 func Error(v ...interface{}) {
-	defaultLogger.Printf("[ERROR] %s", fmt.Sprintln(v...))
+	defaultLogger.Printf("%s%s", errorPrefix, fmt.Sprintln(v...))
 }
 
 // Errorf ...
 func Errorf(format string, v ...interface{}) {
-	defaultLogger.Printf("[ERROR] "+format, v...)
+	defaultLogger.Printf(errorPrefix+format, v...)
 }
 
 // Warn ...
 func Warn(v ...interface{}) {
-	defaultLogger.Printf("[WARN] %s", fmt.Sprintln(v...))
+	defaultLogger.Printf("%s %s", warningPrefix, fmt.Sprintln(v...))
 }
 
 // Warnf ...
 func Warnf(format string, v ...interface{}) {
-	defaultLogger.Printf("[WARN] "+format, v...)
+	defaultLogger.Printf(warningPrefix+format, v...)
 }
 
 // Info ...

tool/internal_pkg/pluginmode/thriftgo/convertor.go

@@ -66,6 +66,8 @@ func (c *converter) init(req *plugin.Request) error {
 }
 
 func (c *converter) initLogs() backend.LogFunc {
+	// todo fix log
+	// todo 单步验证 thriftgo log
 	lf := backend.LogFunc{
 		Info: func(v ...interface{}) {},
 		Warn: func(v ...interface{}) {
@@ -75,13 +77,13 @@ func (c *converter) initLogs() backend.LogFunc {
 			c.Warnings = append(c.Warnings, warns...)
 		},
 	}
-	if c.Config.Verbose {
-		lf.Info = lf.Warn
-	}
+	//if c.Config.Verbose {
+	//	lf.Info = lf.Warn
+	//}
 
-	log.SetDefaultLogger(log.LoggerFunc(func(format string, a ...interface{}) {
-		c.Warnings = append(c.Warnings, fmt.Sprintf(format, a...))
-	}))
+	//log.SetDefaultLogger(log.LoggerFunc(func(format string, a ...interface{}) {
+	//	c.Warnings = append(c.Warnings, fmt.Sprintf(format, a...))
+	//}))
 	return lf
 }
 

tool/internal_pkg/pluginmode/thriftgo/plugin.go

@@ -19,6 +19,8 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/cloudwego/kitex/tool/internal_pkg/log"
+
 	"github.com/cloudwego/thriftgo/plugin"
 
 	"github.com/cloudwego/kitex/tool/internal_pkg/generator"
@@ -129,8 +131,7 @@ func HandleRequest(req *plugin.Request) *plugin.Response {
 	if conv.Config.Use != "" {
 		err := conv.persist(res)
 		if err == nil {
-			// todo 检测这里的效果？修改打印！
-			fmt.Println("kitex_gen is not generated due to the -use option")
+			log.Info("kitex_gen is not generated due to the -use option")
 			return res
 		}
 		return conv.failResp(err)

tool/internal_pkg/thriftgo/thriftgo.go

@@ -16,13 +16,13 @@ package thriftgo
 
 import (
 	"bytes"
+	"fmt"
 
 	"github.com/cloudwego/kitex"
 	"github.com/cloudwego/kitex/tool/internal_pkg/pluginmode/thriftgo"
 
 	kargs "github.com/cloudwego/kitex/tool/cmd/kitex/args"
 	"github.com/cloudwego/kitex/tool/cmd/kitex/code"
-	"github.com/cloudwego/kitex/tool/internal_pkg/log"
 	"github.com/cloudwego/thriftgo/plugin"
 	"github.com/cloudwego/thriftgo/sdk"
 )
@@ -51,6 +51,9 @@ func (k *KitexThriftgoPlugin) GetThriftgoParameters() []string {
 
 // RunKitexThriftgoGenFromArgs kitex tool to generate thrift as sdk
 func RunKitexThriftgoGenFromArgs(wd string, plugins []plugin.SDKPlugin, argsParsed *kargs.Arguments) (error, code.ToolExitCode) {
+	if !argsParsed.IsThrift() {
+		return fmt.Errorf("only support thrift idl"), code.ToolArgsError
+	}
 	p, err := GetKitexThriftgoPluginFromArgs(wd, argsParsed)
 	if err != nil {
 		if code.IsInterrupted(err) {
@@ -64,10 +67,6 @@ func RunKitexThriftgoGenFromArgs(wd string, plugins []plugin.SDKPlugin, argsPars
 
 	plugins = append([]plugin.SDKPlugin{p}, plugins...)
 
-	// fixme
-	l := log.DefaultLogger()      // pluginmode/thriftgo/convertor.go will change the logger
-	defer log.SetDefaultLogger(l) // revert it back
-
 	err = sdk.RunThriftgoAsSDK(wd, plugins, p.GetThriftgoParameters()...)
 	if err == nil {
 		return nil, code.ToolSuccess

tool/internal_pkg/util/color.go

@@ -0,0 +1,50 @@
+package util
+
+// Define common ANSI escape code constants
+const (
+	Reset = "\x1b[0m" // Reset all attributes
+	// Regular Colors (Foreground)
+	FgBlack   = "\x1b[30m"
+	FgRed     = "\x1b[31m"
+	FgGreen   = "\x1b[32m"
+	FgYellow  = "\x1b[33m"
+	FgBlue    = "\x1b[34m"
+	FgMagenta = "\x1b[35m"
+	FgCyan    = "\x1b[36m"
+	FgWhite   = "\x1b[37m"
+	// Bright/High-Intensity Colors (Foreground)
+	FgBrightBlack   = "\x1b[90m" // Often called Gray
+	FgBrightRed     = "\x1b[91m"
+	FgBrightGreen   = "\x1b[92m"
+	FgBrightYellow  = "\x1b[93m"
+	FgBrightBlue    = "\x1b[94m"
+	FgBrightMagenta = "\x1b[95m"
+	FgBrightCyan    = "\x1b[96m"
+	FgBrightWhite   = "\x1b[97m"
+	// Background Colors
+	BgBlack   = "\x1b[40m"
+	BgRed     = "\x1b[41m"
+	BgGreen   = "\x1b[42m"
+	BgYellow  = "\x1b[43m"
+	BgBlue    = "\x1b[44m"
+	BgMagenta = "\x1b[45m"
+	BgCyan    = "\x1b[46m"
+	BgWhite   = "\x1b[47m"
+	// Bright/High-Intensity Background Colors
+	BgBrightBlack   = "\x1b[100m"
+	BgBrightRed     = "\x1b[101m"
+	BgBrightGreen   = "\x1b[102m"
+	BgBrightYellow  = "\x1b[103m"
+	BgBrightBlue    = "\x1b[104m"
+	BgBrightMagenta = "\x1b[105m"
+	BgBrightCyan    = "\x1b[106m"
+	BgBrightWhite   = "\x1b[107m"
+	// Styles
+	Bold      = "\x1b[1m"
+	Dim       = "\x1b[2m" // Dim/Faint
+	Italic    = "\x1b[3m" // Italic (not supported by all terminals)
+	Underline = "\x1b[4m" // Underline
+	Blink     = "\x1b[5m" // Blink (not supported by all terminals)
+	Reverse   = "\x1b[7m" // Reverse foreground and background colors
+	Hidden    = "\x1b[8m" // Hidden (useful for password input)
+)