feat: distributed tracing (#39)

* WIP

* feat: introduce distributed tracing extension for cloud events

* chore: downgrade to python 3.10

* chore: don't test on windows

* chore: don't test on macos because docker won't work

Author: Noah Hummel

Makefile

@@ -4,7 +4,7 @@ analyze:
 	@poetry run pylint eventsourcingdb_client_python tests
 
 test:
-	@poetry run pytest
+	@poetry run pytest --maxfail=1
 
 clean:
 

eventsourcingdb_client_python/event/event.py

@@ -1,7 +1,6 @@
 from datetime import datetime
 from typing import TypeVar
 
-from .tracing import TracingContext
 from ..errors.validation_error import ValidationError
 from .event_context import EventContext
 
@@ -20,7 +19,8 @@ def __init__(
         time: datetime,
         data_content_type: str,
         predecessor_hash: str,
-        tracing_context: TracingContext = None
+        trace_parent: str = None,
+        trace_state: str = None
     ):
         super().__init__(
             source,
@@ -31,13 +31,15 @@ def __init__(
             time,
             data_content_type,
             predecessor_hash,
-            tracing_context
+            trace_parent,
+            trace_state
         )
         self.data = data
 
     @staticmethod
     def parse(unknown_object: dict) -> Self:
         event_context = super(Event, Event).parse(unknown_object)
+
         data = unknown_object.get('data')
         if not isinstance(data, dict):
             raise ValidationError(
@@ -54,7 +56,8 @@ def parse(unknown_object: dict) -> Self:
             event_context.time,
             event_context.data_content_type,
             event_context.predecessor_hash,
-            event_context.tracing_context
+            event_context.trace_parent,
+            event_context.trace_state
         )
 
     def to_json(self):

eventsourcingdb_client_python/event/event_candidate.py

@@ -1,6 +1,5 @@
 from dataclasses import dataclass
 
-from .tracing import TracingContext
 from .validate_subject import validate_subject
 from .validate_type import validate_type
 
@@ -11,7 +10,8 @@ class EventCandidate:
     subject: str
     type: str
     data: dict
-    tracing_context: TracingContext | None = None
+    trace_parent: str = None
+    trace_state: str = None
 
     def validate(self) -> None:
         validate_subject(self.subject)
@@ -25,7 +25,9 @@ def to_json(self):
             'type': self.type
         }
 
-        if self.tracing_context is not None:
-            json['tracingContext'] = self.tracing_context.to_json()
+        if self.trace_parent is not None:
+            json['traceparent'] = self.trace_parent
+        if self.trace_state is not None:
+            json['tracestate'] = self.trace_state
 
         return json

eventsourcingdb_client_python/event/event_context.py

@@ -2,7 +2,6 @@
 from datetime import datetime
 from typing import TypeVar
 
-from .tracing import TracingContext
 from ..errors.internal_error import InternalError
 from ..errors.validation_error import ValidationError
 from .validate_subject import validate_subject
@@ -21,7 +20,8 @@ class EventContext:
     time: datetime
     data_content_type: str
     predecessor_hash: str
-    tracing_context: TracingContext | None = None
+    trace_parent: str = None
+    trace_state: str = None
 
     @staticmethod
     def parse(unknown_object: dict) -> Self:
@@ -77,10 +77,15 @@ def parse(unknown_object: dict) -> Self:
             raise ValidationError(
                 f'Failed to parse predecessor_hash \'{predecessor_hash}\' to string.')
 
-        raw_tracing_context = unknown_object.get("tracingContext")
-        tracing_context = TracingContext.parse(raw_tracing_context) \
-            if raw_tracing_context is not None \
-            else None
+        trace_parent = unknown_object.get('traceparent')
+        if trace_parent is not None and not isinstance(trace_parent, str):
+            raise ValidationError(
+                f'Failed to parse trace_parent \'{trace_parent}\' to string.')
+
+        trace_state = unknown_object.get('tracestate')
+        if trace_state is not None and not isinstance(trace_state, str):
+            raise ValidationError(
+                f'Failed to parse trace_state \'{trace_state}\' to string.')
 
         return EventContext(
             source=source,
@@ -91,11 +96,12 @@ def parse(unknown_object: dict) -> Self:
             time=time,
             data_content_type=data_content_type,
             predecessor_hash=predecessor_hash,
-            tracing_context=tracing_context
+            trace_parent=trace_parent,
+            trace_state=trace_state,
         )
 
     def to_json(self):
-        return {
+        json = {
             'specversion': self.spec_version,
             'id': self.event_id,
             'time': self.time.isoformat(sep='T'),
@@ -105,3 +111,10 @@ def to_json(self):
             'datacontenttype': self.data_content_type,
             'predecessorhash': self.predecessor_hash
         }
+
+        if self.trace_parent is not None:
+            json['traceparent'] = self.trace_parent
+        if self.trace_state is not None:
+            json['tracestate'] = self.trace_state
+
+        return json

eventsourcingdb_client_python/event/source.py

@@ -1,6 +1,5 @@
 from dataclasses import dataclass
 
-from ..event.tracing import TracingContext
 from ..event.event_candidate import EventCandidate
 
 
@@ -13,6 +12,14 @@ def new_event(
         subject: str,
         event_type: str,
         data: dict,
-        tracing_context: TracingContext = None
+        trace_parent: str = None,
+        trace_state: str = None
     ) -> EventCandidate:
-        return EventCandidate(self.source, subject, event_type, data, tracing_context)
+        return EventCandidate(
+            self.source,
+            subject,
+            event_type,
+            data,
+            trace_parent,
+            trace_state
+        )