[Feat][SDK- 431] Add threads information to payload (#327)

* fix: typos

* feat: add new class RollbarThread

* feat: set thread information from RollbarUncaughtExceptionHandler

* feat: add Exception Thread and other threads information

* feat: add Threads to body

* feat: add Threads to throwable wrapper in notifier

* refactor: a Thread should only contain trace_chain, not trace

* refactor: add a list of groups before threads in payload

* refactor: simplify truncation in TelemetryEvents

* refactor: add truncation to TelemetryEvents in body

* refactor: add truncation helper method for a list with Truncatable objects

* refactor: truncate Group in body

* refactor: set expected payload, first threads, with a group of trace_chains inside every thread

* refactor: remove locals field in a Trace from a non exception thread

* chore: fix indentation

* chore: remove * from import

* chore: add Java doc and fix indentations

* chore: add Java doc and fix indentations

* chore: fix lint

* chore: fix lint

* chore: add revapi info

* feat: add threads to a catch exception log

* chore: fix lint, line max size exceeded

* test: now we capture threads info using the current thread

* refactor(FramesStrategy): set truncateTraceChain with default visibility to use it in RollbarThreadStrategy

* refactor(Group): set property as type TraceChain and add getter

* feat(RollbarThreadStrategy): add truncation strategy for RollbarThread

* fix: lint

* fix: lint

* fix: lint

* fix(RollbarThreadStrategy): lint

* feat: Add strategy for Telemetry events

* feat: Add is_main field

* refactor: replace Thread by RollbarThread in ThrowableWrapper

* CI: bump ubuntu image to 22.04

Ref. actions/runner-images#11101

* fix: lint

* fix: update revapi.yml replacing getThread with getRollbarThread

---------

Co-authored-by: chris <[email protected]>

Author: buongarzoni

.github/workflows/ci.yml

@@ -19,13 +19,13 @@ on:
 jobs:
   validation:
     name: Gradle wrapper validation
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - uses: actions/checkout@v4
       - uses: gradle/actions/wrapper-validation@v3
 
   build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     name: Build with Java ${{ matrix.java }}
     needs: [ validation ]
     strategy:
@@ -71,7 +71,7 @@ jobs:
             **/build/reports/*
 
   release:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     name: Release
     # It would be nice to run this as part of the build job, since it would be
     # faster and have less duplicated Yaml, it would not be possible to check

.palantir/revapi.yml

@@ -33,3 +33,15 @@ acceptedBreaks:
     - code: "java.method.addedToInterface"
       new: "method int com.rollbar.notifier.config.CommonConfig::maximumTelemetryData()"
       justification: "This is going to be added in a major version"
+  "2.1.0":
+    com.rollbar:rollbar-java:
+      - code: "java.method.addedToInterface"
+        new: "method java.util.Map<java.lang.Thread, java.lang.StackTraceElement[]> com.rollbar.notifier.wrapper.ThrowableWrapper::getAllStackTraces()"
+        justification: "This is a binary compatible change, which could only break custom\
+        \ implementations of our config interfaces, but those interfaces are not meant\
+        \ to be implemented by users"
+      - code: "java.method.addedToInterface"
+        new: "method com.rollbar.api.payload.data.body.RollbarThread com.rollbar.notifier.wrapper.ThrowableWrapper::getRollbarThread()"
+        justification: "This is a binary compatible change, which could only break custom\
+        \ implementations of our config interfaces, but those interfaces are not meant\
+        \ to be implemented by users"

rollbar-api/src/main/java/com/rollbar/api/payload/data/TelemetryEvent.java

@@ -56,17 +56,12 @@ public Map<String, Object> asJson() {
 
   @Override
   public TelemetryEvent truncateStrings(int maxLength) {
-    Map<String, String> truncatedMap = new HashMap<>();
-    for (Map.Entry<String, String> entry : body.entrySet()) {
-      String truncatedValue = TruncationHelper.truncateString(entry.getValue(), maxLength);
-      truncatedMap.put(entry.getKey(), truncatedValue);
-    }
     return new TelemetryEvent(
         this.type,
         this.level,
         this.timestamp,
         this.source,
-        truncatedMap
+        TruncationHelper.truncateStringsInStringMap(body, maxLength)
     );
   }
 

rollbar-api/src/main/java/com/rollbar/api/payload/data/body/Body.java

@@ -3,6 +3,7 @@
 import com.rollbar.api.json.JsonSerializable;
 import com.rollbar.api.payload.data.TelemetryEvent;
 import com.rollbar.api.truncation.StringTruncatable;
+import com.rollbar.api.truncation.TruncationHelper;
 
 import java.util.HashMap;
 import java.util.List;
@@ -19,19 +20,41 @@ public class Body implements JsonSerializable, StringTruncatable<Body> {
 
   private final List<TelemetryEvent> telemetryEvents;
 
+  private final List<RollbarThread> rollbarThreads;
+
   private Body(Builder builder) {
     this.bodyContent = builder.bodyContent;
     this.telemetryEvents = builder.telemetryEvents;
+    this.rollbarThreads = builder.rollbarThreads;
   }
 
   /**
    * Getter.
+   *
    * @return the contents.
    */
   public BodyContent getContents() {
     return bodyContent;
   }
 
+  /**
+   * Getter.
+   *
+   * @return the rollbar threads.
+   */
+  public List<RollbarThread> getRollbarThreads() {
+    return rollbarThreads;
+  }
+
+  /**
+   * Getter.
+   *
+   * @return the list of Telemetry events.
+   */
+  public List<TelemetryEvent> getTelemetryEvents() {
+    return telemetryEvents;
+  }
+
   @Override
   public Object asJson() {
     HashMap<String, Object> values = new HashMap<>();
@@ -44,15 +67,21 @@ public Object asJson() {
       values.put("telemetry", telemetryEvents);
     }
 
+    if (rollbarThreads != null) {
+      values.put("threads", rollbarThreads);
+    }
+
     return values;
   }
 
   @Override
   public Body truncateStrings(int maxSize) {
     if (bodyContent != null) {
       return new Body.Builder(this)
-          .bodyContent(bodyContent.truncateStrings(maxSize))
-          .build();
+        .bodyContent(bodyContent.truncateStrings(maxSize))
+        .telemetryEvents(TruncationHelper.truncate(telemetryEvents, maxSize))
+        .rollbarThreads(TruncationHelper.truncate(rollbarThreads, maxSize))
+        .build();
     } else {
       return this;
     }
@@ -70,20 +99,22 @@ public boolean equals(Object o) {
 
     Body body = (Body) o;
     return Objects.equals(bodyContent, body.bodyContent)
-        && Objects.equals(telemetryEvents, body.telemetryEvents);
+      && Objects.equals(telemetryEvents, body.telemetryEvents)
+      && Objects.equals(rollbarThreads, body.rollbarThreads);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(bodyContent, telemetryEvents);
+    return Objects.hash(bodyContent, telemetryEvents, rollbarThreads);
   }
 
   @Override
   public String toString() {
     return "Body{"
-        + "bodyContent=" + bodyContent
-        + ", telemetry=" + telemetryEvents
-        + '}';
+      + "bodyContent=" + bodyContent
+      + ", telemetry=" + telemetryEvents
+      + ", threads=" + rollbarThreads
+      + '}';
   }
 
   /**
@@ -95,6 +126,8 @@ public static final class Builder {
 
     private List<TelemetryEvent> telemetryEvents;
 
+    private List<RollbarThread> rollbarThreads;
+
     /**
      * Constructor.
      */
@@ -108,8 +141,9 @@ public Builder() {
      * @param body the {@link Body body} to initialize a new builder instance.
      */
     public Builder(Body body) {
-      this.bodyContent = body.bodyContent;
-      this.telemetryEvents = body.telemetryEvents;
+      bodyContent = body.bodyContent;
+      telemetryEvents = body.telemetryEvents;
+      rollbarThreads = body.rollbarThreads;
     }
 
     /**
@@ -135,6 +169,17 @@ public Builder telemetryEvents(List<TelemetryEvent> telemetryEvents) {
       return this;
     }
 
+    /**
+     * Information from threads.
+     *
+     * @param rollbarThreads a list of threads;
+     * @return the builder instance.
+     */
+    public Builder rollbarThreads(List<RollbarThread> rollbarThreads) {
+      this.rollbarThreads = rollbarThreads;
+      return this;
+    }
+
     /**
      * Builds the {@link Body body}.
      *

rollbar-api/src/main/java/com/rollbar/api/payload/data/body/Group.java

@@ -0,0 +1,63 @@
+package com.rollbar.api.payload.data.body;
+
+import com.rollbar.api.json.JsonSerializable;
+import com.rollbar.api.truncation.StringTruncatable;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.Objects;
+
+/**
+ * This represent a Group of trace chains in a Thread.
+ * In Java we only send 1 TraceChain per Group, in other languages like Python (ExceptionGroup) or
+ * JS (AggregatorError), it may be more TraceChains per group.
+ */
+public class Group implements JsonSerializable, StringTruncatable<Group> {
+  private final TraceChain traceChain;
+
+  public Group(TraceChain traceChain) {
+    this.traceChain = traceChain;
+  }
+
+  /**
+   * Getter.
+   *
+   * @return the trace chain.
+   */
+  public TraceChain getTraceChain() {
+    return traceChain;
+  }
+
+  @Override
+  public Object asJson() {
+    HashMap<String, Object> values = new HashMap<>();
+    values.put("trace_chain", traceChain);
+    ArrayList<HashMap<String, Object>> traceChains = new ArrayList<>();
+    traceChains.add(values);
+    return traceChains;
+  }
+
+  @Override
+  public Group truncateStrings(int maxLength) {
+    return new Group(traceChain.truncateStrings(maxLength));
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (o == null || getClass() != o.getClass()) {
+      return false;
+    }
+    Group group = (Group) o;
+    return Objects.equals(traceChain, group.traceChain);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hashCode(traceChain);
+  }
+
+  @Override
+  public String toString() {
+    return "Group{traceChain=" + traceChain + '}';
+  }
+}