SWIFT-851 Namespace error types #491
Conversation
| /// A MongoDB server error code. | ||
| /// - SeeAlso: https://github.com/mongodb/mongo/blob/master/src/mongo/base/error_codes.yml | ||
| public typealias ServerErrorCode = Int | ||
| public protocol MongoErrorProtocol: LocalizedError {} |
There was a problem hiding this comment.
to disambiguate from the namespace, I added the Protocol suffix that I've seen in a few places in the stdlib (e.g. LazySequenceProtocol)
|
|
||
| /// Protocol conformed to by errors that may contain error labels. | ||
| public protocol LabeledError: MongoError { | ||
| public protocol MongoLabeledError: MongoErrorProtocol { |
There was a problem hiding this comment.
There are limitations to this enum-as-namespace approach, namely protocols can't be defined that way. To avoid collisions, I added the Mongo prefix to all these protocols.
| /// Labels that may describe the context in which this error was thrown. | ||
| public let errorLabels: [String]? | ||
| /// Thrown when commands experience errors on the server that prevent execution. | ||
| public struct CommandError: MongoServerError { |
There was a problem hiding this comment.
We could even do sub-namespaces here for each of the error categories (e.g. MongoError.ServerError.CommandError), but that felt like overkill.
| public var errorDescription: String? { self.message } | ||
| } | ||
| /// A struct to represent a single write error not resulting from an executed write operation. | ||
| public struct WriteFailure: Codable { |
There was a problem hiding this comment.
these -Failure types aren't errors themselves, but they are contained within different error types. I wasn't sure where to put them so I just left them under MongoError.
Codecov Report
@@ Coverage Diff @@
## master #491 +/- ##
==========================================
- Coverage 76.99% 76.98% -0.02%
==========================================
Files 125 125
Lines 13030 13050 +20
==========================================
+ Hits 10033 10046 +13
- Misses 2997 3004 +7
Continue to review full report at Codecov.
|
kmahar
left a comment
kmahar
left a comment
There was a problem hiding this comment.
what you've got here lgtm mod maybe handling the BSON stuff here, but I think probably all of our docstrings listing error types need to be updated now?
patrickfreed
force-pushed
the
SWIFT-851/namespace-errors
branch
from
4908f6c to
beaac75
Compare
4 participants
SWIFT-851
This PR moves all the error type definitions under a new empty enum
MongoError.It also renames
MongoErrortoMongoErrorProtocoland prefixes the other error protocols withMongo.