[grid] After registration, do not send any more registration events

Author: diemol

java/server/src/org/openqa/selenium/grid/node/config/NodeOptions.java

@@ -38,6 +38,7 @@
 import java.lang.reflect.Modifier;
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.Collection;
 import java.util.Comparator;
@@ -79,6 +80,18 @@ public Node getNode() {
     return config.getClass(NODE_SECTION, "implementation", Node.class, DEFAULT_IMPL);
   }
 
+  public Duration getRegisterCycle() {
+    // If the user sets 0 or less, we default to 1s.
+    int seconds = Math.max(config.getInt(NODE_SECTION, "register-cycle").orElse(10), 1);
+    return Duration.ofSeconds(seconds);
+  }
+
+  public Duration getRegisterPeriod() {
+    // If the user sets 0 or less, we default to 1s.
+    int seconds = Math.max(config.getInt(NODE_SECTION, "register-period").orElse(120), 1);
+    return Duration.ofSeconds(seconds);
+  }
+
   public Map<Capabilities, Collection<SessionFactory>> getSessionFactories(
     /* Danger! Java stereotype ahead! */
     Function<Capabilities, Collection<SessionFactory>> factoryFactory) {

java/server/src/org/openqa/selenium/grid/node/httpd/NodeFlags.java

@@ -94,13 +94,26 @@ public class NodeFlags implements HasRoles {
     name = "driver-configuration",
     prefixed = true,
     example = "\n" +
-              "name = \"Firefox Nightly\"\n" +
-              "max-sessions = 2\n" +
-              "stereotype = \"{\"browserName\": \"firefox\", \"browserVersion\": \"86\", " +
-              "\"moz:firefoxOptions\": " +
-              "{\"binary\":\"/Applications/Firefox Nightly.app/Contents/MacOS/firefox-bin\"}}\"")
+      "name = \"Firefox Nightly\"\n" +
+      "max-sessions = 2\n" +
+      "stereotype = \"{\"browserName\": \"firefox\", \"browserVersion\": \"86\", " +
+      "\"moz:firefoxOptions\": " +
+      "{\"binary\":\"/Applications/Firefox Nightly.app/Contents/MacOS/firefox-bin\"}}\"")
   public List<String> driverConfiguration;
 
+  @Parameter(
+    names = "--register-cycle",
+    description = "How often, in seconds, the Node will try to register itself for the first time to the Distributor.")
+  @ConfigValue(section = "node", name = "register-cycle", example = "10")
+  public int registerCycle;
+
+  @Parameter(
+    names = "--register-period",
+    description = "How long, in seconds, will the Node try to register to the Distributor for the first time. " +
+      "After this period is completed, the Node will not attempt to register again.")
+  @ConfigValue(section = "node", name = "register-cycle", example = "120")
+  public int registerPeriod;
+
   @Override
   public Set<Role> getRoles() {
     return Collections.singleton(NODE_ROLE);

java/server/src/org/openqa/selenium/grid/node/httpd/NodeServer.java

@@ -51,11 +51,10 @@
 import org.openqa.selenium.remote.http.Route;
 import org.openqa.selenium.remote.tracing.Tracer;
 
-import java.time.Duration;
-import java.time.temporal.ChronoUnit;
 import java.util.Collections;
 import java.util.Set;
 import java.util.concurrent.Executors;
+import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.logging.Logger;
 
 import static java.net.HttpURLConnection.HTTP_INTERNAL_ERROR;
@@ -70,6 +69,7 @@
 public class NodeServer extends TemplateGridServerCommand {
 
   private static final Logger LOG = Logger.getLogger(NodeServer.class.getName());
+  private final AtomicBoolean nodeRegistered = new AtomicBoolean(false);
   private Node node;
   private EventBus bus;
 
@@ -135,6 +135,7 @@ protected Handlers createHandlers(Config config) {
 
     bus.addListener(NodeAddedEvent.listener(nodeId -> {
       if (node.getId().equals(nodeId)) {
+        nodeRegistered.set(true);
         LOG.info("Node has been added");
       }
     }));
@@ -172,6 +173,7 @@ public Server<?> asServer(Config initialConfig) {
     Require.nonNull("Config", initialConfig);
 
     Config config = new MemoizedConfig(new CompoundConfig(initialConfig, getDefaultConfig()));
+    NodeOptions nodeOptions = new NodeOptions(config);
 
     Handlers handler = createHandlers(config);
 
@@ -183,11 +185,13 @@ public Server<?> asServer(Config initialConfig) {
       public NettyServer start() {
         super.start();
 
-        // Unlimited attempts, initial 5 seconds interval, backoff rate of 1.0005, max interval of 5 minutes
-        RetryPolicy<Object> registrationPolicy =  new RetryPolicy<>()
+        // Unlimited attempts, every X seconds, we assume a Node should not need more than Y minutes to register
+        // X defaults to 10s and Y to 120 seconds, but the user can overwrite that.
+        RetryPolicy<Object> registrationPolicy = new RetryPolicy<>()
           .withMaxAttempts(-1)
-          .handleResultIf(result -> true)
-          .withBackoff(Duration.ofSeconds(5).getSeconds(), Duration.ofMinutes(5).getSeconds(), ChronoUnit.SECONDS, 1.0005);
+          .withMaxDuration(nodeOptions.getRegisterPeriod())
+          .withDelay(nodeOptions.getRegisterCycle())
+          .handleResultIf(result -> true);
 
         LOG.info("Starting registration process for node id " + node.getId());
         Executors.newSingleThreadExecutor().submit(() -> {
@@ -201,6 +205,9 @@ public NettyServer start() {
                 throw new UnsupportedOperationException("Node cannot be registered");
               }
               bus.fire(new NodeStatusEvent(node.getStatus()));
+              if (nodeRegistered.get()) {
+                throw new InterruptedException("Stopping registration thread.");
+              }
             }
           );
         });