diff --git a/fmttests/datadriven_test.go b/fmttests/datadriven_test.go index 77b9568..01bc05e 100644 --- a/fmttests/datadriven_test.go +++ b/fmttests/datadriven_test.go @@ -105,7 +105,7 @@ var leafCommands = map[string]commandFn{ }, "unimplemented": func(_ error, args []arg) error { - return issuelink.UnimplementedErrorf(issuelink.IssueLink{IssueURL: "https://mysite", Detail: "issuedetails"}, strfy(args)) + return issuelink.UnimplementedErrorf(issuelink.IssueLink{IssueURL: "https://mysite", Detail: "issuedetails"}, "%s", strfy(args)) }, } @@ -790,14 +790,19 @@ func TestDatadriven(t *testing.T) { fmt.Fprintf(&buf, "== Message payload\n%s\n", se.Message) - // Make the extra key deterministic. - extraNames := make([]string, 0, len(se.Extra)) - for ek := range se.Extra { - extraNames = append(extraNames, ek) + // Make the extra key deterministic. Only print entries + // that carry our merged "value" sub-key so that Sentry's + // built-in default contexts (device/os/runtime/trace) do + // not leak into fixtures. + extraNames := make([]string, 0, len(se.Contexts)) + for ek, ev := range se.Contexts { + if _, ok := ev["value"]; ok { + extraNames = append(extraNames, ek) + } } sort.Strings(extraNames) for _, ek := range extraNames { - extraS := fmt.Sprintf("%v", se.Extra[ek]) + extraS := fmt.Sprintf("%v", se.Contexts[ek]["value"]) fmt.Fprintf(&buf, "== Extra %q\n%s\n", ek, strings.TrimSpace(extraS)) } @@ -880,10 +885,18 @@ func (it interceptingTransport) Flush(time.Duration) bool { return true } +// FlushWithContext implements the sentry.Transport interface. +func (it interceptingTransport) FlushWithContext(context.Context) bool { + return true +} + // Configure implements the sentry.Transport interface. func (it interceptingTransport) Configure(sentry.ClientOptions) { } +// Close implements the sentry.Transport interface. +func (it interceptingTransport) Close() {} + // SendEvent implements the sentry.Transport interface. func (it interceptingTransport) SendEvent(event *sentry.Event) { it.SendFunc(event) diff --git a/go.mod b/go.mod index 7297c44..e443e8b 100644 --- a/go.mod +++ b/go.mod @@ -1,21 +1,19 @@ module github.com/cockroachdb/errors -go 1.23.0 - -toolchain go1.23.8 +go 1.25.0 require ( github.com/cockroachdb/datadriven v1.0.2 github.com/cockroachdb/logtags v0.0.0-20230118201751-21c54148d20b github.com/cockroachdb/redact v1.1.5 - github.com/getsentry/sentry-go v0.27.0 + github.com/getsentry/sentry-go v0.46.0 github.com/gogo/googleapis v1.4.1 // gogoproto 1.2-compatible, for CRDB github.com/gogo/protobuf v1.3.2 github.com/gogo/status v1.1.0 github.com/hydrogen18/memlistener v1.0.0 github.com/kr/pretty v0.3.1 github.com/pkg/errors v0.9.1 - github.com/stretchr/testify v1.8.2 + github.com/stretchr/testify v1.8.4 google.golang.org/grpc v1.56.3 google.golang.org/protobuf v1.33.0 ) @@ -30,6 +28,5 @@ require ( golang.org/x/sys v0.31.0 // indirect golang.org/x/text v0.23.0 // indirect google.golang.org/genproto v0.0.0-20230410155749-daa745c078e1 // indirect - gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c // indirect gopkg.in/yaml.v3 v3.0.1 // indirect ) diff --git a/go.sum b/go.sum index 0cb96e1..c3adbd4 100644 --- a/go.sum +++ b/go.sum @@ -5,11 +5,10 @@ github.com/cockroachdb/logtags v0.0.0-20230118201751-21c54148d20b/go.mod h1:Vz9D github.com/cockroachdb/redact v1.1.5 h1:u1PMllDkdFfPWaNGMyLD1+so+aq3uUItthCFqzwPJ30= github.com/cockroachdb/redact v1.1.5/go.mod h1:BVNblN9mBWFyMyqK1k3AAiSxhvhfK2oOZZ2lK+dpvRg= github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E= -github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= -github.com/getsentry/sentry-go v0.27.0 h1:Pv98CIbtB3LkMWmXi4Joa5OOcwbmnX88sF5qbK3r3Ps= -github.com/getsentry/sentry-go v0.27.0/go.mod h1:lc76E2QywIyW8WuBnwl8Lc4bkmQH4+w1gwTf25trprY= +github.com/getsentry/sentry-go v0.46.0 h1:mbdDaarbUdOt9X+dx6kDdntkShLEX3/+KyOsVDTPDj0= +github.com/getsentry/sentry-go v0.46.0/go.mod h1:evVbw2qotNUdYG8KxXbAdjOQWWvWIwKxpjdZZIvcIPw= github.com/go-errors/errors v1.4.2 h1:J6MZopCL4uSllY1OfXM374weqZFFItUbrImctkmUxIA= github.com/go-errors/errors v1.4.2/go.mod h1:sIVyrIiJhuEF+Pj9Ebtd6P/rEYROXFi3BopGUQ5a5Og= github.com/gogo/googleapis v0.0.0-20180223154316-0cd9801be74a/go.mod h1:gf4bu3Q80BeJ6H1S1vYPm8/ELATdvryBaNFGgqEef3s= @@ -31,11 +30,8 @@ github.com/hydrogen18/memlistener v1.0.0 h1:JR7eDj8HD6eXrc5fWLbSUnfcQFL06PYvCc0D github.com/hydrogen18/memlistener v1.0.0/go.mod h1:qEIFzExnS6016fRpRfxrExeVn2gbClQA99gQhnIcdhE= github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8= github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck= -github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI= github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE= github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk= -github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= -github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY= github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE= github.com/pingcap/errors v0.11.4 h1:lFuQV/oaUMGcD2tqt+01ROSmJs75VG1ToEOkZIZ4nE4= @@ -47,15 +43,12 @@ github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZb github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= github.com/rogpeppe/go-internal v1.9.0 h1:73kH8U+JUqXU8lRuOHeVHaa/SZPifC7BkcraZVejAe8= github.com/rogpeppe/go-internal v1.9.0/go.mod h1:WtVeX8xhTBvf0smdhujwtBcq4Qrzq/fJaraNFVN+nFs= -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= -github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= -github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU= -github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8= -github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4= +github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk= +github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo= github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74= +go.uber.org/goleak v1.3.0 h1:2K3zAYmnTNqV73imy9J1T3WC+gmCePx2hEGkimedGto= +go.uber.org/goleak v1.3.0/go.mod h1:CoHD4mav9JJNrW/WLlf7HGZPjdw8EucARQHekz1X6bE= golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto= @@ -101,6 +94,5 @@ google.golang.org/protobuf v1.33.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHh gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk= gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q= -gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/report/report.go b/report/report.go index 817583d..055868f 100644 --- a/report/report.go +++ b/report/report.go @@ -365,8 +365,11 @@ var redactedMarker = redact.RedactableString(redact.RedactedMarker()).StripMarke func ReportError(err error) (eventID string) { event, extraDetails := BuildSentryReport(err) + if event.Contexts == nil { + event.Contexts = make(map[string]sentry.Context) + } for extraKey, extraValue := range extraDetails { - event.Extra[extraKey] = extraValue + event.Contexts[extraKey] = sentry.Context{"value": extraValue} } // Avoid leaking the machine's hostname by injecting the literal "". diff --git a/report/report_test.go b/report/report_test.go index 0ff3017..99dd58f 100644 --- a/report/report_test.go +++ b/report/report_test.go @@ -15,6 +15,7 @@ package report_test import ( + "context" goErr "errors" "fmt" "strings" @@ -126,7 +127,7 @@ github.com/cockroachdb/errors/withstack/*withstack.withStack (*::) github.com/cockroachdb/errors/domains/*domains.withDomain (*::error domain: "thisdomain") github.com/cockroachdb/errors/report_test/*report_test.myWrapper (some/previous/path/prevpkg.prevType::) ` - types := fmt.Sprintf("%s", e.Extra["error types"]) + types := fmt.Sprintf("%s", e.Contexts["error types"]["value"]) tt.CheckEqual(types, expectedTypes) }) @@ -183,6 +184,11 @@ func (it interceptingTransport) Flush(time.Duration) bool { return true } +// FlushWithContext implements the sentry.Transport interface. +func (it interceptingTransport) FlushWithContext(context.Context) bool { + return true +} + // Configure implements the sentry.Transport interface. func (it interceptingTransport) Configure(sentry.ClientOptions) { } @@ -191,3 +197,6 @@ func (it interceptingTransport) Configure(sentry.ClientOptions) { func (it interceptingTransport) SendEvent(event *sentry.Event) { it.SendFunc(event) } + +// Close implements the sentry.Transport interface. +func (it interceptingTransport) Close() {}