[grid] Extract GridModel into an interface

Author: pujagani

java/server/src/org/openqa/selenium/grid/distributor/GridModel.java

@@ -0,0 +1,36 @@
+package org.openqa.selenium.grid.distributor;
+
+import org.openqa.selenium.grid.data.Availability;
+import org.openqa.selenium.grid.data.NodeId;
+import org.openqa.selenium.grid.data.NodeStatus;
+import org.openqa.selenium.grid.data.Session;
+import org.openqa.selenium.grid.data.SlotId;
+import org.openqa.selenium.remote.SessionId;
+
+import java.util.Set;
+
+public interface GridModel {
+
+  public void add(NodeStatus node);
+
+  public void refresh(NodeStatus status);
+
+  public void touch(NodeId id);
+
+  public void remove(NodeId id);
+
+  public void purgeDeadNodes();
+
+  public Availability setAvailability(NodeId id, Availability availability);
+
+  public boolean reserve(SlotId slotId);
+
+  public Set<NodeStatus> getSnapshot();
+
+  public Set<NodeStatus> nodes(Availability availability);
+
+  public void release(SessionId id);
+
+  public void setSession(SlotId slotId, Session session);
+
+}

java/server/src/org/openqa/selenium/grid/distributor/local/LocalDistributor.java

@@ -115,7 +115,7 @@ public class LocalDistributor extends Distributor {
   private final Duration healthcheckInterval;
 
   private final ReadWriteLock lock = new ReentrantReadWriteLock(/* fair */ true);
-  private final GridModel model;
+  private final LocalGridModel model;
   private final Map<NodeId, Node> nodes;
 
   private final NewSessionQueue sessionQueue;
@@ -142,7 +142,7 @@ public LocalDistributor(
     this.slotSelector = Require.nonNull("Slot selector", slotSelector);
     this.registrationSecret = Require.nonNull("Registration secret", registrationSecret);
     this.healthcheckInterval = Require.nonNull("Health check interval", healthcheckInterval);
-    this.model = new GridModel(bus);
+    this.model = new LocalGridModel(bus);
     this.nodes = new ConcurrentHashMap<>();
     this.rejectUnsupportedCaps = rejectUnsupportedCaps;
 

java/server/src/org/openqa/selenium/grid/distributor/local/GridModel.java renamed to java/server/src/org/openqa/selenium/grid/distributor/local/LocalGridModel.java

@@ -27,6 +27,7 @@
 import org.openqa.selenium.grid.data.SessionClosedEvent;
 import org.openqa.selenium.grid.data.Slot;
 import org.openqa.selenium.grid.data.SlotId;
+import org.openqa.selenium.grid.distributor.GridModel;
 import org.openqa.selenium.internal.Require;
 import org.openqa.selenium.remote.SessionId;
 
@@ -48,22 +49,23 @@
 import static org.openqa.selenium.grid.data.Availability.DRAINING;
 import static org.openqa.selenium.grid.data.Availability.UP;
 
-public class GridModel {
+public class LocalGridModel implements GridModel {
 
-  private static final Logger LOG = Logger.getLogger(GridModel.class.getName());
+  private static final Logger LOG = Logger.getLogger(LocalGridModel.class.getName());
   private static final SessionId RESERVED = new SessionId("reserved");
   private final ReadWriteLock lock = new ReentrantReadWriteLock(/* fair */ true);
   private final Map<Availability, Set<NodeStatus>> nodes = new ConcurrentHashMap<>();
   private final EventBus events;
 
-  public GridModel(EventBus events) {
+  public LocalGridModel(EventBus events) {
     this.events = Require.nonNull("Event bus", events);
 
     this.events.addListener(NodeDrainStarted.listener(nodeId -> setAvailability(nodeId, DRAINING)));
     this.events.addListener(SessionClosedEvent.listener(this::release));
   }
 
-  public GridModel add(NodeStatus node) {
+  @Override
+  public void add(NodeStatus node) {
     Require.nonNull("Node", node);
 
     Lock writeLock = lock.writeLock();
@@ -88,11 +90,10 @@ public GridModel add(NodeStatus node) {
     } finally {
       writeLock.unlock();
     }
-
-    return this;
   }
 
-  public GridModel refresh(NodeStatus status) {
+  @Override
+  public void refresh(NodeStatus status) {
     Require.nonNull("Node status", status);
 
     Lock writeLock = lock.writeLock();
@@ -101,27 +102,26 @@ public GridModel refresh(NodeStatus status) {
       AvailabilityAndNode availabilityAndNode = findNode(status.getId());
 
       if (availabilityAndNode == null) {
-        return this;
+        return;
       }
 
       // if the node was marked as "down", keep it down until a healthcheck passes:
       // just because the node can hit the event bus doesn't mean it's reachable
       if (DOWN.equals(availabilityAndNode.availability)) {
         nodes(DOWN).remove(availabilityAndNode.status);
         nodes(DOWN).add(status);
-        return this;
       }
 
       // But do trust the node if it tells us it's draining
       nodes(availabilityAndNode.availability).remove(availabilityAndNode.status);
       nodes(status.getAvailability()).add(status);
-      return this;
     } finally {
       writeLock.unlock();
     }
   }
 
-  public GridModel touch(NodeId id) {
+  @Override
+  public void touch(NodeId id) {
     Require.nonNull("Node ID", id);
 
     Lock writeLock = lock.writeLock();
@@ -131,30 +131,30 @@ public GridModel touch(NodeId id) {
       if (availabilityAndNode != null) {
         availabilityAndNode.status.touch();
       }
-      return this;
     } finally {
       writeLock.unlock();
     }
   }
 
-  public GridModel remove(NodeId id) {
+  @Override
+  public void remove(NodeId id) {
     Require.nonNull("Node ID", id);
 
     Lock writeLock = lock.writeLock();
     writeLock.lock();
     try {
       AvailabilityAndNode availabilityAndNode = findNode(id);
       if (availabilityAndNode == null) {
-        return this;
+        return;
       }
 
       nodes(availabilityAndNode.availability).remove(availabilityAndNode.status);
-      return this;
     } finally {
       writeLock.unlock();
     }
   }
 
+  @Override
   public void purgeDeadNodes() {
     long now = System.currentTimeMillis();
     Lock writeLock = lock.writeLock();
@@ -200,6 +200,7 @@ public void purgeDeadNodes() {
     }
   }
 
+  @Override
   public Availability setAvailability(NodeId id, Availability availability) {
     Require.nonNull("Node ID", id);
     Require.nonNull("Availability", availability);
@@ -232,6 +233,7 @@ public Availability setAvailability(NodeId id, Availability availability) {
     }
   }
 
+  @Override
   public boolean reserve(SlotId slotId) {
     Lock writeLock = lock.writeLock();
     writeLock.lock();
@@ -269,6 +271,7 @@ public boolean reserve(SlotId slotId) {
     }
   }
 
+  @Override
   public Set<NodeStatus> getSnapshot() {
     Lock readLock = this.lock.readLock();
     readLock.lock();
@@ -285,7 +288,7 @@ public Set<NodeStatus> getSnapshot() {
     }
   }
 
-  private Set<NodeStatus> nodes(Availability availability) {
+  public Set<NodeStatus> nodes(Availability availability) {
     return nodes.computeIfAbsent(availability, ignored -> new HashSet<>());
   }
 
@@ -312,7 +315,8 @@ private NodeStatus rewrite(NodeStatus status, Availability availability) {
       status.getOsInfo());
   }
 
-  private void release(SessionId id) {
+  @Override
+  public void release(SessionId id) {
     if (id == null) {
       return;
     }
@@ -361,6 +365,7 @@ private void reserve(NodeStatus status, Slot slot) {
     amend(UP, status, reserved);
   }
 
+  @Override
   public void setSession(SlotId slotId, Session session) {
     Require.nonNull("Slot ID", slotId);
 

java/server/test/org/openqa/selenium/grid/distributor/local/GridModelTest.java renamed to java/server/test/org/openqa/selenium/grid/distributor/local/LocalGridModelTest.java

@@ -33,7 +33,7 @@
 
 import java.time.Duration;
 
-public class GridModelTest {
+public class LocalGridModelTest {
 
   private final Tracer tracer = DefaultTestTracer.createTracer();
   private final EventBus events = new GuavaEventBus();