Skip to content

GODRIVER-3690 Add ErrorCodesFrom to the mongo package #2241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
prestonvasquez wants to merge 2 commits into
base: master
Choose a base branch
from
+96 −6
Open

GODRIVER-3690 Add ErrorCodesFrom to the mongo package #2241

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
58198cf
Expose server error codes via mongo package
prestonvasquez Dec 3, 2025
03fda7a
Rename ErrorCodesFrom to ErrorCodes to match error interface function
prestonvasquez Dec 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion internal/integration/clam_prose_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,6 @@ func clamMultiByteTruncLogs(mt *mtest.T) []truncValidator {

// Insert started.
validators[0] = newTruncValidator(mt, cmd, func(cmd string) error {

// Remove the suffix from the command string.
cmd = cmd[:len(cmd)-len(logger.TruncationSuffix)]

Expand Down
24 changes: 20 additions & 4 deletions mongo/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,10 +364,12 @@ func hasErrorCode(srvErr ServerError, code int) bool {
return false
}

var _ ServerError = CommandError{}
var _ ServerError = WriteError{}
var _ ServerError = WriteException{}
var _ ServerError = BulkWriteException{}
var (
_ ServerError = CommandError{}
_ ServerError = WriteError{}
_ ServerError = WriteException{}
_ ServerError = BulkWriteException{}
)

var _ error = ClientBulkWriteException{}

Expand Down Expand Up @@ -901,3 +903,17 @@ func joinBatchErrors(errs []error) string {

return buf.String()
}

// ErrorCodesFrom returns the list of server error codes contained in err.
func ErrorCodesFrom(err error) []int {
Copy link
Collaborator

@matthewdale matthewdale Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional: Consider naming this ErrorCodes, which matches the method name on the error types.

Copy link
Member Author

@prestonvasquez prestonvasquez Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea 👍

if err == nil {
return nil
}

var ec interface{ ErrorCodes() []int }
if errors.As(wrapErrors(err), &ec) {
return ec.ErrorCodes()
Comment on lines +913 to +915
Copy link
Collaborator

@matthewdale matthewdale Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can users use errors.As to convert the error to a mongo.ServerError and get the same information?

E.g.

var se mongo.ServerError
if errors.As(err, &se) {
    se.ErrorCodes()
}

Copy link
Member Author

@prestonvasquez prestonvasquez Dec 5, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This would only work if mongo.ServerError is in the error tree for the arbitrary error which isn't the case for errors propagated by event monitoring. Here's an example: https://github.com/prestonvasquez/go-playground/blob/01e0e77437bdd9ba0a23d912121e152880dc19e9/mgd_errors_test.go#L17

}

return []int{}
}
76 changes: 76 additions & 0 deletions mongo/errors_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -760,3 +760,79 @@ func (n netErr) Temporary() bool {
}

var _ net.Error = (*netErr)(nil)

func TestErrorCodesFrom(t *testing.T) {
tests := []struct {
name string
input error
want []int
}{
{
name: "nil error",
input: nil,
want: nil,
},
{
name: "non-server error",
input: errors.New("boom"),
want: []int{},
},
{
name: "CommandError single code",
input: CommandError{Code: 123},
want: []int{123},
},
{
name: "WriteError single code",
input: WriteError{Code: 45},
want: []int{45},
},
{
name: "WriteException write errors only",
input: WriteException{WriteErrors: WriteErrors{{Code: 1}, {Code: 2}}},
want: []int{1, 2},
},
{
name: "WriteException with write concern error",
input: WriteException{WriteErrors: WriteErrors{{Code: 1}}, WriteConcernError: &WriteConcernError{Code: 64}},
want: []int{1, 64},
},
{
name: "BulkWriteException write errors only",
input: BulkWriteException{
WriteErrors: []BulkWriteError{
{WriteError: WriteError{Code: 10}},
{WriteError: WriteError{Code: 11}},
},
},
want: []int{10, 11},
},
{
name: "BulkWriteException with write concern error",
input: BulkWriteException{
WriteErrors: []BulkWriteError{
{WriteError: WriteError{Code: 10}},
{WriteError: WriteError{Code: 11}},
},
WriteConcernError: &WriteConcernError{Code: 79},
},
want: []int{10, 11, 79},
},
{
name: "driver.Error wraps to CommandError",
input: driver.Error{Code: 91, Message: "shutdown in progress"},
want: []int{91},
},
{
name: "wrapped driver.Error",
input: fmt.Errorf("context: %w", driver.Error{Code: 262, Message: "ExceededTimeLimit"}),
want: []int{262},
},
}

for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
require.Equal(t, tt.want, ErrorCodesFrom(tt.input))
})
}
}
1 change: 0 additions & 1 deletion x/mongo/driver/operation.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -747,7 +747,6 @@ func (op Operation) Execute(ctx context.Context) error {
var moreToCome bool
var startedInfo startedInformation
*wm, moreToCome, startedInfo, err = op.createWireMessage(ctx, maxTimeMS, (*wm)[:0], desc, conn, requestID)

if err != nil {
return err
}
Expand Down
Loading