appmap 2.2.0__tar.gz → 3.0.1__tar.gz

{appmap-2.2.0 → appmap-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: appmap
-Version: 2.2.0
+Version: 3.0.1
 Summary: Create AppMap files by recording a Python application.
 Project-URL: Homepage, https://github.com/applandinc/appmap-python
 Author-email: Alan Potter <alan@app.land>, Viraj Kanwade <viraj.kanwade@forgeahead.io>, Rafał Rzepecki <rafal@app.land>

{appmap-2.2.0 → appmap-3.0.1}/_appmap/configuration.py

@@ -508,5 +508,13 @@ if _startup_messages_shown is None:
     logger.info("file: %s", c._file if c.file_present else "[no appmap.yml]")
     logger.info("config: %r", c)
     logger.debug("package_functions: %s", c.package_functions)
-    logger.info("env: %r", os.environ)
+    # Only log AppMap's own settings, never the full environment: arbitrary
+    # environment variables (API keys, credentials, tokens, etc.) must never
+    # end up in application logs.
+    appmap_env = {
+        k: v
+        for k, v in os.environ.items()
+        if k in ("APPMAP", "_APPMAP") or k.startswith(("APPMAP_", "_APPMAP_"))
+    }
+    logger.info("env: %r", appmap_env)
     os.environ["_APPMAP_MESSAGES_SHOWN"] = "true"

{appmap-2.2.0 → appmap-3.0.1}/_appmap/env.py

@@ -168,7 +168,10 @@ class Env(metaclass=SingletonMeta):
         trace_logger.install()
 
         log_level = self.get("APPMAP_LOG_LEVEL", "warn").upper()
-        disable_log = os.environ.get("APPMAP_DISABLE_LOG_FILE", "false").upper() != "FALSE"
+        # No log file unless the user opts in: it can contain data (e.g.
+        # rendered parameter values) that shouldn't be written to disk or
+        # committed to source control by default.
+        disable_log = os.environ.get("APPMAP_DISABLE_LOG_FILE", "true").upper() != "FALSE"
         log_config = self.get("APPMAP_LOG_CONFIG")
         config_dict = {
             "version": 1,

{appmap-2.2.0 → appmap-3.0.1}/_appmap/event.py

@@ -47,13 +47,14 @@ class _EventIds:
 
 def display_string(val, display_value=False):
     # If we're asked to display parameters, make a best-effort attempt
-    # to get a string value for the parameter using repr(). If parameter
-    # display is disabled, or repr() has raised, just formulate a value
-    # from the class and id.
+    # to get a string value for the parameter. str types are returned as-is;
+    # other types use repr(). If parameter display is disabled, or repr() has
+    # raised, just formulate a value from the class and id.
     value = None
     if display_value:
         try:
-            value = repr(val)
+            # Use issubclass(type()) instead of isinstance() to avoid side effects on lazy objects
+            value = val if issubclass(type(val), str) else repr(val)
         except Exception:  # pylint: disable=broad-except
             pass
 

{appmap-2.2.0 → appmap-3.0.1}/_appmap/test/data/expected.appmap.json

@@ -23,7 +23,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'ExampleClass.static_method\\n...\\n'"
+        "value": "ExampleClass.static_method\n...\n"
       },
       "parent_id": 1,
       "id": 2,
@@ -49,7 +49,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'ClassMethodMixin#class_method, cls ExampleClass'"
+        "value": "ClassMethodMixin#class_method, cls ExampleClass"
       },
       "parent_id": 3,
       "id": 4,
@@ -75,7 +75,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'Super#instance_method'"
+        "value": "Super#instance_method"
       },
       "parent_id": 5,
       "id": 6,
@@ -127,7 +127,7 @@
           "name": "data",
           "kind": "req",
           "class": "builtins.str",
-          "value": "'ExampleClass.call_yaml'"
+          "value": "ExampleClass.call_yaml"
         }
       ],
       "id": 10,
@@ -144,7 +144,7 @@
           "name": "data",
           "kind": "req",
           "class": "builtins.str",
-          "value": "'ExampleClass.call_yaml'"
+          "value": "ExampleClass.call_yaml"
         },
         {
           "name": "stream",
@@ -176,7 +176,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'ExampleClass.call_yaml\\n...\\n'"
+        "value": "ExampleClass.call_yaml\n...\n"
       },
       "parent_id": 11,
       "id": 12,
@@ -190,7 +190,7 @@
           "name": "data",
           "kind": "req",
           "class": "builtins.str",
-          "value": "'ExampleClass.call_yaml'"
+          "value": "ExampleClass.call_yaml"
         },
         {
           "name": "stream",
@@ -222,7 +222,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'ExampleClass.call_yaml\\n...\\n'"
+        "value": "ExampleClass.call_yaml\n...\n"
       },
       "parent_id": 13,
       "id": 14,
@@ -334,4 +334,4 @@
       ]
     }
   ]
-}
+}

{appmap-2.2.0 → appmap-3.0.1}/_appmap/test/data/pytest/expected/pytest-numpy1-no-test-cases.appmap.json

@@ -56,7 +56,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'Hello'"
+        "value": "Hello"
       },
       "parent_id": 2,
       "id": 3,
@@ -83,7 +83,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'world!'"
+        "value": "world!"
       },
       "parent_id": 4,
       "id": 5,
@@ -93,7 +93,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'Hello world!'"
+        "value": "Hello world!"
       },
       "parent_id": 1,
       "id": 6,
@@ -239,4 +239,4 @@
       ]
     }
   ]
-}
+}

{appmap-2.2.0 → appmap-3.0.1}/_appmap/test/data/pytest/expected/pytest-numpy1.appmap.json

@@ -66,7 +66,7 @@
     },
     {
       "return_value": {
-        "value": "'Hello'",
+        "value": "Hello",
         "class": "builtins.str"
       },
       "parent_id": 3,
@@ -93,7 +93,7 @@
     },
     {
       "return_value": {
-        "value": "'world!'",
+        "value": "world!",
         "class": "builtins.str"
       },
       "parent_id": 5,
@@ -103,7 +103,7 @@
     },
     {
       "return_value": {
-        "value": "'Hello world!'",
+        "value": "Hello world!",
         "class": "builtins.str"
       },
       "parent_id": 2,
@@ -278,4 +278,4 @@
       ]
     }
   ]
-}
+}

{appmap-2.2.0 → appmap-3.0.1}/_appmap/test/data/pytest/expected/pytest-numpy2-no-test-cases.appmap.json

@@ -56,7 +56,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'Hello'"
+        "value": "Hello"
       },
       "parent_id": 2,
       "id": 3,
@@ -83,7 +83,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'world!'"
+        "value": "world!"
       },
       "parent_id": 4,
       "id": 5,
@@ -93,7 +93,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'Hello world!'"
+        "value": "Hello world!"
       },
       "parent_id": 1,
       "id": 6,
@@ -239,4 +239,4 @@
       ]
     }
   ]
-}
+}

{appmap-2.2.0 → appmap-3.0.1}/_appmap/test/data/pytest/expected/pytest-numpy2.appmap.json

@@ -66,7 +66,7 @@
     },
     {
       "return_value": {
-        "value": "'Hello'",
+        "value": "Hello",
         "class": "builtins.str"
       },
       "parent_id": 3,
@@ -93,7 +93,7 @@
     },
     {
       "return_value": {
-        "value": "'world!'",
+        "value": "world!",
         "class": "builtins.str"
       },
       "parent_id": 5,
@@ -103,7 +103,7 @@
     },
     {
       "return_value": {
-        "value": "'Hello world!'",
+        "value": "Hello world!",
         "class": "builtins.str"
       },
       "parent_id": 2,
@@ -278,4 +278,4 @@
       ]
     }
   ]
-}
+}

{appmap-2.2.0 → appmap-3.0.1}/_appmap/test/data/unittest/expected/pytest.appmap.json

@@ -53,12 +53,14 @@
         "class": "simple.Simple",
         "value": "<simple.Simple object at 0xabcdef>"
       },
-      "parameters": [{
-        "class": "builtins.str",
-        "kind": "req",
-        "name": "bang",
-        "value": "'!'"
-      }],
+      "parameters": [
+        {
+          "class": "builtins.str",
+          "kind": "req",
+          "name": "bang",
+          "value": "!"
+        }
+      ],
       "id": 2,
       "event": "call",
       "thread_id": 1
@@ -83,7 +85,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'Hello'"
+        "value": "Hello"
       },
       "parent_id": 3,
       "id": 4,
@@ -110,7 +112,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'world'"
+        "value": "world"
       },
       "parent_id": 5,
       "id": 6,
@@ -120,7 +122,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'Hello world!'"
+        "value": "Hello world!"
       },
       "parent_id": 2,
       "id": 7,

{appmap-2.2.0 → appmap-3.0.1}/_appmap/test/data/unittest/expected/unittest-no-test-cases.appmap.json

@@ -35,7 +35,7 @@
       "parameters": [
         {
           "kind": "req",
-          "value": "'!'",
+          "value": "!",
           "name": "bang",
           "class": "builtins.str"
         }
@@ -67,7 +67,7 @@
     },
     {
       "return_value": {
-        "value": "'Hello'",
+        "value": "Hello",
         "class": "builtins.str"
       },
       "parent_id": 2,
@@ -94,7 +94,7 @@
     },
     {
       "return_value": {
-        "value": "'world'",
+        "value": "world",
         "class": "builtins.str"
       },
       "parent_id": 4,
@@ -104,7 +104,7 @@
     },
     {
       "return_value": {
-        "value": "'Hello world!'",
+        "value": "Hello world!",
         "class": "builtins.str"
       },
       "parent_id": 1,
@@ -145,4 +145,4 @@
       ]
     }
   ]
-}
+}

{appmap-2.2.0 → appmap-3.0.1}/_appmap/test/data/unittest/expected/unittest.appmap.json

@@ -53,12 +53,14 @@
         "class": "simple.Simple",
         "value": "<simple.Simple object at 0xabcdef>"
       },
-      "parameters": [{
-        "class": "builtins.str",
-        "kind": "req",
-        "name": "bang",
-        "value": "'!'"
-      }],
+      "parameters": [
+        {
+          "class": "builtins.str",
+          "kind": "req",
+          "name": "bang",
+          "value": "!"
+        }
+      ],
       "id": 2,
       "event": "call",
       "thread_id": 1
@@ -83,7 +85,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'Hello'"
+        "value": "Hello"
       },
       "parent_id": 3,
       "id": 4,
@@ -110,7 +112,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'world'"
+        "value": "world"
       },
       "parent_id": 5,
       "id": 6,
@@ -120,7 +122,7 @@
     {
       "return_value": {
         "class": "builtins.str",
-        "value": "'Hello world!'"
+        "value": "Hello world!"
       },
       "parent_id": 2,
       "id": 7,

{appmap-2.2.0 → appmap-3.0.1}/_appmap/test/test_events.py

@@ -132,11 +132,11 @@ class TestEvents:
 
         assert result == "hello"
         call_event = r.events[0]
-        # Parameter value should be the repr, not the opaque object string
-        assert call_event.parameters[0]["value"] == "'hello'"
+        # Parameter value should be the raw string, not repr-quoted
+        assert call_event.parameters[0]["value"] == "hello"
         # Return value should also be displayed
         return_event = r.events[1]
-        assert return_event.return_value["value"] == "'hello'"
+        assert return_event.return_value["value"] == "hello"
 
         # Unlabeled method should not have its params displayed, even in the same recording
         call_event_unlabeled = r.events[2]

{appmap-2.2.0 → appmap-3.0.1}/_appmap/test/test_http.py

@@ -29,8 +29,8 @@ def test_http_client_capture(mock_requests, events):
     }
     message = request.message
     assert message[0] == DictIncluding({"name": "q", "value": "['one', 'two']"})
-    assert (message[1] == DictIncluding({"name": "q2", "value": "'🦠'"})) or (
-        message[1] == DictIncluding({"name": "q2", "value": "'\\U0001f9a0'"})
+    assert (message[1] == DictIncluding({"name": "q2", "value": "🦠"})) or (
+        message[1] == DictIncluding({"name": "q2", "value": "\\U0001f9a0"})
     )
 
     assert events[3].http_client_response == DictIncluding(

{appmap-2.2.0 → appmap-3.0.1}/_appmap/test/test_labels.py

@@ -1,5 +1,6 @@
 import pytest
 
+import appmap
 from _appmap.wrapt import BoundFunctionWrapper, FunctionWrapper
 
 
@@ -55,6 +56,22 @@ class TestLabels:
 
         verify_example_appmap(check_labels, "instance_method")
 
+    @pytest.mark.appmap_enabled(config="appmap-no-pyyaml.yml")
+    def test_labeled_function_recorded_without_package(self):
+        """A labeled function is recorded even when its package is not in the config."""
+        import yaml  # pylint: disable=import-outside-toplevel
+
+        rec = appmap.Recording()
+        with rec:
+            yaml.dump({"key": "value"})
+
+        # yaml.dump should appear in the recording events because it's labeled
+        # by the formats preset, even though PyYAML is not in the packages list.
+        call_events = [e for e in rec.events if e.event == "call"]
+        assert any(
+            e.method_id == "dump" and "yaml" in e.defined_class for e in call_events
+        ), f"Expected yaml.dump in recorded events, got: {[e.method_id for e in call_events]}"
+
     def test_function_only_in_mod(self, verify_example_appmap):
         def check_labels(*_):
             # pylint: disable=import-outside-toplevel

{appmap-2.2.0 → appmap-3.0.1}/_appmap/test/test_params.py

@@ -108,7 +108,7 @@ class TestStaticMethods(TestMethodBase):
             "name": "p",
             "class": "builtins.str",
             "kind": "req",
-            "value": "'static'",
+            "value": "static",
         }
 
 
@@ -131,7 +131,7 @@ class TestClassMethods(TestMethodBase):
         self.assert_parameter(
             evt,
             0,
-            {"name": "p", "class": "builtins.str", "kind": "req", "value": "'cls'"},
+            {"name": "p", "class": "builtins.str", "kind": "req", "value": "cls"},
         )
 
 
@@ -145,7 +145,7 @@ class TestInstanceMethods(TestMethodBase):
     @pytest.mark.parametrize(
         "params,arg,expected",
         [
-            ("one", "world", ("builtins.str", "'world'")),
+            ("one", "world", ("builtins.str", "world")),
             ("one", None, ("builtins.NoneType", "None")),
         ],
         indirect=["params"],
@@ -192,7 +192,7 @@ class TestInstanceMethods(TestMethodBase):
     @pytest.mark.parametrize(
         "params,arg,expected",
         [
-            ("one", "world", ("builtins.str", "'world'")),
+            ("one", "world", ("builtins.str", "world")),
             ("one", None, ("builtins.NoneType", "None")),
         ],
         indirect=["params"],

{appmap-2.2.0 → appmap-3.0.1}/_appmap/test/test_runner.py

@@ -1,3 +1,4 @@
+import os
 import re
 
 import pytest
@@ -37,6 +38,20 @@ def test_runner_multi_recording_type(script_runner, flag, expected):
     assert len(re.findall("(?m)^APPMAP_RECORD_PYTEST=true$", result.stdout)) == expected
 
 
+@pytest.mark.parametrize(
+    "flags,expected",
+    [
+        ([], "true"),
+        (["--no-enable-log"], "true"),
+        (["--enable-log"], "false"),
+    ],
+)
+def test_runner_log_file_disabled_by_default(script_runner, flags, expected):
+    result = script_runner.run(["appmap-python", *flags, "--record", "process"])
+    assert result.returncode == 0
+    assert re.search(f"(?m)^APPMAP_DISABLE_LOG_FILE={expected}$", result.stdout) is not None
+
+
 @pytest.mark.script_launch_mode("subprocess")
 class TestEnv:
     def test_appmap_present(self, script_runner):
@@ -50,3 +65,19 @@ class TestEnv:
         )
         assert result.returncode == 0
         assert re.match(r"true", result.stdout) is not None
+
+    def test_internal_state_not_leaked_to_child(self, script_runner):
+        # appmap-python is itself instrumented at interpreter startup (via
+        # appmap.pth), which can set internal, process-scoped _APPMAP*
+        # markers using whatever it inherited, before this script has
+        # computed the environment the child command should actually run
+        # with. Simulate that by pre-setting one such marker (the
+        # once-per-process "startup messages already shown" guard) and
+        # confirm it doesn't leak into the child's environment, which would
+        # otherwise silently suppress the child's own startup logging.
+        env = {**os.environ, "_APPMAP_MESSAGES_SHOWN": "true"}
+        result = script_runner.run(
+            ["appmap-python", "printenv", "_APPMAP_MESSAGES_SHOWN"], env=env
+        )
+        assert result.returncode != 0
+        assert result.stdout == ""

{appmap-2.2.0 → appmap-3.0.1}/_appmap/test/web_framework.py

@@ -45,7 +45,7 @@ class _TestFormData:
         )
 
         assert events[0].message == [
-            DictIncluding({"name": "my_param", "class": "builtins.str", "value": "'example'"})
+            DictIncluding({"name": "my_param", "class": "builtins.str", "value": "example"})
         ]
 
     @staticmethod
@@ -53,7 +53,7 @@ class _TestFormData:
         client.post("/test", data={"my_param": "example"}, content_type="multipart/form-data")
 
         assert events[0].message == [
-            DictIncluding({"name": "my_param", "class": "builtins.str", "value": "'example'"})
+            DictIncluding({"name": "my_param", "class": "builtins.str", "value": "example"})
         ]
 
 
@@ -119,7 +119,7 @@ class _TestRequestCapture:
 
         assert events[0].message == [
             DictIncluding(
-                {"name": "my_param", "class": "builtins.str", "value": "'example'"}
+                {"name": "my_param", "class": "builtins.str", "value": "example"}
             )
         ]
         assert events[0].http_server_request == DictIncluding(
@@ -142,7 +142,7 @@ class _TestRequestCapture:
 
         assert events[0].message == [
             DictIncluding(
-                {"name": "my_param", "class": "builtins.str", "value": "'example'"}
+                {"name": "my_param", "class": "builtins.str", "value": "example"}
             )
         ]
 
@@ -166,7 +166,7 @@ class _TestRequestCapture:
 
         assert events[0].message == [
             DictIncluding(
-                {"name": "my_param", "class": "builtins.str", "value": "'example'"}
+                {"name": "my_param", "class": "builtins.str", "value": "example"}
             )
         ]
 
@@ -205,7 +205,7 @@ class _TestRequestCapture:
 
         assert events[0].message == [
             DictIncluding(
-                {"name": "username", "class": "builtins.str", "value": "'alice'"}
+                {"name": "username", "class": "builtins.str", "value": "alice"}
             ),
             DictIncluding({"name": "post_id", "class": "builtins.int", "value": "42"}),
         ]
@@ -222,7 +222,7 @@ class _TestFormCapture:
         )
 
         assert events[0].message == [
-            DictIncluding({"name": "my_param", "class": "builtins.str", "value": "'example'"})
+            DictIncluding({"name": "my_param", "class": "builtins.str", "value": "example"})
         ]
 
     @staticmethod
@@ -230,7 +230,7 @@ class _TestFormCapture:
         client.post("/test", data={"my_param": "example"}, content_type="multipart/form-data")
 
         assert events[0].message == [
-            DictIncluding({"name": "my_param", "class": "builtins.str", "value": "'example'"})
+            DictIncluding({"name": "my_param", "class": "builtins.str", "value": "example"})
         ]
 
 

{appmap-2.2.0 → appmap-3.0.1}/appmap/command/runner.py

@@ -122,7 +122,7 @@ def run():
         envvars[f"APPMAP_RECORD_{disabled.upper()}"] = "false"
 
     envvars["APPMAP_DISABLE_LOG_FILE"] = (
-        "true" if parsed_args.get("no_enable_log", set()) else "false"
+        "false" if parsed_args.get("enable_log", False) else "true"
     )
 
     if len(cmd) == 0:
@@ -130,7 +130,17 @@ def run():
             print(f"{k}={v}")
         sys.exit(0)
 
-    os.execvpe(cmd[0], cmd, {**os.environ, **envvars})
+    # appmap-python is itself instrumented on interpreter startup (via
+    # appmap.pth), before this point, using whatever environment it inherited
+    # rather than the envvars computed above. That incidental self-init can
+    # set internal, process-scoped state under _APPMAP*-prefixed names (e.g.
+    # the once-per-process "startup messages already shown" guard); left in
+    # place, it would carry over into the child's environment and suppress
+    # or corrupt the child's own startup behavior. Drop all of it and let
+    # envvars below re-set whatever the child actually needs.
+    child_env = {k: v for k, v in os.environ.items() if not k.startswith("_APPMAP")}
+    child_env.update(envvars)
+    os.execvpe(cmd[0], cmd, child_env)
 
 
 if __name__ == "__main__":

{appmap-2.2.0 → appmap-3.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "appmap"
-version = "2.2.0"
+version = "3.0.1"
 description = "Create AppMap files by recording a Python application."
 readme = "README.md"
 requires-python = ">=3.8"