Span id encoding (#719)

Author: mhindery

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+- Fix cloud format propagator to use decimal span_id encoding instead of hex
+  ([#719](https://github.com/census-instrumentation/opencensus-python/pull/719))
+
+
 ## 0.6.0
 Released 2019-05-31
 

opencensus/trace/propagation/google_cloud_format.py

@@ -19,7 +19,7 @@
 from opencensus.trace.trace_options import TraceOptions
 
 _TRACE_CONTEXT_HEADER_NAME = 'X-Cloud-Trace-Context'
-_TRACE_CONTEXT_HEADER_FORMAT = r'([0-9a-f]{32})(\/([0-9a-f]{16}))?(;o=(\d+))?'
+_TRACE_CONTEXT_HEADER_FORMAT = r'([0-9a-f]{32})(\/([\d]{0,20}))?(;o=(\d+))?'
 _TRACE_CONTEXT_HEADER_RE = re.compile(_TRACE_CONTEXT_HEADER_FORMAT)
 _TRACE_ID_DELIMETER = '/'
 _SPAN_ID_DELIMETER = ';'
@@ -62,6 +62,9 @@ def from_header(self, header):
             if trace_options is None:
                 trace_options = 1
 
+            if span_id:
+                span_id = '{:016x}'.format(int(span_id))
+
             span_context = SpanContext(
                 trace_id=trace_id,
                 span_id=span_id,
@@ -88,7 +91,6 @@ def from_headers(self, headers):
         header = headers.get(_TRACE_CONTEXT_HEADER_NAME)
         if header is None:
             return SpanContext()
-        header = str(header.encode('utf-8'))
         return self.from_header(header)
 
     def to_header(self, span_context):
@@ -107,7 +109,7 @@ def to_header(self, span_context):
 
         header = '{}/{};o={}'.format(
             trace_id,
-            span_id,
+            int(span_id, 16),
             int(trace_options))
         return header
 

tests/system/trace/basic_trace/basic_trace_system_test.py

@@ -33,7 +33,8 @@ def test_tracer(self):
         span_id = '6e0c63257de34c92'
         trace_option = 1
 
-        trace_header = '{}/{};o={}'.format(trace_id, span_id, trace_option)
+        trace_header = '{}/{};o={}'.format(
+            trace_id, int(span_id, 16), trace_option)
 
         sampler = samplers.AlwaysOnSampler()
         exporter = file_exporter.FileExporter()

tests/system/trace/django/django_system_test.py

@@ -43,7 +43,7 @@ def generate_header():
     span_id = uuid.uuid4().hex[:16]
     trace_option = 1
 
-    header = '{}/{};o={}'.format(trace_id, span_id, trace_option)
+    header = '{}/{};o={}'.format(trace_id, int(span_id, 16), trace_option)
 
     return trace_id, span_id, header
 
@@ -74,7 +74,7 @@ def setUp(self):
 
         self.headers_trace = {
             'x-cloud-trace-context':
-            '{}/{};o={}'.format(self.trace_id, self.span_id, 1)
+            '{}/{};o={}'.format(self.trace_id, int(self.span_id, 16), 1)
         }
 
         # Wait the application to start

tests/system/trace/flask/flask_system_test.py

@@ -43,7 +43,7 @@ def generate_header():
     span_id = uuid.uuid4().hex[:16]
     trace_option = 1
 
-    header = '{}/{};o={}'.format(trace_id, span_id, trace_option)
+    header = '{}/{};o={}'.format(trace_id, int(span_id, 16), trace_option)
 
     return trace_id, span_id, header
 
@@ -73,7 +73,7 @@ def setUp(self):
 
         self.headers_trace = {
             'X-Cloud-Trace-Context':
-            '{}/{};o={}'.format(self.trace_id, self.span_id, 1)
+            '{}/{};o={}'.format(self.trace_id, int(self.span_id, 16), 1)
         }
 
         # Wait the application to start

tests/unit/trace/propagation/test_google_cloud_format.py

@@ -53,7 +53,7 @@ def test_header_type_error(self):
 
     def test_header_match(self):
         # Trace option is not enabled.
-        header = '6e0c63257de34c92bf9efcd03927272e/00f067aa0ba902b7;o=0'
+        header = '6e0c63257de34c92bf9efcd03927272e/67667974448284343;o=0'
         expected_trace_id = '6e0c63257de34c92bf9efcd03927272e'
         expected_span_id = '00f067aa0ba902b7'
 
@@ -65,7 +65,7 @@ def test_header_match(self):
         self.assertFalse(span_context.trace_options.enabled)
 
         # Trace option is enabled.
-        header = '6e0c63257de34c92bf9efcd03927272e/00f067aa0ba902b7;o=1'
+        header = '6e0c63257de34c92bf9efcd03927272e/67667974448284343;o=1'
         expected_trace_id = '6e0c63257de34c92bf9efcd03927272e'
         expected_span_id = '00f067aa0ba902b7'
 
@@ -76,8 +76,58 @@ def test_header_match(self):
         self.assertEqual(span_context.span_id, expected_span_id)
         self.assertTrue(span_context.trace_options.enabled)
 
+    def test_header_match_no_span_id(self):
+        # Trace option is not enabled.
+        header = '6e0c63257de34c92bf9efcd03927272e;o=0'
+        expected_trace_id = '6e0c63257de34c92bf9efcd03927272e'
+        expected_span_id = None
+
+        propagator = google_cloud_format.GoogleCloudFormatPropagator()
+        span_context = propagator.from_header(header)
+
+        self.assertEqual(span_context.trace_id, expected_trace_id)
+        self.assertEqual(span_context.span_id, expected_span_id)
+        self.assertFalse(span_context.trace_options.enabled)
+
+        # Trace option is enabled.
+        header = '6e0c63257de34c92bf9efcd03927272e;o=1'
+        expected_trace_id = '6e0c63257de34c92bf9efcd03927272e'
+        expected_span_id = None
+
+        propagator = google_cloud_format.GoogleCloudFormatPropagator()
+        span_context = propagator.from_header(header)
+
+        self.assertEqual(span_context.trace_id, expected_trace_id)
+        self.assertEqual(span_context.span_id, expected_span_id)
+        self.assertTrue(span_context.trace_options.enabled)
+
+    def test_header_match_empty_span_id(self):
+        # Trace option is not enabled.
+        header = '6e0c63257de34c92bf9efcd03927272e/;o=0'
+        expected_trace_id = '6e0c63257de34c92bf9efcd03927272e'
+        expected_span_id = None
+
+        propagator = google_cloud_format.GoogleCloudFormatPropagator()
+        span_context = propagator.from_header(header)
+
+        self.assertEqual(span_context.trace_id, expected_trace_id)
+        self.assertEqual(span_context.span_id, expected_span_id)
+        self.assertFalse(span_context.trace_options.enabled)
+
+        # Trace option is enabled.
+        header = '6e0c63257de34c92bf9efcd03927272e/;o=1'
+        expected_trace_id = '6e0c63257de34c92bf9efcd03927272e'
+        expected_span_id = None
+
+        propagator = google_cloud_format.GoogleCloudFormatPropagator()
+        span_context = propagator.from_header(header)
+
+        self.assertEqual(span_context.trace_id, expected_trace_id)
+        self.assertEqual(span_context.span_id, expected_span_id)
+        self.assertTrue(span_context.trace_options.enabled)
+
     def test_header_match_no_option(self):
-        header = '6e0c63257de34c92bf9efcd03927272e/00f067aa0ba902b7'
+        header = '6e0c63257de34c92bf9efcd03927272e/67667974448284343'
         expected_trace_id = '6e0c63257de34c92bf9efcd03927272e'
         expected_span_id = '00f067aa0ba902b7'
 
@@ -101,7 +151,7 @@ def test_headers_match(self):
         # Trace option is enabled.
         headers = {
             'X-Cloud-Trace-Context':
-                '6e0c63257de34c92bf9efcd03927272e/00f067aa0ba902b7;o=1',
+                '6e0c63257de34c92bf9efcd03927272e/67667974448284343;o=1',
         }
         expected_trace_id = '6e0c63257de34c92bf9efcd03927272e'
         expected_span_id = '00f067aa0ba902b7'
@@ -128,7 +178,7 @@ def test_to_header(self):
 
         header = propagator.to_header(span_context)
         expected_header = '{}/{};o={}'.format(
-            trace_id, span_id, 1)
+            trace_id, int(span_id, 16), 1)
 
         self.assertEqual(header, expected_header)
 
@@ -147,7 +197,8 @@ def test_to_headers(self):
 
         headers = propagator.to_headers(span_context)
         expected_headers = {
-            'X-Cloud-Trace-Context': '{}/{};o={}'.format(trace_id, span_id, 1),
+            'X-Cloud-Trace-Context': '{}/{};o={}'.format(
+                trace_id, int(span_id, 16), 1),
         }
 
         self.assertEqual(headers, expected_headers)