Merge pull request #45 from honeycombio/tredman.hotfix

Fix crash in contextmanager if span is None

Author: tredman

beeline/test_trace.py

@@ -332,6 +332,18 @@ def test_run_hooks_and_send_adds_trace_fields(self):
         # ensure we only added fields b and c and did not try to overwrite a
         self.assertDictContainsSubset({'app.a': 1, 'app.b': 2, 'app.c': 3}, m_span.event.fields())
 
+    def test_trace_context_manager_does_not_crash_if_span_is_none(self):
+        m_client = Mock()
+        tracer = SynchronousTracer(m_client)
+        tracer.start_span = Mock()
+        tracer.start_span.return_value = None
+        tracer.finish_span = Mock()
+
+        with tracer('foo'):
+            pass
+
+        tracer.start_span.assert_called_once_with(context={'name': 'foo'}, parent_id=None)
+
 class TestTraceContext(unittest.TestCase):
     def test_marshal_trace_context(self):
         trace_id = "123456"

beeline/trace.py

@@ -43,28 +43,34 @@ def __call__(self, name, trace_id=None, parent_id=None):
             span = None
             if self.get_active_trace_id():
                 span = self.start_span(context={'name': name})
-                log('tracer context manager started new span, id = %s',
-                    span.id)
+                if span:
+                    log('tracer context manager started new span, id = %s',
+                        span.id)
             else:
                 span = self.start_trace(context={'name': name})
-                log('tracer context manager started new trace, id = %s',
-                    span.trace_id)
+                if span:
+                    log('tracer context manager started new trace, id = %s',
+                        span.trace_id)
             yield
         except Exception as e:
-            span.add_context({
-                "app.exception_type": str(type(e)),
-                "app.exception_string": str(e),
-            })
+            if span:
+                span.add_context({
+                    "app.exception_type": str(type(e)),
+                    "app.exception_string": str(e),
+                })
             raise
         finally:
-            if span.is_root():
-                log('tracer context manager ending trace, id = %s',
-                    span.trace_id)
-                self.finish_trace(span)
+            if span:
+                if span.is_root():
+                    log('tracer context manager ending trace, id = %s',
+                        span.trace_id)
+                    self.finish_trace(span)
+                else:
+                    log('tracer context manager ending span, id = %s',
+                        span.id)
+                    self.finish_span(span)
             else:
-                log('tracer context manager ending span, id = %s',
-                    span.id)
-                self.finish_span(span)
+                log('tracer context manager span for %s was unexpectedly None', name)
 
     @init_state
     def start_trace(self, context=None, trace_id=None, parent_span_id=None):

beeline/version.py

@@ -1 +1 @@
-VERSION = '2.4.0'
+VERSION = '2.4.1'

setup.py

@@ -4,7 +4,7 @@
 setup(
     python_requires='>=2.7',
     name='honeycomb-beeline',
-    version='2.4.0',
+    version='2.4.1',
     description='Honeycomb library for easy instrumentation',
     url='https://github.com/honeycombio/beeline-python',
     author='Honeycomb.io',
@@ -18,7 +18,7 @@
     tests_require=[
         'mock',
         'flask',
-        'tornado',
+        'tornado==5',
         'django<2; python_version == "2.7"',
         'django>=2; python_version >= "3.0"',
     ],