MongoDriverSettings.timescaleMS.

Combine recoveryPollingMS and flushTimeoutMS into a single "timescale" setting.

Tuning a multitude of individual timeouts is not a reasonable thing to
ask users to do. Just ask them about how responsive they want the system
to be, and then we can take the responsibility of balancing the actual
individual timeout settings in a way that makes sense given how all the
parts of this rather complex driver work together.

This is something I already did in the SQL driver. I'll likely also copy
the patienceFactor idea too.

Author: prdoyle

bosk-mongo/src/main/java/works/bosk/drivers/mongo/ChangeReceiver.java

@@ -59,7 +59,7 @@ class ChangeReceiver implements Closeable {
 		ex.scheduleWithFixedDelay(
 			this::connectionLoop,
 			0,
-			settings.recoveryPollingMS(),
+			settings.timescaleMS(),
 			MILLISECONDS
 		);
 	}
@@ -73,7 +73,7 @@ public void close() {
 
 	/**
 	 * This method has a loop to do immediate reconnections and skip the
-	 * {@link MongoDriverSettings#recoveryPollingMS() recoveryPollingMS} delay,
+	 * {@link MongoDriverSettings#timescaleMS() recoveryPollingMS} delay,
 	 * but besides that, exiting this method has the same effect as continuing
 	 * around the loop.
 	 */
@@ -200,7 +200,7 @@ private void addContextToException(Throwable x) {
 	private MongoChangeStreamCursor<ChangeStreamDocument<BsonDocument>> openCursor() {
 		MongoChangeStreamCursor<ChangeStreamDocument<BsonDocument>> result = collection
 			.watch()
-			.maxAwaitTime(settings.recoveryPollingMS(), MILLISECONDS)
+			.maxAwaitTime(settings.timescaleMS(), MILLISECONDS)
 			.cursor();
 		LOGGER.debug("Cursor is open");
 		return result;

bosk-mongo/src/main/java/works/bosk/drivers/mongo/FlushLock.java

@@ -92,7 +92,7 @@ void awaitRevision(BsonInt64 revision) throws InterruptedException, FlushFailure
 		}
 		if (revisionValue > past) {
 			LOGGER.debug("Awaiting revision {} > {} [{}]", revisionValue, past, identityHashCode(this));
-			if (!semaphore.tryAcquire(settings.flushTimeoutMS(), MILLISECONDS)) {
+			if (!semaphore.tryAcquire(settings.timescaleMS(), MILLISECONDS)) {
 				throw new FlushFailureException("Timed out waiting for revision " + revisionValue + " > " + alreadySeen);
 			}
 			if (isClosed) {

bosk-mongo/src/main/java/works/bosk/drivers/mongo/MainDriver.java

@@ -421,7 +421,7 @@ public void onConnectionSucceeded() throws
 		private void runInitialRootAction(FutureTask<R> initialRootAction) throws InterruptedException, TimeoutException, InitialRootActionException {
 			initialRootAction.run();
 			try {
-				initialRootAction.get(5 * driverSettings.recoveryPollingMS(), MILLISECONDS);
+				initialRootAction.get(5 * driverSettings.timescaleMS(), MILLISECONDS);
 				LOGGER.debug("initialRoot action completed successfully");
 			} catch (ExecutionException e) {
 				LOGGER.debug("initialRoot action failed", e);
@@ -621,7 +621,7 @@ private <X extends Exception, Y extends Exception> void doRetryableDriverOperati
 	private <X extends Exception, Y extends Exception> void waitAndRetry(RetryableOperation<X, Y> operation, String description, Object... args) throws X, Y {
 		try {
 			formatDriverLock.lock();
-			long waitTimeMS = 5 * driverSettings.recoveryPollingMS();
+			long waitTimeMS = 5 * driverSettings.timescaleMS();
 			LOGGER.debug("Waiting for new FormatDriver for {} ms", waitTimeMS);
 			boolean success = formatDriverChanged.await(waitTimeMS, MILLISECONDS);
 			if (!success) {

bosk-mongo/src/main/java/works/bosk/drivers/mongo/MongoDriverSettings.java

@@ -13,8 +13,8 @@
 public class MongoDriverSettings {
 	String database;
 
-	@Default long flushTimeoutMS = 30_000;
-	@Default long recoveryPollingMS = 30_000;
+	@Default long timescaleMS = 30_000;
+
 	/**
 	 * @see DatabaseFormat#SEQUOIA
 	 * @see PandoFormat

bosk-mongo/src/test/java/works/bosk/drivers/mongo/MongoDriverRecoveryTest.java

@@ -58,8 +58,7 @@ static Stream<TestParameters.ParameterSet> parameters() {
 			),
 			Stream.of(TestParameters.EventTiming.NORMAL)
 		).map(b -> b.applyDriverSettings(s -> s
-			.recoveryPollingMS(1500) // Note that some tests can take as long as 10x this
-			.flushTimeoutMS(2000) // A little more than recoveryPollingMS
+			.timescaleMS(1500) // Note that some tests can take as long as 10x this
 		));
 	}
 
@@ -127,7 +126,7 @@ private void waitFor(BoskDriver driver) throws IOException, InterruptedException
 				driver.flush();
 				break;
 			case WAIT:
-				Thread.sleep(2 * driverSettings.recoveryPollingMS());
+				Thread.sleep(2 * driverSettings.timescaleMS());
 				break;
 		}
 	}

bosk-mongo/src/test/java/works/bosk/drivers/mongo/TestParameters.java

@@ -25,8 +25,7 @@ public static ParameterSet from(MongoDriverSettings.DatabaseFormat format, Event
 				timing + "," + format,
 				MongoDriverSettings.builder()
 					.preferredDatabaseFormat(format)
-					.recoveryPollingMS(3000) // Note that some tests can take as long as 10x this
-					.flushTimeoutMS(4000) // A little more than recoveryPollingMS
+					.timescaleMS(3000) // Note that some tests can take as long as 10x this
 					.testing(MongoDriverSettings.Testing.builder()
 						.eventDelayMS(timing.eventDelayMS)
 						.build())