Merge pull request #288 from getappmap/feat/disable-value-tostring-config

feat: add config parameter to disable custom stringification

Author: apotterri

.github/workflows/build.yml

@@ -41,6 +41,8 @@ jobs:
 
             - name: Run Tests
               shell: bash
+              env:
+                  GITHUB_TOKEN: ${{ github.token }}
               run: |
                 set -e
                 bin/disable-gradle-daemon

agent/src/main/java/com/appland/appmap/config/Properties.java

@@ -34,6 +34,7 @@ public class Properties {
   public static final Integer PatternThreshold =
       resolveProperty("appmap.config.patternThreshold", 10);
 
+  public static final Boolean DisableValue = resolveProperty("appmap.event.disableValue", false);
   public static final Integer MaxValueSize = resolveProperty("appmap.event.valueSize", 1024);
 
   public static final String[] Records = resolveProperty("appmap.record", new String[0]);

agent/src/main/java/com/appland/appmap/output/v1/Value.java

@@ -115,19 +115,23 @@ public <T> T get() {
    */
   public Value freeze() {
     if (this.value != null) {
-      try {
-        this.value = this.value.toString();
-
-        if (Properties.MaxValueSize > 0 && this.value != null) {
-          this.value = StringUtils.abbreviate((String) this.value, "...", Properties.MaxValueSize);
+      if (Properties.DisableValue) {
+        this.value = "< disabled >";
+      } else {
+        try {
+          this.value = this.value.toString();
+
+          if (Properties.MaxValueSize > 0 && this.value != null) {
+            this.value = StringUtils.abbreviate((String) this.value, "...", Properties.MaxValueSize);
+          }
+        } catch (Throwable e) {
+          Logger.println("failed to resolve value of " + this.classType);
+          Logger.println(e.getMessage());
+          // it's possible our value object has been partially cleaned up and
+          // calls toString on a null object or the operation is otherwise
+          // unsupported
+          this.value = "< invalid >";
         }
-      } catch (Throwable e) {
-        Logger.println("failed to resolve value of " + this.classType);
-        Logger.println(e.getMessage());
-        // it's possible our value object has been partially cleaned up and
-        // calls toString on a null object or the operation is otherwise
-        // unsupported
-        this.value = "< invalid >";
       }
     }
     return this;

agent/src/test/java/com/appland/appmap/test/fixture/Example.java

@@ -0,0 +1,13 @@
+package com.appland.appmap.test.fixture;
+
+public class Example {
+  @Override
+  public String toString() {
+    return "an Example";
+  }
+
+  public Example doSomething(Example other) {
+    return other;
+  }
+
+}

agent/test/event/.gitignore

@@ -0,0 +1 @@
+*.class

agent/test/event/DisabledValue.java

@@ -0,0 +1,23 @@
+import java.io.IOException;
+import java.io.OutputStreamWriter;
+
+import com.appland.appmap.record.Recorder;
+import com.appland.appmap.record.Recording;
+
+import com.appland.appmap.test.fixture.Example;
+
+public class DisabledValue {
+
+  public static void main(String[] argv) {
+    final Recording recording = Recorder.getInstance().record(() -> {
+      new Example().doSomething(new Example());
+    });
+
+    try {
+      recording.readFully(true, new OutputStreamWriter(System.out));
+    } catch (IOException e) {
+      e.printStackTrace();
+    }
+
+  }
+}

agent/test/event/appmap.yml

@@ -0,0 +1,3 @@
+name: test-event
+packages:
+- path: com.appland.appmap.test.fixture

agent/test/event/event.bats

@@ -0,0 +1,32 @@
+#!/usr/bin/env bats
+
+load '../../build/bats/bats-support/load'
+load '../../build/bats/bats-assert/load'
+load '../helper'
+
+sep="$JAVA_PATH_SEPARATOR"
+AGENT_JAR="$(find_agent_jar)"
+wd=$(getcwd)
+test_cp="${wd}/test/event${sep}${wd}/build/classes/java/test"
+java_cmd="java -javaagent:'${AGENT_JAR}' -cp '${test_cp}'"
+
+setup() {
+  javac -cp "${AGENT_JAR}${sep}${test_cp}" test/event/*.java
+
+  cd test/event
+  _configure_logging
+}
+
+@test "disabled value" {
+  local cmd="${java_cmd} -Dappmap.event.disableValue=true DisabledValue"
+  [[ $BATS_VERBOSE_RUN == 1 ]] && echo "cmd: $cmd" >&3
+  
+  local output
+  output=$(eval "$cmd")
+
+  echo "$output" | jq -e '.events[0] | select(.event=="call" 
+    and .parameters[0].value == "< disabled >" 
+    and .receiver.value == "< disabled >")'
+  echo "$output" | jq -e '.events[1] | select(.event=="return" 
+    and .return_value.value == "< disabled >")'
+}