logtail-python 0.4.2__tar.gz → 0.4.3__tar.gz

{logtail_python-0.4.2 → logtail_python-0.4.3}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: logtail-python
-Version: 0.4.2
+Version: 0.4.3
 Summary: Better Stack client library
 Home-page: https://github.com/logtail/logtail-python
-Download-URL: https://github.com/logtail/logtail-python/tarball/0.4.2
+Download-URL: https://github.com/logtail/logtail-python/tarball/0.4.3
 Author: Logtail
 Author-email: hello@logtail.com
 License: ISC

{logtail_python-0.4.2 → logtail_python-0.4.3}/logtail/__init__.py

@@ -5,6 +5,6 @@ from .handler import LogtailHandler
 from .helpers import LogtailContext, DEFAULT_CONTEXT
 from .formatter import LogtailFormatter
 
-__version__ = '0.4.2'
+__version__ = '0.4.3'
 
 context = DEFAULT_CONTEXT

{logtail_python-0.4.2 → logtail_python-0.4.3}/logtail/frame.py

@@ -93,4 +93,9 @@ def _relative_to_main_module_if_possible(pathname):
     return _relative_to_main_module(pathname) if has_main_module else pathname
 
 def _relative_to_main_module(pathname):
-    return path.relpath(pathname, path.dirname(__main__.__file__))
+    try:
+        return path.relpath(pathname, path.dirname(__main__.__file__))
+    except ValueError:
+        # Windows has no relative path between drives, and a PyInstaller build unpacks the
+        # script to the system drive while the application may run from another one.
+        return pathname

{logtail_python-0.4.2 → logtail_python-0.4.3}/logtail/handler.py

@@ -95,9 +95,16 @@ class LogtailHandler(logging.Handler):
                 raise e
 
     def flush(self):
-        if self.flush_thread and self.flush_thread.is_alive():
-            if not self.flush_thread.flush(timeout=self.flush_timeout):
-                print('Gave up waiting for Better Stack uploads after {}s, logs are still buffered'.format(self.flush_timeout))
+        if not (self.flush_thread and self.flush_thread.is_alive()):
+            return
+        if logging._lock._is_owned():
+            # logging.config.dictConfig() flushes the handlers it replaces while holding the global
+            # logging lock, and the worker's upload needs that lock whenever urllib3's logger has a
+            # level-cache miss, so waiting here could only deadlock. Nothing is lost: the worker
+            # keeps running and sends what is queued as soon as the lock is released.
+            return
+        if not self.flush_thread.flush(timeout=self.flush_timeout):
+            print('Gave up waiting for Better Stack uploads after {}s, logs are still buffered'.format(self.flush_timeout))
 
     def _reset_after_fork(self):
         # A forked child inherits the parent's queue with whatever was still buffered in it,

{logtail_python-0.4.2 → logtail_python-0.4.3}/logtail_python.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: logtail-python
-Version: 0.4.2
+Version: 0.4.3
 Summary: Better Stack client library
 Home-page: https://github.com/logtail/logtail-python
-Download-URL: https://github.com/logtail/logtail-python/tarball/0.4.2
+Download-URL: https://github.com/logtail/logtail-python/tarball/0.4.3
 Author: Logtail
 Author-email: hello@logtail.com
 License: ISC

{logtail_python-0.4.2 → logtail_python-0.4.3}/setup.py

@@ -3,7 +3,7 @@ import os
 from setuptools import setup
 
 
-VERSION = '0.4.2'
+VERSION = '0.4.3'
 ROOT_DIR = os.path.dirname(__file__)
 
 REQUIREMENTS = [

{logtail_python-0.4.2 → logtail_python-0.4.3}/tests/test_frame.py

@@ -4,9 +4,12 @@ from logtail.frame import create_frame
 from logtail.handler import LogtailHandler
 from logtail.helpers import LogtailContext
 import datetime
+import ntpath
 import unittest
 import logging
 
+from unittest.mock import patch
+
 class TestLogtailLogEntry(unittest.TestCase):
     def test_create_frame_happy_path(self):
         handler = LogtailHandler(source_token="some-source-token")
@@ -36,3 +39,15 @@ class TestLogtailLogEntry(unittest.TestCase):
 
         frame = create_frame(log_record, log_record.getMessage(), LogtailContext(), include_extra_attributes=True)
         self.assertIn('non_dict_key', frame)
+
+    @patch('logtail.frame.path', ntpath)
+    @patch('logtail.frame.__main__')
+    def test_create_frame_keeps_the_absolute_path_when_the_file_is_on_another_drive(self, main):
+        # PyInstaller unpacks the script to the system drive while the application's files stay
+        # on the drive it was started from, and Windows has no relative path between drives.
+        main.__file__ = 'C:\\Users\\zi\\AppData\\Local\\Temp\\_MEI61722\\main.py'
+        log_record = logging.LogRecord("logtail-test", 20, 'D:\\workspace\\app\\main.py', 10, "Some log message", [], None)
+
+        frame = create_frame(log_record, log_record.getMessage(), LogtailContext())
+
+        self.assertEqual(frame['context']['runtime']['file'], 'D:\\workspace\\app\\main.py')

{logtail_python-0.4.2 → logtail_python-0.4.3}/tests/test_handler.py

@@ -411,6 +411,35 @@ class TestLogtailHandler(unittest.TestCase):
         self.assertEqual(uploads, [['hello']])
         self.assertTrue(handler.pipe.empty())
 
+    def test_flush_does_not_wait_while_the_caller_holds_the_logging_lock(self):
+        # logging.config.dictConfig() flushes the handlers it replaces while holding the global
+        # logging lock, and the worker's upload needs that lock whenever urllib3's logger has a
+        # level-cache miss, so waiting for the worker there can only deadlock.
+        logger = logging.getLogger(__name__)
+        logger.handlers = []
+        logger.setLevel(logging.INFO)
+        handler = LogtailHandler(source_token=self.source_token, flush_interval=0.01, check_interval=0.01, flush_timeout=2)
+        uploads = []
+        in_upload = threading.Event()
+
+        def upload(frame):
+            in_upload.set()
+            with logging._lock:  # what urllib3's isEnabledFor() does on a level-cache miss
+                uploads.append([f['message'] for f in frame])
+            return mock.MagicMock(status_code=202)
+
+        handler.uploader = upload
+        logger.addHandler(handler)
+        self.addCleanup(self._stop_flush_worker, handler)
+
+        with logging._lock:
+            logger.info('hello')
+            self.assertTrue(in_upload.wait(2))
+            started = time.time()
+            handler.flush()
+            self.assertLess(time.time() - started, 0.5, 'flush() waited for a worker that needs the lock we hold')
+        self._wait_until(lambda: uploads == [['hello']])
+
     def _wait_until(self, condition):
         deadline = time.time() + 2
         while not condition() and time.time() < deadline: