Replace clone() with copy constructor (#1496)

Author: maciejwalkowiak

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 * Feat: Add secondary constructor to SentryOkHttpInterceptor (#1491)
 * Feat: Add option to enable debug mode in Log4j2 integration (#1492)
+* Ref: Replace clone() with copy constructor (#1496)
 
 # 5.0.0-beta.5
 

sentry/api/sentry.api

@@ -17,13 +17,11 @@ public final class io/sentry/Attachment {
 	public fun getPathname ()Ljava/lang/String;
 }
 
-public final class io/sentry/Breadcrumb : io/sentry/IUnknownPropertiesConsumer, java/lang/Cloneable {
+public final class io/sentry/Breadcrumb : io/sentry/IUnknownPropertiesConsumer {
 	public fun <init> ()V
 	public fun <init> (Ljava/lang/String;)V
 	public fun <init> (Ljava/util/Date;)V
 	public fun acceptUnknownProperties (Ljava/util/Map;)V
-	public fun clone ()Lio/sentry/Breadcrumb;
-	public synthetic fun clone ()Ljava/lang/Object;
 	public fun getCategory ()Ljava/lang/String;
 	public fun getData ()Ljava/util/Map;
 	public fun getData (Ljava/lang/String;)Ljava/lang/Object;
@@ -467,7 +465,7 @@ public final class io/sentry/SamplingContext {
 	public fun getTransactionContext ()Lio/sentry/TransactionContext;
 }
 
-public final class io/sentry/Scope : java/lang/Cloneable {
+public final class io/sentry/Scope {
 	public fun <init> (Lio/sentry/SentryOptions;)V
 	public fun addAttachment (Lio/sentry/Attachment;)V
 	public fun addBreadcrumb (Lio/sentry/Breadcrumb;)V
@@ -476,8 +474,6 @@ public final class io/sentry/Scope : java/lang/Cloneable {
 	public fun clear ()V
 	public fun clearBreadcrumbs ()V
 	public fun clearTransaction ()V
-	public fun clone ()Lio/sentry/Scope;
-	public synthetic fun clone ()Ljava/lang/Object;
 	public fun getContexts ()Lio/sentry/protocol/Contexts;
 	public fun getLevel ()Lio/sentry/SentryLevel;
 	public fun getRequest ()Lio/sentry/protocol/Request;
@@ -1017,17 +1013,16 @@ public final class io/sentry/Span : io/sentry/ISpan {
 	public fun toSentryTrace ()Lio/sentry/SentryTraceHeader;
 }
 
-public class io/sentry/SpanContext : java/lang/Cloneable {
+public class io/sentry/SpanContext {
 	public static final field TYPE Ljava/lang/String;
 	protected field description Ljava/lang/String;
 	protected field op Ljava/lang/String;
 	protected field status Lio/sentry/SpanStatus;
 	protected field tags Ljava/util/Map;
+	public fun <init> (Lio/sentry/SpanContext;)V
 	public fun <init> (Lio/sentry/protocol/SentryId;Lio/sentry/SpanId;Ljava/lang/String;Lio/sentry/SpanId;Ljava/lang/Boolean;)V
 	public fun <init> (Ljava/lang/String;)V
 	public fun <init> (Ljava/lang/String;Ljava/lang/Boolean;)V
-	public fun clone ()Lio/sentry/SpanContext;
-	public synthetic fun clone ()Ljava/lang/Object;
 	public fun getDescription ()Ljava/lang/String;
 	public fun getOperation ()Ljava/lang/String;
 	public fun getParentSpanId ()Lio/sentry/SpanId;
@@ -1311,12 +1306,10 @@ public abstract interface class io/sentry/hints/SubmissionResult {
 	public abstract fun setResult (Z)V
 }
 
-public final class io/sentry/protocol/App : io/sentry/IUnknownPropertiesConsumer, java/lang/Cloneable {
+public final class io/sentry/protocol/App : io/sentry/IUnknownPropertiesConsumer {
 	public static final field TYPE Ljava/lang/String;
 	public fun <init> ()V
 	public fun acceptUnknownProperties (Ljava/util/Map;)V
-	public fun clone ()Lio/sentry/protocol/App;
-	public synthetic fun clone ()Ljava/lang/Object;
 	public fun getAppBuild ()Ljava/lang/String;
 	public fun getAppIdentifier ()Ljava/lang/String;
 	public fun getAppName ()Ljava/lang/String;
@@ -1333,22 +1326,19 @@ public final class io/sentry/protocol/App : io/sentry/IUnknownPropertiesConsumer
 	public fun setDeviceAppHash (Ljava/lang/String;)V
 }
 
-public final class io/sentry/protocol/Browser : io/sentry/IUnknownPropertiesConsumer, java/lang/Cloneable {
+public final class io/sentry/protocol/Browser : io/sentry/IUnknownPropertiesConsumer {
 	public static final field TYPE Ljava/lang/String;
 	public fun <init> ()V
 	public fun acceptUnknownProperties (Ljava/util/Map;)V
-	public fun clone ()Lio/sentry/protocol/Browser;
-	public synthetic fun clone ()Ljava/lang/Object;
 	public fun getName ()Ljava/lang/String;
 	public fun getVersion ()Ljava/lang/String;
 	public fun setName (Ljava/lang/String;)V
 	public fun setVersion (Ljava/lang/String;)V
 }
 
-public final class io/sentry/protocol/Contexts : java/util/concurrent/ConcurrentHashMap, java/lang/Cloneable {
+public final class io/sentry/protocol/Contexts : java/util/concurrent/ConcurrentHashMap {
 	public fun <init> ()V
-	public fun clone ()Lio/sentry/protocol/Contexts;
-	public synthetic fun clone ()Ljava/lang/Object;
+	public fun <init> (Lio/sentry/protocol/Contexts;)V
 	public fun getApp ()Lio/sentry/protocol/App;
 	public fun getBrowser ()Lio/sentry/protocol/Browser;
 	public fun getDevice ()Lio/sentry/protocol/Device;
@@ -1398,12 +1388,10 @@ public final class io/sentry/protocol/DebugMeta : io/sentry/IUnknownPropertiesCo
 	public fun setSdkInfo (Lio/sentry/protocol/SdkInfo;)V
 }
 
-public final class io/sentry/protocol/Device : io/sentry/IUnknownPropertiesConsumer, java/lang/Cloneable {
+public final class io/sentry/protocol/Device : io/sentry/IUnknownPropertiesConsumer {
 	public static final field TYPE Ljava/lang/String;
 	public fun <init> ()V
 	public fun acceptUnknownProperties (Ljava/util/Map;)V
-	public fun clone ()Lio/sentry/protocol/Device;
-	public synthetic fun clone ()Ljava/lang/Object;
 	public fun getArchs ()[Ljava/lang/String;
 	public fun getBatteryLevel ()Ljava/lang/Float;
 	public fun getBatteryTemperature ()Ljava/lang/Float;
@@ -1473,12 +1461,10 @@ public final class io/sentry/protocol/Device$DeviceOrientation : java/lang/Enum
 	public static fun values ()[Lio/sentry/protocol/Device$DeviceOrientation;
 }
 
-public final class io/sentry/protocol/Gpu : io/sentry/IUnknownPropertiesConsumer, java/lang/Cloneable {
+public final class io/sentry/protocol/Gpu : io/sentry/IUnknownPropertiesConsumer {
 	public static final field TYPE Ljava/lang/String;
 	public fun <init> ()V
 	public fun acceptUnknownProperties (Ljava/util/Map;)V
-	public fun clone ()Lio/sentry/protocol/Gpu;
-	public synthetic fun clone ()Ljava/lang/Object;
 	public fun getApiType ()Ljava/lang/String;
 	public fun getId ()Ljava/lang/Integer;
 	public fun getMemorySize ()Ljava/lang/Integer;
@@ -1530,12 +1516,10 @@ public final class io/sentry/protocol/Message : io/sentry/IUnknownPropertiesCons
 	public fun setParams (Ljava/util/List;)V
 }
 
-public final class io/sentry/protocol/OperatingSystem : io/sentry/IUnknownPropertiesConsumer, java/lang/Cloneable {
+public final class io/sentry/protocol/OperatingSystem : io/sentry/IUnknownPropertiesConsumer {
 	public static final field TYPE Ljava/lang/String;
 	public fun <init> ()V
 	public fun acceptUnknownProperties (Ljava/util/Map;)V
-	public fun clone ()Lio/sentry/protocol/OperatingSystem;
-	public synthetic fun clone ()Ljava/lang/Object;
 	public fun getBuild ()Ljava/lang/String;
 	public fun getKernelVersion ()Ljava/lang/String;
 	public fun getName ()Ljava/lang/String;
@@ -1550,11 +1534,10 @@ public final class io/sentry/protocol/OperatingSystem : io/sentry/IUnknownProper
 	public fun setVersion (Ljava/lang/String;)V
 }
 
-public final class io/sentry/protocol/Request : io/sentry/IUnknownPropertiesConsumer, java/lang/Cloneable {
+public final class io/sentry/protocol/Request : io/sentry/IUnknownPropertiesConsumer {
 	public fun <init> ()V
+	public fun <init> (Lio/sentry/protocol/Request;)V
 	public fun acceptUnknownProperties (Ljava/util/Map;)V
-	public fun clone ()Lio/sentry/protocol/Request;
-	public synthetic fun clone ()Ljava/lang/Object;
 	public fun getCookies ()Ljava/lang/String;
 	public fun getData ()Ljava/lang/Object;
 	public fun getEnvs ()Ljava/util/Map;
@@ -1638,12 +1621,10 @@ public final class io/sentry/protocol/SentryPackage : io/sentry/IUnknownProperti
 	public fun setVersion (Ljava/lang/String;)V
 }
 
-public final class io/sentry/protocol/SentryRuntime : io/sentry/IUnknownPropertiesConsumer, java/lang/Cloneable {
+public final class io/sentry/protocol/SentryRuntime : io/sentry/IUnknownPropertiesConsumer {
 	public static final field TYPE Ljava/lang/String;
 	public fun <init> ()V
 	public fun acceptUnknownProperties (Ljava/util/Map;)V
-	public fun clone ()Lio/sentry/protocol/SentryRuntime;
-	public synthetic fun clone ()Ljava/lang/Object;
 	public fun getName ()Ljava/lang/String;
 	public fun getRawDescription ()Ljava/lang/String;
 	public fun getVersion ()Ljava/lang/String;
@@ -1754,11 +1735,10 @@ public final class io/sentry/protocol/SentryTransaction : io/sentry/SentryBaseEv
 	public fun isSampled ()Z
 }
 
-public final class io/sentry/protocol/User : io/sentry/IUnknownPropertiesConsumer, java/lang/Cloneable {
+public final class io/sentry/protocol/User : io/sentry/IUnknownPropertiesConsumer {
 	public fun <init> ()V
+	public fun <init> (Lio/sentry/protocol/User;)V
 	public fun acceptUnknownProperties (Ljava/util/Map;)V
-	public fun clone ()Lio/sentry/protocol/User;
-	public synthetic fun clone ()Ljava/lang/Object;
 	public fun getEmail ()Ljava/lang/String;
 	public fun getId ()Ljava/lang/String;
 	public fun getIpAddress ()Ljava/lang/String;

sentry/src/main/java/io/sentry/Breadcrumb.java

@@ -11,7 +11,7 @@
 import org.jetbrains.annotations.TestOnly;
 
 /** Series of application events */
-public final class Breadcrumb implements Cloneable, IUnknownPropertiesConsumer {
+public final class Breadcrumb implements IUnknownPropertiesConsumer {
 
   /** A timestamp representing when the breadcrumb occurred. */
   private final @NotNull Date timestamp;
@@ -43,6 +43,19 @@ public Breadcrumb(final @NotNull Date timestamp) {
     this.timestamp = timestamp;
   }
 
+  Breadcrumb(final @NotNull Breadcrumb breadcrumb) {
+    this.timestamp = breadcrumb.timestamp;
+    this.message = breadcrumb.message;
+    this.type = breadcrumb.type;
+    this.category = breadcrumb.category;
+    final Map<String, Object> dataClone = CollectionUtils.newConcurrentHashMap(breadcrumb.data);
+    if (dataClone != null) {
+      this.data = dataClone;
+    }
+    this.unknown = CollectionUtils.newConcurrentHashMap(breadcrumb.unknown);
+    this.level = breadcrumb.level;
+  }
+
   /**
    * Creates HTTP breadcrumb.
    *
@@ -236,27 +249,4 @@ public void acceptUnknownProperties(@NotNull Map<String, Object> unknown) {
   Map<String, Object> getUnknown() {
     return unknown;
   }
-
-  /**
-   * Clones the breadcrumb aka deep copy
-   *
-   * @return the cloned breadcrumb
-   * @throws CloneNotSupportedException if a breadcrumb is not cloneable
-   */
-  @Override
-  public @NotNull Breadcrumb clone() throws CloneNotSupportedException {
-    final Breadcrumb clone = (Breadcrumb) super.clone();
-
-    final Map<String, Object> dataCopy = CollectionUtils.newConcurrentHashMap(this.data);
-    if (dataCopy != null) {
-      clone.data = dataCopy;
-    }
-    clone.unknown = CollectionUtils.newConcurrentHashMap(unknown);
-
-    final SentryLevel levelRef = level;
-    clone.level =
-        levelRef != null ? SentryLevel.valueOf(levelRef.name().toUpperCase(Locale.ROOT)) : null;
-
-    return clone;
-  }
 }

sentry/src/main/java/io/sentry/Hub.java

@@ -429,16 +429,9 @@ public void pushScope() {
           .log(SentryLevel.WARNING, "Instance is disabled and this 'pushScope' call is a no-op.");
     } else {
       final StackItem item = stack.peek();
-      Scope clone = null;
-      try {
-        clone = item.getScope().clone();
-      } catch (CloneNotSupportedException e) {
-        options.getLogger().log(SentryLevel.ERROR, "An error has occurred when cloning a Scope", e);
-      }
-      if (clone != null) {
-        final StackItem newItem = new StackItem(options, item.getClient(), clone);
-        stack.push(newItem);
-      }
+      final StackItem newItem =
+          new StackItem(options, item.getClient(), new Scope(item.getScope()));
+      stack.push(newItem);
     }
   }