fix: record servlet request redirect (#161)

Author: mr3

arex-agent-bootstrap/src/main/java/io/arex/agent/bootstrap/model/Mocker.java

@@ -1,5 +1,6 @@
 package io.arex.agent.bootstrap.model;
 
+import io.arex.agent.bootstrap.util.StringUtil;
 import java.io.Serializable;
 import java.util.HashMap;
 import java.util.Map;
@@ -90,4 +91,21 @@ public void setType(String type) {
             this.type = type;
         }
     }
+
+    default StringBuilder logBuilder() {
+        StringBuilder builder = new StringBuilder("[arex]");
+        boolean isReplay = StringUtil.isNotEmpty(getReplayId());
+        if (isReplay) {
+            builder.append("replay");
+        } else {
+            builder.append("record");
+        }
+        builder.append(" category: ").append(getCategoryType().getName());
+        builder.append(", operation: ").append(getOperationName());
+        builder.append(", recordId: ").append(getRecordId());
+        if (isReplay) {
+            builder.append(", replayId: ").append(getReplayId());
+        }
+        return builder;
+    }
 }

arex-agent-core/src/test/java/io/arex/agent/instrumentation/InstrumentationInstallerTest.java

@@ -119,6 +119,5 @@ void onTransformation() throws IOException {
         DynamicType dynamicType = Mockito.mock(DynamicType.class);
         listener.onTransformation(typeDescription, null, null, false, dynamicType);
         verify(dynamicType).saveIn(any());
-        listener.onError(null, null,null, false, null);
     }
-}
+}

arex-instrumentation-api/src/main/java/io/arex/inst/runtime/context/ArexContext.java

@@ -1,9 +1,12 @@
 package io.arex.inst.runtime.context;
 
 import io.arex.agent.bootstrap.util.StringUtil;
+import io.arex.inst.runtime.model.ArexConstants;
 import java.util.ArrayList;
+import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
 
@@ -17,16 +20,16 @@ public class ArexContext {
     private final Map<String, Object> cachedReplayResultMap = new ConcurrentHashMap<>();
     private Map<String, Set<String>> excludeMockTemplate;
 
-    public String getCaseId() {
-        return this.caseId;
-    }
+    private Map<String, Object> attachments = null;
 
-    public String getReplayId() {
-        return this.replayId;
+    private boolean isRedirectRequest;
+
+    public static ArexContext of(String caseId) {
+        return of(caseId, null);
     }
 
-    public long getCreateTime() {
-        return createTime;
+    public static ArexContext of(String caseId, String replayId) {
+        return new ArexContext(caseId, replayId);
     }
 
     private ArexContext(String caseId, String replayId) {
@@ -36,32 +39,28 @@ private ArexContext(String caseId, String replayId) {
         this.replayId = replayId;
     }
 
-    public boolean isReplay() {
-        return StringUtil.isNotEmpty(this.replayId);
-    }
-
-    public void add(String key, String value) {
-
+    public String getCaseId() {
+        return this.caseId;
     }
 
-    public String get(String key) {
-        return null;
+    public String getReplayId() {
+        return this.replayId;
     }
 
-    public int calculateSequence(String target) {
-        return StringUtil.isEmpty(target) ? 0 : sequence.get(target);
+    public long getCreateTime() {
+        return createTime;
     }
 
-    public int calculateSequence() {
-        return 0;
+    public boolean isRecord() {
+        return !isReplay();
     }
 
-    public static ArexContext of(String caseId) {
-        return of(caseId, null);
+    public boolean isReplay() {
+        return StringUtil.isNotEmpty(this.replayId);
     }
 
-    public static ArexContext of(String caseId, String replayId) {
-        return new ArexContext(caseId, replayId);
+    public int calculateSequence(String target) {
+        return StringUtil.isEmpty(target) ? 0 : sequence.get(target);
     }
 
     public List<Integer> getMethodSignatureHashList() {
@@ -78,12 +77,61 @@ public Map<String, Set<String>> getExcludeMockTemplate() {
     public void setExcludeMockTemplate(Map<String, Set<String>> excludeMockTemplate) {
         this.excludeMockTemplate = excludeMockTemplate;
     }
+
+    public void setAttachment(String key, Object value) {
+        if (attachments == null) {
+            attachments = new HashMap<>();
+        }
+
+        attachments.put(key, value);
+    }
+
+    public Object getAttachment(String key) {
+        if (attachments == null) {
+            return null;
+        }
+
+        return attachments.get(key);
+    }
+
+    public boolean isRedirectRequest() {
+        return isRedirectRequest;
+    }
+
+    public void setRedirectRequest(boolean redirectRequest) {
+        isRedirectRequest = redirectRequest;
+    }
+
+    public boolean isRedirectRequest(String referer) {
+        if (attachments == null) {
+            isRedirectRequest = false;
+            return false;
+        }
+
+        if (StringUtil.isEmpty(referer)) {
+            isRedirectRequest = false;
+            return false;
+        }
+
+        Object location = attachments.get(ArexConstants.REDIRECT_REFERER);
+
+        if (location == null) {
+            isRedirectRequest = false;
+            return false;
+        }
+        isRedirectRequest = Objects.equals(location, referer);
+        return isRedirectRequest;
+    }
+
     public void clear() {
         methodSignatureHashList.clear();
         cachedReplayResultMap.clear();
         sequence.clear();
         if (excludeMockTemplate != null) {
             excludeMockTemplate.clear();
         }
+        if (attachments != null) {
+            attachments.clear();
+        }
     }
 }

arex-instrumentation-api/src/main/java/io/arex/inst/runtime/context/ContextManager.java

@@ -51,6 +51,10 @@ public static ArexContext currentContext(boolean createIfAbsent, String caseId)
         return RECORD_MAP.get(traceId);
     }
 
+    public static ArexContext getRecordContext(String recordId) {
+        return RECORD_MAP.get(recordId);
+    }
+
     public static boolean needRecord() {
         ArexContext context = currentContext();
         return context != null && !context.isReplay();

arex-instrumentation-api/src/main/java/io/arex/inst/runtime/model/ArexConstants.java

@@ -7,6 +7,9 @@ private ArexConstants() {}
     public static final String REPLAY_ID = "arex-replay-id";
     public static final String REPLAY_WARM_UP = "arex-replay-warm-up";
     public static final String FORCE_RECORD = "arex-force-record";
+    public static final String REDIRECT_REQUEST_METHOD = "arex-redirect-request-method";
+    public static final String REDIRECT_REFERER = "arex-redirect-referer";
+    public static final String REDIRECT_PATTERN = "arex-redirect-pattern";
     /**
      * mock template
      */

arex-instrumentation-api/src/main/java/io/arex/inst/runtime/util/MockUtils.java

@@ -17,6 +17,8 @@
 
 public final class MockUtils {
 
+    private static final String EMPTY_JSON = "{}";
+
     private MockUtils() {
     }
 
@@ -87,6 +89,11 @@ public static ArexMocker create(MockCategoryType categoryType, String operationN
 
     public static void recordMocker(Mocker requestMocker) {
         String postJson = Serializer.serialize(requestMocker);
+
+        if (Config.get().isEnableDebug()) {
+            LOGGER.info("{}\nrequest: {}", requestMocker.logBuilder(), postJson);
+        }
+
         DataService.INSTANCE.save(postJson);
     }
 
@@ -96,8 +103,14 @@ public static Mocker replayMocker(Mocker requestMocker) {
 
     public static Mocker replayMocker(Mocker requestMocker, MockStrategyEnum mockStrategy) {
         String postJson = Serializer.serialize(requestMocker);
+
         String data = DataService.INSTANCE.query(postJson, mockStrategy);
-        if (StringUtil.isEmpty(data) || "{}".equals(data)) {
+
+        if (Config.get().isEnableDebug()) {
+            LOGGER.info("{}\nrequest: {}\nresponse: {}", requestMocker.logBuilder(), postJson, data);
+        }
+
+        if (StringUtil.isEmpty(data) || EMPTY_JSON.equals(data)) {
             LOGGER.warn("[arex] response body is null. request: {}", postJson);
             return null;
         }
@@ -142,4 +155,4 @@ public static boolean checkResponseMocker(Mocker responseMocker) {
 
         return true;
     }
-}
+}

arex-instrumentation-foundation/src/main/java/io/arex/foundation/services/DataCollectorService.java

@@ -106,9 +106,6 @@ static void doSleep(long millis) {
     }
 
     void saveData(DataEntity entity) {
-        if (ConfigManager.INSTANCE.isEnableDebug()) {
-            LOGGER.info("[arex] save mocker: {}", entity.getPostData());
-        }
         AsyncHttpClientUtil.executeAsync(saveApiUrl, entity.getPostData()).whenComplete(saveMockDataConsumer(entity));
     }