Merge pull request #23 from PierreZ/watch_v2

Watch v2

Author: PierreZ

.idea/checkstyle-idea.xml

@@ -1,4 +1,4 @@
-# fdb-etcd ![https://img.shields.io/badge/vert.x-3.8.5-purple.svg](https://img.shields.io/badge/vert.x-3.8.5-purple.svg) ![gradle build](https://github.com/PierreZ/fdb-etcd/workflows/gradle%20build/badge.svg)
+# fdb-etcd ![https://img.shields.io/badge/vert.x-4.0.3-purple.svg](https://img.shields.io/badge/vert.x-3.8.5-purple.svg) ![gradle build](https://github.com/PierreZ/fdb-etcd/workflows/gradle%20build/badge.svg)
 
 An experiment to provide ETCD layer on top of FoundationDB, built with [Record-Layer](https://foundationdb.github.io/fdb-record-layer/) and [Vert.x](https://vertx.io/).
 
@@ -9,13 +9,13 @@ An experiment to provide ETCD layer on top of FoundationDB, built with [Record-L
 * Integrations test using a real FDB spawned with testcontainers and official Java etcd client,
 * Tests are backported from jetcd test cases
 * Supported operations:
-    * put,
-    * get,
-    * scan,
-    * delete,
-    * compact,
-    * leases,
-    * watches,
+  * put,
+  * get,
+  * scan,
+  * delete,
+  * compact,
+  * leases,
+  * watches,
 * ETCD MVCC simulated using FDB's read version
 * multi-tenancy (soon back by the AuthService)
 
@@ -30,20 +30,22 @@ For TODO's, please have a look to the [Github issues](https://github.com/pierrez
 * gradle 6.2.2
 * [FoundationDB Client Packages](https://www.foundationdb.org/download/)
 
-
 ### Gradle cheat-sheet
 
 To launch your tests:
+
 ```
 ./gradlew clean test
 ```
 
 To package your application:
+
 ```
 ./gradlew clean assemble
 ```
 
 To run your application:
+
 ```
 ./gradlew clean run
 ```

README.md

@@ -23,7 +23,7 @@ repositories {
 }
 
 ext {
-  vertxVersion = '3.8.5'
+  vertxVersion = '4.0.3'
   junitJupiterEngineVersion = '5.4.0'
 }
 
@@ -42,19 +42,20 @@ dependencies {
   implementation "io.vertx:vertx-grpc:$vertxVersion"
   implementation 'org.foundationdb:fdb-record-layer-core-pb3:2.8.91.0'
 
-  compile group: 'javax.annotation', name: 'javax.annotation-api', version: '1.3.2'
+  implementation group: 'io.grpc', name: 'grpc-alts', version: "1.35.0"
+
+  implementation group: 'javax.annotation', name: 'javax.annotation-api', version: '1.3.2'
 
   testImplementation "io.vertx:vertx-junit5:$vertxVersion"
-  testCompile "org.testcontainers:testcontainers:1.13.0"
+  testImplementation "org.testcontainers:testcontainers:1.15.3"
   testImplementation "io.etcd:jetcd-core:0.5.0"
 
   // https://mvnrepository.com/artifact/org.slf4j/slf4j-simple
-  testCompile group: 'org.slf4j', name: 'slf4j-simple', version: '1.7.30'
-
+  testImplementation group: 'org.slf4j', name: 'slf4j-simple', version: '1.7.30'
 
   testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitJupiterEngineVersion"
   testImplementation "org.junit.jupiter:junit-jupiter-api:$junitJupiterEngineVersion"
-  testCompile("org.junit.jupiter:junit-jupiter-params:$junitJupiterEngineVersion")
+  testImplementation("org.junit.jupiter:junit-jupiter-params:$junitJupiterEngineVersion")
 }
 
 
@@ -90,12 +91,16 @@ protobuf {
   }
   plugins {
     grpc {
-      artifact = "io.vertx:protoc-gen-grpc-java:1.25.0"
+      artifact = "io.grpc:protoc-gen-grpc-java:1.35.0"
+    }
+    vertx {
+      artifact = "io.vertx:vertx-grpc-protoc-plugin:${vertxVersion}"
     }
   }
   generateProtoTasks {
     all()*.plugins {
       grpc
+      vertx
     }
   }
 }

build.gradle

@@ -1,6 +1,5 @@
-#Sat Mar 21 15:26:57 CET 2020
-distributionUrl=https\://services.gradle.org/distributions/gradle-6.2.2-all.zip
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.0-all.zip
 zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

gradle/wrapper/gradle-wrapper.jar

@@ -1,5 +1,21 @@
 #!/usr/bin/env sh
 
+#
+# Copyright 2015 the original author or authors.
+#
+# 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
+#
+#      https://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.
+#
+
 ##############################################################################
 ##
 ##  Gradle start up script for UN*X
@@ -28,7 +44,7 @@ APP_NAME="Gradle"
 APP_BASE_NAME=`basename "$0"`
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m"'
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD="maximum"
@@ -109,8 +125,8 @@ if $darwin; then
     GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
 fi
 
-# For Cygwin, switch paths to Windows format before running java
-if $cygwin ; then
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
     APP_HOME=`cygpath --path --mixed "$APP_HOME"`
     CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
     JAVACMD=`cygpath --unix "$JAVACMD"`
@@ -138,19 +154,19 @@ if $cygwin ; then
         else
             eval `echo args$i`="\"$arg\""
         fi
-        i=$((i+1))
+        i=`expr $i + 1`
     done
     case $i in
-        (0) set -- ;;
-        (1) set -- "$args0" ;;
-        (2) set -- "$args0" "$args1" ;;
-        (3) set -- "$args0" "$args1" "$args2" ;;
-        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
-        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
-        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
-        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
-        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
-        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+        0) set -- ;;
+        1) set -- "$args0" ;;
+        2) set -- "$args0" "$args1" ;;
+        3) set -- "$args0" "$args1" "$args2" ;;
+        4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
     esac
 fi
 
@@ -159,14 +175,9 @@ save () {
     for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
     echo " "
 }
-APP_ARGS=$(save "$@")
+APP_ARGS=`save "$@"`
 
 # Collect all arguments for the java command, following the shell quoting and substitution rules
 eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
 
-# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
-if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
-  cd "$(dirname "$0")"
-fi
-
 exec "$JAVACMD" "$@"

gradle/wrapper/gradle-wrapper.properties

@@ -1,3 +1,19 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+
 @if "%DEBUG%" == "" @echo off
 @rem ##########################################################################
 @rem
@@ -13,8 +29,11 @@ if "%DIRNAME%" == "" set DIRNAME=.
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
 @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS="-Xmx64m"
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
 
 @rem Find java.exe
 if defined JAVA_HOME goto findJavaFromJavaHome

gradlew

@@ -5,8 +5,6 @@
 import fr.pierrezemb.fdb.layer.etcd.grpc.KVService;
 import fr.pierrezemb.fdb.layer.etcd.grpc.LeaseService;
 import fr.pierrezemb.fdb.layer.etcd.grpc.WatchService;
-import fr.pierrezemb.fdb.layer.etcd.notifier.Notifier;
-import fr.pierrezemb.fdb.layer.etcd.notifier.VertxNotifier;
 import fr.pierrezemb.fdb.layer.etcd.store.EtcdRecordLayer;
 import io.vertx.core.AbstractVerticle;
 import io.vertx.core.Promise;
@@ -24,23 +22,25 @@ public void start(Promise<Void> startPromise) throws Exception {
     System.out.println("connecting to fdb@" + clusterFilePath);
 
     EtcdRecordLayer recordLayer = new EtcdRecordLayer(clusterFilePath);
-    Notifier notifier = new VertxNotifier(vertx.eventBus());
 
     VertxServerBuilder serverBuilder = VertxServerBuilder
       .forAddress(vertx,
         this.context.config().getString("listen-address", "localhost"),
         this.context.config().getInteger("listen-port", 8080))
       .intercept(new AuthInterceptor(authEnabled, defaultTenant))
-      .addService(new KVService(recordLayer, notifier))
+      .addService(new KVService(recordLayer))
       .addService(new LeaseService(recordLayer))
-      .addService(new WatchService(recordLayer, notifier))
+      .addService(new WatchService(recordLayer, vertx))
       .addService(new AuthService());
 
     VertxServer server = serverBuilder.build();
 
     server.start(ar -> {
       if (ar.succeeded()) {
-        System.out.println("gRPC service started");
+        System.out.println("gRPC service started on "
+          + this.context.config().getString("listen-address", "localhost")
+          + ":"
+          + this.context.config().getInteger("listen-port", 8080));
         startPromise.complete();
       } else {
         System.out.println("Could not start server " + ar.cause().getMessage());

gradlew.bat

@@ -0,0 +1,81 @@
+package fr.pierrezemb.fdb.layer.etcd;
+
+import com.apple.foundationdb.record.query.expressions.Query;
+import com.apple.foundationdb.record.query.expressions.QueryComponent;
+import com.google.protobuf.AbstractMessageLite;
+import com.google.protobuf.ByteString;
+import fr.pierrezemb.fdb.layer.etcd.store.EtcdRecordLayer;
+import fr.pierrezemb.fdb.layer.etcd.store.LatestOperations;
+import io.vertx.core.AbstractVerticle;
+import io.vertx.core.Promise;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.concurrent.Semaphore;
+
+public class WatchVerticle extends AbstractVerticle {
+
+  private static final Logger log = LoggerFactory.getLogger(WatchVerticle.class);
+
+  private final String tenantId;
+  private final long watchID;
+  private final EtcdRecordLayer recordLayer;
+  private final QueryComponent keyQueryFilter;
+  private final Semaphore mutex;
+  private long timerID;
+  private long lastCommitedVersion;
+
+  public WatchVerticle(String tenantId, long watchId, EtcdRecordLayer recordLayer, long commitVersion, ByteString rangeStart, ByteString rangeEnd) {
+    this.tenantId = tenantId;
+    this.watchID = watchId;
+    this.recordLayer = recordLayer;
+    this.lastCommitedVersion = commitVersion;
+    this.mutex = new Semaphore(1);
+
+    this.keyQueryFilter = rangeEnd.size() == 0 ?
+      Query.field("key").equalsValue(rangeStart.toByteArray()) :
+      Query.and(
+        Query.field("key").greaterThanOrEquals(rangeStart.toByteArray()),
+        Query.field("key").lessThanOrEquals(rangeEnd.toByteArray())
+      );
+  }
+
+  @Override
+  public void start(Promise<Void> startPromise) throws Exception {
+    super.start(startPromise);
+    log.debug("started WatchService {}/{}", tenantId, this.watchID);
+    this.timerID = vertx.setTimer(10, id -> {
+      this.poll();
+    });
+  }
+
+  private void poll() {
+    long nextPollMS = 100;
+    try {
+      mutex.acquire();
+      log.trace("poll started");
+      long start = System.currentTimeMillis();
+      LatestOperations ops = this.recordLayer.retrieveLatestOperations(tenantId, lastCommitedVersion, keyQueryFilter);
+      long elapsed = System.currentTimeMillis() - start;
+      log.trace("poll finished: found {} events in {}ms", ops.events.size(), elapsed);
+
+      if (elapsed > 100 && elapsed < 1000) {
+        nextPollMS = elapsed * 2;
+      }
+
+      ops.events.stream()
+        .map(AbstractMessageLite::toByteArray)
+        .forEach(e -> this.vertx.eventBus().publish(tenantId + watchID, e));
+      log.trace("old readVersion: {}, new readVersion: {}", lastCommitedVersion, ops.readVersion);
+      this.lastCommitedVersion = ops.readVersion;
+    } catch (InterruptedException e) {
+      // exception handling code
+    } finally {
+      mutex.release();
+    }
+
+    log.trace("scheduling a poll in {}ms", nextPollMS);
+    vertx.setTimer(nextPollMS, timerID -> poll());
+  }
+
+}

src/main/java/fr/pierrezemb/fdb/layer/etcd/MainVerticle.java

@@ -7,7 +7,7 @@
 import org.slf4j.LoggerFactory;
 
 public class AuthService extends AuthGrpc.AuthImplBase {
-  private static Logger log = LoggerFactory.getLogger(AuthService.class);
+  private static final Logger log = LoggerFactory.getLogger(AuthService.class);
 
   /**
    * <pre>