deprecate enhance print (#238)

* deprecate enhance print (no need anymore)

Author: saartochner-lumigo

requirements.txt

@@ -11,4 +11,4 @@ redispy==3.0.0
 sqlalchemy==1.3.20
 moto==1.3.16
 urllib3==1.26.6
-aiohttp==3.7.4
+aiohttp==3.7.4

scripts/ci_deploy.sh

@@ -4,5 +4,5 @@ set -eo pipefail
 pushd "$(dirname "$0")" &> /dev/null
 # Go back one spot because we are on scripts dir. The other scripts assume you are in the root folder
 cd ..
-../utils/common_bash/defaults/ci_deploy.sh java-tracer
+../utils/common_bash/defaults/ci_deploy.sh python_tracer
 popd &> /dev/null

src/lumigo_tracer/lumigo_utils.py

@@ -127,7 +127,6 @@ class Configuration:
     host: str = ""
     token: Optional[str] = ""
     verbose: bool = True
-    enhanced_print: bool = False
     is_step_function: bool = False
     timeout_timer: bool = True
     timeout_timer_buffer: Optional[float] = None
@@ -171,7 +170,7 @@ def config(
     :param edge_host: The host to send the events. Leave empty for default.
     :param should_report: Whether we should send the events. Change to True in the production.
     :param token: The token to use when sending back the events.
-    :param enhance_print: Should we add prefix to the print (so the logs will be in the platform).
+    :param enhance_print: Deprecated - Should we add prefix to the print (so the logs will be in the platform).
     :param step_function: Is this function is a part of a step function?
     :param timeout_timer: Should we start a timer to send the traced data before timeout acceded.
     :param timeout_timer_buffer: The buffer (seconds) that we take before reaching timeout to send the traces to lumigo.
@@ -195,9 +194,6 @@ def config(
     elif not is_aws_environment():
         Configuration.should_report = False
     Configuration.host = edge_host or os.environ.get("LUMIGO_TRACER_HOST", "")
-    Configuration.enhanced_print = (
-        enhance_print or os.environ.get("LUMIGO_ENHANCED_PRINT", "").lower() == "true"
-    )
     Configuration.verbose = verbose and os.environ.get("LUMIGO_VERBOSE", "").lower() != "false"
     Configuration.get_key_depth = get_key_depth or int(
         os.environ.get("LUMIGO_EVENT_KEY_DEPTH", DEFAULT_KEY_DEPTH)

src/lumigo_tracer/tracer.py

@@ -1,12 +1,9 @@
 import inspect
-import logging
-import builtins
 from functools import wraps
 
 from lumigo_tracer.auto_tag.auto_tag_event import AutoTagEvent
 from lumigo_tracer.lumigo_utils import (
     config,
-    Configuration,
     get_logger,
     lumigo_safe_execute,
     is_aws_environment,
@@ -49,11 +46,7 @@ def lambda_wrapper(*args, **kwargs):
         _add_wrap_flag_to_context(*args)
         executed = False
         ret_val = None
-        local_print = print
-        local_logging_format = logging.Formatter.format
         try:
-            if Configuration.enhanced_print:
-                _enhance_output(args, local_print, local_logging_format)
             SpansContainer.create_span(*args, is_new_invocation=True)
             with lumigo_safe_execute("auto tag"):
                 AutoTagEvent.auto_tag_event(args[0])
@@ -66,10 +59,8 @@ def lambda_wrapper(*args, **kwargs):
                     SpansContainer.get_span().add_exception_event(e, inspect.trace())
                 raise
             finally:
-                SpansContainer.get_span().end(ret_val, *args)
-                if Configuration.enhanced_print:
-                    builtins.print = local_print
-                    logging.Formatter.format = local_logging_format
+                with lumigo_safe_execute("end"):
+                    SpansContainer.get_span().end(ret_val, *args)
             return ret_val
         except Exception:
             # The case where our wrapping raised an exception
@@ -83,19 +74,6 @@ def lambda_wrapper(*args, **kwargs):
     return lambda_wrapper
 
 
-def _enhance_output(args, local_print, local_logging_format):
-    if len(args) < 2:
-        return
-    request_id = getattr(args[1], "aws_request_id", "")
-    prefix = f"RequestId: {request_id}"
-    builtins.print = lambda *args, **kwargs: local_print(
-        *[_add_prefix_for_each_line(prefix, str(arg)) for arg in args], **kwargs
-    )
-    logging.Formatter.format = lambda self, record: _add_prefix_for_each_line(
-        prefix, local_logging_format(self, record)
-    )
-
-
 def _add_prefix_for_each_line(prefix: str, text: str):
     enhanced_lines = []
     for line in text.split("\n"):

src/lumigo_tracer/user_utils.py

@@ -3,7 +3,7 @@
 from typing import Dict, Optional
 
 from lumigo_tracer.spans_container import SpansContainer
-from lumigo_tracer.lumigo_utils import Configuration, warn_client
+from lumigo_tracer.lumigo_utils import warn_client
 
 LUMIGO_REPORT_ERROR_STRING = "[LUMIGO_LOG]"
 MAX_TAGS = 50
@@ -80,11 +80,10 @@ def log(level: int, msg: str, error_type: str, extra: Optional[Dict[str, str]]):
 
 def report_error(msg: str):
     message_with_initials = f"{LUMIGO_REPORT_ERROR_STRING} {msg}"
-    if Configuration.enhanced_print:
-        print(message_with_initials)
-    else:
-        message_with_request_id = f"RequestId: {SpansContainer.get_span().function_span.get('id')} {message_with_initials}"
-        print(message_with_request_id)
+    message_with_request_id = (
+        f"RequestId: {SpansContainer.get_span().function_span.get('id')} {message_with_initials}"
+    )
+    print(message_with_request_id)
 
 
 def validate_tag(key, value, tags_len, should_log_errors):

src/test/unit/test_lumigo_utils.py

@@ -385,28 +385,14 @@ def test_omit_keys_environment(monkeypatch):
 
 
 @pytest.mark.parametrize("configuration_value", (True, False))
-def test_config_enhanced_print_with_envs(monkeypatch, configuration_value):
-    monkeypatch.setenv("LUMIGO_ENHANCED_PRINT", "TRUE")
-    config(enhance_print=configuration_value)
-    assert Configuration.enhanced_print is True
-
-
-@pytest.mark.parametrize("configuration_value", (True, False))
-def test_config_enhanced_print_without_envs(monkeypatch, configuration_value):
-    monkeypatch.delenv("LUMIGO_ENHANCED_PRINT", raising=False)
-    config(enhance_print=configuration_value)
-    assert Configuration.enhanced_print == configuration_value
-
-
-@pytest.mark.parametrize("configuration_value", (True, False))
-def test_config_enhanced_printstep_function_with_envs(monkeypatch, configuration_value):
+def test_config_step_function_with_envs(monkeypatch, configuration_value):
     monkeypatch.setenv("LUMIGO_STEP_FUNCTION", "TRUE")
     config(step_function=configuration_value)
     assert Configuration.is_step_function is True
 
 
 @pytest.mark.parametrize("configuration_value", (True, False))
-def test_config_enhanced_printstep_function_without_envs(monkeypatch, configuration_value):
+def test_config_step_function_without_envs(monkeypatch, configuration_value):
     monkeypatch.delenv("LUMIGO_STEP_FUNCTION", raising=False)
     config(step_function=configuration_value)
     assert Configuration.is_step_function == configuration_value

src/test/unit/test_tracer.py

@@ -5,9 +5,7 @@
 from decimal import Decimal
 import http.client
 import os
-import sys
 from functools import wraps
-import logging
 from unittest.mock import MagicMock, ANY
 
 import boto3
@@ -183,28 +181,25 @@ def lambda_test_function(event, context):
     assert Configuration.should_report == "123"
 
 
-def test_wrapping_with_print_override(context):
-    @lumigo_tracer(enhance_print=True)
+def test_wrapping_print_happy_flow(context):
+    @lumigo_tracer()
     def lambda_test_function(event, context):
-        print("hello\nworld")
+        print("hello")
         return 1
 
     with CaptureOutput() as capturer:
         assert lambda_test_function({}, context) == 1
-        assert Configuration.enhanced_print is True
-        assert "RequestId: 1234 hello" in capturer.get_lines()
-        assert "RequestId: 1234 world" in capturer.get_lines()
+        assert any(line == "hello" for line in capturer.get_lines())
 
 
-def test_wrapping_without_print_override(context):
-    @lumigo_tracer()
+def test_wrapping_enhanced_print_backward_compatible(context):
+    @lumigo_tracer(enhance_print=True)
     def lambda_test_function(event, context):
         print("hello")
         return 1
 
     with CaptureOutput() as capturer:
         assert lambda_test_function({}, context) == 1
-        assert Configuration.enhanced_print is False
         assert any(line == "hello" for line in capturer.get_lines())
 
 
@@ -273,78 +268,6 @@ def handler(event, context):
     assert SpansContainer._span
 
 
-def test_wrapping_with_logging_override_default_usage(caplog, context):
-    @lumigo_tracer(enhance_print=True)
-    def lambda_test_function(event, context):
-        logging.warning("hello\nworld")
-        return 1
-
-    assert lambda_test_function({}, context) == 1
-    assert Configuration.enhanced_print is True
-    assert any("RequestId: 1234" in line and "hello" in line for line in caplog.text.split("\n"))
-    assert any("RequestId: 1234" in line and "world" in line for line in caplog.text.split("\n"))
-
-
-def test_wrapping_with_logging_exception(caplog, context):
-    @lumigo_tracer(enhance_print=True)
-    def lambda_test_function(event, context):
-        logger = logging.getLogger("logger_name")
-        handler = logging.StreamHandler()
-        logger.addHandler(handler)
-
-        try:
-            1 / 0
-        except Exception:  # You must call the logging.exception method just inside the except part.
-            logger.exception("hello")
-        return 1
-
-    assert lambda_test_function({}, context) == 1
-    #  Check all lines have exactly one RequestId.
-    for line in caplog.text.splitlines():
-        assert line.startswith("RequestId: 1234") and line.count("RequestId: 1234") == 1
-    #  Check the message was logged.
-    test_message = [line for line in caplog.text.splitlines() if line.endswith("hello")][0].replace(
-        " ", ""
-    )
-    assert "ERROR" in test_message and "hello" in test_message
-
-
-def test_wrapping_with_logging_override_complex_usage(context):
-    @lumigo_tracer(enhance_print=True)
-    def lambda_test_function(event, context):
-        handler = logging.StreamHandler(sys.stdout)
-        formatter = logging.Formatter("%(name)s [%(levelname)s] %(message)s")  # Format of a client.
-        handler.setFormatter(formatter)
-        logger = logging.getLogger("my_test")
-        logger.handlers = [handler]
-        logger.setLevel("INFO")
-
-        logger.info("hello\nworld")
-        return 1
-
-    with CaptureOutput() as capturer:
-        assert lambda_test_function({}, context) == 1
-        assert Configuration.enhanced_print is True
-        assert "RequestId: 1234 my_test [INFO] hello" in capturer.get_lines()
-        assert "RequestId: 1234 world" in capturer.get_lines()
-
-
-def test_wrapping_without_logging_override(caplog, context):
-    @lumigo_tracer()
-    def lambda_test_function(event, context):
-        logging.warning("hello\nworld")
-        return 1
-
-    assert lambda_test_function({}, context) == 1
-    assert Configuration.enhanced_print is False
-    assert any(
-        "RequestId: 1234" not in line and "world" in line for line in caplog.text.split("\n")
-    )
-    assert any(
-        "RequestId: 1234" not in line and "hello" in line for line in caplog.text.split("\n")
-    )
-
-
 @pytest.mark.parametrize(
     "event, expected_triggered_by, expected_message_id",
     [

src/test/unit/test_user_utils.py

@@ -1,6 +1,5 @@
 from lumigo_tracer.spans_container import SpansContainer
 from lumigo_tracer.user_utils import (
-    report_error,
     warn,
     info,
     error,
@@ -11,15 +10,7 @@
     MAX_TAGS,
     MAX_ELEMENTS_IN_EXTRA,
 )
-from lumigo_tracer.lumigo_utils import Configuration, EXECUTION_TAGS_KEY
-
-
-def test_report_error_with_enhance_print(capsys):
-    Configuration.enhanced_print = True
-    msg = "oh no - an error"
-    report_error(msg)
-    captured = capsys.readouterr()
-    assert captured.out == f"{LUMIGO_REPORT_ERROR_STRING} {msg}\n"
+from lumigo_tracer.lumigo_utils import EXECUTION_TAGS_KEY
 
 
 def test_err_without_alert_type_with_exception(capsys):
@@ -81,15 +72,6 @@ def test_basic_info_warn_error(capsys):
     assert captured[2] == error_msg
 
 
-def test_report_error_without_enhance_print(capsys):
-    Configuration.enhanced_print = False
-    SpansContainer.get_span().function_span["id"] = "123"
-    msg = "oh no - an error"
-    report_error(msg)
-    captured = capsys.readouterr()
-    assert captured.out == f"RequestId: 123 {LUMIGO_REPORT_ERROR_STRING} {msg}\n"
-
-
 def test_add_execution_tag():
     key = "my_key"
     value = "my_value"