fix(protogen): wrap bookName and sheetName when parsing special sheet mode (#365)

* fix(protogen): wrap bookName and sheetName when parsing special sheet mode

* test(xerrors): add TestWrapKVSameKeyNotOverwritten to verify module preservation

Author: Kybxd

internal/protogen/protogen.go

@@ -476,7 +476,9 @@ func (gen *Generator) convertTable(dir, filename string, checkProtoFileConflicts
 			} else {
 				worksheets, err := gen.parseSpecialSheetMode(ws.Options.Mode, ws, sheet, debugBookName, debugSheetName)
 				if err != nil {
-					return err
+					return xerrors.WrapKV(err,
+						xerrors.KeyBookName, debugBookName,
+						xerrors.KeySheetName, debugSheetName)
 				}
 				// append parsed sheets to workbook
 				bp.wb.Worksheets = append(bp.wb.Worksheets, worksheets...)

internal/protogen/sheet_mode.go

@@ -57,7 +57,7 @@ func isEnumTypeBlockHeader(cols []string) bool {
 func parseEnumType(ws *internalpb.Worksheet, sheet *book.Sheet, parser book.SheetParser, gen *Generator) error {
 	desc := &internalpb.EnumDescriptor{}
 	if err := parser.Parse(desc, sheet); err != nil {
-		return xerrors.Wrapf(err, "failed to parse enum type sheet (block): %s", sheet.Name)
+		return err
 	}
 	prefix := strcase.FromContext(gen.ctx).ToScreamingSnake(ws.Name) + "_"
 	for i, value := range desc.Values {
@@ -98,7 +98,7 @@ func isStructTypeBlockHeader(cols []string) bool {
 func extractStructTypeInfo(sheet *book.Sheet, typeName, parentFilename string, parser book.SheetParser, gen *Generator) error {
 	desc := &internalpb.StructDescriptor{}
 	if err := parser.Parse(desc, sheet); err != nil {
-		return xerrors.Wrapf(err, "failed to parse struct type sheet: %s", sheet.Name)
+		return err
 	}
 	firstFieldOptionName := ""
 	if len(desc.Fields) != 0 {
@@ -118,7 +118,7 @@ func extractStructTypeInfo(sheet *book.Sheet, typeName, parentFilename string, p
 func parseStructType(ws *internalpb.Worksheet, sheet *book.Sheet, parser book.SheetParser, gen *Generator, debugBookName, debugSheetName string) error {
 	desc := &internalpb.StructDescriptor{}
 	if err := parser.Parse(desc, sheet); err != nil {
-		return xerrors.Wrapf(err, "failed to parse struct type sheet (block): %s", sheet.Name)
+		return err
 	}
 	bp := newTableParser("struct", "", "", gen)
 	shHeader := &tableHeader{
@@ -185,7 +185,7 @@ func extractUnionTypeInfo(sheet *book.Sheet, typeName, parentFilename string, pa
 
 	desc := &internalpb.UnionDescriptor{}
 	if err := parser.Parse(desc, sheet); err != nil {
-		return xerrors.Wrapf(err, "failed to parse union type sheet: %s", sheet.Name)
+		return err
 	}
 	// add types nested in union type
 	for _, value := range desc.Values {
@@ -208,7 +208,7 @@ func extractUnionTypeInfo(sheet *book.Sheet, typeName, parentFilename string, pa
 func parseUnionType(ws *internalpb.Worksheet, sheet *book.Sheet, parser book.SheetParser, gen *Generator, debugBookName, debugSheetName string) error {
 	desc := &internalpb.UnionDescriptor{}
 	if err := parser.Parse(desc, sheet); err != nil {
-		return xerrors.Wrapf(err, "failed to parse union type sheet: %s", sheet.Name)
+		return err
 	}
 
 	for i, value := range desc.Values {

xerrors/desc.go

@@ -158,17 +158,16 @@ func (d *Desc) ErrString(withDebug bool) string {
 }
 
 func (d *Desc) DebugString() string {
-	str := ""
+	str := new(strings.Builder)
 	for _, key := range keys {
 		val := d.fields[key]
 		if val != nil {
-			str += fmt.Sprintf("\t%s: %v\n", key, val)
+			fmt.Fprintf(str, "\t%s: %v\n", key, val)
 		}
 	}
-	return str
+	return str.String()
 }
 
 func (d *Desc) GetValue(key string) any {
 	return d.fields[key]
 }
-

xerrors/desc_test.go

@@ -47,3 +47,48 @@ func TestNewDesc(t *testing.T) {
 		})
 	}
 }
+
+func TestWrapKVSameKeyNotOverwritten(t *testing.T) {
+	// Base error with KeyModule set to "first"
+	baseErr := WrapKV(Newf("some error"), KeyModule, "first")
+
+	// Wrap with the same key KeyModule again
+	wrappedOnce := WrapKV(baseErr, KeyModule, "second")
+
+	// Wrap with the same key KeyModule a third time
+	wrappedTwice := WrapKV(wrappedOnce, KeyModule, "third")
+
+	tests := []struct {
+		name       string
+		err        error
+		wantModule string
+	}{
+		{
+			name:       "single WrapKV sets Module",
+			err:        baseErr,
+			wantModule: "first",
+		},
+		{
+			name:       "second WrapKV with same key does not overwrite",
+			err:        wrappedOnce,
+			wantModule: "first",
+		},
+		{
+			name:       "third WrapKV with same key does not overwrite",
+			err:        wrappedTwice,
+			wantModule: "first",
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			desc := NewDesc(tt.err)
+			if desc == nil {
+				t.Fatal("NewDesc() returned nil")
+			}
+			gotModule := desc.GetValue(KeyModule)
+			if gotModule != tt.wantModule {
+				t.Errorf("KeyModule = %v, want %v", gotModule, tt.wantModule)
+			}
+		})
+	}
+}