Improve error message clarity in MongoCommandException. (#1789)

vbabanin · web-flow · commit daa7cbd1236c · 2025-08-27T10:25:41.000-07:00
JAVA-5905
diff --git a/driver-core/src/main/com/mongodb/ClientBulkWriteException.java b/driver-core/src/main/com/mongodb/ClientBulkWriteException.java
@@ -88,7 +88,7 @@ private static String message(
             @Nullable final Map<Integer, WriteError> writeErrors,
             @Nullable final ClientBulkWriteResult partialResult,
             final ServerAddress serverAddress) {
-        return "Client-level bulk write operation error on server " + serverAddress + "."
+        return "Client-level bulk write operation error on MongoDB server " + serverAddress + "."
                 + (error == null ? "" : " Top-level error: " + error + ".")
                 + (writeErrors == null || writeErrors.isEmpty() ? "" : " Write errors: " + writeErrors + ".")
                 + (writeConcernErrors == null || writeConcernErrors.isEmpty() ? "" : " Write concern errors: " + writeConcernErrors + ".")
diff --git a/driver-core/src/main/com/mongodb/MongoBulkWriteException.java b/driver-core/src/main/com/mongodb/MongoBulkWriteException.java
@@ -53,7 +53,7 @@ public class MongoBulkWriteException extends MongoServerException {
     public MongoBulkWriteException(final BulkWriteResult writeResult, final List<BulkWriteError> writeErrors,
                                    @Nullable final WriteConcernError writeConcernError, final ServerAddress serverAddress,
                                    final Set<String> errorLabels) {
-        super("Bulk write operation error on server " + serverAddress + ". "
+        super("Bulk write operation error on MongoDB server " + serverAddress + ". "
                 + (writeErrors.isEmpty() ? "" : "Write errors: " + writeErrors + ". ")
                 + (writeConcernError == null ? "" : "Write concern error: " + writeConcernError + ". "), serverAddress);
         this.writeResult = writeResult;
diff --git a/driver-core/src/main/com/mongodb/MongoCommandException.java b/driver-core/src/main/com/mongodb/MongoCommandException.java
@@ -48,7 +48,7 @@ public class MongoCommandException extends MongoServerException {
      */
     public MongoCommandException(final BsonDocument response, final ServerAddress address) {
         super(extractErrorCode(response), extractErrorCodeName(response),
-              format("Command failed with error %s: '%s' on server %s. The full response is %s", extractErrorCodeAndName(response),
+              format("Command execution failed on MongoDB server with error %s: '%s' on server %s. The full response is %s", extractErrorCodeAndName(response),
                      extractErrorMessage(response), address, getResponseAsJson(response)), address);
         this.response = response;
         addLabels(extractErrorLabelsAsBson(response));
diff --git a/driver-core/src/main/com/mongodb/MongoWriteException.java b/driver-core/src/main/com/mongodb/MongoWriteException.java
@@ -50,7 +50,7 @@ public MongoWriteException(final WriteError error, final ServerAddress serverAdd
      * @since 5.0
      */
     public MongoWriteException(final WriteError error, final ServerAddress serverAddress, final Collection<String> errorLabels) {
-        super(error.getCode(), "Write operation error on server " + serverAddress + ". Write error: " + error + ".", serverAddress);
+        super(error.getCode(), "Write operation error on MongoDB server " + serverAddress + ". Write error: " + error + ".", serverAddress);
         this.error = error;
         addLabels(errorLabels);
     }
diff --git a/driver-core/src/test/unit/com/mongodb/MongoCommandExceptionSpecification.groovy b/driver-core/src/test/unit/com/mongodb/MongoCommandExceptionSpecification.groovy
@@ -56,11 +56,12 @@ class MongoCommandExceptionSpecification extends Specification {
         new MongoCommandException(new BsonDocument('ok', BsonBoolean.FALSE).append('code', new BsonInt32(26))
                 .append('codeName', new BsonString('TimeoutError')).append('errmsg', new BsonString('the error message')),
                 new ServerAddress())
-                .getMessage() == 'Command failed with error 26 (TimeoutError): \'the error message\' on server 127.0.0.1:27017. ' +
-                'The full response is {"ok": false, "code": 26, "codeName": "TimeoutError", "errmsg": "the error message"}'
+                .getMessage() == 'Command execution failed on MongoDB server with error 26 (TimeoutError): \'the error message\' ' +
+                'on server 127.0.0.1:27017. The full response is {"ok": false, "code": 26, "codeName": "TimeoutError", ' +
+                '"errmsg": "the error message"}'
         new MongoCommandException(new BsonDocument('ok', BsonBoolean.FALSE).append('code', new BsonInt32(26))
                 .append('errmsg', new BsonString('the error message')), new ServerAddress())
-                .getMessage() == 'Command failed with error 26: \'the error message\' on server 127.0.0.1:27017. ' +
-                'The full response is {"ok": false, "code": 26, "errmsg": "the error message"}'
+                .getMessage() == 'Command execution failed on MongoDB server with error 26: \'the error message\' ' +
+                'on server 127.0.0.1:27017. The full response is {"ok": false, "code": 26, "errmsg": "the error message"}'
     }
 }
diff --git a/driver-core/src/test/unit/com/mongodb/MongoWriteExceptionTest.java b/driver-core/src/test/unit/com/mongodb/MongoWriteExceptionTest.java
@@ -32,7 +32,7 @@ public void testExceptionProperties() {
         WriteError writeError = new WriteError(11000, "Duplicate key", new BsonDocument("x", new BsonInt32(1)));
         MongoWriteException e = new MongoWriteException(writeError, new ServerAddress("host1"), Collections.emptySet());
 
-        assertEquals("Write operation error on server host1:27017. Write error: WriteError{code=11000, message='Duplicate key', "
+        assertEquals("Write operation error on MongoDB server host1:27017. Write error: WriteError{code=11000, message='Duplicate key', "
                 + "details={\"x\": 1}}.",
                 e.getMessage());
         assertEquals(writeError.getCode(), e.getCode());
diff --git a/driver-legacy/src/main/com/mongodb/BulkWriteException.java b/driver-legacy/src/main/com/mongodb/BulkWriteException.java
@@ -46,7 +46,7 @@ public class BulkWriteException extends MongoServerException {
      */
     BulkWriteException(final BulkWriteResult writeResult, final List<BulkWriteError> writeErrors,
                        @Nullable final WriteConcernError writeConcernError, final ServerAddress serverAddress) {
-        super("Bulk write operation error on server " + serverAddress + ". "
+        super("Bulk write operation error on MongoDB server " + serverAddress + ". "
               + (writeErrors.isEmpty() ? "" : "Write errors: " + writeErrors + ". ")
               + (writeConcernError == null ? "" : "Write concern error: " + writeConcernError + ". "), serverAddress);
         this.writeResult = writeResult;
diff --git a/driver-sync/src/test/functional/com/mongodb/internal/connection/OidcAuthenticationProseTests.java b/driver-sync/src/test/functional/com/mongodb/internal/connection/OidcAuthenticationProseTests.java
@@ -406,7 +406,7 @@ public void test3p2AuthFailsWithoutCachedToken() {
         MongoClientSettings clientSettings = createSettings(callback);
         try (MongoClient mongoClient = createMongoClient(clientSettings)) {
             assertCause(MongoCommandException.class,
-                    "Command failed with error 18 (AuthenticationFailed):",
+                    "Command execution failed on MongoDB server with error 18 (AuthenticationFailed):",
                     () -> performFind(mongoClient));
         }
     }
@@ -424,7 +424,7 @@ public void test3p3UnexpectedErrorDoesNotClearCache() {
         try (MongoClient mongoClient = createMongoClient(clientSettings)) {
             failCommand(20, 1, "saslStart");
             assertCause(MongoCommandException.class,
-                    "Command failed with error 20",
+                    "Command execution failed on MongoDB server with error 20",
                     () -> performFind(mongoClient));
 
             assertEquals(Arrays.asList(
@@ -471,7 +471,7 @@ public void test4p2ReadCommandsFailIfReauthenticationFails() {
             performFind(mongoClient);
             failCommand(391, 1, "find");
             assertCause(MongoCommandException.class,
-                    "Command failed with error 18",
+                    "Command execution failed on MongoDB server with error 18",
                     () -> performFind(mongoClient));
         }
         assertEquals(2, wrappedCallback.invocations.get());
@@ -492,7 +492,7 @@ public void test4p3WriteCommandsFailIfReauthenticationFails() {
             performInsert(mongoClient);
             failCommand(391, 1, "insert");
             assertCause(MongoCommandException.class,
-                    "Command failed with error 18",
+                    "Command execution failed on MongoDB server with error 18",
                     () -> performInsert(mongoClient));
         }
         assertEquals(2, wrappedCallback.invocations.get());
@@ -740,7 +740,7 @@ public void testh3p2NoSpecAuthIfNoCachedToken() {
         TestCommandListener commandListener = new TestCommandListener(listener);
         assertFindFails(createHumanSettings(createHumanCallback(), commandListener),
                 MongoCommandException.class,
-                "Command failed with error 18");
+                "Command execution failed on MongoDB server with error 18");
         assertEquals(Arrays.asList(
                 "isMaster started",
                 "isMaster succeeded",
@@ -833,7 +833,7 @@ public void testh4p4Fails() {
             assertEquals(1, callback1.getInvocations());
             failCommand(391, 1, "find");
             assertCause(MongoCommandException.class,
-                    "Command failed with error 18",
+                    "Command execution failed on MongoDB server with error 18",
                     () -> performFind(mongoClient));
             assertEquals(3, callback1.getInvocations());
         }

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public MongoWriteException(final WriteError error, final ServerAddress serverAdd`
`50`	`50`	`* @since 5.0`
`51`	`51`	`*/`
`52`	`52`	`public MongoWriteException(final WriteError error, final ServerAddress serverAddress, final Collection<String> errorLabels) {`
`53`		`- super(error.getCode(), "Write operation error on server " + serverAddress + ". Write error: " + error + ".", serverAddress);`
	`53`	`+ super(error.getCode(), "Write operation error on MongoDB server " + serverAddress + ". Write error: " + error + ".", serverAddress);`
`54`	`54`	`this.error = error;`
`55`	`55`	`addLabels(errorLabels);`
`56`	`56`	`}`