From 72b1841f5cecc5ff393ce75f6d42af423ddcb4ed Mon Sep 17 00:00:00 2001
From: "tibor.digana" <tibordigana@apache.org>
Date: Wed, 13 Apr 2022 02:28:26 +0200
Subject: [PATCH] Refactored decode(Memento) and embedded Memento in the
 decoder instance

---
 .../surefire/extensions/EventConsumerThread.java      |  4 +---
 .../apache/maven/surefire/stream/EventDecoder.java    | 11 ++++++++++-
 .../surefire/api/stream/AbstractStreamDecoder.java    | 10 +++++++++-
 .../api/stream/MalformedChannelException.java         |  2 +-
 .../api/stream/AbstractStreamDecoderTest.java         |  2 +-
 .../surefire/booter/spi/CommandChannelDecoder.java    | 11 +----------
 .../maven/surefire/booter/stream/CommandDecoder.java  | 10 +++++++++-
 7 files changed, 32 insertions(+), 18 deletions(-)

diff --git a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/EventConsumerThread.java b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/EventConsumerThread.java
index 79d5c85ab1..2e5b5d3f20 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/EventConsumerThread.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/plugin/surefire/extensions/EventConsumerThread.java
@@ -21,7 +21,6 @@
 
 import org.apache.maven.surefire.api.event.Event;
 import org.apache.maven.surefire.api.fork.ForkNodeArguments;
-import org.apache.maven.surefire.api.stream.AbstractStreamDecoder.Memento;
 import org.apache.maven.surefire.extensions.CloseableDaemonThread;
 import org.apache.maven.surefire.extensions.EventHandler;
 import org.apache.maven.surefire.extensions.util.CountdownCloseable;
@@ -67,10 +66,9 @@ public void run()
               CountdownCloseable c = countdownCloseable;
               EventDecoder eventDecoder = decoder )
         {
-            Memento memento = eventDecoder.new Memento();
             do
             {
-                Event event = eventDecoder.decode( memento );
+                Event event = eventDecoder.decode();
                 if ( event != null && !disabled )
                 {
                     eventHandler.handleEvent( event );
diff --git a/maven-surefire-common/src/main/java/org/apache/maven/surefire/stream/EventDecoder.java b/maven-surefire-common/src/main/java/org/apache/maven/surefire/stream/EventDecoder.java
index ea11889846..fa61d491ef 100644
--- a/maven-surefire-common/src/main/java/org/apache/maven/surefire/stream/EventDecoder.java
+++ b/maven-surefire-common/src/main/java/org/apache/maven/surefire/stream/EventDecoder.java
@@ -140,6 +140,8 @@ public class EventDecoder extends AbstractStreamDecoder<Event, ForkedProcessEven
 
     private final OutputStream debugSink;
 
+    private Memento memento;
+
     public EventDecoder( @Nonnull ReadableByteChannel channel,
                          @Nonnull ForkNodeArguments arguments )
     {
@@ -148,8 +150,15 @@ public EventDecoder( @Nonnull ReadableByteChannel channel,
     }
 
     @Override
-    public Event decode( @Nonnull Memento memento ) throws IOException
+    public Event decode() throws IOException
     {
+        if ( memento == null )
+        {
+            // do not create memento in constructor because the constructor is called in another thread
+            // memento is the thread confinement object
+            memento = new Memento();
+        }
+
         try
         {
             ForkedProcessEventType eventType = readMessageType( memento );
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/AbstractStreamDecoder.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/AbstractStreamDecoder.java
index 6ddbb4514f..02b3d3a3b9 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/AbstractStreamDecoder.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/AbstractStreamDecoder.java
@@ -89,7 +89,15 @@ protected AbstractStreamDecoder( @Nonnull ReadableByteChannel channel,
         logger = arguments.getConsoleLogger();
     }
 
-    public abstract M decode( @Nonnull Memento memento ) throws MalformedChannelException, IOException;
+    /**
+     * Decoding and returns a message {@code M} and waiting, if necessary, for the next
+     * message received from the channel.
+     *
+     * @return message {@code M}, or null if could not decode a message due to a frame error
+     * @throws MalformedChannelException the channel error
+     * @throws IOException stream I/O exception
+     */
+    public abstract M decode() throws MalformedChannelException, IOException;
 
     @Nonnull
     protected abstract byte[] getEncodedMagicNumber();
diff --git a/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/MalformedChannelException.java b/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/MalformedChannelException.java
index cf4468ffce..89447356c9 100644
--- a/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/MalformedChannelException.java
+++ b/surefire-api/src/main/java/org/apache/maven/surefire/api/stream/MalformedChannelException.java
@@ -20,7 +20,7 @@
  */
 
 /**
- *
+ * No supported message type.
  */
 public class MalformedChannelException extends Exception
 {
diff --git a/surefire-api/src/test/java/org/apache/maven/surefire/api/stream/AbstractStreamDecoderTest.java b/surefire-api/src/test/java/org/apache/maven/surefire/api/stream/AbstractStreamDecoderTest.java
index 2ff06eab62..2cec298222 100644
--- a/surefire-api/src/test/java/org/apache/maven/surefire/api/stream/AbstractStreamDecoderTest.java
+++ b/surefire-api/src/test/java/org/apache/maven/surefire/api/stream/AbstractStreamDecoderTest.java
@@ -664,7 +664,7 @@ protected Mock( @Nonnull ReadableByteChannel channel, @Nonnull ForkNodeArguments
         }
 
         @Override
-        public Event decode( @Nonnull Memento memento ) throws MalformedChannelException
+        public Event decode() throws MalformedChannelException
         {
             throw new MalformedChannelException();
         }
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/CommandChannelDecoder.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/CommandChannelDecoder.java
index 85bda73a83..8b7a5d7b7c 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/CommandChannelDecoder.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/spi/CommandChannelDecoder.java
@@ -22,7 +22,6 @@
 import org.apache.maven.surefire.api.booter.Command;
 import org.apache.maven.surefire.api.booter.MasterProcessChannelDecoder;
 import org.apache.maven.surefire.api.fork.ForkNodeArguments;
-import org.apache.maven.surefire.api.stream.AbstractStreamDecoder.Memento;
 import org.apache.maven.surefire.api.stream.MalformedChannelException;
 import org.apache.maven.surefire.booter.stream.CommandDecoder;
 
@@ -40,7 +39,6 @@
 public class CommandChannelDecoder implements MasterProcessChannelDecoder
 {
     private final CommandDecoder decoder;
-    private Memento memento;
 
     public CommandChannelDecoder( @Nonnull ReadableByteChannel channel,
                                   @Nonnull ForkNodeArguments arguments )
@@ -53,18 +51,11 @@ public CommandChannelDecoder( @Nonnull ReadableByteChannel channel,
     @SuppressWarnings( "checkstyle:innerassignment" )
     public Command decode() throws IOException
     {
-        if ( memento == null )
-        {
-            // do not create memento in constructor because the constructor is called in another thread
-            // memento is the thread confinement object
-            memento = decoder.new Memento();
-        }
-
         do
         {
             try
             {
-                Command command = decoder.decode( memento );
+                Command command = decoder.decode();
                 if ( command != null )
                 {
                     return command;
diff --git a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/stream/CommandDecoder.java b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/stream/CommandDecoder.java
index 4a7e257f71..9387f85d58 100644
--- a/surefire-booter/src/main/java/org/apache/maven/surefire/booter/stream/CommandDecoder.java
+++ b/surefire-booter/src/main/java/org/apache/maven/surefire/booter/stream/CommandDecoder.java
@@ -70,6 +70,7 @@ public class CommandDecoder extends AbstractStreamDecoder<Command, MasterProcess
 
     private final ForkNodeArguments arguments;
     private final OutputStream debugSink;
+    private Memento memento;
 
     public CommandDecoder( @Nonnull ReadableByteChannel channel,
                            @Nonnull ForkNodeArguments arguments )
@@ -80,8 +81,15 @@ public CommandDecoder( @Nonnull ReadableByteChannel channel,
     }
 
     @Override
-    public Command decode( @Nonnull Memento memento ) throws IOException, MalformedChannelException
+    public Command decode() throws IOException, MalformedChannelException
     {
+        if ( memento == null )
+        {
+            // do not create memento in constructor because the constructor is called in another thread
+            // memento is the thread confinement object
+            memento = new Memento();
+        }
+
         try
         {
             MasterProcessCommand commandType = readMessageType( memento );