Passthrough logger

Author: Paul Glass

Makefile

@@ -55,7 +55,7 @@ bench:
 genvisitor:
 	go run ./cmd/tools/genvisitor/ > proxy/debug/repair_utf8_gen.go
 	sed -i '' 's/package main_test/package debug/' proxy/debug/repair_utf8_gen.go
-	go fmt proxy/debug/repair_utf8_gen.go
+	make fmt
 
 
 # Mocks

cmd/tools/genvisitor/emitter.go

@@ -20,6 +20,7 @@ type (
 		funcSignature string
 		handlers      []*Handler
 		imports       map[string]struct{}
+		extraImports  map[string]struct{}
 		root          *Tree
 		inScopeVars   map[string]struct{}
 		trailer       string
@@ -41,10 +42,11 @@ type (
 
 func NewEmitter(mode Mode) *Emitter {
 	return &Emitter{
-		mode:        mode,
-		imports:     make(map[string]struct{}),
-		root:        NewTree(),
-		inScopeVars: map[string]struct{}{},
+		mode:         mode,
+		imports:      make(map[string]struct{}),
+		extraImports: make(map[string]struct{}),
+		root:         NewTree(),
+		inScopeVars:  map[string]struct{}{},
 	}
 }
 
@@ -63,6 +65,10 @@ func (e *Emitter) AddHandler(include func(string) bool, invocation func(string)
 	})
 }
 
+func (e *Emitter) AddImport(s string) {
+	e.extraImports[s] = struct{}{}
+}
+
 func (e *Emitter) Visit(mt protoreflect.MessageType) {
 	if e.mode == Gogo122Version &&
 		shouldIgnoreTypeIfDoesntExistIn122(string(mt.Descriptor().FullName())) {
@@ -161,6 +167,12 @@ func (e *Emitter) genPreamble(out io.Writer) {
 		}
 		writef(out, "%s \"%s\"\n", alias, imp)
 	}
+
+	for imp := range e.extraImports {
+		writef(out, "\"%s\"\n", imp)
+
+	}
+
 	writeln(out, `)`)
 }
 
@@ -177,17 +189,17 @@ func (e *Emitter) emit(out io.Writer, parentVar string, node *Tree) {
 				defer freeVar()
 				writef(out, "for _, %s := range %s.%s {\n", varName, parentVar, vt.GoGetter())
 				e.emit(out, varName, node.Children[vt.GoName()])
-				fmt.Println("}")
+				writeln(out, "}")
 			} else if desc.IsList() {
 				varName, freeVar := e.makeVar("item")
 				defer freeVar()
 				writef(out, "for _, %s := range %s.%s {\n", varName, parentVar, vt.GoGetter())
 				e.emit(out, varName, node.Children[vt.GoName()])
-				fmt.Println("}")
+				writeln(out, "}")
 			} else if oneof := desc.ContainingOneof(); oneof != nil {
 				writef(out, "switch oneof := %s.%s.(type) {\n", parentVar, vt.GoGetter())
 				e.emitOneOfCases(out, "oneof", vt, node.Children[vt.GoName()])
-				fmt.Println("}")
+				writeln(out, "}")
 			} else {
 				varName, freeVar := e.makeVar("y")
 				defer freeVar()

cmd/tools/genvisitor/main.go

@@ -13,16 +13,17 @@ import (
 
 func main() {
 	emitter := NewEmitter(Gogo122Version)
+	emitter.AddImport("go.temporal.io/server/common/log")
 	emitter.SetFunctionSignature(
-		`func repairInvalidUTF8(vAny any) (ret bool)`,
+		`func repairInvalidUTF8(logger log.Logger, vAny any) (ret bool)`,
 	)
 	emitter.SetTrailer("return")
 	emitter.AddHandler(
 		func(s string) bool {
 			return s == "LastFailure"
 		},
 		func(varName string) string {
-			return fmt.Sprintf(`ret = ret || repairUTF8InLastFailure(%s)`, varName)
+			return fmt.Sprintf(`ret = ret || repairUTF8InLastFailure(logger, %s)`, varName)
 		},
 	)
 	protoregistry.GlobalTypes.RangeMessages(func(mt protoreflect.MessageType) bool {

cmd/tools/genvisitor/type.go

@@ -31,11 +31,7 @@ func (v VisitType) GoQualifiedName() string {
 func (v VisitType) GoPackageName() string {
 	pkg := v.ParentFile().Package()
 	isServerPkg := strings.Contains(string(pkg), "temporal.server.api")
-
-	//fmt.Printf("// v = %v\n", v)
-	//fmt.Printf("// pkg = %v\n", pkg)
 	if pkg.Name() == "v1" {
-		//fmt.Printf("// pkg = %v\n", pkg)
 		pkg = pkg.Parent()
 	}
 	result := string(pkg.Name())

cmd/tools/genvisitor/visit.go

@@ -33,7 +33,6 @@ func visit(
 	// }
 	seenKey := string(obj.Parent().Name() + "." + obj.Name())
 	if _, ok := seen[seenKey]; ok {
-		// fmt.Printf("// skipping already seen key %s\n", seenKey)
 		return
 	}
 	seen[seenKey] = struct{}{}

proxy/debug/codec.go

@@ -69,7 +69,6 @@ func (c *CodecV2) Name() string {
 
 // Unmarshal implements encoding.CodecV2.
 func (c *CodecV2) Unmarshal(data mem.BufferSlice, v any) error {
-	c.Logger.Info("Unmarshal", tag.NewStringTag("type", fmt.Sprintf("%v", v)))
 	err := c.delegate.Unmarshal(data, v)
 	if err != nil && strings.Contains(err.Error(), "invalid UTF-8") {
 		c.Logger.Warn("invalid UTF-8 error encountered during unmarshal; attempting to repair")
@@ -102,7 +101,7 @@ func (c *CodecV2) Unmarshal(data mem.BufferSlice, v any) error {
 			return err
 		}
 
-		changed := repairInvalidUTF8(msg122)
+		changed := repairInvalidUTF8(c.Logger, msg122)
 		if !changed {
 			c.Logger.Error("during UTF-8 repair, nothing was repaired",
 				tag.NewStringTag("type", fmt.Sprintf("%T", v)),
@@ -134,11 +133,11 @@ func (c *CodecV2) Unmarshal(data mem.BufferSlice, v any) error {
 
 // In old versions of Temporal, it was possible that certain history events could
 // be written with invalid UTF-8.
-func repairUTF8InLastFailure(lastFailure *failure122.Failure) bool {
+func repairUTF8InLastFailure(logger log.Logger, lastFailure *failure122.Failure) bool {
 	cause := lastFailure.GetCause()
 	if !utf8.ValidString(cause.GetMessage()) {
 		cause.Message = strings.ToValidUTF8(cause.Message, string(utf8.RuneError))
-		fmt.Println("repaired invalid utf-8 in last failure message")
+		logger.Info("repaired invalid utf-8 in LastFailure field")
 		return true
 	}
 	return false