[broker-14] improve ActionResult computing

Author: crazyrokr

src/main/java/com/ss/mqtt/broker/handler/publish/in/AbstractPublishInHandler.java

@@ -25,7 +25,7 @@ public void handle(@NotNull MqttClient client, @NotNull PublishInPacket packet)
         handleResult(client, packet, result);
     }
 
-    private boolean publish(
+    private @NotNull ActionResult publish(
         @NotNull Subscriber subscriber,
         @NotNull PublishInPacket packet
     ) {

src/main/java/com/ss/mqtt/broker/handler/publish/out/PublishOutHandler.java

@@ -1,5 +1,6 @@
 package com.ss.mqtt.broker.handler.publish.out;
 
+import com.ss.mqtt.broker.model.ActionResult;
 import com.ss.mqtt.broker.model.Subscriber;
 import com.ss.mqtt.broker.network.packet.in.PublishInPacket;
 import org.jetbrains.annotations.NotNull;
@@ -9,5 +10,5 @@
  */
 public interface PublishOutHandler {
 
-    boolean handle(@NotNull PublishInPacket packet, @NotNull Subscriber subscriber);
+    @NotNull ActionResult handle(@NotNull PublishInPacket packet, @NotNull Subscriber subscriber);
 }

src/main/java/com/ss/mqtt/broker/handler/publish/out/Qos0PublishOutHandler.java

@@ -1,5 +1,7 @@
 package com.ss.mqtt.broker.handler.publish.out;
 
+import static com.ss.mqtt.broker.model.ActionResult.SUCCESS;
+import com.ss.mqtt.broker.model.ActionResult;
 import com.ss.mqtt.broker.model.MqttPropertyConstants;
 import com.ss.mqtt.broker.model.QoS;
 import com.ss.mqtt.broker.model.Subscriber;
@@ -9,7 +11,7 @@
 public class Qos0PublishOutHandler extends AbstractPublishOutHandler {
 
     @Override
-    public boolean handle(@NotNull PublishInPacket packet, @NotNull Subscriber subscriber) {
+    public @NotNull ActionResult handle(@NotNull PublishInPacket packet, @NotNull Subscriber subscriber) {
 
         var client = subscriber.getMqttClient();
         var packetOutFactory = client.getPacketOutFactory();
@@ -28,6 +30,6 @@ public boolean handle(@NotNull PublishInPacket packet, @NotNull Subscriber subsc
             packet.getCorrelationData(),
             packet.getUserProperties()
         ));
-        return true;
+        return SUCCESS;
     }
 }

src/main/java/com/ss/mqtt/broker/handler/publish/out/Qos1PublishOutHandler.java

@@ -1,5 +1,7 @@
 package com.ss.mqtt.broker.handler.publish.out;
 
+import static com.ss.mqtt.broker.model.ActionResult.EMPTY;
+import static com.ss.mqtt.broker.model.ActionResult.SUCCESS;
 import com.ss.mqtt.broker.model.*;
 import com.ss.mqtt.broker.network.client.MqttClient;
 import com.ss.mqtt.broker.network.packet.HasPacketId;
@@ -11,14 +13,14 @@
 public class Qos1PublishOutHandler extends AbstractPublishOutHandler implements MqttSession.PendingPacketHandler {
 
     @Override
-    public boolean handle(@NotNull PublishInPacket packet, @NotNull Subscriber subscriber) {
+    public @NotNull ActionResult handle(@NotNull PublishInPacket packet, @NotNull Subscriber subscriber) {
 
         var client = subscriber.getMqttClient();
         var session = client.getSession();
 
         // it means this client was already closed
         if (session == null) {
-            return false;
+            return EMPTY;
         }
 
         var packetId = session.nextPacketId();
@@ -39,7 +41,7 @@ public boolean handle(@NotNull PublishInPacket packet, @NotNull Subscriber subsc
             packet.getCorrelationData(),
             packet.getUserProperties()
         ));
-        return true;
+        return SUCCESS;
     }
 
     @Override

src/main/java/com/ss/mqtt/broker/handler/publish/out/Qos2PublishOutHandler.java

@@ -1,5 +1,6 @@
 package com.ss.mqtt.broker.handler.publish.out;
 
+import com.ss.mqtt.broker.model.ActionResult;
 import com.ss.mqtt.broker.model.Subscriber;
 import com.ss.mqtt.broker.network.packet.in.PublishInPacket;
 import lombok.RequiredArgsConstructor;
@@ -9,7 +10,7 @@
 public class Qos2PublishOutHandler extends AbstractPublishOutHandler {
 
     @Override
-    public boolean handle(@NotNull PublishInPacket packet, @NotNull Subscriber subscriber) {
+    public @NotNull ActionResult handle(@NotNull PublishInPacket packet, @NotNull Subscriber subscriber) {
         throw new UnsupportedOperationException();
     }
 }

src/main/java/com/ss/mqtt/broker/model/ActionResult.java

@@ -1,9 +1,20 @@
 package com.ss.mqtt.broker.model;
 
+import org.jetbrains.annotations.NotNull;
+
 public enum ActionResult {
 
     SUCCESS,
     FAILED,
     EMPTY;
 
+    public @NotNull ActionResult and(@NotNull ActionResult another) {
+        if (this == FAILED || another == FAILED) {
+            return FAILED;
+        } else if (this == SUCCESS || another == SUCCESS) {
+            return SUCCESS;
+        } else {
+            return EMPTY;
+        }
+    }
 }

src/main/java/com/ss/mqtt/broker/service/SubscriptionService.java

@@ -6,6 +6,7 @@
 import com.ss.mqtt.broker.model.topic.TopicFilter;
 import com.ss.mqtt.broker.model.topic.TopicName;
 import com.ss.mqtt.broker.network.client.MqttClient;
+import com.ss.rlib.common.function.NotNullBiFunction;
 import com.ss.rlib.common.function.NotNullNullableBiFunction;
 import com.ss.rlib.common.util.array.Array;
 import org.jetbrains.annotations.NotNull;
@@ -26,7 +27,7 @@ public interface SubscriptionService {
     @NotNull <A> ActionResult forEachTopicSubscriber(
         @NotNull TopicName topicName,
         @NotNull A argument,
-        @NotNull NotNullNullableBiFunction<Subscriber, A, Boolean> action
+        @NotNull NotNullBiFunction<Subscriber, A, ActionResult> action
     );
 
     /**

src/main/java/com/ss/mqtt/broker/service/impl/SimpleSubscriptionService.java

@@ -1,6 +1,6 @@
 package com.ss.mqtt.broker.service.impl;
 
-import static com.ss.mqtt.broker.model.ActionResult.*;
+import static com.ss.mqtt.broker.model.ActionResult.EMPTY;
 import com.ss.mqtt.broker.model.ActionResult;
 import com.ss.mqtt.broker.model.MqttSession;
 import com.ss.mqtt.broker.model.SubscribeTopicFilter;
@@ -12,7 +12,7 @@
 import com.ss.mqtt.broker.model.topic.TopicSubscribers;
 import com.ss.mqtt.broker.network.client.MqttClient;
 import com.ss.mqtt.broker.service.SubscriptionService;
-import com.ss.rlib.common.function.NotNullNullableBiFunction;
+import com.ss.rlib.common.function.NotNullBiFunction;
 import com.ss.rlib.common.util.array.Array;
 import com.ss.rlib.common.util.array.ArrayCollectors;
 import org.jetbrains.annotations.NotNull;
@@ -29,18 +29,17 @@ public class SimpleSubscriptionService implements SubscriptionService {
     public <A> @NotNull ActionResult forEachTopicSubscriber(
         @NotNull TopicName topicName,
         @NotNull A argument,
-        @NotNull NotNullNullableBiFunction<Subscriber, A, Boolean> action
+        @NotNull NotNullBiFunction<Subscriber, A, ActionResult> action
     ) {
         var subscribers = topicSubscribers.matches(topicName);
         if (subscribers.isEmpty()) {
             return EMPTY;
         }
-        boolean result = true;
+        ActionResult result = EMPTY;
         for (var subscriber : subscribers) {
-            //noinspection ConstantConditions
-            result = result && action.apply(subscriber, argument);
+            result = result.and(action.apply(subscriber, argument));
         }
-        return result ? SUCCESS : FAILED;
+        return result;
     }
 
     @Override

src/test/groovy/com/ss/mqtt/broker/test/model/ActionResultTest.groovy

@@ -0,0 +1,32 @@
+package com.ss.mqtt.broker.test.model
+
+import com.ss.mqtt.broker.model.ActionResult
+import com.ss.mqtt.broker.test.network.NetworkUnitSpecification
+import spock.lang.Unroll
+
+import static com.ss.mqtt.broker.model.ActionResult.*
+
+class ActionResultTest extends NetworkUnitSpecification {
+    
+    @Unroll
+    def "#first and #second == #result"(
+        ActionResult first,
+        ActionResult second,
+        ActionResult result
+    ) {
+        expect:
+            first.and(second) == result
+        where:
+            first   | second  | result
+            SUCCESS | SUCCESS | SUCCESS
+            SUCCESS | FAILED  | FAILED
+            FAILED  | SUCCESS | FAILED
+            FAILED  | FAILED  | FAILED
+            EMPTY   | EMPTY   | EMPTY
+            EMPTY   | FAILED  | FAILED
+            FAILED  | EMPTY   | FAILED
+            SUCCESS | EMPTY   | SUCCESS
+            EMPTY   | SUCCESS | SUCCESS
+    }
+    
+}