Requires a port name for $availableXxxPort() config functions

Author: adrienlauer

CHANGELOG.md

@@ -1,4 +1,8 @@
-# Version 3.10.0 (2019-08-06)
+# Version 3.11.0 (2020-08-06)
+
+* [brk] Config functions that find available ports now take a port name as argument so they can return the same port for each evaluation (example: `$availableTcpPort()` becomes `$availableTcpPort('web')`).
+
+# Version 3.10.0 (2020-08-06)
 
 * [brk] Generic session options moved from `web.server.sessions` to `web.sessions`.
 * [brk] Static resources options moved from `web.staticResources` to `web.static`.

cli/pom.xml

@@ -14,7 +14,7 @@
     <parent>
         <groupId>org.seedstack.seed</groupId>
         <artifactId>seed</artifactId>
-        <version>3.10.1-SNAPSHOT</version>
+        <version>3.11.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>seed-cli</artifactId>

core/pom.xml

@@ -14,7 +14,7 @@
     <parent>
         <groupId>org.seedstack.seed</groupId>
         <artifactId>seed</artifactId>
-        <version>3.10.1-SNAPSHOT</version>
+        <version>3.11.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>seed-core</artifactId>

core/src/main/java/org/seedstack/seed/core/internal/configuration/AvailablePortFunctionHolder.java

@@ -7,44 +7,49 @@
  */
 package org.seedstack.seed.core.internal.configuration;
 
+import org.seedstack.coffig.spi.ConfigFunction;
+import org.seedstack.coffig.spi.ConfigFunctionHolder;
+
+import javax.net.ServerSocketFactory;
 import java.io.IOException;
 import java.net.DatagramSocket;
 import java.net.InetAddress;
 import java.net.ServerSocket;
-import javax.net.ServerSocketFactory;
-import org.seedstack.coffig.spi.ConfigFunction;
-import org.seedstack.coffig.spi.ConfigFunctionHolder;
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
 
 public class AvailablePortFunctionHolder implements ConfigFunctionHolder {
+    private static final ConcurrentMap<String, Integer> TCP_PORTS = new ConcurrentHashMap<>();
+    private static final ConcurrentMap<String, Integer> UDP_PORTS = new ConcurrentHashMap<>();
     private static final int PORT_RANGE_MIN = 49152;
     private static final int PORT_RANGE_MAX = 65535;
-    private static final Object TCP_SYNC = new Object();
-    private static final Object UDP_SYNC = new Object();
 
     @ConfigFunction
-    int availableTcpPort() {
-        synchronized (TCP_SYNC) {
-            for (int i = PORT_RANGE_MIN; i <= PORT_RANGE_MAX; i++) {
-                if (isTcpPortAvailable(i)) {
-                    return i;
+    int availableTcpPort(String name) {
+        return TCP_PORTS.computeIfAbsent(name, n -> {
+            synchronized (TCP_PORTS) {
+                for (int i = PORT_RANGE_MIN; i <= PORT_RANGE_MAX; i++) {
+                    if (isTcpPortAvailable(i)) {
+                        return i;
+                    }
                 }
+                throw new IllegalStateException("Unable to find an available TCP port in range " + PORT_RANGE_MIN + "-" + PORT_RANGE_MAX);
             }
-        }
-        throw new IllegalStateException("Unable to find an available TCP port in range " + PORT_RANGE_MIN + "-" +
-                PORT_RANGE_MAX);
+        });
     }
 
     @ConfigFunction
-    int availableUdpPort() {
-        synchronized (UDP_SYNC) {
-            for (int i = PORT_RANGE_MIN; i <= PORT_RANGE_MAX; i++) {
-                if (isUdpPortAvailable(i)) {
-                    return i;
+    int availableUdpPort(String name) {
+        return UDP_PORTS.computeIfAbsent(name, n -> {
+            synchronized (UDP_PORTS) {
+                for (int i = PORT_RANGE_MIN; i <= PORT_RANGE_MAX; i++) {
+                    if (isUdpPortAvailable(i)) {
+                        return i;
+                    }
                 }
             }
-        }
-        throw new IllegalStateException("Unable to find an available UDP port in range " + PORT_RANGE_MIN + "-" +
-                PORT_RANGE_MAX);
+            throw new IllegalStateException("Unable to find an available UDP port in range " + PORT_RANGE_MIN + "-" + PORT_RANGE_MAX);
+        });
     }
 
     private boolean isTcpPortAvailable(int port) {

core/src/test/resources/application.yaml

@@ -75,6 +75,6 @@ crypto:
     keystore: ssl
     keyPassword: changeMe
 functions:
-  availableTcpPort: $availableTcpPort()
-  availableUdpPort: $availableUdpPort()
+  availableTcpPort: $availableTcpPort('port1')
+  availableUdpPort: $availableUdpPort('port2')
   randomUuid: $randomUuid()

pom.xml

@@ -19,7 +19,7 @@
 
     <groupId>org.seedstack.seed</groupId>
     <artifactId>seed</artifactId>
-    <version>3.10.1-SNAPSHOT</version>
+    <version>3.11.0-SNAPSHOT</version>
     <packaging>pom</packaging>
 
     <properties>

rest/core/pom.xml

@@ -14,7 +14,7 @@
     <parent>
         <groupId>org.seedstack.seed</groupId>
         <artifactId>seed-rest</artifactId>
-        <version>3.10.1-SNAPSHOT</version>
+        <version>3.11.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>seed-rest-core</artifactId>

rest/jersey2/pom.xml

@@ -14,7 +14,7 @@
     <parent>
         <groupId>org.seedstack.seed</groupId>
         <artifactId>seed-rest</artifactId>
-        <version>3.10.1-SNAPSHOT</version>
+        <version>3.11.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>seed-rest-jersey2</artifactId>

rest/pom.xml

@@ -13,7 +13,7 @@
     <parent>
         <groupId>org.seedstack.seed</groupId>
         <artifactId>seed</artifactId>
-        <version>3.10.1-SNAPSHOT</version>
+        <version>3.11.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>seed-rest</artifactId>

rest/specs/pom.xml

@@ -13,7 +13,7 @@
     <parent>
         <groupId>org.seedstack.seed</groupId>
         <artifactId>seed-rest</artifactId>
-        <version>3.10.1-SNAPSHOT</version>
+        <version>3.11.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>seed-rest-specs</artifactId>