mreutegg commented on a change in pull request #295:
URL: https://github.com/apache/jackrabbit-oak/pull/295#discussion_r641528524
##########
File path:
oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/util/MongoConnection.java
##########
@@ -300,4 +308,65 @@ public static ReadConcernLevel
readConcernLevel(ReadConcern readConcern) {
return
ReadConcernLevel.fromString(readConcern.asDocument().getString("level").getValue());
}
}
+
+ /**
+ * Returns {@code true} if the MongoDB server is part of a Replica Set,
+ * {@code false} otherwise. The Replica Set Status is achieved by the
+ * ReplicaSetStatusListener, which is triggered whenever the cluster
+ * description changes.
+ *
+ * @param client the mongo client.
+ * @return {@code true} if part of Replica Set, {@code false} otherwise.
+ */
+ public static boolean isReplicaSet(@NotNull MongoClient client) {
+ MongoClusterListener listener = getOakClusterListener(client);
+ if (listener != null) {
+ return listener.isReplicaSet();
+ }
+ System.out.println("Method isReplicaSet called for a MongoClient
without any OakClusterListener!");
+ LOG.warn("Method isReplicaSet called for a MongoClient without any
OakClusterListener!");
+ return false;
+ }
+
+ /**
+ * Returns the {@ServerAddress} of the MongoDB cluster.
+ *
+ * @param client the mongo client.
+ * @return {@ServerAddress} of the cluster. {@null} if not connected or no
listener was available.
+ */
+ public static ServerAddress getAddress(@NotNull MongoClient client) {
+ MongoClusterListener listener = getOakClusterListener(client);
+ if (listener != null) {
+ return listener.getServerAddress();
+ }
+ System.out.println("Method getAddress called for a MongoClient without
any OakClusterListener!");
Review comment:
Same as above.
##########
File path:
oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/util/MongoConnection.java
##########
@@ -300,4 +308,65 @@ public static ReadConcernLevel
readConcernLevel(ReadConcern readConcern) {
return
ReadConcernLevel.fromString(readConcern.asDocument().getString("level").getValue());
}
}
+
+ /**
+ * Returns {@code true} if the MongoDB server is part of a Replica Set,
+ * {@code false} otherwise. The Replica Set Status is achieved by the
+ * ReplicaSetStatusListener, which is triggered whenever the cluster
+ * description changes.
+ *
+ * @param client the mongo client.
+ * @return {@code true} if part of Replica Set, {@code false} otherwise.
+ */
+ public static boolean isReplicaSet(@NotNull MongoClient client) {
+ MongoClusterListener listener = getOakClusterListener(client);
+ if (listener != null) {
+ return listener.isReplicaSet();
+ }
+ System.out.println("Method isReplicaSet called for a MongoClient
without any OakClusterListener!");
Review comment:
Please do not use System.out. Writing to the logger is sufficient.
##########
File path:
oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/util/MongoConnection.java
##########
@@ -27,18 +27,27 @@
import com.mongodb.MongoException;
import com.mongodb.ReadConcern;
import com.mongodb.ReadConcernLevel;
+import com.mongodb.ServerAddress;
import com.mongodb.WriteConcern;
import com.mongodb.client.MongoDatabase;
import static com.google.common.base.Preconditions.checkNotNull;
+import com.mongodb.event.ClusterListener;
+import org.apache.jackrabbit.oak.plugins.document.mongo.MongoUtils;
+import org.apache.jackrabbit.oak.plugins.document.mongo.MongoClusterListener;
import org.jetbrains.annotations.NotNull;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
/**
* The {@code MongoConnection} abstracts connection to the {@code MongoDB}.
*/
public class MongoConnection {
+ public static final String MONGODB_PREFIX = "mongodb://";
+
+ private static final Logger LOG =
LoggerFactory.getLogger(MongoUtils.class);
Review comment:
This is the wrong class for the logger. It should get the logger for
`MongoConnection`.
##########
File path:
oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/mongo/MongoUtils.java
##########
@@ -31,18 +29,19 @@
import com.mongodb.client.FindIterable;
import com.mongodb.client.MongoCollection;
import com.mongodb.client.model.IndexOptions;
-
import org.apache.jackrabbit.oak.plugins.document.DocumentStoreException.Type;
import org.bson.Document;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
+import java.util.Set;
+
import static com.google.common.base.Preconditions.checkArgument;
/**
* Provides static utility methods for MongoDB.
*/
-class MongoUtils {
+public class MongoUtils {
Review comment:
This is unnecessary because its only incorrect use is to get a logger
for this class in `MongoConnection`.
##########
File path:
oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/mongo/MongoClusterListener.java
##########
@@ -0,0 +1,88 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.jackrabbit.oak.plugins.document.mongo;
+
+import com.mongodb.ServerAddress;
+import com.mongodb.connection.ServerConnectionState;
+import com.mongodb.connection.ServerDescription;
+import com.mongodb.event.ClusterClosedEvent;
+import com.mongodb.event.ClusterDescriptionChangedEvent;
+import com.mongodb.event.ClusterListener;
+import com.mongodb.event.ClusterOpeningEvent;
+
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+
+public class MongoClusterListener implements ClusterListener {
+
+ // Sometimes we need to wait a few seconds in case the connection was just
created, the listener
+ // didn't have time to receive the description from the cluster. This
latch is used to check
+ // if the connection was properly initialized.
+ private final CountDownLatch latch;
+ private boolean replicaSet = false;
+ private ServerAddress serverAddress;
+ private ServerAddress primaryAddress;
+
+ public MongoClusterListener() {
+ latch = new CountDownLatch(1);
+ }
+
+ public ServerAddress getServerAddress() {
+ try {
+ latch.await(15, TimeUnit.SECONDS);
+ } catch (InterruptedException e) {}
+ return serverAddress;
+ }
+
+ public ServerAddress getPrimaryAddress() {
+ try {
+ latch.await(15, TimeUnit.SECONDS);
+ } catch (InterruptedException e) {}
+ return primaryAddress;
+ }
+
+ public boolean isReplicaSet() {
+ try {
+ latch.await(15, TimeUnit.SECONDS);
+ } catch (InterruptedException e) {}
+ return replicaSet;
+ }
+
+ @Override
+ public void clusterOpening(ClusterOpeningEvent event) {
+ }
+
+ @Override
+ public void clusterClosed(ClusterClosedEvent event) {
Review comment:
Same as above.
##########
File path:
oak-store-document/src/test/java/org/apache/jackrabbit/oak/plugins/document/MongoDbTest.java
##########
@@ -201,7 +201,8 @@ public void updateDocument() {
private static BasicDBObject explain(MongoCollection<BasicDBObject>
collection,
Bson query) {
- return collection.find(query).modifiers(new BasicDBObject("$explain",
true)).first();
+ //TODO: Determine if this test is still needed. Modifiers is removed
in driver 4, so this has to be reworked
+ return collection.find(query)/*.modifiers(new
BasicDBObject("$explain", true))*/.first();
Review comment:
While those tests are all ignored, this can still be fixed. I think
simply calling `collection.find(query).explain(BasicDBObject.class)` will do
the trick.
##########
File path:
oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/util/MongoConnection.java
##########
@@ -300,4 +308,65 @@ public static ReadConcernLevel
readConcernLevel(ReadConcern readConcern) {
return
ReadConcernLevel.fromString(readConcern.asDocument().getString("level").getValue());
}
}
+
+ /**
+ * Returns {@code true} if the MongoDB server is part of a Replica Set,
+ * {@code false} otherwise. The Replica Set Status is achieved by the
+ * ReplicaSetStatusListener, which is triggered whenever the cluster
+ * description changes.
+ *
+ * @param client the mongo client.
+ * @return {@code true} if part of Replica Set, {@code false} otherwise.
+ */
+ public static boolean isReplicaSet(@NotNull MongoClient client) {
+ MongoClusterListener listener = getOakClusterListener(client);
+ if (listener != null) {
+ return listener.isReplicaSet();
+ }
+ System.out.println("Method isReplicaSet called for a MongoClient
without any OakClusterListener!");
+ LOG.warn("Method isReplicaSet called for a MongoClient without any
OakClusterListener!");
+ return false;
+ }
+
+ /**
+ * Returns the {@ServerAddress} of the MongoDB cluster.
+ *
+ * @param client the mongo client.
+ * @return {@ServerAddress} of the cluster. {@null} if not connected or no
listener was available.
+ */
+ public static ServerAddress getAddress(@NotNull MongoClient client) {
+ MongoClusterListener listener = getOakClusterListener(client);
+ if (listener != null) {
+ return listener.getServerAddress();
+ }
+ System.out.println("Method getAddress called for a MongoClient without
any OakClusterListener!");
+ LOG.warn("Method getAddress called for a MongoClient without any
OakClusterListener!");
+ return null;
+ }
+
+ /**
+ * Returns the {@ServerAddress} of the MongoDB cluster primary node.
+ *
+ * @param client the mongo client.
+ * @return {@ServerAddress} of the primary. {@null} if not connected or no
listener was available.
+ */
+ public static ServerAddress getPrimaryAddress(@NotNull MongoClient client)
{
+ MongoClusterListener listener = getOakClusterListener(client);
+ if (listener != null) {
+ return listener.getPrimaryAddress();
+ }
+ return null;
+ }
+
+ private static MongoClusterListener getOakClusterListener(@NotNull
MongoClient client) {
+ for (ClusterListener clusterListener :
client.getMongoClientOptions().getClusterListeners()) {
+ if (clusterListener instanceof MongoClusterListener) {
+ MongoClusterListener replClusterListener =
(MongoClusterListener) clusterListener;
+ return replClusterListener;
+ }
+ }
+ System.out.println("No OakClusterListener found for this
MongoClient!");
Review comment:
Same as above.
##########
File path:
oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/mongo/MongoClusterListener.java
##########
@@ -0,0 +1,88 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.jackrabbit.oak.plugins.document.mongo;
+
+import com.mongodb.ServerAddress;
+import com.mongodb.connection.ServerConnectionState;
+import com.mongodb.connection.ServerDescription;
+import com.mongodb.event.ClusterClosedEvent;
+import com.mongodb.event.ClusterDescriptionChangedEvent;
+import com.mongodb.event.ClusterListener;
+import com.mongodb.event.ClusterOpeningEvent;
+
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+
+public class MongoClusterListener implements ClusterListener {
+
+ // Sometimes we need to wait a few seconds in case the connection was just
created, the listener
+ // didn't have time to receive the description from the cluster. This
latch is used to check
+ // if the connection was properly initialized.
+ private final CountDownLatch latch;
+ private boolean replicaSet = false;
+ private ServerAddress serverAddress;
+ private ServerAddress primaryAddress;
+
+ public MongoClusterListener() {
+ latch = new CountDownLatch(1);
+ }
+
+ public ServerAddress getServerAddress() {
+ try {
Review comment:
Can you please move the latch.await and exception handling into a
separate method and reuse?
##########
File path: oak-parent/pom.xml
##########
@@ -54,7 +54,7 @@
<segment.db>SegmentMK</segment.db>
<lucene.version>4.7.1</lucene.version>
<solr.version>8.6.3</solr.version>
- <mongo.driver.version>3.12.7</mongo.driver.version>
+ <mongo.driver.version>4.2.1</mongo.driver.version>
Review comment:
Can you please update to 4.2.3? That seems to be the most recently
available.
##########
File path:
oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/util/MongoConnection.java
##########
@@ -300,4 +308,65 @@ public static ReadConcernLevel
readConcernLevel(ReadConcern readConcern) {
return
ReadConcernLevel.fromString(readConcern.asDocument().getString("level").getValue());
}
}
+
+ /**
+ * Returns {@code true} if the MongoDB server is part of a Replica Set,
+ * {@code false} otherwise. The Replica Set Status is achieved by the
+ * ReplicaSetStatusListener, which is triggered whenever the cluster
+ * description changes.
+ *
+ * @param client the mongo client.
+ * @return {@code true} if part of Replica Set, {@code false} otherwise.
+ */
+ public static boolean isReplicaSet(@NotNull MongoClient client) {
+ MongoClusterListener listener = getOakClusterListener(client);
+ if (listener != null) {
+ return listener.isReplicaSet();
+ }
+ System.out.println("Method isReplicaSet called for a MongoClient
without any OakClusterListener!");
+ LOG.warn("Method isReplicaSet called for a MongoClient without any
OakClusterListener!");
+ return false;
+ }
+
+ /**
+ * Returns the {@ServerAddress} of the MongoDB cluster.
+ *
+ * @param client the mongo client.
+ * @return {@ServerAddress} of the cluster. {@null} if not connected or no
listener was available.
+ */
+ public static ServerAddress getAddress(@NotNull MongoClient client) {
+ MongoClusterListener listener = getOakClusterListener(client);
+ if (listener != null) {
+ return listener.getServerAddress();
+ }
+ System.out.println("Method getAddress called for a MongoClient without
any OakClusterListener!");
+ LOG.warn("Method getAddress called for a MongoClient without any
OakClusterListener!");
+ return null;
+ }
+
+ /**
+ * Returns the {@ServerAddress} of the MongoDB cluster primary node.
+ *
+ * @param client the mongo client.
+ * @return {@ServerAddress} of the primary. {@null} if not connected or no
listener was available.
+ */
+ public static ServerAddress getPrimaryAddress(@NotNull MongoClient client)
{
+ MongoClusterListener listener = getOakClusterListener(client);
+ if (listener != null) {
+ return listener.getPrimaryAddress();
+ }
+ return null;
+ }
+
+ private static MongoClusterListener getOakClusterListener(@NotNull
MongoClient client) {
+ for (ClusterListener clusterListener :
client.getMongoClientOptions().getClusterListeners()) {
+ if (clusterListener instanceof MongoClusterListener) {
+ MongoClusterListener replClusterListener =
(MongoClusterListener) clusterListener;
+ return replClusterListener;
+ }
+ }
+ System.out.println("No OakClusterListener found for this
MongoClient!");
+ LOG.warn("No OakClusterListener found for this MongoClient!");
Review comment:
In this case, I wouldn't log a warning. Returning null when there is no
OakClusterListener is valid. I would leave it up to the caller to decide
whether a WARN message is appropriate, depending on the context.
##########
File path:
oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/mongo/MongoClusterListener.java
##########
@@ -0,0 +1,88 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.jackrabbit.oak.plugins.document.mongo;
+
+import com.mongodb.ServerAddress;
+import com.mongodb.connection.ServerConnectionState;
+import com.mongodb.connection.ServerDescription;
+import com.mongodb.event.ClusterClosedEvent;
+import com.mongodb.event.ClusterDescriptionChangedEvent;
+import com.mongodb.event.ClusterListener;
+import com.mongodb.event.ClusterOpeningEvent;
+
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+
+public class MongoClusterListener implements ClusterListener {
+
+ // Sometimes we need to wait a few seconds in case the connection was just
created, the listener
+ // didn't have time to receive the description from the cluster. This
latch is used to check
+ // if the connection was properly initialized.
+ private final CountDownLatch latch;
+ private boolean replicaSet = false;
+ private ServerAddress serverAddress;
+ private ServerAddress primaryAddress;
+
+ public MongoClusterListener() {
+ latch = new CountDownLatch(1);
+ }
+
+ public ServerAddress getServerAddress() {
+ try {
+ latch.await(15, TimeUnit.SECONDS);
+ } catch (InterruptedException e) {}
+ return serverAddress;
+ }
+
+ public ServerAddress getPrimaryAddress() {
+ try {
+ latch.await(15, TimeUnit.SECONDS);
+ } catch (InterruptedException e) {}
+ return primaryAddress;
+ }
+
+ public boolean isReplicaSet() {
+ try {
+ latch.await(15, TimeUnit.SECONDS);
+ } catch (InterruptedException e) {}
+ return replicaSet;
+ }
+
+ @Override
+ public void clusterOpening(ClusterOpeningEvent event) {
Review comment:
The default implementation is already a NOP. Overriding the method is
not necessary.
##########
File path:
oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/mongo/MongoClusterListener.java
##########
@@ -0,0 +1,88 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.jackrabbit.oak.plugins.document.mongo;
+
+import com.mongodb.ServerAddress;
+import com.mongodb.connection.ServerConnectionState;
+import com.mongodb.connection.ServerDescription;
+import com.mongodb.event.ClusterClosedEvent;
+import com.mongodb.event.ClusterDescriptionChangedEvent;
+import com.mongodb.event.ClusterListener;
+import com.mongodb.event.ClusterOpeningEvent;
+
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+
+public class MongoClusterListener implements ClusterListener {
+
+ // Sometimes we need to wait a few seconds in case the connection was just
created, the listener
+ // didn't have time to receive the description from the cluster. This
latch is used to check
+ // if the connection was properly initialized.
+ private final CountDownLatch latch;
+ private boolean replicaSet = false;
+ private ServerAddress serverAddress;
+ private ServerAddress primaryAddress;
+
+ public MongoClusterListener() {
+ latch = new CountDownLatch(1);
+ }
+
+ public ServerAddress getServerAddress() {
Review comment:
Can you please add a `@Nullable` annotation for the return?
##########
File path:
oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/mongo/MongoClusterListener.java
##########
@@ -0,0 +1,88 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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 org.apache.jackrabbit.oak.plugins.document.mongo;
+
+import com.mongodb.ServerAddress;
+import com.mongodb.connection.ServerConnectionState;
+import com.mongodb.connection.ServerDescription;
+import com.mongodb.event.ClusterClosedEvent;
+import com.mongodb.event.ClusterDescriptionChangedEvent;
+import com.mongodb.event.ClusterListener;
+import com.mongodb.event.ClusterOpeningEvent;
+
+import java.util.concurrent.CountDownLatch;
+import java.util.concurrent.TimeUnit;
+
+public class MongoClusterListener implements ClusterListener {
+
+ // Sometimes we need to wait a few seconds in case the connection was just
created, the listener
+ // didn't have time to receive the description from the cluster. This
latch is used to check
+ // if the connection was properly initialized.
+ private final CountDownLatch latch;
+ private boolean replicaSet = false;
+ private ServerAddress serverAddress;
+ private ServerAddress primaryAddress;
+
+ public MongoClusterListener() {
+ latch = new CountDownLatch(1);
+ }
+
+ public ServerAddress getServerAddress() {
+ try {
+ latch.await(15, TimeUnit.SECONDS);
+ } catch (InterruptedException e) {}
+ return serverAddress;
+ }
+
+ public ServerAddress getPrimaryAddress() {
Review comment:
Can you please add a `@Nullable` annotation for the return?
##########
File path:
oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/mongo/MongoDocumentNodeStoreBuilderBase.java
##########
@@ -116,25 +114,6 @@ public T setMongoDB(@NotNull MongoClient client,
return setMongoDB(client, dbName, 16);
}
- /**
- * Enables or disables the socket keep-alive option for MongoDB. The
default
- * is enabled.
- *
- * @param enable whether to enable or disable it.
- * @return this
- */
- public T setSocketKeepAlive(boolean enable) {
Review comment:
To ease upgrades I'd suggest deprecating the methods first and then
remove it in a subsequent Oak release.
##########
File path:
oak-store-document/src/test/java/org/apache/jackrabbit/oak/plugins/document/mongo/MongoTestClient.java
##########
@@ -19,9 +19,11 @@
import java.util.concurrent.atomic.AtomicReference;
import com.mongodb.MongoClient;
+import com.mongodb.MongoClientOptions;
Review comment:
This import is not used.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
