refactor: move write_appmap out of web_framework

It never made any sense to have write_appmap in web_framework. Move it
to recording where it belongs.

Author: apotterri

_appmap/recording.py

@@ -44,3 +44,27 @@ def __exit__(self, exc_type, exc_value, tb):
         if self.exit_hook is not None:
             self.exit_hook(self)
         return False
+
+
+def write_appmap(
+    appmap, appmap_fname, recorder_type, metadata=None, basedir=Env.current.output_dir
+):
+    """Write an appmap file into basedir.
+
+    Adds APPMAP_SUFFIX to basename; shortens the name if necessary.
+    Atomically replaces existing files. Creates the basedir if required.
+    """
+
+    if len(appmap_fname) > NAME_MAX - len(APPMAP_SUFFIX):
+        part = NAME_MAX - len(APPMAP_SUFFIX) - 1 - HASH_LEN
+        appmap_fname = appmap_fname[:part] + "-" + name_hash(appmap_fname[part:])[:HASH_LEN]
+    filename = appmap_fname + APPMAP_SUFFIX
+
+    basedir = basedir / recorder_type
+    basedir.mkdir(parents=True, exist_ok=True)
+
+    with NamedTemporaryFile(mode="w", dir=basedir, delete=False) as tmp:
+        tmp.write(generation.dump(appmap, metadata))
+    appmap_file = basedir / filename
+    logger.info("info, writing %s", appmap_file)
+    os.replace(tmp.name, appmap_file)

_appmap/test/test_test_frameworks.py

@@ -1,14 +1,17 @@
 """Test cases dealing with various test framework runners and cases."""
+
 # pylint: disable=missing-function-docstring
 
 import json
 import re
 import sys
+import types
 from abc import ABC, abstractmethod
+from pathlib import Path
 
 import pytest
 
-from _appmap import web_framework
+from _appmap import recording
 
 from ..test.helpers import DictIncluding
 from .normalize import normalize_appmap
@@ -117,21 +120,33 @@ def test_pytest_trial(self, testdir):
         verify_expected_appmap(testdir)
 
 
-def test_overwrites_existing(tmp_path):
-    foo_file = tmp_path / "foo.appmap.json"
+EMPTY_APPMAP = types.SimpleNamespace(events=[])
+
+RECORDER_TYPE = "test"
+
+
+@pytest.fixture
+def recorder_outdir(tmp_path) -> Path:
+    ret = tmp_path / RECORDER_TYPE
+    ret.mkdir(parents=True)
+    return ret
+
+
+def test_overwrites_existing(recorder_outdir):
+    foo_file = recorder_outdir / "foo.appmap.json"
     foo_file.write_text("existing")
-    web_framework.write_appmap(tmp_path, "foo", "replacement")
-    assert foo_file.read_text() == "replacement"
+    recording.write_appmap(EMPTY_APPMAP, "foo", RECORDER_TYPE, None, recorder_outdir.parent)
+    assert foo_file.read_text().startswith('{"version"')
 
 
-def test_write_appmap(tmp_path):
-    web_framework.write_appmap(tmp_path, "foo", "bar")
-    assert (tmp_path / "foo.appmap.json").read_text() == "bar"
+def test_write_appmap(recorder_outdir):
+    recording.write_appmap(EMPTY_APPMAP, "foo", RECORDER_TYPE, None, recorder_outdir.parent)
+    assert (recorder_outdir / "foo.appmap.json").read_text().startswith('{"version"')
 
     longname = "-".join(["testing"] * 42)
-    web_framework.write_appmap(tmp_path, longname, "bar")
+    recording.write_appmap(EMPTY_APPMAP, longname, RECORDER_TYPE, None, recorder_outdir.parent)
     expected_shortname = longname[:235] + "-5d6e10d.appmap.json"
-    assert (tmp_path / expected_shortname).read_text() == "bar"
+    assert (recorder_outdir / expected_shortname).read_text().startswith('{"version"')
 
 
 @pytest.fixture(name="testdir")

_appmap/testing_framework.py

@@ -1,14 +1,14 @@
 """Shared infrastructure for testing framework integration."""
 
 import os
-from pathlib import PurePath
 import re
-from contextlib import contextmanager
 import traceback
+from contextlib import contextmanager
+from pathlib import PurePath
 
 import inflection
 
-from _appmap import configuration, env, generation, web_framework
+from _appmap import configuration, env, generation, recording
 from _appmap.env import Env
 from _appmap.recording import Recording
 from _appmap.utils import fqname, root_relative_path
@@ -121,8 +121,7 @@ def record(self, klass, method, **kwds):
             with rec, environ.disabled("requests"):
                 yield metadata
         finally:
-            basedir = environ.output_dir / self.name
-            web_framework.write_appmap(basedir, item.filename, generation.dump(rec, metadata))
+            recording.write_appmap(rec, item.filename, self.name, metadata)
 
 
 @contextmanager
@@ -135,7 +134,10 @@ def collect_result_metadata(metadata):
         yield
         metadata["test_status"] = "succeeded"
     except Exception as exn:
-        metadata["test_failure"] = {"message": failure_message(exn), "location": failure_location(exn)}
+        metadata["test_failure"] = {
+            "message": failure_message(exn),
+            "location": failure_location(exn),
+        }
         metadata["test_status"] = "failed"
         metadata["exception"] = {"class": exn.__class__.__name__, "message": str(exn)}
         raise
@@ -149,7 +151,7 @@ def file_delete(filename):
 
 
 def failure_message(exn: Exception) -> str:
-    return f'{exn.__class__.__name__}: {exn}'
+    return f"{exn.__class__.__name__}: {exn}"
 
 
 def failure_location(exn: Exception) -> str:

_appmap/web_framework.py

@@ -11,7 +11,8 @@
 from contextvars import ContextVar
 from hashlib import sha256
 from json.decoder import JSONDecodeError
-from tempfile import NamedTemporaryFile
+
+from _appmap import recording
 
 from . import generation, remote_recording
 from .env import Env
@@ -87,26 +88,6 @@ def name_hash(namepart):
     return sha256(os.fsencode(namepart)).hexdigest()
 
 
-def write_appmap(basedir, basename, contents):
-    """Write an appmap file into basedir.
-
-    Adds APPMAP_SUFFIX to basename; shortens the name if necessary.
-    Atomically replaces existing files. Creates the basedir if required.
-    """
-
-    if len(basename) > NAME_MAX - len(APPMAP_SUFFIX):
-        part = NAME_MAX - len(APPMAP_SUFFIX) - 1 - HASH_LEN
-        basename = basename[:part] + "-" + name_hash(basename[part:])[:HASH_LEN]
-    filename = basename + APPMAP_SUFFIX
-
-    if not basedir.exists():
-        basedir.mkdir(parents=True, exist_ok=True)
-
-    with NamedTemporaryFile(mode="w", dir=basedir, delete=False) as tmp:
-        tmp.write(contents)
-    os.replace(tmp.name, basedir / filename)
-
-
 def create_appmap_file(
     output_dir,
     request_method,
@@ -126,16 +107,16 @@ def create_appmap_file(
         + ") - "
         + start_time.strftime("%T.%f")[:-3]
     )
-    appmap_basename = scenario_filename(
-        "_".join([str(start_time.timestamp()), request_full_path])
-    )
+    appmap_basename = scenario_filename("_".join([str(start_time.timestamp()), request_full_path]))
     appmap_file_path = os.path.join(output_dir, appmap_basename)
+
+    recorder_type = "requests"
     metadata = {
         "name": appmap_name,
         "timestamp": start_time.timestamp(),
-        "recorder": {"name": "record_requests"},
+        "recorder": {"name": "record_requests", "type": recorder_type},
     }
-    write_appmap(output_dir, appmap_basename, generation.dump(rec, metadata))
+    recording.write_appmap(rec, appmap_basename, recorder_type, metadata)
     headers["AppMap-Name"] = os.path.abspath(appmap_name)
     headers["AppMap-File-Name"] = os.path.abspath(appmap_file_path) + APPMAP_SUFFIX