refactor instructionAddressAdjustment from String to enum

Author: supervacuus

sentry-android-core/src/main/java/io/sentry/android/core/internal/tombstone/TombstoneParser.java

@@ -104,7 +104,7 @@ private static SentryStackTrace createStackTrace(@NonNull final TombstoneProtos.
     // `libunwindstack` used for tombstones already applies instruction address adjustment:
     // https://android.googlesource.com/platform/system/unwinding/+/refs/heads/main/libunwindstack/Regs.cpp#175
     // prevent "processing" from doing it again.
-    stacktrace.setInstructionAddressAdjustment("none");
+    stacktrace.setInstructionAddressAdjustment(SentryStackTrace.InstructionAddressAdjustment.NONE);
 
     final Map<String, String> registers = new HashMap<>();
     for (TombstoneProtos.Register register : thread.getRegistersList()) {

sentry/api/sentry.api

@@ -6233,13 +6233,13 @@ public final class io/sentry/protocol/SentryStackTrace : io/sentry/JsonSerializa
 	public fun <init> ()V
 	public fun <init> (Ljava/util/List;)V
 	public fun getFrames ()Ljava/util/List;
-	public fun getInstructionAddressAdjustment ()Ljava/lang/String;
+	public fun getInstructionAddressAdjustment ()Lio/sentry/protocol/SentryStackTrace$InstructionAddressAdjustment;
 	public fun getRegisters ()Ljava/util/Map;
 	public fun getSnapshot ()Ljava/lang/Boolean;
 	public fun getUnknown ()Ljava/util/Map;
 	public fun serialize (Lio/sentry/ObjectWriter;Lio/sentry/ILogger;)V
 	public fun setFrames (Ljava/util/List;)V
-	public fun setInstructionAddressAdjustment (Ljava/lang/String;)V
+	public fun setInstructionAddressAdjustment (Lio/sentry/protocol/SentryStackTrace$InstructionAddressAdjustment;)V
 	public fun setRegisters (Ljava/util/Map;)V
 	public fun setSnapshot (Ljava/lang/Boolean;)V
 	public fun setUnknown (Ljava/util/Map;)V
@@ -6251,6 +6251,22 @@ public final class io/sentry/protocol/SentryStackTrace$Deserializer : io/sentry/
 	public synthetic fun deserialize (Lio/sentry/ObjectReader;Lio/sentry/ILogger;)Ljava/lang/Object;
 }
 
+public final class io/sentry/protocol/SentryStackTrace$InstructionAddressAdjustment : java/lang/Enum, io/sentry/JsonSerializable {
+	public static final field ALL Lio/sentry/protocol/SentryStackTrace$InstructionAddressAdjustment;
+	public static final field ALL_BUT_FIRST Lio/sentry/protocol/SentryStackTrace$InstructionAddressAdjustment;
+	public static final field AUTO Lio/sentry/protocol/SentryStackTrace$InstructionAddressAdjustment;
+	public static final field NONE Lio/sentry/protocol/SentryStackTrace$InstructionAddressAdjustment;
+	public fun serialize (Lio/sentry/ObjectWriter;Lio/sentry/ILogger;)V
+	public static fun valueOf (Ljava/lang/String;)Lio/sentry/protocol/SentryStackTrace$InstructionAddressAdjustment;
+	public static fun values ()[Lio/sentry/protocol/SentryStackTrace$InstructionAddressAdjustment;
+}
+
+public final class io/sentry/protocol/SentryStackTrace$InstructionAddressAdjustment$Deserializer : io/sentry/JsonDeserializer {
+	public fun <init> ()V
+	public fun deserialize (Lio/sentry/ObjectReader;Lio/sentry/ILogger;)Lio/sentry/protocol/SentryStackTrace$InstructionAddressAdjustment;
+	public synthetic fun deserialize (Lio/sentry/ObjectReader;Lio/sentry/ILogger;)Ljava/lang/Object;
+}
+
 public final class io/sentry/protocol/SentryStackTrace$JsonKeys {
 	public static final field FRAMES Ljava/lang/String;
 	public static final field INSTRUCTION_ADDRESS_ADJUSTMENT Ljava/lang/String;

sentry/src/main/java/io/sentry/JsonSerializer.java

@@ -87,6 +87,9 @@ public JsonSerializer(@NotNull SentryOptions options) {
         Device.DeviceOrientation.class, new Device.DeviceOrientation.Deserializer());
     deserializersByClass.put(Feedback.class, new Feedback.Deserializer());
     deserializersByClass.put(Gpu.class, new Gpu.Deserializer());
+    deserializersByClass.put(
+        SentryStackTrace.InstructionAddressAdjustment.class,
+        new SentryStackTrace.InstructionAddressAdjustment.Deserializer());
     deserializersByClass.put(MeasurementValue.class, new MeasurementValue.Deserializer());
     deserializersByClass.put(Mechanism.class, new Mechanism.Deserializer());
     deserializersByClass.put(Message.class, new Message.Deserializer());

sentry/src/main/java/io/sentry/protocol/SentryStackTrace.java

@@ -10,6 +10,7 @@
 import io.sentry.vendor.gson.stream.JsonToken;
 import java.io.IOException;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 import org.jetbrains.annotations.NotNull;
@@ -68,13 +69,12 @@ public final class SentryStackTrace implements JsonUnknown, JsonSerializable {
 
   /**
    * This value indicates if, and how, `instruction_addr` values in the stack frames need to be
-   * adjusted before they are symbolicated. TODO: should we make this an enum or is a string value
-   * fine?
+   * adjusted before they are symbolicated.
    *
    * @see SentryStackFrame#getInstructionAddr()
    * @see SentryStackFrame#setInstructionAddr(String)
    */
-  private @Nullable String instructionAddressAdjustment;
+  private @Nullable InstructionAddressAdjustment instructionAddressAdjustment;
 
   @SuppressWarnings("unused")
   private @Nullable Map<String, Object> unknown;
@@ -132,11 +132,12 @@ public void setUnknown(@Nullable Map<String, Object> unknown) {
     this.unknown = unknown;
   }
 
-  public @Nullable String getInstructionAddressAdjustment() {
+  public @Nullable InstructionAddressAdjustment getInstructionAddressAdjustment() {
     return instructionAddressAdjustment;
   }
 
-  public void setInstructionAddressAdjustment(@Nullable String instructionAddressAdjustment) {
+  public void setInstructionAddressAdjustment(
+      @Nullable InstructionAddressAdjustment instructionAddressAdjustment) {
     this.instructionAddressAdjustment = instructionAddressAdjustment;
   }
 
@@ -161,7 +162,9 @@ public void serialize(final @NotNull ObjectWriter writer, final @NotNull ILogger
       writer.name(JsonKeys.SNAPSHOT).value(snapshot);
     }
     if (instructionAddressAdjustment != null) {
-      writer.name(JsonKeys.INSTRUCTION_ADDRESS_ADJUSTMENT).value(instructionAddressAdjustment);
+      writer
+          .name(JsonKeys.INSTRUCTION_ADDRESS_ADJUSTMENT)
+          .value(logger, instructionAddressAdjustment);
     }
     if (unknown != null) {
       for (String key : unknown.keySet()) {
@@ -197,7 +200,8 @@ public static final class Deserializer implements JsonDeserializer<SentryStackTr
             sentryStackTrace.snapshot = reader.nextBooleanOrNull();
             break;
           case JsonKeys.INSTRUCTION_ADDRESS_ADJUSTMENT:
-            sentryStackTrace.instructionAddressAdjustment = reader.nextStringOrNull();
+            sentryStackTrace.instructionAddressAdjustment =
+                reader.nextOrNull(logger, new InstructionAddressAdjustment.Deserializer());
             break;
           default:
             if (unknown == null) {
@@ -214,4 +218,26 @@ public static final class Deserializer implements JsonDeserializer<SentryStackTr
   }
 
   // endregion
+
+  public enum InstructionAddressAdjustment implements JsonSerializable {
+    AUTO,
+    ALL,
+    ALL_BUT_FIRST,
+    NONE;
+
+    @Override
+    public void serialize(@NotNull ObjectWriter writer, @NotNull ILogger logger)
+        throws IOException {
+      writer.value(toString().toLowerCase(Locale.ROOT));
+    }
+
+    public static final class Deserializer
+        implements JsonDeserializer<InstructionAddressAdjustment> {
+      @Override
+      public @NotNull SentryStackTrace.InstructionAddressAdjustment deserialize(
+          @NotNull ObjectReader reader, @NotNull ILogger logger) throws Exception {
+        return InstructionAddressAdjustment.valueOf(reader.nextString().toUpperCase(Locale.ROOT));
+      }
+    }
+  }
 }