Provide GraalVM metadata and substitutions (#1357)

JAVA-5219
JAVA-5408

Author: stIncMale

bson/src/main/resources/META-INF/native-image/org.mongodb/bson/native-image.properties renamed to bson/src/main/resources/META-INF/native-image/native-image.properties

@@ -0,0 +1,17 @@
+[
+{
+  "name":"java.lang.Object",
+  "queryAllDeclaredMethods":true
+},
+{
+  "name":"sun.security.provider.NativePRNG",
+  "methods":[{"name":"<init>","parameterTypes":[] }, {"name":"<init>","parameterTypes":["java.security.SecureRandomParameters"] }]
+},
+{
+  "name":"sun.security.provider.SHA",
+  "methods":[{"name":"<init>","parameterTypes":[] }]
+},
+{
+  "name":"org.slf4j.Logger"
+}
+]

bson/src/main/resources/META-INF/native-image/reflect-config.json

@@ -58,6 +58,7 @@ ext {
     projectReactorVersion = '2022.0.0'
     junitBomVersion = '5.10.2'
     logbackVersion = '1.3.14'
+    graalSdkVersion = '24.0.0'
     gitVersion = getGitVersion()
 }
 

build.gradle

@@ -46,6 +46,7 @@ dependencies {
     api "io.netty:netty-buffer", optional
     api "io.netty:netty-transport", optional
     api "io.netty:netty-handler", optional
+    compileOnly "org.graalvm.sdk:graal-sdk:$graalSdkVersion"
 
     // Optionally depend on both AWS SDK v2 and v1.  The driver will use v2 is present, v1 if present, or built-in functionality if
     // neither are present

driver-core/build.gradle

@@ -17,12 +17,14 @@
 package com.mongodb;
 
 import com.mongodb.annotations.Immutable;
+import com.mongodb.internal.graalvm.substitution.UnixServerAddressSubstitution;
 
 import static com.mongodb.assertions.Assertions.isTrueArgument;
 import static com.mongodb.assertions.Assertions.notNull;
 
 /**
  * Represents the location of a MongoD unix domain socket.
+ * It is {@linkplain UnixServerAddressSubstitution not supported in GraalVM native image}.
  *
  * <p>Requires the 'jnr.unixsocket' library.</p>
  * @since 3.7
@@ -34,10 +36,18 @@ public final class UnixServerAddress extends ServerAddress {
     /**
      * Creates a new instance
      * @param path the path of the MongoD unix domain socket.
+     * @throws UnsupportedOperationException If {@linkplain UnixServerAddressSubstitution called in a GraalVM native image}.
      */
     public UnixServerAddress(final String path) {
         super(notNull("The path cannot be null", path));
         isTrueArgument("The path must end in .sock", path.endsWith(".sock"));
+        checkNotInGraalVmNativeImage();
+    }
+
+    /**
+     * @throws UnsupportedOperationException If {@linkplain UnixServerAddressSubstitution called in a GraalVM native image}.
+     */
+    private static void checkNotInGraalVmNativeImage() {
     }
 
     @Override

driver-core/src/main/com/mongodb/UnixServerAddress.java

@@ -32,7 +32,10 @@
 import java.util.Hashtable;
 import java.util.List;
 
-final class JndiDnsClient implements DnsClient {
+/**
+ * <p>This class is not part of the public API and may be removed or changed at any time</p>
+ */
+public final class JndiDnsClient implements DnsClient {
 
     @Override
     public List<String> getResourceRecordData(final String name, final String type) throws DnsException {

driver-core/src/main/com/mongodb/internal/dns/JndiDnsClient.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2008-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.mongodb.internal.graalvm.substitution;
+
+import com.mongodb.UnixServerAddress;
+import com.oracle.svm.core.annotate.Substitute;
+import com.oracle.svm.core.annotate.TargetClass;
+
+@TargetClass(UnixServerAddress.class)
+public final class UnixServerAddressSubstitution {
+    @Substitute
+    private static void checkNotInGraalVmNativeImage() {
+        throw new UnsupportedOperationException("UnixServerAddress is not supported in GraalVM native image");
+    }
+
+    private UnixServerAddressSubstitution() {
+    }
+}

driver-core/src/main/com/mongodb/internal/graalvm/substitution/UnixServerAddressSubstitution.java

@@ -18,4 +18,5 @@ Args =\
     com.mongodb.UnixServerAddress,\
     com.mongodb.internal.connection.SnappyCompressor,\
     com.mongodb.internal.connection.ClientMetadataHelper,\
-    com.mongodb.internal.connection.ServerAddressHelper
+    com.mongodb.internal.connection.ServerAddressHelper,\
+    com.mongodb.internal.dns.DefaultDnsResolver

driver-core/src/main/resources/META-INF/native-image/org.mongodb/bson/native-image.properties renamed to driver-core/src/main/resources/META-INF/native-image/native-image.properties

@@ -0,0 +1,83 @@
+[
+{
+  "name":"com.mongodb.BasicDBObject",
+  "methods":[{"name":"<init>","parameterTypes":[] }]
+},
+{
+  "name":"com.mongodb.MongoNamespace",
+  "allDeclaredFields":true,
+  "queryAllDeclaredMethods":true,
+  "queryAllDeclaredConstructors":true
+},
+{
+  "name":"com.mongodb.WriteConcern",
+  "allPublicFields":true
+},
+{
+  "name":"com.mongodb.client.model.changestream.ChangeStreamDocument",
+  "allDeclaredFields":true,
+  "queryAllDeclaredMethods":true,
+  "queryAllDeclaredConstructors":true,
+  "methods":[{"name":"<init>","parameterTypes":["java.lang.String","org.bson.BsonDocument","org.bson.BsonDocument","org.bson.BsonDocument","java.lang.Object","java.lang.Object","org.bson.BsonDocument","org.bson.BsonTimestamp","com.mongodb.client.model.changestream.UpdateDescription","org.bson.BsonInt64","org.bson.BsonDocument","org.bson.BsonDateTime","com.mongodb.client.model.changestream.SplitEvent","org.bson.BsonDocument"] }]
+},
+{
+  "name":"com.mongodb.client.model.changestream.SplitEvent",
+  "allDeclaredFields":true,
+  "queryAllDeclaredMethods":true,
+  "queryAllDeclaredConstructors":true
+},
+{
+  "name":"com.mongodb.client.model.changestream.TruncatedArray",
+  "allDeclaredFields":true,
+  "queryAllDeclaredMethods":true,
+  "queryAllDeclaredConstructors":true
+},
+{
+  "name":"com.mongodb.client.model.changestream.UpdateDescription",
+  "allDeclaredFields":true,
+  "queryAllDeclaredMethods":true,
+  "queryAllDeclaredConstructors":true,
+  "methods":[{"name":"<init>","parameterTypes":["java.util.List","org.bson.BsonDocument","java.util.List","org.bson.BsonDocument"] }]
+},
+{
+  "name":"java.lang.Record"
+},
+{
+  "name":"java.lang.Thread",
+  "fields":[{"name":"threadLocalRandomProbe"}]
+},
+{
+  "name":"java.net.Socket",
+  "methods":[{"name":"setOption","parameterTypes":["java.net.SocketOption","java.lang.Object"] }]
+},
+{
+  "name":"java.security.SecureRandomParameters"
+},
+{
+  "name":"java.util.concurrent.ForkJoinTask",
+  "fields":[{"name":"aux"}, {"name":"status"}]
+},
+{
+  "name":"java.util.concurrent.atomic.Striped64",
+  "fields":[{"name":"base"}, {"name":"cellsBusy"}]
+},
+{
+  "name":"jdk.internal.misc.Unsafe"
+},
+{
+  "name":"jdk.net.ExtendedSocketOptions",
+  "fields":[{"name":"TCP_KEEPCOUNT"}, {"name":"TCP_KEEPIDLE"}, {"name":"TCP_KEEPINTERVAL"}]
+},
+{
+  "name":"org.bson.codecs.kotlin.DataClassCodecProvider"
+},
+{
+  "name":"org.bson.codecs.kotlinx.KotlinSerializerCodecProvider"
+},
+{
+  "name":"org.bson.codecs.record.RecordCodecProvider"
+},
+{
+  "name":"org.slf4j.Logger"
+}
+]

driver-core/src/main/resources/META-INF/native-image/reflect-config.json

@@ -1,6 +1,8 @@
 {
   "resources":{
   "includes":[{
+    "pattern":"\\QMETA-INF/services/com.mongodb.spi.dns.DnsClientProvider\\E"
+  }, {
     "pattern":"\\QMETA-INF/services/com.mongodb.spi.dns.InetAddressResolverProvider\\E"
   }]},
   "bundles":[]