fix: netty v4 mocker records missing response (#528)

* fix: netty mocker records missing response

* fix tests: remove case `writeCompleteCase` as no longer needed

* extract `invoke` method

* fix: netty v3 request recording may be incomplete due to lack of handling of httpChunk

* fix: netty mocker records missing response

* fix tests: remove case `writeCompleteCase` as no longer needed

* extract `invoke` method

* fix: netty v3 request recording may be incomplete due to lack of handling of httpChunk

* fix tests: remove netty v4 tests case `channelReadComplete`

* fix: netty v3 record & mock

* Revert "fix: netty v3 request recording may be incomplete due to lack of handling of httpChunk"

This reverts commit 604d1b5.

* Revert "fix tests: remove case `writeCompleteCase` as no longer needed"

This reverts commit 27f3384.

* Revert "fix: netty v3 record & mock"

This reverts commit 28ba00d.

* replace ctx.write with super.write(ctx..)
replace ctx.fireChannelRead with super.read(ctx...)

* add unit tests

* ut coment zh to en

* fix tests

Author: shichanglin5

arex-instrumentation/netty/arex-netty-v4/src/main/java/io/arex/inst/netty/v4/server/RequestTracingHandler.java

@@ -102,25 +102,4 @@ private boolean shouldSkip(HttpRequest request, String caseId) {
 
         return Config.get().invalidRecord(request.getUri());
     }
-
-    @Override
-    public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
-        try {
-            Mocker mocker = ctx.channel().attr(AttributeKey.TRACING_MOCKER).getAndSet(null);
-            if (mocker == null) {
-                return;
-            }
-            if (ContextManager.needReplay()) {
-                MockUtils.replayBody(mocker);
-            } else if (ContextManager.needRecord()) {
-                MockUtils.recordMocker(mocker);
-            }
-
-            CaseEventDispatcher.onEvent(CaseEvent.ofExitEvent());
-        } catch (Throwable e) {
-            LogManager.warn("netty channelReadComplete error", e);
-        } finally {
-            super.channelReadComplete(ctx);
-        }
-    }
 }

arex-instrumentation/netty/arex-netty-v4/src/main/java/io/arex/inst/netty/v4/server/ResponseTracingHandler.java

@@ -2,11 +2,14 @@
 
 import io.arex.agent.bootstrap.model.Mocker;
 import io.arex.inst.runtime.context.ContextManager;
+import io.arex.inst.runtime.listener.CaseEvent;
+import io.arex.inst.runtime.listener.CaseEventDispatcher;
 import io.arex.inst.runtime.log.LogManager;
 import io.arex.inst.runtime.model.ArexConstants;
 import io.arex.inst.netty.v4.common.AttributeKey;
 import io.arex.inst.netty.v4.common.NettyHelper;
 import io.arex.inst.runtime.serializer.Serializer;
+import io.arex.inst.runtime.util.MockUtils;
 import io.arex.inst.runtime.util.TypeUtil;
 import io.netty.channel.*;
 import io.netty.handler.codec.http.FullHttpResponse;
@@ -25,20 +28,11 @@ public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)
         }
 
         try {
-            ChannelPromise prm = promise;
             if (msg instanceof LastHttpContent) {
                 if (msg instanceof FullHttpResponse) {
                     processHeaders(ctx.channel(), (HttpResponse) msg);
                 }
-
-                // compatible with VoidChannelPromise.java package not visible (< 4.1.0)
-                if (prm.getClass().getName().contains("VoidChannelPromise")) {
-                    prm = ctx.newPromise();
-                }
-
-                String body = NettyHelper.parseBody(((LastHttpContent) msg).content());
-                // record response and save record on RequestTracingHandler#channelReadComplete
-                invoke(ctx.channel(), body, prm.cause());
+                invoke(ctx, (LastHttpContent) msg, promise);
             } else {
                 if (msg instanceof HttpResponse) {
                     processHeaders(ctx.channel(), (HttpResponse) msg);
@@ -51,7 +45,7 @@ public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)
         }
     }
 
-    private void processHeaders(final Channel channel, final HttpResponse response) {
+    void processHeaders(final Channel channel, final HttpResponse response) {
         Mocker mocker = channel.attr(AttributeKey.TRACING_MOCKER).get();
         if (mocker == null) {
             return;
@@ -62,7 +56,7 @@ private void processHeaders(final Channel channel, final HttpResponse response)
         appendHeader(response);
     }
 
-    private void appendHeader(HttpResponse response) {
+    void appendHeader(HttpResponse response) {
         if (ContextManager.needRecord()) {
             response.headers().set(ArexConstants.RECORD_ID, ContextManager.currentContext().getCaseId());
             return;
@@ -73,13 +67,26 @@ private void appendHeader(HttpResponse response) {
         }
     }
 
-    private void invoke(final Channel channel, final String content, Throwable throwable) {
-        Mocker mocker = channel.attr(AttributeKey.TRACING_MOCKER).get();
-        Object response = throwable != null ? throwable : content;
+    void invoke(ChannelHandlerContext ctx, LastHttpContent msg, ChannelPromise prm) {
+        // compatible with VoidChannelPromise.java package not visible (< 4.1.0)
+        if (prm.getClass().getName().contains("VoidChannelPromise")) {
+            prm = ctx.newPromise();
+        }
+
+        String body = NettyHelper.parseBody(msg.content());
+        Mocker mocker = ctx.channel().attr(AttributeKey.TRACING_MOCKER).get();
+        Throwable throwable = prm.cause();
+        Object response = throwable != null ? throwable : body;
         if (mocker == null || response == null) {
             return;
         }
         mocker.getTargetResponse().setBody(Serializer.serialize(response));
         mocker.getTargetResponse().setType(TypeUtil.getName(response));
+        if (ContextManager.needReplay()) {
+            MockUtils.replayMocker(mocker);
+        } else {
+            MockUtils.recordMocker(mocker);
+        }
+        CaseEventDispatcher.onEvent(CaseEvent.ofExitEvent());
     }
 }

arex-instrumentation/netty/arex-netty-v4/src/test/java/io/arex/inst/netty/v4/server/RequestTracingHandlerTest.java

@@ -148,46 +148,4 @@ static Stream<Arguments> channelReadCase() {
                 arguments(mocker10, request)
         );
     }
-
-    @ParameterizedTest
-    @MethodSource("channelReadCompleteCase")
-    void channelReadComplete(Runnable mocker, Assert asserts) throws Exception {
-        mocker.run();
-        target.channelReadComplete(ctx);
-        asserts.verity();
-    }
-
-    static Stream<Arguments> channelReadCompleteCase() {
-        Channel channel = Mockito.mock(Channel.class);
-        Attribute attribute = Mockito.mock(Attribute.class);
-        Runnable mocker1 = () -> {
-            Mockito.when(ctx.channel()).thenReturn(channel);
-            Mockito.when(channel.attr(any())).thenReturn(attribute);
-        };
-
-        ArexMocker mocker = new ArexMocker();
-        Runnable mocker2 = () -> {
-            mocker.setTargetRequest(new Target());
-            mocker.setTargetResponse(new Target());
-            Mockito.when(attribute.getAndSet(null)).thenReturn(mocker);
-            Mockito.when(ContextManager.needReplay()).thenReturn(true);
-        };
-        Runnable mocker3 = () -> {
-            Mockito.when(ContextManager.needReplay()).thenReturn(false);
-            Mockito.when(ContextManager.needRecord()).thenReturn(true);
-        };
-
-        Assert asserts1 = () -> {
-            mockCaseEvent.verify(() -> CaseEventDispatcher.onEvent(any()), times(0));
-        };
-        Assert asserts2 = () -> {
-            mockCaseEvent.verify(() -> CaseEventDispatcher.onEvent(any()), atLeastOnce());
-        };
-
-        return Stream.of(
-                arguments(mocker1, asserts1),
-                arguments(mocker2, asserts2),
-                arguments(mocker3, asserts2)
-        );
-    }
 }