refactor(ecode): add codegen and improve testability (#312)

* refactor: add codegen for ecode

* refactor: deprecate GeneratedBuf

* refactor: use error.Is to check ecode equality

* fix: caller stack levels

* fix: imports of maps and slices packages

* fix: lint errors

* fix: coverage

* refactor: i18n APIs

* fix: duplicate verb +v print

* test: add more cases

* feat: check extracted fields names

Author: wenchy

codecov.yml

@@ -5,5 +5,7 @@ coverage:
         target: 63%
         threshold: 1%
 ignore:
-    - "**/*.pb.go" # ignore all *.pb.go files
-    - "test" # ignore folders and all its contents
+  - "**/*.pb.go" # ignore all *.pb.go files
+  - "**/*_generated.go"
+  - "test" # ignore folders and all its contents
+  - "internal/tools"

go.mod

@@ -12,8 +12,8 @@ require (
 	github.com/stretchr/testify v1.9.0
 	github.com/subchen/go-xmldom v1.1.2
 	github.com/xuri/excelize/v2 v2.9.0
-	go.uber.org/multierr v1.11.0
 	go.uber.org/zap v1.24.0
+	golang.org/x/exp v0.0.0-20240808152545-0cdaa3abc0fa
 	golang.org/x/sync v0.8.0
 	golang.org/x/text v0.19.0
 	google.golang.org/protobuf v1.34.2
@@ -40,6 +40,7 @@ require (
 	github.com/xuri/efp v0.0.0-20240408161823-9ad904a10d6d // indirect
 	github.com/xuri/nfp v0.0.0-20240318013403-ab9948c2c4a7 // indirect
 	go.uber.org/atomic v1.7.0 // indirect
+	go.uber.org/multierr v1.11.0 // indirect
 	golang.org/x/arch v0.14.0 // indirect
 	golang.org/x/crypto v0.28.0 // indirect
 	golang.org/x/net v0.30.0 // indirect

go.sum

@@ -104,6 +104,8 @@ golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACk
 golang.org/x/crypto v0.28.0 h1:GBDwsMXVQi34v5CCYUm2jkJvu4cbtru2U4TN2PSyQnw=
 golang.org/x/crypto v0.28.0/go.mod h1:rmgy+3RHxRZMyY0jjAJShp2zgEdOqj2AO7U0pYmeQ7U=
 golang.org/x/exp v0.0.0-20190121172915-509febef88a4/go.mod h1:CJ0aWSM057203Lf6IL+f9T1iT9GByDxfZKAQTCR3kQA=
+golang.org/x/exp v0.0.0-20240808152545-0cdaa3abc0fa h1:ELnwvuAXPNtPk1TJRuGkI9fDTwym6AYBu0qzT8AcHdI=
+golang.org/x/exp v0.0.0-20240808152545-0cdaa3abc0fa/go.mod h1:akd2r19cwCdwSwWeIdzYQGa/EZZyqcOdwWiwj5L5eKQ=
 golang.org/x/image v0.18.0 h1:jGzIakQa/ZXI1I0Fxvaa9W7yP25TqT6cHIHn+6CqvSQ=
 golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=
 golang.org/x/lint v0.0.0-20190227174305-5b3e6a55c961/go.mod h1:wehouNa3lNwaWXcvxsM5YxQ5yQlVC4a0KAMCusXpPoU=

internal/confgen/document_parser_test.go

@@ -31,7 +31,7 @@ func TestDocParser_parseFieldNotFound(t *testing.T) {
 		parser  *sheetParser
 		args    args
 		wantErr bool
-		errcode string
+		err     error
 	}{
 		{
 			name:   "no duplicate key",
@@ -120,7 +120,7 @@ func TestDocParser_parseFieldNotFound(t *testing.T) {
 				},
 			},
 			wantErr: true,
-			errcode: "E2014",
+			err:     xerrors.ErrE2014,
 		},
 	}
 	for _, tt := range tests {
@@ -130,10 +130,7 @@ func TestDocParser_parseFieldNotFound(t *testing.T) {
 				t.Errorf("sheetParser.Parse() error = %v, wantErr %v", err, tt.wantErr)
 			}
 			if err != nil {
-				if tt.errcode != "" {
-					desc := xerrors.NewDesc(err)
-					require.Equal(t, tt.errcode, desc.ErrCode())
-				}
+				require.ErrorIs(t, err, tt.err)
 			}
 		})
 	}
@@ -148,7 +145,7 @@ func TestDocParser_parseDocumentUniqueFieldStructList(t *testing.T) {
 		parser  *sheetParser
 		args    args
 		wantErr bool
-		errcode string
+		err     error
 	}{
 		{
 			name:   "no duplicate key",
@@ -305,7 +302,7 @@ func TestDocParser_parseDocumentUniqueFieldStructList(t *testing.T) {
 				},
 			},
 			wantErr: true,
-			errcode: "E2022",
+			err:     xerrors.ErrE2022,
 		},
 		{
 			name:   "duplicate name",
@@ -384,7 +381,7 @@ func TestDocParser_parseDocumentUniqueFieldStructList(t *testing.T) {
 				},
 			},
 			wantErr: true,
-			errcode: "E2022",
+			err:     xerrors.ErrE2022,
 		},
 	}
 	for _, tt := range tests {
@@ -394,10 +391,8 @@ func TestDocParser_parseDocumentUniqueFieldStructList(t *testing.T) {
 				t.Errorf("sheetParser.Parse() error = %+v, wantErr %v", err, tt.wantErr)
 			}
 			if err != nil {
-				if tt.errcode != "" {
-					desc := xerrors.NewDesc(err)
-					require.Equal(t, tt.errcode, desc.ErrCode())
-				}
+				t.Logf("err: %+v", err)
+				require.ErrorIs(t, err, tt.err)
 			}
 		})
 	}
@@ -412,7 +407,7 @@ func TestDocParser_parseDocumentUniqueFieldStructMap(t *testing.T) {
 		parser  *sheetParser
 		args    args
 		wantErr bool
-		errcode string
+		err     error
 	}{
 		{
 			name:   "no duplicate key",
@@ -631,7 +626,7 @@ func TestDocParser_parseDocumentUniqueFieldStructMap(t *testing.T) {
 				},
 			},
 			wantErr: true,
-			errcode: "E2022",
+			err:     xerrors.ErrE2022,
 		},
 		{
 			name:   "duplicate section name",
@@ -741,7 +736,7 @@ func TestDocParser_parseDocumentUniqueFieldStructMap(t *testing.T) {
 				},
 			},
 			wantErr: true,
-			errcode: "E2022",
+			err:     xerrors.ErrE2022,
 		},
 		{
 			name:   "duplicate chapter id",
@@ -851,7 +846,7 @@ func TestDocParser_parseDocumentUniqueFieldStructMap(t *testing.T) {
 				},
 			},
 			wantErr: true,
-			errcode: "E2005",
+			err:     xerrors.ErrE2005,
 		},
 		{
 			name:   "duplicate scalar map key",
@@ -891,7 +886,7 @@ func TestDocParser_parseDocumentUniqueFieldStructMap(t *testing.T) {
 				},
 			},
 			wantErr: true,
-			errcode: "E2005",
+			err:     xerrors.ErrE2005,
 		},
 		{
 			name:   "duplicate incell map key",
@@ -917,7 +912,7 @@ func TestDocParser_parseDocumentUniqueFieldStructMap(t *testing.T) {
 				},
 			},
 			wantErr: true,
-			errcode: "E2005",
+			err:     xerrors.ErrE2005,
 		},
 		{
 			name:   "card prefix uniqueness",
@@ -1102,10 +1097,7 @@ func TestDocParser_parseDocumentUniqueFieldStructMap(t *testing.T) {
 				t.Errorf("sheetParser.Parse() error = %+v, wantErr %v", err, tt.wantErr)
 			}
 			if err != nil {
-				if tt.errcode != "" {
-					desc := xerrors.NewDesc(err)
-					require.Equal(t, tt.errcode, desc.ErrCode())
-				}
+				require.ErrorIs(t, err, tt.err)
 			}
 		})
 	}
@@ -1120,7 +1112,7 @@ func TestDocParser_parseSequenceUniqueFieldStructList(t *testing.T) {
 		parser  *sheetParser
 		args    args
 		wantErr bool
-		errcode string
+		err     error
 	}{
 		{
 			name:   "in sequence",
@@ -1277,7 +1269,7 @@ func TestDocParser_parseSequenceUniqueFieldStructList(t *testing.T) {
 				},
 			},
 			wantErr: true,
-			errcode: "E2003",
+			err:     xerrors.ErrE2003,
 		},
 	}
 	for _, tt := range tests {
@@ -1287,10 +1279,7 @@ func TestDocParser_parseSequenceUniqueFieldStructList(t *testing.T) {
 				t.Errorf("sheetParser.Parse() error = %+v, wantErr %v", err, tt.wantErr)
 			}
 			if err != nil {
-				if tt.errcode != "" {
-					desc := xerrors.NewDesc(err)
-					require.Equal(t, tt.errcode, desc.ErrCode())
-				}
+				require.ErrorIs(t, err, tt.err)
 			}
 		})
 	}

internal/confgen/parser.go

@@ -561,7 +561,7 @@ func (p *sheetParser) checkKeyUnique(md protoreflect.MessageDescriptor, fdOpts *
 	defer keyField.release()
 	if fieldprop.RequireUnique(keyField.opts.Prop) ||
 		(!fieldprop.HasUnique(keyField.opts.Prop) && p.deduceKeyUnique(fdOpts.Layout, md)) {
-		return xerrors.Wrap(xerrors.E2005(keyData))
+		return xerrors.E2005(keyData)
 	}
 	return nil
 }
@@ -704,7 +704,7 @@ func (p *sheetParser) checkSubFieldProp(field *Field, cardPrefix string, newValu
 		}
 		valStr := newValue.Message().Get(field.fd).String()
 		if field.values[valStr] {
-			return name, xerrors.E2022(field.fd.Name(), valStr)
+			return name, xerrors.E2022(string(field.fd.Name()), valStr)
 		}
 		// add new unique value
 		field.values[valStr] = true
@@ -760,7 +760,7 @@ func (p *sheetParser) parseListElems(field *Field, list protoreflect.List, cardP
 			// Guarantee all the remaining elements are not present,
 			// otherwise report error!
 			if elemPresent {
-				return false, xerrors.Wrap(xerrors.E2016(firstNonePresentIndex, i))
+				return false, xerrors.E2016(firstNonePresentIndex, i)
 			}
 			continue
 		}