Compare commits
	
		
			50 Commits
		
	
	
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 813ce71e3e | |||
| 56ae0cfc6c | |||
| 202afc9068 | |||
| 56094b3cb6 | |||
| 0da098e9f9 | |||
| f0881c9fd6 | |||
| 029b408749 | |||
| 84b2be3169 | |||
| c872cecc67 | |||
| 99cd92729e | |||
| ac416f7b69 | |||
| e10140e143 | |||
| e165f0f62f | |||
| 655d4daad9 | |||
| 87a004e577 | |||
| 376c6cab50 | |||
| 4a3f25baa0 | |||
| aa33bc8df3 | |||
| 96b3718375 | |||
| 5f9b55933b | |||
| 74d42637e7 | |||
| 0c05bcf29b | |||
| 9136143f2f | |||
| 2f1b784dc2 | |||
| 190584e0e6 | |||
| b7003b9ec9 | |||
| 4f871271e8 | |||
| 91f4793678 | |||
| 3b30bb049e | |||
| f0c5b36ea9 | |||
| 647ec64c3b | |||
| b5f9b6b638 | |||
| c7949febf2 | |||
| 15a4b2a713 | |||
| 493c6ebae8 | |||
| fb847b03af | |||
| f826633e6e | |||
| edeae23bf1 | |||
| a038b86147 | |||
| ede0b99d3a | |||
| d04ce18eb0 | |||
| 8ae9a0f107 | |||
| a259bb6dbc | |||
| adf32568ee | |||
| 0cfa159cb1 | |||
| 0ead99608a | |||
| 7fe3e66cad | |||
| a73d7d1654 | |||
| bbd7a7bc2c | |||
| f5151eb214 | 
| @@ -31,13 +31,13 @@ type EnumDef struct { | ||||
| 	Values       []EnumDefVal | ||||
| } | ||||
|  | ||||
| var rexPackage = rext.W(regexp.MustCompile("^package\\s+(?P<name>[A-Za-z0-9_]+)\\s*$")) | ||||
| var rexPackage = rext.W(regexp.MustCompile(`^package\s+(?P<name>[A-Za-z0-9_]+)\s*$`)) | ||||
|  | ||||
| var rexEnumDef = rext.W(regexp.MustCompile("^\\s*type\\s+(?P<name>[A-Za-z0-9_]+)\\s+(?P<type>[A-Za-z0-9_]+)\\s*//\\s*(@enum:type).*$")) | ||||
| var rexEnumDef = rext.W(regexp.MustCompile(`^\s*type\s+(?P<name>[A-Za-z0-9_]+)\s+(?P<type>[A-Za-z0-9_]+)\s*//\s*(@enum:type).*$`)) | ||||
|  | ||||
| var rexValueDef = rext.W(regexp.MustCompile("^\\s*(?P<name>[A-Za-z0-9_]+)\\s+(?P<type>[A-Za-z0-9_]+)\\s*=\\s*(?P<value>(\"[A-Za-z0-9_:]+\"|[0-9]+))\\s*(//(?P<descr>.*))?.*$")) | ||||
| var rexValueDef = rext.W(regexp.MustCompile(`^\s*(?P<name>[A-Za-z0-9_]+)\s+(?P<type>[A-Za-z0-9_]+)\s*=\s*(?P<value>("[A-Za-z0-9_:]+"|[0-9]+))\s*(//(?P<descr>.*))?.*$`)) | ||||
|  | ||||
| var rexChecksumConst = rext.W(regexp.MustCompile("const ChecksumGenerator = \"(?P<cs>[A-Za-z0-9_]*)\"")) | ||||
| var rexChecksumConst = rext.W(regexp.MustCompile(`const ChecksumGenerator = "(?P<cs>[A-Za-z0-9_]*)"`)) | ||||
|  | ||||
| func GenerateEnumSpecs(sourceDir string, destFile string) error { | ||||
|  | ||||
| @@ -209,36 +209,10 @@ func fmtOutput(cs string, enums []EnumDef, pkgname string) string { | ||||
| 	str += "\n" | ||||
|  | ||||
| 	str += "import \"gogs.mikescher.com/BlackForestBytes/goext/langext\"" + "\n" | ||||
| 	str += "import \"gogs.mikescher.com/BlackForestBytes/goext/enums\"" + "\n" | ||||
| 	str += "\n" | ||||
|  | ||||
| 	str += "const ChecksumGenerator = \"" + cs + "\"" + "\n" | ||||
| 	str += "\n" | ||||
|  | ||||
| 	str += "type Enum interface {" + "\n" | ||||
| 	str += "    Valid() bool" + "\n" | ||||
| 	str += "    ValuesAny() []any" + "\n" | ||||
| 	str += "    ValuesMeta() []EnumMetaValue" + "\n" | ||||
| 	str += "    VarName() string" + "\n" | ||||
| 	str += "}" + "\n" | ||||
| 	str += "" + "\n" | ||||
|  | ||||
| 	str += "type StringEnum interface {" + "\n" | ||||
| 	str += "    Enum" + "\n" | ||||
| 	str += "    String() string" + "\n" | ||||
| 	str += "}" + "\n" | ||||
| 	str += "" + "\n" | ||||
|  | ||||
| 	str += "type DescriptionEnum interface {" + "\n" | ||||
| 	str += "    Enum" + "\n" | ||||
| 	str += "    Description() string" + "\n" | ||||
| 	str += "}" + "\n" | ||||
| 	str += "\n" | ||||
|  | ||||
| 	str += "type EnumMetaValue struct {" + "\n" | ||||
| 	str += "    VarName     string  `json:\"varName\"`" + "\n" | ||||
| 	str += "    Value       any     `json:\"value\"`" + "\n" | ||||
| 	str += "    Description *string `json:\"description\"`" + "\n" | ||||
| 	str += "}" + "\n" | ||||
| 	str += "const ChecksumGenerator = \"" + cs + "\" // GoExtVersion: " + goext.GoextVersion + "\n" | ||||
| 	str += "\n" | ||||
|  | ||||
| 	for _, enumdef := range enums { | ||||
| @@ -292,7 +266,7 @@ func fmtOutput(cs string, enums []EnumDef, pkgname string) string { | ||||
| 		str += "}" + "\n" | ||||
| 		str += "" + "\n" | ||||
|  | ||||
| 		str += "func (e " + enumdef.EnumTypeName + ") ValuesMeta() []EnumMetaValue {" + "\n" | ||||
| 		str += "func (e " + enumdef.EnumTypeName + ") ValuesMeta() []enums.EnumMetaValue {" + "\n" | ||||
| 		str += "    return " + enumdef.EnumTypeName + "ValuesMeta()" | ||||
| 		str += "}" + "\n" | ||||
| 		str += "" + "\n" | ||||
| @@ -322,11 +296,11 @@ func fmtOutput(cs string, enums []EnumDef, pkgname string) string { | ||||
| 		str += "}" + "\n" | ||||
| 		str += "" + "\n" | ||||
|  | ||||
| 		str += "func (e " + enumdef.EnumTypeName + ") Meta() EnumMetaValue {" + "\n" | ||||
| 		str += "func (e " + enumdef.EnumTypeName + ") Meta() enums.EnumMetaValue {" + "\n" | ||||
| 		if hasDescr { | ||||
| 			str += "    return EnumMetaValue{VarName: e.VarName(), Value: e, Description: langext.Ptr(e.Description())}" | ||||
| 			str += "    return enums.EnumMetaValue{VarName: e.VarName(), Value: e, Description: langext.Ptr(e.Description())}" | ||||
| 		} else { | ||||
| 			str += "    return EnumMetaValue{VarName: e.VarName(), Value: e, Description: nil}" | ||||
| 			str += "    return enums.EnumMetaValue{VarName: e.VarName(), Value: e, Description: nil}" | ||||
| 		} | ||||
| 		str += "}" + "\n" | ||||
| 		str += "" + "\n" | ||||
| @@ -346,8 +320,8 @@ func fmtOutput(cs string, enums []EnumDef, pkgname string) string { | ||||
| 		str += "}" + "\n" | ||||
| 		str += "" + "\n" | ||||
|  | ||||
| 		str += "func " + enumdef.EnumTypeName + "ValuesMeta() []EnumMetaValue {" + "\n" | ||||
| 		str += "    return []EnumMetaValue{" + "\n" | ||||
| 		str += "func " + enumdef.EnumTypeName + "ValuesMeta() []enums.EnumMetaValue {" + "\n" | ||||
| 		str += "    return []enums.EnumMetaValue{" + "\n" | ||||
| 		for _, v := range enumdef.Values { | ||||
| 			str += "        " + v.VarName + ".Meta(),\n" | ||||
| 		} | ||||
|   | ||||
| @@ -14,6 +14,7 @@ type CommandRunner struct { | ||||
| 	listener         []CommandListener | ||||
| 	enforceExitCodes *[]int | ||||
| 	enforceNoTimeout bool | ||||
| 	enforceNoStderr  bool | ||||
| } | ||||
|  | ||||
| func Runner(program string) *CommandRunner { | ||||
| @@ -25,6 +26,7 @@ func Runner(program string) *CommandRunner { | ||||
| 		listener:         make([]CommandListener, 0), | ||||
| 		enforceExitCodes: nil, | ||||
| 		enforceNoTimeout: false, | ||||
| 		enforceNoStderr:  false, | ||||
| 	} | ||||
| } | ||||
|  | ||||
| @@ -73,6 +75,11 @@ func (r *CommandRunner) FailOnTimeout() *CommandRunner { | ||||
| 	return r | ||||
| } | ||||
|  | ||||
| func (r *CommandRunner) FailOnStderr() *CommandRunner { | ||||
| 	r.enforceNoStderr = true | ||||
| 	return r | ||||
| } | ||||
|  | ||||
| func (r *CommandRunner) Listen(lstr CommandListener) *CommandRunner { | ||||
| 	r.listener = append(r.listener, lstr) | ||||
| 	return r | ||||
|   | ||||
| @@ -11,6 +11,7 @@ import ( | ||||
|  | ||||
| var ErrExitCode = errors.New("process exited with an unexpected exitcode") | ||||
| var ErrTimeout = errors.New("process did not exit after the specified timeout") | ||||
| var ErrStderrPrint = errors.New("process did print to stderr stream") | ||||
|  | ||||
| type CommandResult struct { | ||||
| 	StdOut          string | ||||
| @@ -53,12 +54,27 @@ func run(opt CommandRunner) (CommandResult, error) { | ||||
| 		err         error | ||||
| 	} | ||||
|  | ||||
| 	stderrFailChan := make(chan bool) | ||||
|  | ||||
| 	outputChan := make(chan resultObj) | ||||
| 	go func() { | ||||
| 		// we need to first fully read the pipes and then call Wait | ||||
| 		// see https://pkg.go.dev/os/exec#Cmd.StdoutPipe | ||||
|  | ||||
| 		stdout, stderr, stdcombined, err := preader.Read(opt.listener) | ||||
| 		listener := make([]CommandListener, 0) | ||||
| 		listener = append(listener, opt.listener...) | ||||
|  | ||||
| 		if opt.enforceNoStderr { | ||||
| 			listener = append(listener, genericCommandListener{ | ||||
| 				_readRawStderr: langext.Ptr(func(v []byte) { | ||||
| 					if len(v) > 0 { | ||||
| 						stderrFailChan <- true | ||||
| 					} | ||||
| 				}), | ||||
| 			}) | ||||
| 		} | ||||
|  | ||||
| 		stdout, stderr, stdcombined, err := preader.Read(listener) | ||||
| 		if err != nil { | ||||
| 			outputChan <- resultObj{stdout, stderr, stdcombined, err} | ||||
| 			_ = cmd.Process.Kill() | ||||
| @@ -115,6 +131,34 @@ func run(opt CommandRunner) (CommandResult, error) { | ||||
| 			return res, nil | ||||
| 		} | ||||
|  | ||||
| 	case <-stderrFailChan: | ||||
| 		_ = cmd.Process.Kill() | ||||
| 		for _, lstr := range opt.listener { | ||||
| 			lstr.Timeout() | ||||
| 		} | ||||
|  | ||||
| 		if fallback, ok := syncext.ReadChannelWithTimeout(outputChan, 32*time.Millisecond); ok { | ||||
| 			// most of the time the cmd.Process.Kill() should also have finished the pipereader | ||||
| 			// and we can at least return the already collected stdout, stderr, etc | ||||
| 			res := CommandResult{ | ||||
| 				StdOut:          fallback.stdout, | ||||
| 				StdErr:          fallback.stderr, | ||||
| 				StdCombined:     fallback.stdcombined, | ||||
| 				ExitCode:        -1, | ||||
| 				CommandTimedOut: false, | ||||
| 			} | ||||
| 			return res, ErrStderrPrint | ||||
| 		} else { | ||||
| 			res := CommandResult{ | ||||
| 				StdOut:          "", | ||||
| 				StdErr:          "", | ||||
| 				StdCombined:     "", | ||||
| 				ExitCode:        -1, | ||||
| 				CommandTimedOut: false, | ||||
| 			} | ||||
| 			return res, ErrStderrPrint | ||||
| 		} | ||||
|  | ||||
| 	case outobj := <-outputChan: | ||||
| 		if exiterr, ok := outobj.err.(*exec.ExitError); ok { | ||||
| 			excode := exiterr.ExitCode() | ||||
|   | ||||
| @@ -1,6 +1,7 @@ | ||||
| package cmdext | ||||
|  | ||||
| import ( | ||||
| 	"errors" | ||||
| 	"fmt" | ||||
| 	"testing" | ||||
| 	"time" | ||||
| @@ -289,16 +290,40 @@ func TestLongStdout(t *testing.T) { | ||||
| func TestFailOnTimeout(t *testing.T) { | ||||
|  | ||||
| 	_, err := Runner("sleep").Arg("2").Timeout(200 * time.Millisecond).FailOnTimeout().Run() | ||||
| 	if err != ErrTimeout { | ||||
| 	if !errors.Is(err, ErrTimeout) { | ||||
| 		t.Errorf("wrong err := %v", err) | ||||
| 	} | ||||
|  | ||||
| } | ||||
|  | ||||
| func TestFailOnStderr(t *testing.T) { | ||||
|  | ||||
| 	res1, err := Runner("python").Arg("-c").Arg("import sys; print(\"error\", file=sys.stderr, end='')").FailOnStderr().Run() | ||||
| 	if err == nil { | ||||
| 		t.Errorf("no err") | ||||
| 	} | ||||
| 	if res1.CommandTimedOut { | ||||
| 		t.Errorf("Timeout") | ||||
| 	} | ||||
| 	if res1.ExitCode != -1 { | ||||
| 		t.Errorf("res1.ExitCode == %v", res1.ExitCode) | ||||
| 	} | ||||
| 	if res1.StdErr != "error" { | ||||
| 		t.Errorf("res1.StdErr == '%v'", res1.StdErr) | ||||
| 	} | ||||
| 	if res1.StdOut != "" { | ||||
| 		t.Errorf("res1.StdOut == '%v'", res1.StdOut) | ||||
| 	} | ||||
| 	if res1.StdCombined != "error\n" { | ||||
| 		t.Errorf("res1.StdCombined == '%v'", res1.StdCombined) | ||||
| 	} | ||||
|  | ||||
| } | ||||
|  | ||||
| func TestFailOnExitcode(t *testing.T) { | ||||
|  | ||||
| 	_, err := Runner("false").Timeout(200 * time.Millisecond).FailOnExitCode().Run() | ||||
| 	if err != ErrExitCode { | ||||
| 	if !errors.Is(err, ErrExitCode) { | ||||
| 		t.Errorf("wrong err := %v", err) | ||||
| 	} | ||||
|  | ||||
|   | ||||
| @@ -7,6 +7,9 @@ type SyncSet[TData comparable] struct { | ||||
| 	lock sync.Mutex | ||||
| } | ||||
|  | ||||
| // Add adds `value` to the set | ||||
| // returns true  if the value was actually inserted | ||||
| // returns false if the value already existed | ||||
| func (s *SyncSet[TData]) Add(value TData) bool { | ||||
| 	s.lock.Lock() | ||||
| 	defer s.lock.Unlock() | ||||
| @@ -15,10 +18,10 @@ func (s *SyncSet[TData]) Add(value TData) bool { | ||||
| 		s.data = make(map[TData]bool) | ||||
| 	} | ||||
|  | ||||
| 	_, ok := s.data[value] | ||||
| 	_, existsInPreState := s.data[value] | ||||
| 	s.data[value] = true | ||||
|  | ||||
| 	return !ok | ||||
| 	return !existsInPreState | ||||
| } | ||||
|  | ||||
| func (s *SyncSet[TData]) AddAll(values []TData) { | ||||
|   | ||||
							
								
								
									
										24
									
								
								enums/enum.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										24
									
								
								enums/enum.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,24 @@ | ||||
| package enums | ||||
|  | ||||
| type Enum interface { | ||||
| 	Valid() bool | ||||
| 	ValuesAny() []any | ||||
| 	ValuesMeta() []EnumMetaValue | ||||
| 	VarName() string | ||||
| } | ||||
|  | ||||
| type StringEnum interface { | ||||
| 	Enum | ||||
| 	String() string | ||||
| } | ||||
|  | ||||
| type DescriptionEnum interface { | ||||
| 	Enum | ||||
| 	Description() string | ||||
| } | ||||
|  | ||||
| type EnumMetaValue struct { | ||||
| 	VarName     string  `json:"varName"` | ||||
| 	Value       any     `json:"value"` | ||||
| 	Description *string `json:"description"` | ||||
| } | ||||
| @@ -9,6 +9,7 @@ import ( | ||||
| 	"github.com/rs/zerolog" | ||||
| 	"go.mongodb.org/mongo-driver/bson/primitive" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/dataext" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/enums" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | ||||
| 	"net/http" | ||||
| 	"os" | ||||
| @@ -80,6 +81,10 @@ func New(t ErrorType, msg string) *Builder { | ||||
| } | ||||
|  | ||||
| func Wrap(err error, msg string) *Builder { | ||||
| 	if err == nil { | ||||
| 		return &Builder{errorData: newExErr(CatSystem, TypeInternal, msg)} // prevent NPE if we call Wrap with err==nil | ||||
| 	} | ||||
|  | ||||
| 	if !pkgconfig.RecursiveErrors { | ||||
| 		v := FromError(err) | ||||
| 		v.Message = msg | ||||
| @@ -269,6 +274,18 @@ func (b *Builder) Any(key string, val any) *Builder { | ||||
| 	return b.addMeta(key, MDTAny, newAnyWrap(val)) | ||||
| } | ||||
|  | ||||
| func (b *Builder) Stringer(key string, val fmt.Stringer) *Builder { | ||||
| 	if val == nil { | ||||
| 		return b.addMeta(key, MDTString, "(!nil)") | ||||
| 	} else { | ||||
| 		return b.addMeta(key, MDTString, val.String()) | ||||
| 	} | ||||
| } | ||||
|  | ||||
| func (b *Builder) Enum(key string, val enums.Enum) *Builder { | ||||
| 	return b.addMeta(key, MDTEnum, newEnumWrap(val)) | ||||
| } | ||||
|  | ||||
| func (b *Builder) Stack() *Builder { | ||||
| 	return b.addMeta("@Stack", MDTString, string(debug.Stack())) | ||||
| } | ||||
| @@ -289,7 +306,7 @@ func (b *Builder) GinReq(ctx context.Context, g *gin.Context, req *http.Request) | ||||
| 	} | ||||
| 	b.Str("gin.method", req.Method) | ||||
| 	b.Str("gin.path", g.FullPath()) | ||||
| 	b.Str("gin.header", formatHeader(g.Request.Header)) | ||||
| 	b.Strs("gin.header", extractHeader(g.Request.Header)) | ||||
| 	if req.URL != nil { | ||||
| 		b.Str("gin.url", req.URL.String()) | ||||
| 	} | ||||
| @@ -305,7 +322,9 @@ func (b *Builder) GinReq(ctx context.Context, g *gin.Context, req *http.Request) | ||||
| 	if ctxVal := g.GetString("reqid"); ctxVal != "" { | ||||
| 		b.Str("gin.context.reqid", ctxVal) | ||||
| 	} | ||||
| 	if req.Method != "GET" && req.Body != nil && req.Header.Get("Content-Type") == "application/json" { | ||||
| 	if req.Method != "GET" && req.Body != nil { | ||||
|  | ||||
| 		if req.Header.Get("Content-Type") == "application/json" { | ||||
| 			if brc, ok := req.Body.(dataext.BufferedReadCloser); ok { | ||||
| 				if bin, err := brc.BufferedAll(); err == nil { | ||||
| 					if len(bin) < 16*1024 { | ||||
| @@ -317,12 +336,26 @@ func (b *Builder) GinReq(ctx context.Context, g *gin.Context, req *http.Request) | ||||
| 							b.Bytes("gin.body", bin) | ||||
| 						} | ||||
| 					} else { | ||||
| 					b.Str("gin.body", fmt.Sprintf("[[%v bytes]]", len(bin))) | ||||
| 						b.Str("gin.body", fmt.Sprintf("[[%v bytes | %s]]", len(bin), req.Header.Get("Content-Type"))) | ||||
| 					} | ||||
| 				} | ||||
| 			} | ||||
| 		} | ||||
|  | ||||
| 		if req.Header.Get("Content-Type") == "multipart/form-data" || req.Header.Get("Content-Type") == "x-www-form-urlencoded" { | ||||
| 			if brc, ok := req.Body.(dataext.BufferedReadCloser); ok { | ||||
| 				if bin, err := brc.BufferedAll(); err == nil { | ||||
| 					if len(bin) < 16*1024 { | ||||
| 						b.Bytes("gin.body", bin) | ||||
| 					} else { | ||||
| 						b.Str("gin.body", fmt.Sprintf("[[%v bytes | %s]]", len(bin), req.Header.Get("Content-Type"))) | ||||
| 					} | ||||
| 				} | ||||
| 			} | ||||
| 		} | ||||
|  | ||||
| 	} | ||||
|  | ||||
| 	b.containsGinData = true | ||||
| 	return b | ||||
| } | ||||
| @@ -350,6 +383,20 @@ func formatHeader(header map[string][]string) string { | ||||
| 	return r | ||||
| } | ||||
|  | ||||
| func extractHeader(header map[string][]string) []string { | ||||
| 	r := make([]string, 0, len(header)) | ||||
| 	for k, v := range header { | ||||
| 		for _, hval := range v { | ||||
| 			value := hval | ||||
| 			value = strings.ReplaceAll(value, "\n", "\\n") | ||||
| 			value = strings.ReplaceAll(value, "\r", "\\r") | ||||
| 			value = strings.ReplaceAll(value, "\t", "\\t") | ||||
| 			r = append(r, k+": "+value) | ||||
| 		} | ||||
| 	} | ||||
| 	return r | ||||
| } | ||||
|  | ||||
| // ---------------------------------------------------------------------------- | ||||
|  | ||||
| // Build creates a new error, ready to pass up the stack | ||||
|   | ||||
| @@ -27,6 +27,7 @@ func FromError(err error) *ExErr { | ||||
| 		StatusCode:     nil, | ||||
| 		Message:        err.Error(), | ||||
| 		WrappedErrType: fmt.Sprintf("%T", err), | ||||
| 		WrappedErr:     err, | ||||
| 		Caller:         "", | ||||
| 		OriginalError:  nil, | ||||
| 		Meta:           getForeignMeta(err), | ||||
| @@ -43,6 +44,7 @@ func newExErr(cat ErrorCategory, errtype ErrorType, msg string) *ExErr { | ||||
| 		StatusCode:     nil, | ||||
| 		Message:        msg, | ||||
| 		WrappedErrType: "", | ||||
| 		WrappedErr:     nil, | ||||
| 		Caller:         callername(2), | ||||
| 		OriginalError:  nil, | ||||
| 		Meta:           make(map[string]MetaValue), | ||||
| @@ -59,6 +61,7 @@ func wrapExErr(e *ExErr, msg string, cat ErrorCategory, stacktraceskip int) *ExE | ||||
| 		StatusCode:     e.StatusCode, | ||||
| 		Message:        msg, | ||||
| 		WrappedErrType: "", | ||||
| 		WrappedErr:     nil, | ||||
| 		Caller:         callername(1 + stacktraceskip), | ||||
| 		OriginalError:  e, | ||||
| 		Meta:           make(map[string]MetaValue), | ||||
|   | ||||
| @@ -1,6 +1,7 @@ | ||||
| package exerr | ||||
|  | ||||
| import ( | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/dataext" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | ||||
| ) | ||||
|  | ||||
| @@ -37,24 +38,32 @@ type ErrorType struct { | ||||
|  | ||||
| //goland:noinspection GoUnusedGlobalVariable | ||||
| var ( | ||||
| 	TypeInternal       = ErrorType{"INTERNAL_ERROR", langext.Ptr(500)} | ||||
| 	TypePanic          = ErrorType{"PANIC", langext.Ptr(500)} | ||||
| 	TypeNotImplemented = ErrorType{"NOT_IMPLEMENTED", langext.Ptr(500)} | ||||
| 	TypeInternal       = NewType("INTERNAL_ERROR", langext.Ptr(500)) | ||||
| 	TypePanic          = NewType("PANIC", langext.Ptr(500)) | ||||
| 	TypeNotImplemented = NewType("NOT_IMPLEMENTED", langext.Ptr(500)) | ||||
|  | ||||
| 	TypeWrap = ErrorType{"Wrap", nil} | ||||
| 	TypeWrap = NewType("Wrap", nil) | ||||
|  | ||||
| 	TypeBindFailURI      = ErrorType{"BINDFAIL_URI", langext.Ptr(400)} | ||||
| 	TypeBindFailQuery    = ErrorType{"BINDFAIL_QUERY", langext.Ptr(400)} | ||||
| 	TypeBindFailJSON     = ErrorType{"BINDFAIL_JSON", langext.Ptr(400)} | ||||
| 	TypeBindFailFormData = ErrorType{"BINDFAIL_FORMDATA", langext.Ptr(400)} | ||||
| 	TypeBindFailURI      = NewType("BINDFAIL_URI", langext.Ptr(400)) | ||||
| 	TypeBindFailQuery    = NewType("BINDFAIL_QUERY", langext.Ptr(400)) | ||||
| 	TypeBindFailJSON     = NewType("BINDFAIL_JSON", langext.Ptr(400)) | ||||
| 	TypeBindFailFormData = NewType("BINDFAIL_FORMDATA", langext.Ptr(400)) | ||||
| 	TypeBindFailHeader   = NewType("BINDFAIL_HEADER", langext.Ptr(400)) | ||||
|  | ||||
| 	TypeUnauthorized = ErrorType{"UNAUTHORIZED", langext.Ptr(401)} | ||||
| 	TypeAuthFailed   = ErrorType{"AUTH_FAILED", langext.Ptr(401)} | ||||
| 	TypeUnauthorized = NewType("UNAUTHORIZED", langext.Ptr(401)) | ||||
| 	TypeAuthFailed   = NewType("AUTH_FAILED", langext.Ptr(401)) | ||||
|  | ||||
| 	// other values come from pkgconfig | ||||
| ) | ||||
|  | ||||
| var registeredTypes = dataext.SyncSet[string]{} | ||||
|  | ||||
| func NewType(key string, defStatusCode *int) ErrorType { | ||||
| 	insertOkay := registeredTypes.Add(key) | ||||
| 	if !insertOkay { | ||||
| 		panic("Cannot register same ErrType ('" + key + "') more than once") | ||||
| 	} | ||||
|  | ||||
| 	return ErrorType{key, defStatusCode} | ||||
| } | ||||
|  | ||||
|   | ||||
| @@ -10,8 +10,9 @@ type ErrorPackageConfig struct { | ||||
| 	ZeroLogAllTraces       bool                                             // autom print zerolog logs on .Build()  (for all Severities) | ||||
| 	RecursiveErrors        bool                                             // errors contains their Origin-Error | ||||
| 	ExtendedGinOutput      bool                                             // Log extended data (trace, meta, ...) to gin in err.Output() | ||||
| 	ExtendGinOutput     func(json map[string]any) // (Optionally) extend the gin output with more fields | ||||
| 	ExtendGinDataOutput func(json map[string]any) // (Optionally) extend the gin `__data` output with more fields | ||||
| 	IncludeMetaInGinOutput bool                                             // Log meta fields ( from e.g. `.Str(key, val).Build()` ) to gin in err.Output() | ||||
| 	ExtendGinOutput        func(err *ExErr, json map[string]any)            // (Optionally) extend the gin output with more fields | ||||
| 	ExtendGinDataOutput    func(err *ExErr, depth int, json map[string]any) // (Optionally) extend the gin `__data` output with more fields | ||||
| } | ||||
|  | ||||
| type ErrorPackageConfigInit struct { | ||||
| @@ -19,8 +20,9 @@ type ErrorPackageConfigInit struct { | ||||
| 	ZeroLogAllTraces       bool | ||||
| 	RecursiveErrors        bool | ||||
| 	ExtendedGinOutput      bool | ||||
| 	ExtendGinOutput     *func(json map[string]any) | ||||
| 	ExtendGinDataOutput *func(json map[string]any) | ||||
| 	IncludeMetaInGinOutput bool | ||||
| 	ExtendGinOutput        func(err *ExErr, json map[string]any) | ||||
| 	ExtendGinDataOutput    func(err *ExErr, depth int, json map[string]any) | ||||
| } | ||||
|  | ||||
| var initialized = false | ||||
| @@ -30,8 +32,9 @@ var pkgconfig = ErrorPackageConfig{ | ||||
| 	ZeroLogAllTraces:       false, | ||||
| 	RecursiveErrors:        true, | ||||
| 	ExtendedGinOutput:      false, | ||||
| 	ExtendGinOutput:     func(json map[string]any) {}, | ||||
| 	ExtendGinDataOutput: func(json map[string]any) {}, | ||||
| 	IncludeMetaInGinOutput: true, | ||||
| 	ExtendGinOutput:        func(err *ExErr, json map[string]any) {}, | ||||
| 	ExtendGinDataOutput:    func(err *ExErr, depth int, json map[string]any) {}, | ||||
| } | ||||
|  | ||||
| // Init initializes the exerr packages | ||||
| @@ -42,13 +45,24 @@ func Init(cfg ErrorPackageConfigInit) { | ||||
| 		panic("Cannot re-init error package") | ||||
| 	} | ||||
|  | ||||
| 	ego := func(err *ExErr, json map[string]any) {} | ||||
| 	egdo := func(err *ExErr, depth int, json map[string]any) {} | ||||
|  | ||||
| 	if cfg.ExtendGinOutput != nil { | ||||
| 		ego = cfg.ExtendGinOutput | ||||
| 	} | ||||
| 	if cfg.ExtendGinDataOutput != nil { | ||||
| 		egdo = cfg.ExtendGinDataOutput | ||||
| 	} | ||||
|  | ||||
| 	pkgconfig = ErrorPackageConfig{ | ||||
| 		ZeroLogErrTraces:       cfg.ZeroLogErrTraces, | ||||
| 		ZeroLogAllTraces:       cfg.ZeroLogAllTraces, | ||||
| 		RecursiveErrors:        cfg.RecursiveErrors, | ||||
| 		ExtendedGinOutput:      cfg.ExtendedGinOutput, | ||||
| 		ExtendGinOutput:     langext.Coalesce(cfg.ExtendGinOutput, func(json map[string]any) {}), | ||||
| 		ExtendGinDataOutput: langext.Coalesce(cfg.ExtendGinDataOutput, func(json map[string]any) {}), | ||||
| 		IncludeMetaInGinOutput: cfg.IncludeMetaInGinOutput, | ||||
| 		ExtendGinOutput:        ego, | ||||
| 		ExtendGinDataOutput:    egdo, | ||||
| 	} | ||||
|  | ||||
| 	initialized = true | ||||
|   | ||||
							
								
								
									
										110
									
								
								exerr/exerr.go
									
									
									
									
									
								
							
							
						
						
									
										110
									
								
								exerr/exerr.go
									
									
									
									
									
								
							| @@ -4,6 +4,7 @@ import ( | ||||
| 	"github.com/rs/xid" | ||||
| 	"github.com/rs/zerolog" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | ||||
| 	"reflect" | ||||
| 	"strings" | ||||
| 	"time" | ||||
| ) | ||||
| @@ -20,9 +21,10 @@ type ExErr struct { | ||||
|  | ||||
| 	Message        string `json:"message"` | ||||
| 	WrappedErrType string `json:"wrappedErrType"` | ||||
| 	WrappedErr     any    `json:"-"` | ||||
| 	Caller         string `json:"caller"` | ||||
|  | ||||
| 	OriginalError *ExErr | ||||
| 	OriginalError *ExErr `json:"originalError"` | ||||
|  | ||||
| 	Meta MetaMap `json:"meta"` | ||||
| } | ||||
| @@ -31,10 +33,49 @@ func (ee *ExErr) Error() string { | ||||
| 	return ee.Message | ||||
| } | ||||
|  | ||||
| // Unwrap must be implemented so that some error.XXX methods work | ||||
| func (ee *ExErr) Unwrap() error { | ||||
| 	if ee.OriginalError == nil { | ||||
| 		return nil // this is neccessary - otherwise we return a wrapped nil and the `x == nil` comparison fails (= panic in errors.Is and other failures) | ||||
| 	} | ||||
| 	return ee.OriginalError | ||||
| } | ||||
|  | ||||
| // Is must be implemented so that error.Is(x) works | ||||
| func (ee *ExErr) Is(e error) bool { | ||||
| 	return IsFrom(ee, e) | ||||
| } | ||||
|  | ||||
| // As must be implemented so that error.As(x) works | ||||
| // | ||||
| //goland:noinspection GoTypeAssertionOnErrors | ||||
| func (ee *ExErr) As(target any) bool { | ||||
| 	if dstErr, ok := target.(*ExErr); ok { | ||||
|  | ||||
| 		if dst0, ok := ee.contains(dstErr); ok { | ||||
| 			dstErr = dst0 | ||||
| 			return true | ||||
| 		} else { | ||||
| 			return false | ||||
| 		} | ||||
|  | ||||
| 	} else { | ||||
|  | ||||
| 		val := reflect.ValueOf(target) | ||||
|  | ||||
| 		typStr := val.Type().Elem().String() | ||||
|  | ||||
| 		for curr := ee; curr != nil; curr = curr.OriginalError { | ||||
| 			if curr.Category == CatForeign && curr.WrappedErrType == typStr && curr.WrappedErr != nil { | ||||
| 				val.Elem().Set(reflect.ValueOf(curr.WrappedErr)) | ||||
| 				return true | ||||
| 			} | ||||
| 		} | ||||
|  | ||||
| 		return false | ||||
| 	} | ||||
| } | ||||
|  | ||||
| func (ee *ExErr) Log(evt *zerolog.Event) { | ||||
| 	evt.Msg(ee.FormatLog(LogPrintFull)) | ||||
| } | ||||
| @@ -162,7 +203,6 @@ func (ee *ExErr) RecursiveStatuscode() *int { | ||||
| 		} | ||||
| 	} | ||||
|  | ||||
| 	// fallback to <empty> | ||||
| 	return nil | ||||
| } | ||||
|  | ||||
| @@ -179,6 +219,19 @@ func (ee *ExErr) RecursiveCategory() ErrorCategory { | ||||
| 	return ee.Category | ||||
| } | ||||
|  | ||||
| // RecursiveMeta searches (top-down) for teh first error that has a meta value with teh specified key | ||||
| // and returns its value (or nil) | ||||
| func (ee *ExErr) RecursiveMeta(key string) *MetaValue { | ||||
| 	for curr := ee; curr != nil; curr = curr.OriginalError { | ||||
| 		if metaval, ok := curr.Meta[key]; ok { | ||||
| 			return langext.Ptr(metaval) | ||||
| 		} | ||||
| 	} | ||||
|  | ||||
| 	return nil | ||||
| } | ||||
|  | ||||
| // Depth returns the depth of recursively contained errors | ||||
| func (ee *ExErr) Depth() int { | ||||
| 	if ee.OriginalError == nil { | ||||
| 		return 1 | ||||
| @@ -187,6 +240,59 @@ func (ee *ExErr) Depth() int { | ||||
| 	} | ||||
| } | ||||
|  | ||||
| // contains test if the supplied error is contained in this error (anywhere in the chain) | ||||
| func (ee *ExErr) contains(original *ExErr) (*ExErr, bool) { | ||||
| 	if original == nil { | ||||
| 		return nil, false | ||||
| 	} | ||||
|  | ||||
| 	if ee == original { | ||||
| 		return ee, true | ||||
| 	} | ||||
|  | ||||
| 	for curr := ee; curr != nil; curr = curr.OriginalError { | ||||
| 		if curr.equalsDirectProperties(curr) { | ||||
| 			return curr, true | ||||
| 		} | ||||
| 	} | ||||
|  | ||||
| 	return nil, false | ||||
| } | ||||
|  | ||||
| // equalsDirectProperties tests if ee and other are equals, but only looks at primary properties (not `OriginalError` or `Meta`) | ||||
| func (ee *ExErr) equalsDirectProperties(other *ExErr) bool { | ||||
|  | ||||
| 	if ee.UniqueID != other.UniqueID { | ||||
| 		return false | ||||
| 	} | ||||
| 	if ee.Timestamp != other.Timestamp { | ||||
| 		return false | ||||
| 	} | ||||
| 	if ee.Category != other.Category { | ||||
| 		return false | ||||
| 	} | ||||
| 	if ee.Severity != other.Severity { | ||||
| 		return false | ||||
| 	} | ||||
| 	if ee.Type != other.Type { | ||||
| 		return false | ||||
| 	} | ||||
| 	if ee.StatusCode != other.StatusCode { | ||||
| 		return false | ||||
| 	} | ||||
| 	if ee.Message != other.Message { | ||||
| 		return false | ||||
| 	} | ||||
| 	if ee.WrappedErrType != other.WrappedErrType { | ||||
| 		return false | ||||
| 	} | ||||
| 	if ee.Caller != other.Caller { | ||||
| 		return false | ||||
| 	} | ||||
|  | ||||
| 	return true | ||||
| } | ||||
|  | ||||
| func newID() string { | ||||
| 	return xid.New().String() | ||||
| } | ||||
|   | ||||
							
								
								
									
										93
									
								
								exerr/exerr_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										93
									
								
								exerr/exerr_test.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,93 @@ | ||||
| package exerr | ||||
|  | ||||
| import ( | ||||
| 	"errors" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/tst" | ||||
| 	"testing" | ||||
| ) | ||||
|  | ||||
| type golangErr struct { | ||||
| 	Message string | ||||
| } | ||||
|  | ||||
| func (g golangErr) Error() string { | ||||
| 	return g.Message | ||||
| } | ||||
|  | ||||
| type golangErr2 struct { | ||||
| 	Message string | ||||
| } | ||||
|  | ||||
| func (g golangErr2) Error() string { | ||||
| 	return g.Message | ||||
| } | ||||
|  | ||||
| type simpleError struct { | ||||
| } | ||||
|  | ||||
| func (g simpleError) Error() string { | ||||
| 	return "Something simple went wroong" | ||||
| } | ||||
|  | ||||
| type simpleError2 struct { | ||||
| } | ||||
|  | ||||
| func (g simpleError2) Error() string { | ||||
| 	return "Something simple went wroong" | ||||
| } | ||||
|  | ||||
| func TestExErrIs1(t *testing.T) { | ||||
| 	e0 := simpleError{} | ||||
|  | ||||
| 	wrap := Wrap(e0, "something went wrong").Str("test", "123").Build() | ||||
|  | ||||
| 	tst.AssertTrue(t, errors.Is(wrap, simpleError{})) | ||||
| 	tst.AssertFalse(t, errors.Is(wrap, golangErr{})) | ||||
| 	tst.AssertFalse(t, errors.Is(wrap, golangErr{"error1"})) | ||||
| } | ||||
|  | ||||
| func TestExErrIs2(t *testing.T) { | ||||
| 	e0 := golangErr{"error1"} | ||||
|  | ||||
| 	wrap := Wrap(e0, "something went wrong").Str("test", "123").Build() | ||||
|  | ||||
| 	tst.AssertTrue(t, errors.Is(wrap, e0)) | ||||
| 	tst.AssertTrue(t, errors.Is(wrap, golangErr{"error1"})) | ||||
| 	tst.AssertFalse(t, errors.Is(wrap, golangErr{"error2"})) | ||||
| 	tst.AssertFalse(t, errors.Is(wrap, simpleError{})) | ||||
| } | ||||
|  | ||||
| func TestExErrAs(t *testing.T) { | ||||
|  | ||||
| 	e0 := golangErr{"error1"} | ||||
|  | ||||
| 	w0 := Wrap(e0, "something went wrong").Str("test", "123").Build() | ||||
|  | ||||
| 	{ | ||||
| 		out := golangErr{} | ||||
| 		ok := errors.As(w0, &out) | ||||
| 		tst.AssertTrue(t, ok) | ||||
| 		tst.AssertEqual(t, out.Message, "error1") | ||||
| 	} | ||||
|  | ||||
| 	w1 := Wrap(w0, "outher error").Build() | ||||
|  | ||||
| 	{ | ||||
| 		out := golangErr{} | ||||
| 		ok := errors.As(w1, &out) | ||||
| 		tst.AssertTrue(t, ok) | ||||
| 		tst.AssertEqual(t, out.Message, "error1") | ||||
| 	} | ||||
|  | ||||
| 	{ | ||||
| 		out := golangErr2{} | ||||
| 		ok := errors.As(w1, &out) | ||||
| 		tst.AssertFalse(t, ok) | ||||
| 	} | ||||
|  | ||||
| 	{ | ||||
| 		out := simpleError2{} | ||||
| 		ok := errors.As(w1, &out) | ||||
| 		tst.AssertFalse(t, ok) | ||||
| 	} | ||||
| } | ||||
							
								
								
									
										84
									
								
								exerr/gin.go
									
									
									
									
									
								
							
							
						
						
									
										84
									
								
								exerr/gin.go
									
									
									
									
									
								
							| @@ -3,50 +3,91 @@ package exerr | ||||
| import ( | ||||
| 	"github.com/gin-gonic/gin" | ||||
| 	json "gogs.mikescher.com/BlackForestBytes/goext/gojson" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | ||||
| 	"net/http" | ||||
| 	"time" | ||||
| ) | ||||
|  | ||||
| func (ee *ExErr) toJson() gin.H { | ||||
| 	json := gin.H{} | ||||
| func (ee *ExErr) toJson(depth int, applyExtendListener bool, outputMeta bool) langext.H { | ||||
| 	ginJson := langext.H{} | ||||
|  | ||||
| 	if ee.UniqueID != "" { | ||||
| 		json["id"] = ee.UniqueID | ||||
| 		ginJson["id"] = ee.UniqueID | ||||
| 	} | ||||
| 	if ee.Category != CatWrap { | ||||
| 		json["category"] = ee.Category | ||||
| 		ginJson["category"] = ee.Category | ||||
| 	} | ||||
| 	if ee.Type != TypeWrap { | ||||
| 		json["type"] = ee.Type | ||||
| 		ginJson["type"] = ee.Type | ||||
| 	} | ||||
| 	if ee.StatusCode != nil { | ||||
| 		json["statuscode"] = ee.StatusCode | ||||
| 		ginJson["statuscode"] = ee.StatusCode | ||||
| 	} | ||||
| 	if ee.Message != "" { | ||||
| 		json["message"] = ee.Message | ||||
| 		ginJson["message"] = ee.Message | ||||
| 	} | ||||
| 	if ee.Caller != "" { | ||||
| 		json["caller"] = ee.Caller | ||||
| 		ginJson["caller"] = ee.Caller | ||||
| 	} | ||||
| 	if ee.Severity != SevErr { | ||||
| 		json["severity"] = ee.Severity | ||||
| 		ginJson["severity"] = ee.Severity | ||||
| 	} | ||||
| 	if ee.Timestamp != (time.Time{}) { | ||||
| 		json["time"] = ee.Timestamp.Format(time.RFC3339) | ||||
| 		ginJson["time"] = ee.Timestamp.Format(time.RFC3339) | ||||
| 	} | ||||
| 	if ee.WrappedErrType != "" { | ||||
| 		json["wrappedErrType"] = ee.WrappedErrType | ||||
| 		ginJson["wrappedErrType"] = ee.WrappedErrType | ||||
| 	} | ||||
| 	if ee.OriginalError != nil { | ||||
| 		json["original"] = ee.OriginalError.toJson() | ||||
| 		ginJson["original"] = ee.OriginalError.toJson(depth+1, applyExtendListener, outputMeta) | ||||
| 	} | ||||
|  | ||||
| 	pkgconfig.ExtendGinDataOutput(json) | ||||
| 	if outputMeta { | ||||
| 		metaJson := langext.H{} | ||||
| 		for metaKey, metaVal := range ee.Meta { | ||||
| 			metaJson[metaKey] = metaVal.rawValueForJson() | ||||
| 		} | ||||
| 		ginJson["meta"] = metaJson | ||||
| 	} | ||||
|  | ||||
| 	return json | ||||
| 	if applyExtendListener { | ||||
| 		pkgconfig.ExtendGinDataOutput(ee, depth, ginJson) | ||||
| 	} | ||||
|  | ||||
| 	return ginJson | ||||
| } | ||||
|  | ||||
| // ToAPIJson converts the ExError to a json object | ||||
| // (the same object as used in the Output(gin) method) | ||||
| // | ||||
| // Parameters: | ||||
| //   - [applyExtendListener]:  if false the pkgconfig.ExtendGinOutput / pkgconfig.ExtendGinDataOutput will not be applied | ||||
| //   - [includeWrappedErrors]: if false we do not include the recursive/wrapped errors in `__data` | ||||
| //   - [includeMetaFields]:    if true  we also include meta-values (aka from `.Str(key, value).Build()`), needs includeWrappedErrors=true | ||||
| func (ee *ExErr) ToAPIJson(applyExtendListener bool, includeWrappedErrors bool, includeMetaFields bool) langext.H { | ||||
|  | ||||
| 	apiOutput := langext.H{ | ||||
| 		"errorid":   ee.UniqueID, | ||||
| 		"message":   ee.RecursiveMessage(), | ||||
| 		"errorcode": ee.RecursiveType().Key, | ||||
| 		"category":  ee.RecursiveCategory().Category, | ||||
| 	} | ||||
|  | ||||
| 	if includeWrappedErrors { | ||||
| 		apiOutput["__data"] = ee.toJson(0, applyExtendListener, includeMetaFields) | ||||
| 	} | ||||
|  | ||||
| 	if applyExtendListener { | ||||
| 		pkgconfig.ExtendGinOutput(ee, apiOutput) | ||||
| 	} | ||||
|  | ||||
| 	return apiOutput | ||||
| } | ||||
|  | ||||
| func (ee *ExErr) Output(g *gin.Context) { | ||||
|  | ||||
| 	warnOnPkgConfigNotInitialized() | ||||
|  | ||||
| 	var statuscode = http.StatusInternalServerError | ||||
|  | ||||
| 	var baseCat = ee.RecursiveCategory() | ||||
| @@ -65,20 +106,7 @@ func (ee *ExErr) Output(g *gin.Context) { | ||||
| 		statuscode = *baseType.DefaultStatusCode | ||||
| 	} | ||||
|  | ||||
| 	warnOnPkgConfigNotInitialized() | ||||
|  | ||||
| 	ginOutput := gin.H{ | ||||
| 		"errorid":   ee.UniqueID, | ||||
| 		"message":   ee.RecursiveMessage(), | ||||
| 		"errorcode": ee.RecursiveType(), | ||||
| 		"category":  ee.RecursiveCategory(), | ||||
| 	} | ||||
|  | ||||
| 	if pkgconfig.ExtendedGinOutput { | ||||
| 		ginOutput["__data"] = ee.toJson() | ||||
| 	} | ||||
|  | ||||
| 	pkgconfig.ExtendGinOutput(ginOutput) | ||||
| 	ginOutput := ee.ToAPIJson(true, pkgconfig.ExtendedGinOutput, pkgconfig.IncludeMetaInGinOutput) | ||||
|  | ||||
| 	g.Render(statuscode, json.GoJsonRender{Data: ginOutput, NilSafeSlices: true, NilSafeMaps: true}) | ||||
| } | ||||
|   | ||||
| @@ -24,6 +24,8 @@ func IsFrom(e error, original error) bool { | ||||
| 	if e == nil { | ||||
| 		return false | ||||
| 	} | ||||
|  | ||||
| 	//goland:noinspection GoDirectComparisonOfErrors | ||||
| 	if e == original { | ||||
| 		return true | ||||
| 	} | ||||
|   | ||||
| @@ -43,6 +43,7 @@ const ( | ||||
| 	MDTID          metaDataType = "ID" | ||||
| 	MDTAny         metaDataType = "Interface" | ||||
| 	MDTNil         metaDataType = "Nil" | ||||
| 	MDTEnum        metaDataType = "Enum" | ||||
| ) | ||||
|  | ||||
| type MetaValue struct { | ||||
| @@ -131,6 +132,8 @@ func (v MetaValue) SerializeValue() (string, error) { | ||||
| 		return string(r), nil | ||||
| 	case MDTNil: | ||||
| 		return "", nil | ||||
| 	case MDTEnum: | ||||
| 		return v.Value.(EnumWrap).Serialize(), nil | ||||
| 	} | ||||
| 	return "", errors.New("Unknown type: " + string(v.DataType)) | ||||
| } | ||||
| @@ -208,6 +211,8 @@ func (v MetaValue) ShortString(lim int) string { | ||||
| 		return langext.StrLimit(string(r), lim, "...") | ||||
| 	case MDTNil: | ||||
| 		return "<<null>>" | ||||
| 	case MDTEnum: | ||||
| 		return v.Value.(EnumWrap).String() | ||||
| 	} | ||||
| 	return "(err)" | ||||
| } | ||||
| @@ -270,6 +275,14 @@ func (v MetaValue) Apply(key string, evt *zerolog.Event) *zerolog.Event { | ||||
| 		return evt.Ints32(key, v.Value.([]int32)) | ||||
| 	case MDTNil: | ||||
| 		return evt.Str(key, "<<null>>") | ||||
| 	case MDTEnum: | ||||
| 		if v.Value.(EnumWrap).IsNil { | ||||
| 			return evt.Any(key, nil) | ||||
| 		} else if v.Value.(EnumWrap).ValueRaw != nil { | ||||
| 			return evt.Any(key, v.Value.(EnumWrap).ValueRaw) | ||||
| 		} else { | ||||
| 			return evt.Str(key, v.Value.(EnumWrap).ValueString) | ||||
| 		} | ||||
| 	} | ||||
| 	return evt.Str(key, "(err)") | ||||
| } | ||||
| @@ -511,6 +524,10 @@ func (v *MetaValue) Deserialize(value string, datatype metaDataType) error { | ||||
| 		v.Value = nil | ||||
| 		v.DataType = datatype | ||||
| 		return nil | ||||
| 	case MDTEnum: | ||||
| 		v.Value = deserializeEnumWrap(value) | ||||
| 		v.DataType = datatype | ||||
| 		return nil | ||||
| 	} | ||||
| 	return errors.New("Unknown type: " + string(datatype)) | ||||
| } | ||||
| @@ -581,10 +598,55 @@ func (v MetaValue) ValueString() string { | ||||
| 		return string(r) | ||||
| 	case MDTNil: | ||||
| 		return "<<null>>" | ||||
| 	case MDTEnum: | ||||
| 		return v.Value.(EnumWrap).String() | ||||
| 	} | ||||
| 	return "(err)" | ||||
| } | ||||
|  | ||||
| // rawValueForJson returns most-of-the-time the `Value` field | ||||
| // but for some datatyes we do special processing | ||||
| // all, so we can pluck the output value in json.Marshal without any suprises | ||||
| func (v MetaValue) rawValueForJson() any { | ||||
| 	if v.DataType == MDTAny { | ||||
| 		if v.Value.(AnyWrap).IsNil { | ||||
| 			return nil | ||||
| 		} | ||||
| 		return v.Value.(AnyWrap).Serialize() | ||||
| 	} | ||||
| 	if v.DataType == MDTID { | ||||
| 		if v.Value.(IDWrap).IsNil { | ||||
| 			return nil | ||||
| 		} | ||||
| 		return v.Value.(IDWrap).Value | ||||
| 	} | ||||
| 	if v.DataType == MDTBytes { | ||||
| 		return hex.EncodeToString(v.Value.([]byte)) | ||||
| 	} | ||||
| 	if v.DataType == MDTDuration { | ||||
| 		return v.Value.(time.Duration).String() | ||||
| 	} | ||||
| 	if v.DataType == MDTTime { | ||||
| 		return v.Value.(time.Time).Format(time.RFC3339Nano) | ||||
| 	} | ||||
| 	if v.DataType == MDTObjectID { | ||||
| 		return v.Value.(primitive.ObjectID).Hex() | ||||
| 	} | ||||
| 	if v.DataType == MDTNil { | ||||
| 		return nil | ||||
| 	} | ||||
| 	if v.DataType == MDTEnum { | ||||
| 		if v.Value.(EnumWrap).IsNil { | ||||
| 			return nil | ||||
| 		} | ||||
| 		if v.Value.(EnumWrap).ValueRaw != nil { | ||||
| 			return v.Value.(EnumWrap).ValueRaw | ||||
| 		} | ||||
| 		return v.Value.(EnumWrap).ValueString | ||||
| 	} | ||||
| 	return v.Value | ||||
| } | ||||
|  | ||||
| func (mm MetaMap) FormatOneLine(singleMaxLen int) string { | ||||
| 	r := "" | ||||
|  | ||||
|   | ||||
| @@ -4,6 +4,7 @@ import ( | ||||
| 	"encoding/json" | ||||
| 	"fmt" | ||||
| 	"github.com/rs/zerolog/log" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/enums" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | ||||
| 	"strings" | ||||
| ) | ||||
| @@ -131,3 +132,58 @@ func deserializeAnyWrap(v string) AnyWrap { | ||||
| 		} | ||||
| 	} | ||||
| } | ||||
|  | ||||
| type EnumWrap struct { | ||||
| 	Type        string | ||||
| 	ValueString string | ||||
| 	ValueRaw    enums.Enum // `ValueRaw` is lost during serialization roundtrip | ||||
| 	IsNil       bool | ||||
| } | ||||
|  | ||||
| func newEnumWrap(val enums.Enum) EnumWrap { | ||||
| 	t := fmt.Sprintf("%T", val) | ||||
| 	arr := strings.Split(t, ".") | ||||
| 	if len(arr) > 0 { | ||||
| 		t = arr[len(arr)-1] | ||||
| 	} | ||||
|  | ||||
| 	if langext.IsNil(val) { | ||||
| 		return EnumWrap{Type: t, ValueString: "", ValueRaw: val, IsNil: true} | ||||
| 	} | ||||
|  | ||||
| 	if enumstr, ok := val.(enums.StringEnum); ok { | ||||
| 		return EnumWrap{Type: t, ValueString: enumstr.String(), ValueRaw: val, IsNil: false} | ||||
| 	} | ||||
|  | ||||
| 	return EnumWrap{Type: t, ValueString: fmt.Sprintf("%v", val), ValueRaw: val, IsNil: false} | ||||
| } | ||||
|  | ||||
| func (w EnumWrap) Serialize() string { | ||||
| 	if w.IsNil { | ||||
| 		return "!nil" + ":" + w.Type | ||||
| 	} | ||||
| 	return w.Type + ":" + w.ValueString | ||||
| } | ||||
|  | ||||
| func (w EnumWrap) String() string { | ||||
| 	if w.IsNil { | ||||
| 		return w.Type + "<<nil>>" | ||||
| 	} | ||||
| 	return "[" + w.Type + "] " + w.ValueString | ||||
| } | ||||
|  | ||||
| func deserializeEnumWrap(v string) EnumWrap { | ||||
| 	r := strings.SplitN(v, ":", 2) | ||||
|  | ||||
| 	if len(r) == 2 && r[0] == "!nil" { | ||||
| 		return EnumWrap{Type: r[1], ValueString: v, ValueRaw: nil, IsNil: true} | ||||
| 	} | ||||
|  | ||||
| 	if len(r) == 0 { | ||||
| 		return EnumWrap{} | ||||
| 	} else if len(r) == 1 { | ||||
| 		return EnumWrap{Type: "", ValueString: v, ValueRaw: nil, IsNil: false} | ||||
| 	} else { | ||||
| 		return EnumWrap{Type: r[0], ValueString: r[1], ValueRaw: nil, IsNil: false} | ||||
| 	} | ||||
| } | ||||
|   | ||||
| @@ -14,6 +14,9 @@ type AppContext struct { | ||||
| } | ||||
|  | ||||
| func CreateAppContext(g *gin.Context, innerCtx context.Context, cancelFn context.CancelFunc) *AppContext { | ||||
| 	for key, value := range g.Keys { | ||||
| 		innerCtx = context.WithValue(innerCtx, key, value) | ||||
| 	} | ||||
| 	return &AppContext{ | ||||
| 		inner:      innerCtx, | ||||
| 		cancelFunc: cancelFn, | ||||
| @@ -38,6 +41,10 @@ func (ac *AppContext) Value(key any) any { | ||||
| 	return ac.inner.Value(key) | ||||
| } | ||||
|  | ||||
| func (ac *AppContext) Set(key, value any) { | ||||
| 	ac.inner = context.WithValue(ac.inner, key, value) | ||||
| } | ||||
|  | ||||
| func (ac *AppContext) Cancel() { | ||||
| 	ac.cancelled = true | ||||
| 	ac.cancelFunc() | ||||
|   | ||||
							
								
								
									
										12
									
								
								ginext/commonMiddlewares.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								ginext/commonMiddlewares.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,12 @@ | ||||
| package ginext | ||||
|  | ||||
| import ( | ||||
| 	"github.com/gin-gonic/gin" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/dataext" | ||||
| ) | ||||
|  | ||||
| func BodyBuffer(g *gin.Context) { | ||||
| 	if g.Request.Body != nil { | ||||
| 		g.Request.Body = dataext.NewBufferedReadCloser(g.Request.Body) | ||||
| 	} | ||||
| } | ||||
							
								
								
									
										105
									
								
								ginext/engine.go
									
									
									
									
									
								
							
							
						
						
									
										105
									
								
								ginext/engine.go
									
									
									
									
									
								
							| @@ -1,8 +1,14 @@ | ||||
| package ginext | ||||
|  | ||||
| import ( | ||||
| 	"fmt" | ||||
| 	"github.com/gin-gonic/gin" | ||||
| 	"github.com/rs/zerolog/log" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/mathext" | ||||
| 	"net" | ||||
| 	"net/http" | ||||
| 	"strings" | ||||
| 	"time" | ||||
| ) | ||||
|  | ||||
| @@ -12,10 +18,26 @@ type GinWrapper struct { | ||||
|  | ||||
| 	allowCors      bool | ||||
| 	ginDebug       bool | ||||
| 	bufferBody     bool | ||||
| 	requestTimeout time.Duration | ||||
|  | ||||
| 	routeSpecs []ginRouteSpec | ||||
| } | ||||
|  | ||||
| func NewEngine(allowCors bool, ginDebug bool, timeout time.Duration) *GinWrapper { | ||||
| type ginRouteSpec struct { | ||||
| 	Method      string | ||||
| 	URL         string | ||||
| 	Middlewares []string | ||||
| 	Handler     string | ||||
| } | ||||
|  | ||||
| // NewEngine creates a new (wrapped) ginEngine | ||||
| // Parameters are: | ||||
| // - [allowCors]    Add cors handler to allow all CORS requests on the default http methods | ||||
| // - [ginDebug]     Set gin.debug to true (adds more logs) | ||||
| // - [bufferBody]   Buffers the input body stream, this way the ginext error handler can later include the whole request body | ||||
| // - [timeout]      The default handler timeout | ||||
| func NewEngine(allowCors bool, ginDebug bool, bufferBody bool, timeout time.Duration) *GinWrapper { | ||||
| 	engine := gin.New() | ||||
|  | ||||
| 	wrapper := &GinWrapper{ | ||||
| @@ -23,6 +45,7 @@ func NewEngine(allowCors bool, ginDebug bool, timeout time.Duration) *GinWrapper | ||||
| 		SuppressGinLogs: false, | ||||
| 		allowCors:       allowCors, | ||||
| 		ginDebug:        ginDebug, | ||||
| 		bufferBody:      bufferBody, | ||||
| 		requestTimeout:  timeout, | ||||
| 	} | ||||
|  | ||||
| @@ -33,18 +56,94 @@ func NewEngine(allowCors bool, ginDebug bool, timeout time.Duration) *GinWrapper | ||||
| 		engine.Use(CorsMiddleware()) | ||||
| 	} | ||||
|  | ||||
| 	// do not debug-print routes | ||||
| 	gin.DebugPrintRouteFunc = func(_, _, _ string, _ int) {} | ||||
|  | ||||
| 	if ginDebug { | ||||
| 		gin.SetMode(gin.ReleaseMode) | ||||
|  | ||||
| 		ginlogger := gin.Logger() | ||||
| 		engine.Use(func(context *gin.Context) { | ||||
| 			if !wrapper.SuppressGinLogs { | ||||
| 				ginlogger(context) | ||||
| 			} | ||||
| 		}) | ||||
| 	} else { | ||||
| 		gin.SetMode(gin.DebugMode) | ||||
| 	} | ||||
|  | ||||
| 	return wrapper | ||||
| } | ||||
|  | ||||
| func (w *GinWrapper) ServeHTTP(writer http.ResponseWriter, request *http.Request) { | ||||
| 	w.engine.ServeHTTP(writer, request) | ||||
| func (w *GinWrapper) ListenAndServeHTTP(addr string, postInit func(port string)) (chan error, *http.Server) { | ||||
|  | ||||
| 	w.DebugPrintRoutes() | ||||
|  | ||||
| 	httpserver := &http.Server{ | ||||
| 		Addr:    addr, | ||||
| 		Handler: w.engine, | ||||
| 	} | ||||
|  | ||||
| 	errChan := make(chan error) | ||||
|  | ||||
| 	go func() { | ||||
|  | ||||
| 		ln, err := net.Listen("tcp", httpserver.Addr) | ||||
| 		if err != nil { | ||||
| 			errChan <- err | ||||
| 			return | ||||
| 		} | ||||
|  | ||||
| 		_, port, err := net.SplitHostPort(ln.Addr().String()) | ||||
| 		if err != nil { | ||||
| 			errChan <- err | ||||
| 			return | ||||
| 		} | ||||
|  | ||||
| 		log.Info().Str("address", httpserver.Addr).Msg("HTTP-Server started on http://localhost:" + port) | ||||
|  | ||||
| 		if postInit != nil { | ||||
| 			postInit(port) // the net.Listener a few lines above is at this point actually already buffering requests | ||||
| 		} | ||||
|  | ||||
| 		errChan <- httpserver.Serve(ln) | ||||
| 	}() | ||||
|  | ||||
| 	return errChan, httpserver | ||||
| } | ||||
|  | ||||
| func (w *GinWrapper) DebugPrintRoutes() { | ||||
| 	if !w.ginDebug { | ||||
| 		return | ||||
| 	} | ||||
|  | ||||
| 	lines := make([][4]string, 0) | ||||
|  | ||||
| 	pad := [4]int{0, 0, 0, 0} | ||||
|  | ||||
| 	for _, spec := range w.routeSpecs { | ||||
|  | ||||
| 		line := [4]string{ | ||||
| 			spec.Method, | ||||
| 			spec.URL, | ||||
| 			strings.Join(spec.Middlewares, " -> "), | ||||
| 			spec.Handler, | ||||
| 		} | ||||
|  | ||||
| 		lines = append(lines, line) | ||||
|  | ||||
| 		pad[0] = mathext.Max(pad[0], len(line[0])) | ||||
| 		pad[1] = mathext.Max(pad[1], len(line[1])) | ||||
| 		pad[2] = mathext.Max(pad[2], len(line[2])) | ||||
| 		pad[3] = mathext.Max(pad[3], len(line[3])) | ||||
| 	} | ||||
|  | ||||
| 	for _, line := range lines { | ||||
|  | ||||
| 		fmt.Printf("Gin-Route: %s  %s  -->  %s  -->  %s\n", | ||||
| 			langext.StrPadRight("["+line[0]+"]", " ", pad[0]+2), | ||||
| 			langext.StrPadRight(line[1], " ", pad[1]), | ||||
| 			langext.StrPadRight(line[2], " ", pad[2]), | ||||
| 			langext.StrPadRight(line[3], " ", pad[3])) | ||||
| 	} | ||||
| } | ||||
|   | ||||
| @@ -25,7 +25,7 @@ func Wrap(w *GinWrapper, fn WHandlerFunc) gin.HandlerFunc { | ||||
| 				Str("trace", stackTrace). | ||||
| 				Build() | ||||
|  | ||||
| 			wrap = APIError(g, err) | ||||
| 			wrap = Error(err) | ||||
| 		} | ||||
|  | ||||
| 		if g.Writer.Written() { | ||||
|   | ||||
| @@ -2,10 +2,13 @@ package ginext | ||||
|  | ||||
| import ( | ||||
| 	"context" | ||||
| 	"fmt" | ||||
| 	"github.com/gin-gonic/gin" | ||||
| 	"github.com/gin-gonic/gin/binding" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/exerr" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | ||||
| 	"runtime/debug" | ||||
| 	"time" | ||||
| ) | ||||
|  | ||||
| type PreContext struct { | ||||
| @@ -15,6 +18,8 @@ type PreContext struct { | ||||
| 	query   any | ||||
| 	body    any | ||||
| 	form    any | ||||
| 	header  any | ||||
| 	timeout *time.Duration | ||||
| } | ||||
|  | ||||
| func (pctx *PreContext) URI(uri any) *PreContext { | ||||
| @@ -37,40 +42,90 @@ func (pctx *PreContext) Form(form any) *PreContext { | ||||
| 	return pctx | ||||
| } | ||||
|  | ||||
| func (pctx *PreContext) Header(header any) *PreContext { | ||||
| 	pctx.header = header | ||||
| 	return pctx | ||||
| } | ||||
|  | ||||
| func (pctx *PreContext) WithTimeout(to time.Duration) *PreContext { | ||||
| 	pctx.timeout = &to | ||||
| 	return pctx | ||||
| } | ||||
|  | ||||
| func (pctx PreContext) Start() (*AppContext, *gin.Context, *HTTPResponse) { | ||||
| 	if pctx.uri != nil { | ||||
| 		if err := pctx.ginCtx.ShouldBindUri(pctx.uri); err != nil { | ||||
| 			return nil, nil, langext.Ptr(APIError(pctx.ginCtx, commonApiErr.BindFailURI, "Failed to read uri", err)) | ||||
| 			err = exerr.Wrap(err, "Failed to read uri"). | ||||
| 				WithType(exerr.TypeBindFailURI). | ||||
| 				Str("struct_type", fmt.Sprintf("%T", pctx.uri)). | ||||
| 				Build() | ||||
| 			return nil, nil, langext.Ptr(Error(err)) | ||||
| 		} | ||||
| 	} | ||||
|  | ||||
| 	if pctx.query != nil { | ||||
| 		if err := pctx.ginCtx.ShouldBindQuery(pctx.query); err != nil { | ||||
| 			return nil, nil, langext.Ptr(APIError(pctx.ginCtx, commonApiErr.BindFailQuery, "Failed to read query", err)) | ||||
| 			err = exerr.Wrap(err, "Failed to read query"). | ||||
| 				WithType(exerr.TypeBindFailQuery). | ||||
| 				Str("struct_type", fmt.Sprintf("%T", pctx.query)). | ||||
| 				Build() | ||||
| 			return nil, nil, langext.Ptr(Error(err)) | ||||
| 		} | ||||
| 	} | ||||
|  | ||||
| 	if pctx.body != nil { | ||||
| 		if pctx.ginCtx.ContentType() == "application/json" { | ||||
| 			if err := pctx.ginCtx.ShouldBindJSON(pctx.body); err != nil { | ||||
| 				return nil, nil, langext.Ptr(APIError(pctx.ginCtx, commonApiErr.BindFailJSON, "Failed to read body", err)) | ||||
| 				err = exerr.Wrap(err, "Failed to read json-body"). | ||||
| 					WithType(exerr.TypeBindFailJSON). | ||||
| 					Str("struct_type", fmt.Sprintf("%T", pctx.body)). | ||||
| 					Build() | ||||
| 				return nil, nil, langext.Ptr(Error(err)) | ||||
| 			} | ||||
| 		} else { | ||||
| 			return nil, nil, langext.Ptr(APIError(pctx.ginCtx, commonApiErr.BindFailJSON, "missing JSON body", nil)) | ||||
| 			err := exerr.New(exerr.TypeBindFailJSON, "missing JSON body"). | ||||
| 				Str("struct_type", fmt.Sprintf("%T", pctx.body)). | ||||
| 				Build() | ||||
| 			return nil, nil, langext.Ptr(Error(err)) | ||||
| 		} | ||||
| 	} | ||||
|  | ||||
| 	if pctx.form != nil { | ||||
| 		if pctx.ginCtx.ContentType() == "multipart/form-data" { | ||||
| 			if err := pctx.ginCtx.ShouldBindWith(pctx.form, binding.Form); err != nil { | ||||
| 				return nil, nil, langext.Ptr(APIError(pctx.ginCtx, commonApiErr.BindFailFormData, "Failed to read multipart-form", err)) | ||||
| 				err = exerr.Wrap(err, "Failed to read multipart-form"). | ||||
| 					WithType(exerr.TypeBindFailFormData). | ||||
| 					Str("struct_type", fmt.Sprintf("%T", pctx.form)). | ||||
| 					Build() | ||||
| 				return nil, nil, langext.Ptr(Error(err)) | ||||
| 			} | ||||
| 		} else if pctx.ginCtx.ContentType() == "application/x-www-form-urlencoded" { | ||||
| 			if err := pctx.ginCtx.ShouldBindWith(pctx.form, binding.Form); err != nil { | ||||
| 				err = exerr.Wrap(err, "Failed to read urlencoded-form"). | ||||
| 					WithType(exerr.TypeBindFailFormData). | ||||
| 					Str("struct_type", fmt.Sprintf("%T", pctx.form)). | ||||
| 					Build() | ||||
| 				return nil, nil, langext.Ptr(Error(err)) | ||||
| 			} | ||||
| 		} else { | ||||
| 			return nil, nil, langext.Ptr(APIError(pctx.ginCtx, commonApiErr.BindFailJSON, "missing form body", nil)) | ||||
| 			err := exerr.New(exerr.TypeBindFailFormData, "missing form body"). | ||||
| 				Str("struct_type", fmt.Sprintf("%T", pctx.form)). | ||||
| 				Build() | ||||
| 			return nil, nil, langext.Ptr(Error(err)) | ||||
| 		} | ||||
| 	} | ||||
|  | ||||
| 	ictx, cancel := context.WithTimeout(context.Background(), pctx.wrapper.requestTimeout) | ||||
| 	if pctx.header != nil { | ||||
| 		if err := pctx.ginCtx.ShouldBindHeader(pctx.query); err != nil { | ||||
| 			err = exerr.Wrap(err, "Failed to read header"). | ||||
| 				WithType(exerr.TypeBindFailHeader). | ||||
| 				Str("struct_type", fmt.Sprintf("%T", pctx.query)). | ||||
| 				Build() | ||||
| 			return nil, nil, langext.Ptr(Error(err)) | ||||
| 		} | ||||
| 	} | ||||
|  | ||||
| 	ictx, cancel := context.WithTimeout(context.Background(), langext.Coalesce(pctx.timeout, pctx.wrapper.requestTimeout)) | ||||
| 	actx := CreateAppContext(pctx.ginCtx, ictx, cancel) | ||||
|  | ||||
| 	return actx, pctx.ginCtx, nil | ||||
|   | ||||
| @@ -7,50 +7,93 @@ import ( | ||||
| 	json "gogs.mikescher.com/BlackForestBytes/goext/gojson" | ||||
| ) | ||||
|  | ||||
| type headerval struct { | ||||
| 	Key string | ||||
| 	Val string | ||||
| } | ||||
|  | ||||
| type HTTPResponse interface { | ||||
| 	Write(g *gin.Context) | ||||
| 	WithHeader(k string, v string) HTTPResponse | ||||
| } | ||||
|  | ||||
| type jsonHTTPResponse struct { | ||||
| 	statusCode int | ||||
| 	data       any | ||||
| 	headers    []headerval | ||||
| } | ||||
|  | ||||
| func (j jsonHTTPResponse) Write(g *gin.Context) { | ||||
| 	for _, v := range j.headers { | ||||
| 		g.Header(v.Key, v.Val) | ||||
| 	} | ||||
| 	g.Render(j.statusCode, json.GoJsonRender{Data: j.data, NilSafeSlices: true, NilSafeMaps: true}) | ||||
| } | ||||
|  | ||||
| func (j jsonHTTPResponse) WithHeader(k string, v string) HTTPResponse { | ||||
| 	j.headers = append(j.headers, headerval{k, v}) | ||||
| 	return j | ||||
| } | ||||
|  | ||||
| type emptyHTTPResponse struct { | ||||
| 	statusCode int | ||||
| 	headers    []headerval | ||||
| } | ||||
|  | ||||
| func (j emptyHTTPResponse) Write(g *gin.Context) { | ||||
| 	for _, v := range j.headers { | ||||
| 		g.Header(v.Key, v.Val) | ||||
| 	} | ||||
| 	g.Status(j.statusCode) | ||||
| } | ||||
|  | ||||
| func (j emptyHTTPResponse) WithHeader(k string, v string) HTTPResponse { | ||||
| 	j.headers = append(j.headers, headerval{k, v}) | ||||
| 	return j | ||||
| } | ||||
|  | ||||
| type textHTTPResponse struct { | ||||
| 	statusCode int | ||||
| 	data       string | ||||
| 	headers    []headerval | ||||
| } | ||||
|  | ||||
| func (j textHTTPResponse) Write(g *gin.Context) { | ||||
| 	for _, v := range j.headers { | ||||
| 		g.Header(v.Key, v.Val) | ||||
| 	} | ||||
| 	g.String(j.statusCode, "%s", j.data) | ||||
| } | ||||
|  | ||||
| func (j textHTTPResponse) WithHeader(k string, v string) HTTPResponse { | ||||
| 	j.headers = append(j.headers, headerval{k, v}) | ||||
| 	return j | ||||
| } | ||||
|  | ||||
| type dataHTTPResponse struct { | ||||
| 	statusCode  int | ||||
| 	data        []byte | ||||
| 	contentType string | ||||
| 	headers     []headerval | ||||
| } | ||||
|  | ||||
| func (j dataHTTPResponse) Write(g *gin.Context) { | ||||
| 	for _, v := range j.headers { | ||||
| 		g.Header(v.Key, v.Val) | ||||
| 	} | ||||
| 	g.Data(j.statusCode, j.contentType, j.data) | ||||
| } | ||||
|  | ||||
| func (j dataHTTPResponse) WithHeader(k string, v string) HTTPResponse { | ||||
| 	j.headers = append(j.headers, headerval{k, v}) | ||||
| 	return j | ||||
| } | ||||
|  | ||||
| type fileHTTPResponse struct { | ||||
| 	mimetype string | ||||
| 	filepath string | ||||
| 	filename *string | ||||
| 	headers  []headerval | ||||
| } | ||||
|  | ||||
| func (j fileHTTPResponse) Write(g *gin.Context) { | ||||
| @@ -59,26 +102,71 @@ func (j fileHTTPResponse) Write(g *gin.Context) { | ||||
| 		g.Header("Content-Disposition", fmt.Sprintf("attachment; filename=\"%s\"", *j.filename)) | ||||
|  | ||||
| 	} | ||||
| 	for _, v := range j.headers { | ||||
| 		g.Header(v.Key, v.Val) | ||||
| 	} | ||||
| 	g.File(j.filepath) | ||||
| } | ||||
|  | ||||
| func (j fileHTTPResponse) WithHeader(k string, v string) HTTPResponse { | ||||
| 	j.headers = append(j.headers, headerval{k, v}) | ||||
| 	return j | ||||
| } | ||||
|  | ||||
| type downloadDataHTTPResponse struct { | ||||
| 	statusCode int | ||||
| 	mimetype   string | ||||
| 	data       []byte | ||||
| 	filename   *string | ||||
| 	headers    []headerval | ||||
| } | ||||
|  | ||||
| func (j downloadDataHTTPResponse) Write(g *gin.Context) { | ||||
| 	g.Header("Content-Type", j.mimetype) // if we don't set it here gin does weird file-sniffing later... | ||||
| 	if j.filename != nil { | ||||
| 		g.Header("Content-Disposition", fmt.Sprintf("attachment; filename=\"%s\"", *j.filename)) | ||||
|  | ||||
| 	} | ||||
| 	for _, v := range j.headers { | ||||
| 		g.Header(v.Key, v.Val) | ||||
| 	} | ||||
| 	g.Data(j.statusCode, j.mimetype, j.data) | ||||
| } | ||||
|  | ||||
| func (j downloadDataHTTPResponse) WithHeader(k string, v string) HTTPResponse { | ||||
| 	j.headers = append(j.headers, headerval{k, v}) | ||||
| 	return j | ||||
| } | ||||
|  | ||||
| type redirectHTTPResponse struct { | ||||
| 	statusCode int | ||||
| 	url        string | ||||
| 	headers    []headerval | ||||
| } | ||||
|  | ||||
| func (j redirectHTTPResponse) Write(g *gin.Context) { | ||||
| 	g.Redirect(j.statusCode, j.url) | ||||
| } | ||||
|  | ||||
| func (j redirectHTTPResponse) WithHeader(k string, v string) HTTPResponse { | ||||
| 	j.headers = append(j.headers, headerval{k, v}) | ||||
| 	return j | ||||
| } | ||||
|  | ||||
| type jsonAPIErrResponse struct { | ||||
| 	err     *exerr.ExErr | ||||
| 	headers []headerval | ||||
| } | ||||
|  | ||||
| func (j jsonAPIErrResponse) Write(g *gin.Context) { | ||||
| 	j.err.Output(g) | ||||
| } | ||||
|  | ||||
| func (j jsonAPIErrResponse) WithHeader(k string, v string) HTTPResponse { | ||||
| 	j.headers = append(j.headers, headerval{k, v}) | ||||
| 	return j | ||||
| } | ||||
|  | ||||
| func Status(sc int) HTTPResponse { | ||||
| 	return &emptyHTTPResponse{statusCode: sc} | ||||
| } | ||||
| @@ -103,16 +191,26 @@ func Download(mimetype string, filepath string, filename string) HTTPResponse { | ||||
| 	return &fileHTTPResponse{mimetype: mimetype, filepath: filepath, filename: &filename} | ||||
| } | ||||
|  | ||||
| func DownloadData(status int, mimetype string, filename string, data []byte) HTTPResponse { | ||||
| 	return &downloadDataHTTPResponse{statusCode: status, mimetype: mimetype, data: data, filename: &filename} | ||||
| } | ||||
|  | ||||
| func Redirect(sc int, newURL string) HTTPResponse { | ||||
| 	return &redirectHTTPResponse{statusCode: sc, url: newURL} | ||||
| } | ||||
|  | ||||
| func APIError(g *gin.Context, e error) HTTPResponse { | ||||
| func Error(e error) HTTPResponse { | ||||
| 	return &jsonAPIErrResponse{ | ||||
| 		err: exerr.FromError(e), | ||||
| 	} | ||||
| } | ||||
|  | ||||
| func NotImplemented(g *gin.Context) HTTPResponse { | ||||
| 	return APIError(g, exerr.New(exerr.TypeNotImplemented, "").Build()) | ||||
| func ErrWrap(e error, errorType exerr.ErrorType, msg string) HTTPResponse { | ||||
| 	return &jsonAPIErrResponse{ | ||||
| 		err: exerr.FromError(exerr.Wrap(e, msg).WithType(errorType).Build()), | ||||
| 	} | ||||
| } | ||||
|  | ||||
| func NotImplemented() HTTPResponse { | ||||
| 	return Error(exerr.New(exerr.TypeNotImplemented, "").Build()) | ||||
| } | ||||
|   | ||||
							
								
								
									
										158
									
								
								ginext/routes.go
									
									
									
									
									
								
							
							
						
						
									
										158
									
								
								ginext/routes.go
									
									
									
									
									
								
							| @@ -2,7 +2,14 @@ package ginext | ||||
|  | ||||
| import ( | ||||
| 	"github.com/gin-gonic/gin" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/rext" | ||||
| 	"net/http" | ||||
| 	"path" | ||||
| 	"reflect" | ||||
| 	"regexp" | ||||
| 	"runtime" | ||||
| 	"strings" | ||||
| ) | ||||
|  | ||||
| var anyMethods = []string{ | ||||
| @@ -14,58 +21,87 @@ var anyMethods = []string{ | ||||
| type GinRoutesWrapper struct { | ||||
| 	wrapper        *GinWrapper | ||||
| 	routes         gin.IRouter | ||||
| 	absPath        string | ||||
| 	defaultHandler []gin.HandlerFunc | ||||
| } | ||||
|  | ||||
| type GinRouteBuilder struct { | ||||
| 	routes *GinRoutesWrapper | ||||
|  | ||||
| 	methods  []string | ||||
| 	method   string | ||||
| 	relPath  string | ||||
| 	absPath  string | ||||
| 	handlers []gin.HandlerFunc | ||||
| } | ||||
|  | ||||
| func (w *GinWrapper) Routes() *GinRoutesWrapper { | ||||
| 	return &GinRoutesWrapper{wrapper: w, routes: w.engine} | ||||
| 	return &GinRoutesWrapper{ | ||||
| 		wrapper:        w, | ||||
| 		routes:         w.engine, | ||||
| 		absPath:        "", | ||||
| 		defaultHandler: make([]gin.HandlerFunc, 0), | ||||
| 	} | ||||
| } | ||||
|  | ||||
| func (w *GinRoutesWrapper) Group(relativePath string) *GinRoutesWrapper { | ||||
| 	return &GinRoutesWrapper{wrapper: w.wrapper, routes: w.routes.Group(relativePath)} | ||||
| 	return &GinRoutesWrapper{ | ||||
| 		wrapper:        w.wrapper, | ||||
| 		routes:         w.routes.Group(relativePath), | ||||
| 		defaultHandler: langext.ArrCopy(w.defaultHandler), | ||||
| 		absPath:        joinPaths(w.absPath, relativePath), | ||||
| 	} | ||||
| } | ||||
|  | ||||
| func (w *GinRoutesWrapper) Use(middleware ...gin.HandlerFunc) *GinRoutesWrapper { | ||||
| 	defHandler := langext.ArrCopy(w.defaultHandler) | ||||
| 	defHandler = append(defHandler, middleware...) | ||||
| 	return &GinRoutesWrapper{wrapper: w.wrapper, routes: w.routes, defaultHandler: defHandler} | ||||
| } | ||||
|  | ||||
| func (w *GinRoutesWrapper) GET(relativePath string) *GinRouteBuilder { | ||||
| 	return &GinRouteBuilder{routes: w, methods: []string{http.MethodGet}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)} | ||||
| 	return w._route(http.MethodGet, relativePath) | ||||
| } | ||||
|  | ||||
| func (w *GinRoutesWrapper) POST(relativePath string) *GinRouteBuilder { | ||||
| 	return &GinRouteBuilder{routes: w, methods: []string{http.MethodPost}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)} | ||||
| 	return w._route(http.MethodPost, relativePath) | ||||
| } | ||||
|  | ||||
| func (w *GinRoutesWrapper) DELETE(relativePath string) *GinRouteBuilder { | ||||
| 	return &GinRouteBuilder{routes: w, methods: []string{http.MethodDelete}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)} | ||||
| 	return w._route(http.MethodDelete, relativePath) | ||||
| } | ||||
|  | ||||
| func (w *GinRoutesWrapper) PATCH(relativePath string) *GinRouteBuilder { | ||||
| 	return &GinRouteBuilder{routes: w, methods: []string{http.MethodPatch}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)} | ||||
| 	return w._route(http.MethodPatch, relativePath) | ||||
| } | ||||
|  | ||||
| func (w *GinRoutesWrapper) PUT(relativePath string) *GinRouteBuilder { | ||||
| 	return &GinRouteBuilder{routes: w, methods: []string{http.MethodPut}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)} | ||||
| 	return w._route(http.MethodPut, relativePath) | ||||
| } | ||||
|  | ||||
| func (w *GinRoutesWrapper) OPTIONS(relativePath string) *GinRouteBuilder { | ||||
| 	return &GinRouteBuilder{routes: w, methods: []string{http.MethodOptions}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)} | ||||
| 	return w._route(http.MethodOptions, relativePath) | ||||
| } | ||||
|  | ||||
| func (w *GinRoutesWrapper) HEAD(relativePath string) *GinRouteBuilder { | ||||
| 	return &GinRouteBuilder{routes: w, methods: []string{http.MethodHead}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)} | ||||
| 	return w._route(http.MethodHead, relativePath) | ||||
| } | ||||
|  | ||||
| func (w *GinRoutesWrapper) COUNT(relativePath string) *GinRouteBuilder { | ||||
| 	return &GinRouteBuilder{routes: w, methods: []string{"COUNT"}, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)} | ||||
| 	return w._route("COUNT", relativePath) | ||||
| } | ||||
|  | ||||
| func (w *GinRoutesWrapper) Any(relativePath string) *GinRouteBuilder { | ||||
| 	return &GinRouteBuilder{routes: w, methods: anyMethods, relPath: relativePath, handlers: make([]gin.HandlerFunc, 0)} | ||||
| 	return w._route("*", relativePath) | ||||
| } | ||||
|  | ||||
| func (w *GinRoutesWrapper) _route(method string, relativePath string) *GinRouteBuilder { | ||||
| 	return &GinRouteBuilder{ | ||||
| 		routes:   w, | ||||
| 		method:   method, | ||||
| 		relPath:  relativePath, | ||||
| 		absPath:  joinPaths(w.absPath, relativePath), | ||||
| 		handlers: langext.ArrCopy(w.defaultHandler), | ||||
| 	} | ||||
| } | ||||
|  | ||||
| func (w *GinRouteBuilder) Use(middleware ...gin.HandlerFunc) *GinRouteBuilder { | ||||
| @@ -74,12 +110,102 @@ func (w *GinRouteBuilder) Use(middleware ...gin.HandlerFunc) *GinRouteBuilder { | ||||
| } | ||||
|  | ||||
| func (w *GinRouteBuilder) Handle(handler WHandlerFunc) { | ||||
| 	w.handlers = append(w.handlers, Wrap(w.routes.wrapper, handler)) | ||||
| 	for _, m := range w.methods { | ||||
| 		w.routes.routes.Handle(m, w.relPath, w.handlers...) | ||||
|  | ||||
| 	if w.routes.wrapper.bufferBody { | ||||
| 		arr := make([]gin.HandlerFunc, 0, len(w.handlers)+1) | ||||
| 		arr = append(arr, BodyBuffer) | ||||
| 		arr = append(arr, w.handlers...) | ||||
| 		w.handlers = arr | ||||
| 	} | ||||
|  | ||||
| 	middlewareNames := langext.ArrMap(w.handlers, func(v gin.HandlerFunc) string { return nameOfFunction(v) }) | ||||
| 	handlerName := nameOfFunction(handler) | ||||
|  | ||||
| 	w.handlers = append(w.handlers, Wrap(w.routes.wrapper, handler)) | ||||
|  | ||||
| 	methodName := w.method | ||||
|  | ||||
| 	if w.method == "*" { | ||||
| 		methodName = "ANY" | ||||
| 		for _, method := range anyMethods { | ||||
| 			w.routes.routes.Handle(method, w.relPath, w.handlers...) | ||||
| 		} | ||||
| 	} else { | ||||
| 		w.routes.routes.Handle(w.method, w.relPath, w.handlers...) | ||||
| 	} | ||||
|  | ||||
| 	w.routes.wrapper.routeSpecs = append(w.routes.wrapper.routeSpecs, ginRouteSpec{ | ||||
| 		Method:      methodName, | ||||
| 		URL:         w.absPath, | ||||
| 		Middlewares: middlewareNames, | ||||
| 		Handler:     handlerName, | ||||
| 	}) | ||||
| } | ||||
|  | ||||
| func (w *GinWrapper) NoRoute(handler WHandlerFunc) { | ||||
| 	w.engine.NoRoute(Wrap(w, handler)) | ||||
|  | ||||
| 	handlers := make([]gin.HandlerFunc, 0) | ||||
|  | ||||
| 	if w.bufferBody { | ||||
| 		handlers = append(handlers, BodyBuffer) | ||||
| 	} | ||||
|  | ||||
| 	middlewareNames := langext.ArrMap(handlers, func(v gin.HandlerFunc) string { return nameOfFunction(v) }) | ||||
| 	handlerName := nameOfFunction(handler) | ||||
|  | ||||
| 	handlers = append(handlers, Wrap(w, handler)) | ||||
|  | ||||
| 	w.engine.NoRoute(handlers...) | ||||
|  | ||||
| 	w.routeSpecs = append(w.routeSpecs, ginRouteSpec{ | ||||
| 		Method:      "ANY", | ||||
| 		URL:         "[NO_ROUTE]", | ||||
| 		Middlewares: middlewareNames, | ||||
| 		Handler:     handlerName, | ||||
| 	}) | ||||
| } | ||||
|  | ||||
| func nameOfFunction(f any) string { | ||||
|  | ||||
| 	fname := runtime.FuncForPC(reflect.ValueOf(f).Pointer()).Name() | ||||
|  | ||||
| 	split := strings.Split(fname, "/") | ||||
| 	if len(split) == 0 { | ||||
| 		return "" | ||||
| 	} | ||||
|  | ||||
| 	fname = split[len(split)-1] | ||||
|  | ||||
| 	// https://stackoverflow.com/a/32925345/1761622 | ||||
| 	if strings.HasSuffix(fname, "-fm") { | ||||
| 		fname = fname[:len(fname)-len("-fm")] | ||||
| 	} | ||||
|  | ||||
| 	suffix := rext.W(regexp.MustCompile(`\.func[0-9]+(?:\.[0-9]+)*$`)) | ||||
|  | ||||
| 	if match, ok := suffix.MatchFirst(fname); ok { | ||||
| 		fname = fname[:len(fname)-match.FullMatch().Length()] | ||||
| 	} | ||||
|  | ||||
| 	return fname | ||||
| } | ||||
|  | ||||
| // joinPaths is copied verbatim from gin@v1.9.1/gin.go | ||||
| func joinPaths(absolutePath, relativePath string) string { | ||||
| 	if relativePath == "" { | ||||
| 		return absolutePath | ||||
| 	} | ||||
|  | ||||
| 	finalPath := path.Join(absolutePath, relativePath) | ||||
| 	if lastChar(relativePath) == '/' && lastChar(finalPath) != '/' { | ||||
| 		return finalPath + "/" | ||||
| 	} | ||||
| 	return finalPath | ||||
| } | ||||
|  | ||||
| func lastChar(str string) uint8 { | ||||
| 	if str == "" { | ||||
| 		panic("The length of the string can't be 0") | ||||
| 	} | ||||
| 	return str[len(str)-1] | ||||
| } | ||||
|   | ||||
							
								
								
									
										18
									
								
								go.mod
									
									
									
									
									
								
							
							
						
						
									
										18
									
								
								go.mod
									
									
									
									
									
								
							| @@ -6,22 +6,22 @@ require ( | ||||
| 	github.com/gin-gonic/gin v1.9.1 | ||||
| 	github.com/jmoiron/sqlx v1.3.5 | ||||
| 	github.com/rs/xid v1.5.0 | ||||
| 	github.com/rs/zerolog v1.29.1 | ||||
| 	go.mongodb.org/mongo-driver v1.12.0 | ||||
| 	golang.org/x/crypto v0.11.0 | ||||
| 	golang.org/x/sys v0.10.0 | ||||
| 	golang.org/x/term v0.10.0 | ||||
| 	github.com/rs/zerolog v1.30.0 | ||||
| 	go.mongodb.org/mongo-driver v1.12.1 | ||||
| 	golang.org/x/crypto v0.12.0 | ||||
| 	golang.org/x/sys v0.11.0 | ||||
| 	golang.org/x/term v0.11.0 | ||||
| ) | ||||
|  | ||||
| require ( | ||||
| 	github.com/bytedance/sonic v1.10.0-rc2 // indirect | ||||
| 	github.com/bytedance/sonic v1.10.0 // indirect | ||||
| 	github.com/chenzhuoyu/base64x v0.0.0-20230717121745-296ad89f973d // indirect | ||||
| 	github.com/chenzhuoyu/iasm v0.9.0 // indirect | ||||
| 	github.com/gabriel-vasile/mimetype v1.4.2 // indirect | ||||
| 	github.com/gin-contrib/sse v0.1.0 // indirect | ||||
| 	github.com/go-playground/locales v0.14.1 // indirect | ||||
| 	github.com/go-playground/universal-translator v0.18.1 // indirect | ||||
| 	github.com/go-playground/validator/v10 v10.14.1 // indirect | ||||
| 	github.com/go-playground/validator/v10 v10.15.0 // indirect | ||||
| 	github.com/goccy/go-json v0.10.2 // indirect | ||||
| 	github.com/golang/snappy v0.0.4 // indirect | ||||
| 	github.com/json-iterator/go v1.1.12 // indirect | ||||
| @@ -42,9 +42,9 @@ require ( | ||||
| 	github.com/xdg-go/stringprep v1.0.4 // indirect | ||||
| 	github.com/youmark/pkcs8 v0.0.0-20201027041543-1326539a0a0a // indirect | ||||
| 	golang.org/x/arch v0.4.0 // indirect | ||||
| 	golang.org/x/net v0.12.0 // indirect | ||||
| 	golang.org/x/net v0.14.0 // indirect | ||||
| 	golang.org/x/sync v0.3.0 // indirect | ||||
| 	golang.org/x/text v0.11.0 // indirect | ||||
| 	golang.org/x/text v0.12.0 // indirect | ||||
| 	google.golang.org/protobuf v1.31.0 // indirect | ||||
| 	gopkg.in/yaml.v3 v3.0.1 // indirect | ||||
| ) | ||||
|   | ||||
							
								
								
									
										22
									
								
								go.sum
									
									
									
									
									
								
							
							
						
						
									
										22
									
								
								go.sum
									
									
									
									
									
								
							| @@ -2,6 +2,10 @@ github.com/bytedance/sonic v1.5.0/go.mod h1:ED5hyg4y6t3/9Ku1R6dU/4KyJ48DZ4jPhfY1 | ||||
| github.com/bytedance/sonic v1.10.0-rc/go.mod h1:ElCzW+ufi8qKqNW0FY314xriJhyJhuoJ3gFZdAHF7NM= | ||||
| github.com/bytedance/sonic v1.10.0-rc2 h1:oDfRZ+4m6AYCOC0GFeOCeYqvBmucy1isvouS2K0cPzo= | ||||
| github.com/bytedance/sonic v1.10.0-rc2/go.mod h1:iZcSUejdk5aukTND/Eu/ivjQuEL0Cu9/rf50Hi0u/g4= | ||||
| github.com/bytedance/sonic v1.10.0-rc3 h1:uNSnscRapXTwUgTyOF0GVljYD08p9X/Lbr9MweSV3V0= | ||||
| github.com/bytedance/sonic v1.10.0-rc3/go.mod h1:iZcSUejdk5aukTND/Eu/ivjQuEL0Cu9/rf50Hi0u/g4= | ||||
| github.com/bytedance/sonic v1.10.0 h1:qtNZduETEIWJVIyDl01BeNxur2rW9OwTQ/yBqFRkKEk= | ||||
| github.com/bytedance/sonic v1.10.0/go.mod h1:iZcSUejdk5aukTND/Eu/ivjQuEL0Cu9/rf50Hi0u/g4= | ||||
| github.com/chenzhuoyu/base64x v0.0.0-20211019084208-fb5309c8db06/go.mod h1:DH46F32mSOjUmXrMHnKwZdA8wcEefY7UVqBKYGjpdQY= | ||||
| github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311/go.mod h1:b583jCggY9gE99b6G5LEC39OIiVsWj+R97kbl5odCEk= | ||||
| github.com/chenzhuoyu/base64x v0.0.0-20230717121745-296ad89f973d h1:77cEq6EriyTZ0g/qfRdp61a3Uu/AWrgIq2s0ClJV1g0= | ||||
| @@ -24,6 +28,8 @@ github.com/go-playground/universal-translator v0.18.1 h1:Bcnm0ZwsGyWbCzImXv+pAJn | ||||
| github.com/go-playground/universal-translator v0.18.1/go.mod h1:xekY+UJKNuX9WP91TpwSH2VMlDf28Uj24BCp08ZFTUY= | ||||
| github.com/go-playground/validator/v10 v10.14.1 h1:9c50NUPC30zyuKprjL3vNZ0m5oG+jU0zvx4AqHGnv4k= | ||||
| github.com/go-playground/validator/v10 v10.14.1/go.mod h1:9iXMNT7sEkjXb0I+enO7QXmzG6QCsPWY4zveKFVRSyU= | ||||
| github.com/go-playground/validator/v10 v10.15.0 h1:nDU5XeOKtB3GEa+uB7GNYwhVKsgjAR7VgKoNB6ryXfw= | ||||
| github.com/go-playground/validator/v10 v10.15.0/go.mod h1:9iXMNT7sEkjXb0I+enO7QXmzG6QCsPWY4zveKFVRSyU= | ||||
| github.com/go-sql-driver/mysql v1.6.0/go.mod h1:DCzpHaOWr8IXmIStZouvnhqoel9Qv2LBy8hT2VhHyBg= | ||||
| github.com/goccy/go-json v0.10.2 h1:CrxCmQqYDkv1z7lO7Wbh2HN93uovUHgrECaO5ZrCXAU= | ||||
| github.com/goccy/go-json v0.10.2/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I= | ||||
| @@ -85,6 +91,8 @@ github.com/rs/zerolog v1.29.0 h1:Zes4hju04hjbvkVkOhdl2HpZa+0PmVwigmo8XoORE5w= | ||||
| github.com/rs/zerolog v1.29.0/go.mod h1:NILgTygv/Uej1ra5XxGf82ZFSLk58MFGAUS2o6usyD0= | ||||
| github.com/rs/zerolog v1.29.1 h1:cO+d60CHkknCbvzEWxP0S9K6KqyTjrCNUy1LdQLCGPc= | ||||
| github.com/rs/zerolog v1.29.1/go.mod h1:Le6ESbR7hc+DP6Lt1THiV8CQSdkkNrd3R0XbEgp3ZBU= | ||||
| github.com/rs/zerolog v1.30.0 h1:SymVODrcRsaRaSInD9yQtKbtWqwsfoPcRff/oRXLj4c= | ||||
| github.com/rs/zerolog v1.30.0/go.mod h1:/tk+P47gFdPXq4QYjvCmT5/Gsug2nagsFWBWhAiSi1w= | ||||
| github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= | ||||
| github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw= | ||||
| github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo= | ||||
| @@ -120,6 +128,8 @@ go.mongodb.org/mongo-driver v1.11.2 h1:+1v2rDQUWNcGW7/7E0Jvdz51V38XXxJfhzbV17aNH | ||||
| go.mongodb.org/mongo-driver v1.11.2/go.mod h1:s7p5vEtfbeR1gYi6pnj3c3/urpbLv2T5Sfd6Rp2HBB8= | ||||
| go.mongodb.org/mongo-driver v1.12.0 h1:aPx33jmn/rQuJXPQLZQ8NtfPQG8CaqgLThFtqRb0PiE= | ||||
| go.mongodb.org/mongo-driver v1.12.0/go.mod h1:AZkxhPnFJUoH7kZlFkVKucV20K387miPfm7oimrSmK0= | ||||
| go.mongodb.org/mongo-driver v1.12.1 h1:nLkghSU8fQNaK7oUmDhQFsnrtcoNy7Z6LVFKsEecqgE= | ||||
| go.mongodb.org/mongo-driver v1.12.1/go.mod h1:/rGBTebI3XYboVmgz+Wv3Bcbl3aD0QF9zl6kDDw18rQ= | ||||
| golang.org/x/arch v0.0.0-20210923205945-b76863e36670/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8= | ||||
| golang.org/x/arch v0.4.0 h1:A8WCeEWhLwPBKNbFi5Wv5UTCBx5zzubnXDlMOFAzFMc= | ||||
| golang.org/x/arch v0.4.0/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8= | ||||
| @@ -131,6 +141,8 @@ golang.org/x/crypto v0.4.0 h1:UVQgzMY87xqpKNgb+kDsll2Igd33HszWHFLmpaRMq/8= | ||||
| golang.org/x/crypto v0.4.0/go.mod h1:3quD/ATkf6oY+rnes5c3ExXTbLc8mueNue5/DoinL80= | ||||
| golang.org/x/crypto v0.11.0 h1:6Ewdq3tDic1mg5xRO4milcWCfMVQhI4NkqWWvqejpuA= | ||||
| golang.org/x/crypto v0.11.0/go.mod h1:xgJhtzW8F9jGdVFWZESrid1U1bjeNy4zgy5cRr/CIio= | ||||
| golang.org/x/crypto v0.12.0 h1:tFM/ta59kqch6LlvYnPa0yx5a83cL2nHflFhYKvv9Yk= | ||||
| golang.org/x/crypto v0.12.0/go.mod h1:NF0Gs7EO5K4qLn+Ylc+fih8BSTeIjAP05siRnAh98yw= | ||||
| golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= | ||||
| golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= | ||||
| golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= | ||||
| @@ -139,6 +151,10 @@ golang.org/x/net v0.0.0-20211112202133-69e39bad7dc2/go.mod h1:9nx3DQGgdP8bBQD5qx | ||||
| golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= | ||||
| golang.org/x/net v0.12.0 h1:cfawfvKITfUsFCeJIHJrbSxpeu/E81khclypR0GVT50= | ||||
| golang.org/x/net v0.12.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA= | ||||
| golang.org/x/net v0.13.0 h1:Nvo8UFsZ8X3BhAC9699Z1j7XQ3rsZnUUm7jfBEk1ueY= | ||||
| golang.org/x/net v0.13.0/go.mod h1:zEVYFnQC7m/vmpQFELhcD1EWkZlX69l4oqgmer6hfKA= | ||||
| golang.org/x/net v0.14.0 h1:BONx9s002vGdD9umnlX1Po8vOZmrgH34qlHcD1MfK14= | ||||
| golang.org/x/net v0.14.0/go.mod h1:PpSgVXXLK0OxS0F31C1/tv6XNguvCrnXIDrFMspZIUI= | ||||
| golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= | ||||
| golang.org/x/sync v0.0.0-20210220032951-036812b2e83c h1:5KslGYwFpkhGh+Q16bwMP3cOontH8FOep7tGV86Y7SQ= | ||||
| golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= | ||||
| @@ -164,6 +180,8 @@ golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= | ||||
| golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= | ||||
| golang.org/x/sys v0.10.0 h1:SqMFp9UcQJZa+pmYuAKjd9xq1f0j5rLcDIk0mj4qAsA= | ||||
| golang.org/x/sys v0.10.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= | ||||
| golang.org/x/sys v0.11.0 h1:eG7RXZHdqOJ1i+0lgLgCpSXAp6M3LYlAo6osgSi0xOM= | ||||
| golang.org/x/sys v0.11.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= | ||||
| golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= | ||||
| golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= | ||||
| golang.org/x/term v0.1.0 h1:g6Z6vPFA9dYBAF7DWcH6sCcOntplXsDKcliusYijMlw= | ||||
| @@ -172,6 +190,8 @@ golang.org/x/term v0.3.0 h1:qoo4akIqOcDME5bhc/NgxUdovd6BSS2uMsVjB56q1xI= | ||||
| golang.org/x/term v0.3.0/go.mod h1:q750SLmJuPmVoN1blW3UFBPREJfb1KmY3vwxfr+nFDA= | ||||
| golang.org/x/term v0.10.0 h1:3R7pNqamzBraeqj/Tj8qt1aQ2HpmlC+Cx/qL/7hn4/c= | ||||
| golang.org/x/term v0.10.0/go.mod h1:lpqdcUyK/oCiQxvxVrppt5ggO2KCZ5QblwqPnfZ6d5o= | ||||
| golang.org/x/term v0.11.0 h1:F9tnn/DA/Im8nCwm+fX+1/eBwi4qFjRT++MhtVC4ZX0= | ||||
| golang.org/x/term v0.11.0/go.mod h1:zC9APTIj3jG3FdV/Ons+XE1riIZXG4aZ4GTHiPZJPIU= | ||||
| golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= | ||||
| golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= | ||||
| golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= | ||||
| @@ -182,6 +202,8 @@ golang.org/x/text v0.5.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= | ||||
| golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= | ||||
| golang.org/x/text v0.11.0 h1:LAntKIrcmeSKERyiOh0XMV39LXS8IE9UL2yP7+f5ij4= | ||||
| golang.org/x/text v0.11.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= | ||||
| golang.org/x/text v0.12.0 h1:k+n5B8goJNdU7hSvEtMUz3d1Q6D/XW4COJSJR6fN0mc= | ||||
| golang.org/x/text v0.12.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= | ||||
| golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= | ||||
| golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= | ||||
| golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= | ||||
|   | ||||
| @@ -1,5 +1,5 @@ | ||||
| package goext | ||||
|  | ||||
| const GoextVersion = "0.0.192" | ||||
| const GoextVersion = "0.0.242" | ||||
|  | ||||
| const GoextVersionTimestamp = "2023-07-24T11:30:07+0200" | ||||
| const GoextVersionTimestamp = "2023-08-14T16:05:12+0200" | ||||
|   | ||||
| @@ -467,3 +467,15 @@ func ArrayToInterface[T any](t []T) []interface{} { | ||||
| 	} | ||||
| 	return res | ||||
| } | ||||
|  | ||||
| func JoinString(arr []string, delimiter string) string { | ||||
| 	str := "" | ||||
| 	for i, v := range arr { | ||||
| 		str += v | ||||
| 		if i < len(arr)-1 { | ||||
| 			str += delimiter | ||||
| 		} | ||||
| 	} | ||||
|  | ||||
| 	return str | ||||
| } | ||||
|   | ||||
							
								
								
									
										12
									
								
								langext/array_test.go
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								langext/array_test.go
									
									
									
									
									
										Normal file
									
								
							| @@ -0,0 +1,12 @@ | ||||
| package langext | ||||
|  | ||||
| import ( | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/tst" | ||||
| 	"testing" | ||||
| ) | ||||
|  | ||||
| func TestJoinString(t *testing.T) { | ||||
| 	ids := []string{"1", "2", "3"} | ||||
| 	res := JoinString(ids, ",") | ||||
| 	tst.AssertEqual(t, res, "1,2,3") | ||||
| } | ||||
| @@ -1,6 +1,7 @@ | ||||
| package langext | ||||
|  | ||||
| import ( | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/tst" | ||||
| 	"testing" | ||||
| ) | ||||
|  | ||||
| @@ -59,9 +60,3 @@ func TestBase58FlickrDecoding(t *testing.T) { | ||||
| 	tst.AssertEqual(t, _decStr(t, Base58FlickrEncoding, "9aJCVZR"), "Hello") | ||||
| 	tst.AssertEqual(t, _decStr(t, Base58FlickrEncoding, "48638rmBiUzG5NKQoX4KcuE5C8paCFACnE28F7qDx13PRtennAmYSSJQ5gJSRihf5ZDyEQS4UimtihR7uARt4wbty2fW9duTQTM9n1DwUBevreyzGwu6W4YSgrvQgCPDxsiE1mCdZsF8VEBpuHHEiJyw"), "If debugging is the process of removing software bugs, then programming must be the process of putting them in.") | ||||
| } | ||||
|  | ||||
| func tst.AssertEqual(t *testing.T, actual string, expected string) { | ||||
| 	if actual != expected { | ||||
| 		t.Errorf("values differ: Actual: '%v', Expected: '%v'", actual, expected) | ||||
| 	} | ||||
| } | ||||
|   | ||||
| @@ -8,7 +8,7 @@ import ( | ||||
|  | ||||
| func TestGroupByNameOrEmpty1(t *testing.T) { | ||||
|  | ||||
| 	regex1 := W(regexp.MustCompile("0(?P<group1>A+)B(?P<group2>C+)0")) | ||||
| 	regex1 := W(regexp.MustCompile(`0(?P<group1>A+)B(?P<group2>C+)0`)) | ||||
|  | ||||
| 	match1, ok1 := regex1.MatchFirst("Hello 0AAAABCCC0 Bye.") | ||||
|  | ||||
| @@ -26,7 +26,7 @@ func TestGroupByNameOrEmpty1(t *testing.T) { | ||||
|  | ||||
| func TestGroupByNameOrEmpty2(t *testing.T) { | ||||
|  | ||||
| 	regex1 := W(regexp.MustCompile("0(?P<group1>A+)B(?P<group2>C+)(?P<group3>C+)?0")) | ||||
| 	regex1 := W(regexp.MustCompile(`0(?P<group1>A+)B(?P<group2>C+)(?P<group3>C+)?0`)) | ||||
|  | ||||
| 	match1, ok1 := regex1.MatchFirst("Hello 0AAAABCCC0 Bye.") | ||||
|  | ||||
|   | ||||
| @@ -39,7 +39,7 @@ func HashSqliteSchema(ctx context.Context, schemaStr string) (string, error) { | ||||
| 	return HashSqliteDatabase(ctx, db) | ||||
| } | ||||
|  | ||||
| func HashSqliteDatabase(ctx context.Context, db DB) (string, error) { | ||||
| func HashSqliteDatabase(ctx context.Context, db Queryable) (string, error) { | ||||
| 	ss, err := CreateSqliteDatabaseSchemaString(ctx, db) | ||||
| 	if err != nil { | ||||
| 		return "", err | ||||
| @@ -50,7 +50,7 @@ func HashSqliteDatabase(ctx context.Context, db DB) (string, error) { | ||||
| 	return hex.EncodeToString(cs[:]), nil | ||||
| } | ||||
|  | ||||
| func CreateSqliteDatabaseSchemaString(ctx context.Context, db DB) (string, error) { | ||||
| func CreateSqliteDatabaseSchemaString(ctx context.Context, db Queryable) (string, error) { | ||||
|  | ||||
| 	type colInfo struct { | ||||
| 		Name       string  `db:"name"` | ||||
|   | ||||
| @@ -7,9 +7,19 @@ import ( | ||||
| 	"gogs.mikescher.com/BlackForestBytes/goext/langext" | ||||
| ) | ||||
|  | ||||
| type TxStatus string | ||||
|  | ||||
| const ( | ||||
| 	TxStatusInitial  TxStatus = "INITIAL" | ||||
| 	TxStatusActive   TxStatus = "ACTIVE" | ||||
| 	TxStatusComitted TxStatus = "COMMITTED" | ||||
| 	TxStatusRollback TxStatus = "ROLLBACK" | ||||
| ) | ||||
|  | ||||
| type Tx interface { | ||||
| 	Rollback() error | ||||
| 	Commit() error | ||||
| 	Status() TxStatus | ||||
| 	Exec(ctx context.Context, sql string, prep PP) (sql.Result, error) | ||||
| 	Query(ctx context.Context, sql string, prep PP) (*sqlx.Rows, error) | ||||
| } | ||||
| @@ -18,6 +28,9 @@ type transaction struct { | ||||
| 	tx       *sqlx.Tx | ||||
| 	id       uint16 | ||||
| 	lstr     []Listener | ||||
| 	status   TxStatus | ||||
| 	execCtr  int | ||||
| 	queryCtr int | ||||
| } | ||||
|  | ||||
| func NewTransaction(xtx *sqlx.Tx, txid uint16, lstr []Listener) Tx { | ||||
| @@ -25,6 +38,9 @@ func NewTransaction(xtx *sqlx.Tx, txid uint16, lstr []Listener) Tx { | ||||
| 		tx:       xtx, | ||||
| 		id:       txid, | ||||
| 		lstr:     lstr, | ||||
| 		status:   TxStatusInitial, | ||||
| 		execCtr:  0, | ||||
| 		queryCtr: 0, | ||||
| 	} | ||||
| } | ||||
|  | ||||
| @@ -38,6 +54,10 @@ func (tx *transaction) Rollback() error { | ||||
|  | ||||
| 	result := tx.tx.Rollback() | ||||
|  | ||||
| 	if result == nil { | ||||
| 		tx.status = TxStatusRollback | ||||
| 	} | ||||
|  | ||||
| 	for _, v := range tx.lstr { | ||||
| 		v.PostTxRollback(tx.id, result) | ||||
| 	} | ||||
| @@ -55,6 +75,10 @@ func (tx *transaction) Commit() error { | ||||
|  | ||||
| 	result := tx.tx.Commit() | ||||
|  | ||||
| 	if result == nil { | ||||
| 		tx.status = TxStatusComitted | ||||
| 	} | ||||
|  | ||||
| 	for _, v := range tx.lstr { | ||||
| 		v.PostTxRollback(tx.id, result) | ||||
| 	} | ||||
| @@ -73,6 +97,10 @@ func (tx *transaction) Exec(ctx context.Context, sqlstr string, prep PP) (sql.Re | ||||
|  | ||||
| 	res, err := tx.tx.NamedExecContext(ctx, sqlstr, prep) | ||||
|  | ||||
| 	if tx.status == TxStatusInitial && err == nil { | ||||
| 		tx.status = TxStatusActive | ||||
| 	} | ||||
|  | ||||
| 	for _, v := range tx.lstr { | ||||
| 		v.PostExec(langext.Ptr(tx.id), origsql, sqlstr, prep) | ||||
| 	} | ||||
| @@ -94,6 +122,10 @@ func (tx *transaction) Query(ctx context.Context, sqlstr string, prep PP) (*sqlx | ||||
|  | ||||
| 	rows, err := sqlx.NamedQueryContext(ctx, tx.tx, sqlstr, prep) | ||||
|  | ||||
| 	if tx.status == TxStatusInitial && err == nil { | ||||
| 		tx.status = TxStatusActive | ||||
| 	} | ||||
|  | ||||
| 	for _, v := range tx.lstr { | ||||
| 		v.PostQuery(langext.Ptr(tx.id), origsql, sqlstr, prep) | ||||
| 	} | ||||
| @@ -103,3 +135,11 @@ func (tx *transaction) Query(ctx context.Context, sqlstr string, prep PP) (*sqlx | ||||
| 	} | ||||
| 	return rows, nil | ||||
| } | ||||
|  | ||||
| func (tx *transaction) Status() TxStatus { | ||||
| 	return tx.status | ||||
| } | ||||
|  | ||||
| func (tx *transaction) Traffic() (int, int) { | ||||
| 	return tx.execCtr, tx.queryCtr | ||||
| } | ||||
|   | ||||
| @@ -71,12 +71,12 @@ func SupportsColors() bool { | ||||
| 		} | ||||
| 	} | ||||
|  | ||||
| 	var term256Regex = regexp.MustCompile("(?i)-256(color)?$") | ||||
| 	var term256Regex = regexp.MustCompile(`(?i)-256(color)?$`) | ||||
| 	if term256Regex.MatchString(termenv) { | ||||
| 		return true | ||||
| 	} | ||||
|  | ||||
| 	var termBasicRegex = regexp.MustCompile("(?i)^screen|^xterm|^vt100|^vt220|^rxvt|color|ansi|cygwin|linux") | ||||
| 	var termBasicRegex = regexp.MustCompile(`(?i)^screen|^xterm|^vt100|^vt220|^rxvt|color|ansi|cygwin|linux`) | ||||
|  | ||||
| 	if termBasicRegex.MatchString(termenv) { | ||||
| 		return true | ||||
|   | ||||
		Reference in New Issue
	
	Block a user