Review fixes for mongo-async-3.3:javaagent (#18214)

Co-authored-by: otelbot <197425009+otelbot@users.noreply.github.com>
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>

Author: otelbot[bot]

instrumentation/mongo/mongo-async-3.3/javaagent/src/test/java/io/opentelemetry/javaagent/instrumentation/mongoasync/v3_3/MongoAsyncClientTest.java

@@ -19,6 +19,7 @@
 import com.mongodb.client.result.UpdateResult;
 import com.mongodb.connection.ClusterSettings;
 import io.opentelemetry.instrumentation.mongo.testing.AbstractMongoClientTest;
+import io.opentelemetry.instrumentation.testing.internal.AutoCleanupExtension;
 import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
 import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
 import java.util.concurrent.CompletableFuture;
@@ -27,7 +28,6 @@
 import org.bson.BsonDocument;
 import org.bson.BsonString;
 import org.bson.Document;
-import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
@@ -36,6 +36,8 @@ class MongoAsyncClientTest extends AbstractMongoClientTest<MongoCollection<Docum
   @RegisterExtension
   static final InstrumentationExtension testing = AgentInstrumentationExtension.create();
 
+  @RegisterExtension static final AutoCleanupExtension cleanup = AutoCleanupExtension.create();
+
   private MongoClient client;
 
   @BeforeAll
@@ -50,13 +52,7 @@ void setup() {
                             new ConnectionString("mongodb://" + host + ":" + port))
                         .build())
                 .build());
-  }
-
-  @AfterAll
-  void cleanup() {
-    if (client != null) {
-      client.close();
-    }
+    cleanup.deferAfterAll(client);
   }
 
   @Override
@@ -65,27 +61,30 @@ protected InstrumentationExtension testing() {
   }
 
   @Override
-  public void createCollection(String dbName, String collectionName) {
+  protected void createCollection(String dbName, String collectionName) {
     MongoDatabase db = client.getDatabase(dbName);
     db.createCollection(collectionName, toCallback(result -> {}));
   }
 
   @Override
-  public void createCollectionNoDescription(String dbName, String collectionName) {
-    MongoDatabase db = MongoClients.create("mongodb://" + host + ":" + port).getDatabase(dbName);
-    db.createCollection(collectionName, toCallback(result -> {}));
+  protected void createCollectionNoDescription(String dbName, String collectionName) {
+    MongoClient mongoClient = MongoClients.create("mongodb://" + host + ":" + port);
+    cleanup.deferAfterAll(mongoClient);
+    mongoClient.getDatabase(dbName).createCollection(collectionName, toCallback(result -> {}));
   }
 
   @Override
-  public void createCollectionWithAlreadyBuiltClientOptions(String dbName, String collectionName) {
+  protected void createCollectionWithAlreadyBuiltClientOptions(
+      String dbName, String collectionName) {
     MongoClientSettings clientSettings = client.getSettings();
     MongoClientSettings newClientSettings = MongoClientSettings.builder(clientSettings).build();
-    MongoDatabase db = MongoClients.create(newClientSettings).getDatabase(dbName);
-    db.createCollection(collectionName, toCallback(result -> {}));
+    MongoClient mongoClient = MongoClients.create(newClientSettings);
+    cleanup.deferAfterAll(mongoClient);
+    mongoClient.getDatabase(dbName).createCollection(collectionName, toCallback(result -> {}));
   }
 
   @Override
-  public void createCollectionCallingBuildTwice(String dbName, String collectionName) {
+  protected void createCollectionCallingBuildTwice(String dbName, String collectionName) {
     MongoClientSettings.Builder settings =
         MongoClientSettings.builder()
             .clusterSettings(
@@ -94,20 +93,21 @@ public void createCollectionCallingBuildTwice(String dbName, String collectionNa
                     .applyConnectionString(new ConnectionString("mongodb://" + host + ":" + port))
                     .build());
     settings.build();
-    MongoDatabase db = MongoClients.create(settings.build()).getDatabase(dbName);
-    db.createCollection(collectionName, toCallback(result -> {}));
+    MongoClient mongoClient = MongoClients.create(settings.build());
+    cleanup.deferAfterAll(mongoClient);
+    mongoClient.getDatabase(dbName).createCollection(collectionName, toCallback(result -> {}));
   }
 
   @Override
-  public long getCollection(String dbName, String collectionName) {
+  protected long getCollection(String dbName, String collectionName) {
     MongoDatabase db = client.getDatabase(dbName);
     CompletableFuture<Long> count = new CompletableFuture<>();
     db.getCollection(collectionName).count(toCallback(o -> count.complete(((Long) o))));
     return count.join();
   }
 
   @Override
-  public MongoCollection<Document> setupInsert(String dbName, String collectionName)
+  protected MongoCollection<Document> setupInsert(String dbName, String collectionName)
       throws InterruptedException {
     MongoCollection<Document> collection =
         testing()
@@ -125,7 +125,7 @@ public MongoCollection<Document> setupInsert(String dbName, String collectionNam
   }
 
   @Override
-  public long insert(MongoCollection<Document> collection) {
+  protected long insert(MongoCollection<Document> collection) {
     CompletableFuture<Long> count = new CompletableFuture<>();
     collection.insertOne(
         new Document("password", "SECRET"),
@@ -134,7 +134,7 @@ public long insert(MongoCollection<Document> collection) {
   }
 
   @Override
-  public MongoCollection<Document> setupUpdate(String dbName, String collectionName)
+  protected MongoCollection<Document> setupUpdate(String dbName, String collectionName)
       throws InterruptedException {
     MongoCollection<Document> collection =
         testing()
@@ -157,7 +157,7 @@ public MongoCollection<Document> setupUpdate(String dbName, String collectionNam
   }
 
   @Override
-  public long update(MongoCollection<Document> collection) {
+  protected long update(MongoCollection<Document> collection) {
     CompletableFuture<UpdateResult> result = new CompletableFuture<>();
     CompletableFuture<Long> count = new CompletableFuture<>();
     collection.updateOne(
@@ -172,7 +172,7 @@ public long update(MongoCollection<Document> collection) {
   }
 
   @Override
-  public MongoCollection<Document> setupDelete(String dbName, String collectionName)
+  protected MongoCollection<Document> setupDelete(String dbName, String collectionName)
       throws InterruptedException {
     MongoCollection<Document> collection =
         testing()
@@ -195,7 +195,7 @@ public MongoCollection<Document> setupDelete(String dbName, String collectionNam
   }
 
   @Override
-  public long delete(MongoCollection<Document> collection) {
+  protected long delete(MongoCollection<Document> collection) {
     CompletableFuture<DeleteResult> result = new CompletableFuture<>();
     CompletableFuture<Long> count = new CompletableFuture<>();
     collection.deleteOne(
@@ -209,17 +209,17 @@ public long delete(MongoCollection<Document> collection) {
   }
 
   @Override
-  public MongoCollection<Document> setupGetMore(String dbName, String collectionName) {
+  protected MongoCollection<Document> setupGetMore(String dbName, String collectionName) {
     return abort("not tested on async");
   }
 
   @Override
-  public void getMore(MongoCollection<Document> collection) {
+  protected void getMore(MongoCollection<Document> collection) {
     abort("not tested on async");
   }
 
   @Override
-  public void error(String dbName, String collectionName) throws Throwable {
+  protected void error(String dbName, String collectionName) throws Throwable {
     MongoCollection<Document> collection =
         testing()
             .runWithSpan(
@@ -240,7 +240,7 @@ public void error(String dbName, String collectionName) throws Throwable {
     throw result.join();
   }
 
-  <T> SingleResultCallback<T> toCallback(Consumer<Object> closure) {
+  private static <T> SingleResultCallback<T> toCallback(Consumer<Object> closure) {
     return (result, t) -> {
       if (t != null) {
         closure.accept(t);

instrumentation/mongo/mongo-async-3.3/metadata.yaml

@@ -8,12 +8,14 @@ semantic_conventions:
 library_link: https://www.mongodb.com/docs/drivers/java-drivers/
 configurations:
   - name: otel.instrumentation.mongo.query-sanitization.enabled
+    declarative_name: java.mongo.query_sanitization.enabled
     description: >
       Enables query sanitization for MongoDB queries. Takes precedence over
       otel.instrumentation.common.db.query-sanitization.enabled.
     type: boolean
     default: true
   - name: otel.instrumentation.common.db.query-sanitization.enabled
+    declarative_name: java.common.db.query_sanitization.enabled
     description: Enables query sanitization for database queries.
     type: boolean
     default: true