Fix Error() method for exception types

Summary: Implement a type alias workaround to be able to `fmt.Sprintf` a Thrift exception type without causing infinite recursion. Reviewed By: leoleovich Differential Revision: D45934359 fbshipit-source-id: 536b95ac4359b0bee500b78ffc2ee2725352586c
paulbiss · May 17, 2023 · ebf3143 · ebf3143
1 parent 57df0a2
commit ebf3143
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 12 deletions.
diff --git a/third-party/thrift/src/thrift/compiler/generate/templates/go/types/struct_methods.mustache b/third-party/thrift/src/thrift/compiler/generate/templates/go/types/struct_methods.mustache
@@ -78,9 +78,15 @@ func (x *{{struct:go_name}}) String() string {
 
   Error method.
 
+  Note: 'fmt' package calls Error() method when formatting objects which
+  implement error interface. This will result in infinite recursion and
+  stack overflow unless type aliasing is used (as done below).
+
 }}{{#struct:exception?}}
 func (x *{{struct:go_name}}) Error() string {
-    return x.String()
+    type {{struct:go_name}}Alias {{struct:go_name}}
+    valueAlias := (*{{struct:go_name}}Alias)(x)
+    return fmt.Sprintf("%+v", valueAlias)
 }
 
 {{/struct:exception?}}{{!

diff --git a/...y/thrift/src/thrift/compiler/test/fixtures/basic-annotations/gen-go_mstch/module/types.go b/...y/thrift/src/thrift/compiler/test/fixtures/basic-annotations/gen-go_mstch/module/types.go
diff --git a/third-party/thrift/src/thrift/compiler/test/fixtures/doctext/gen-go_mstch/module/types.go b/third-party/thrift/src/thrift/compiler/test/fixtures/doctext/gen-go_mstch/module/types.go
diff --git a/third-party/thrift/src/thrift/compiler/test/fixtures/exceptions/gen-go_mstch/module/types.go b/third-party/thrift/src/thrift/compiler/test/fixtures/exceptions/gen-go_mstch/module/types.go
diff --git a/...-party/thrift/src/thrift/compiler/test/fixtures/interactions/gen-go_mstch/module/types.go b/...-party/thrift/src/thrift/compiler/test/fixtures/interactions/gen-go_mstch/module/types.go
diff --git a/...ty/thrift/src/thrift/compiler/test/fixtures/terse_write/gen-go_mstch/terse_write/types.go b/...ty/thrift/src/thrift/compiler/test/fixtures/terse_write/gen-go_mstch/terse_write/types.go