fix(analytics): exclude UUID from Event equality checks to allow for easier testing

Author: constantinius

src/sentry/analytics/event.py

@@ -64,7 +64,7 @@ def wrapper(cls: type[Event]) -> type[Event]:
         # set the Event subclass `type` attribute, if it is set to anything
         if isinstance(event_name_or_class, str):
             cls.type = event_name_or_class
-        return cast(type[Event], dataclass(kw_only=True)(cls))
+        return cast(type[Event], dataclass(kw_only=True, eq=False)(cls))
 
     # for using without parenthesis, wrap the passed class
     if isinstance(event_name_or_class, type) and issubclass(event_name_or_class, Event):
@@ -75,7 +75,7 @@ def wrapper(cls: type[Event]) -> type[Event]:
 
 
 # unfortunately we cannot directly use `eventclass` here, as it is making a typecheck to Event
-@dataclass(kw_only=True)
+@dataclass(kw_only=True, eq=False)
 class Event:
     """
     Base class for custom analytics Events.
@@ -123,6 +123,18 @@ def from_instance(cls, instance: Any, **kwargs: Any) -> Self:
             }
         )
 
+    def __eq__(self, other: Any) -> bool:
+        if not isinstance(other, Event):
+            return False
+
+        self_values = self.serialize()
+        other_values = other.serialize()
+
+        self_values.pop("uuid")
+        other_values.pop("uuid")
+
+        return self_values == other_values
+
 
 def serialize_event(event: Event) -> dict[str, Any]:
     # TODO: this is the "old-style" attributes based serializer. Once all events are migrated to the new style,

tests/sentry/analytics/test_event.py

@@ -53,6 +53,21 @@ def test_simple(self, mock_uuid1):
             "uuid": b"AAEC",
         }
 
+    def test_equality_no_uuid_mock(self):
+        a = ExampleEvent(
+            id="1",  # type: ignore[arg-type]
+            map={"key": "value"},
+            optional=False,
+        )
+        a.datetime_ = datetime(2001, 4, 18, tzinfo=timezone.utc)
+        b = ExampleEvent(
+            id="1",  # type: ignore[arg-type]
+            map={"key": "value"},
+            optional=False,
+        )
+        b.datetime_ = datetime(2001, 4, 18, tzinfo=timezone.utc)
+        assert a == b
+
     @patch("sentry.analytics.event.uuid1")
     def test_simple_old_style(self, mock_uuid1):
         mock_uuid1.return_value = self.get_mock_uuid()