Merge pull request #278 from getappmap/process-recording_20240205

Add process recording

Author: apotterri

README.md

@@ -24,36 +24,22 @@ of code and key data flows.
 
 Visit the [AppMap for Python](https://appland.com/docs/reference/appmap-python.html) reference page on AppLand.com for a complete reference guide.
 
-# Development 
+# Development
 
 [![Build Status](https://travis-ci.com/getappmap/appmap-python.svg?branch=master)](https://travis-ci.com/getappmap/appmap-python)
 
 ## Getting the code
-Clone the repo to begin development. Note that vendored dependencies are included as
-submodules.
+Clone the repo to begin development.
 
 ```shell
-% git clone --recurse-submodules https://github.com/applandinc/appmap-python.git
+% git clone https://github.com/applandinc/appmap-python.git
 Cloning into 'appmap-python'...
 remote: Enumerating objects: 167, done.
 remote: Counting objects: 100% (167/167), done.
 remote: Compressing objects: 100% (100/100), done.
 remote: Total 962 (delta 95), reused 116 (delta 61), pack-reused 795
 Receiving objects: 100% (962/962), 217.31 KiB | 4.62 MiB/s, done.
 Resolving deltas: 100% (653/653), done.
-Submodule 'extern/wrapt' (https://github.com/applandinc/wrapt.git) registered for path 'vendor/wrapt'
-Cloning into '/private/tmp/appmap-python/vendor/wrapt'...
-remote: Enumerating objects: 46, done.
-remote: Counting objects: 100% (46/46), done.
-remote: Compressing objects: 100% (39/39), done.
-remote: Total 2537 (delta 9), reused 19 (delta 4), pack-reused 2491
-Receiving objects: 100% (2537/2537), 755.94 KiB | 7.48 MiB/s, done.
-Resolving deltas: 100% (1643/1643), done.
-Submodule path 'vendor/wrapt': checked out '9bdfbe54b88a64069cba1f3c36e77edc3c1339c9'
-
-% ls appmap-python/vendor/wrapt
-LICENSE		Makefile	appveyor.yml	docs		src		tests
-MANIFEST.in	README.rst	blog		setup.py	tddium.yml	tox.ini
 ```
 
 ## Python version support
@@ -114,7 +100,7 @@ Note that you must install the dependencies contained in
 
 ### tox
 Additionally, the `tox` configuration provides the ability to run the tests for all
-supported versions of Python and djanggo. 
+supported versions of Python and Django.
 
 `tox` requires that all the correct versions of Python to be available to create
 the test environments. [pyenv](https://github.com/pyenv/pyenv) is an easy way to manage

_appmap/__init__.py

@@ -1,6 +1,6 @@
 from . import configuration
 from . import env as appmapenv
-from . import event, importer, metadata, recorder, web_framework
+from . import event, importer, metadata, recorder, recording, web_framework
 from .py_version_check import check_py_version
 
 
@@ -13,6 +13,7 @@ def initialize(**kwargs):
     configuration.initialize()  # needs to be initialized after recorder
     metadata.initialize()
     web_framework.initialize()
+    recording.initialize()
 
 
 initialize()

_appmap/django.py

@@ -12,7 +12,7 @@
 from . import remote_recording
 
 
-class RemoteRecording:  # pylint: disable=missing-class-docstring
+class RemoteRecording:  # pylint: disable=missing-class-docstring,too-few-public-methods
     def __init__(self, get_response):
         super().__init__()
         self.get_response = get_response

_appmap/event.py

@@ -329,7 +329,7 @@ def to_dict(self, attrs=None):
         return ret
 
 
-class SqlEvent(Event):
+class SqlEvent(Event):  # pylint: disable=too-few-public-methods
     __slots__ = ["sql_query"]
 
     def __init__(self, sql, vendor=None, version=None):
@@ -345,7 +345,7 @@ def __init__(self, sql, vendor=None, version=None):
         )
 
 
-class MessageEvent(Event):
+class MessageEvent(Event):  # pylint: disable=too-few-public-methods
     __slots__ = ["message"]
 
     def __init__(self, message_parameters):

_appmap/generation.py

@@ -19,7 +19,7 @@ def values(self):
         return self._dict.values()
 
 
-class ClassMapEntry:
+class ClassMapEntry:  # pylint: disable=too-few-public-methods
     # pylint: disable=redefined-builtin
     def __init__(self, name, type):
         self.name = name
@@ -32,19 +32,19 @@ def to_dict(self):
         return {k: v for k, v in vars(self).items() if v is not None}
 
 
-class PackageEntry(ClassMapEntry):
+class PackageEntry(ClassMapEntry):  # pylint: disable=too-few-public-methods
     def __init__(self, name):
         super().__init__(name, "package")
         self.children = ClassMapDict()
 
 
-class ClassEntry(ClassMapEntry):
+class ClassEntry(ClassMapEntry):  # pylint: disable=too-few-public-methods
     def __init__(self, name):
         super().__init__(name, "class")
         self.children = ClassMapDict()
 
 
-class FuncEntry(ClassMapEntry):
+class FuncEntry(ClassMapEntry):  # pylint: disable=too-few-public-methods
     def __init__(self, e):
         super().__init__(e.method_id, "function")
         self.location = "%s:%s" % (e.path, e.lineno)

_appmap/importer.py

@@ -62,7 +62,7 @@ def fntype(self):
         return self.scope.classify_fn(self.static_fn)
 
 
-class Filter(ABC):
+class Filter(ABC):  # pylint: disable=too-few-public-methods
     def __init__(self, next_filter):
         self.next_filter = next_filter
 
@@ -75,7 +75,7 @@ def filter(self, filterable):
         """
 
 
-class NullFilter(Filter):
+class NullFilter(Filter):  # pylint: disable=too-few-public-methods
     def __init__(self, next_filter=None):
         super().__init__(next_filter)
 

_appmap/labels.py

@@ -7,7 +7,7 @@
 logger = Env.current.getLogger(__name__)
 
 
-class labels:
+class labels:  # pylint: disable=too-few-public-methods
     def __init__(self, *args):
         self._labels = args
 

_appmap/metadata.py

@@ -72,10 +72,10 @@ def base(root_dir):
     @lru_cache()
     def _git_available(root_dir):
         try:
-            ret = utils.subprocess_run(["git", "status"], cwd=root_dir)
+            ret = utils.subprocess_run(["git", "rev-parse", "HEAD"], cwd=root_dir)
             if not ret.returncode:
                 return True
-            logger.warning("Failed running 'git status', %s", ret.stderr)
+            logger.warning("Failed running 'git rev-parse HEAD', %s", ret.stderr)
         except FileNotFoundError as exc:
             msg = """
     Couldn't find git executable, repository information
@@ -97,34 +97,12 @@ def _git_metadata(root_dir):
         repository = git("config --get remote.origin.url")
         branch = git("rev-parse --abbrev-ref HEAD")
         commit = git("rev-parse HEAD")
-        status = _lines(git("status -s"))
-        annotated_tag = git("describe --abbrev=0") or None
-        tag = git("describe --abbrev=0 --tags") or None
-
-        pattern = re.compile(r".*-(\d+)-\w+$")
-
-        commits_since_annotated_tag = None
-        if annotated_tag:
-            result = pattern.search(git("describe"))
-            if result:
-                commits_since_annotated_tag = int(result.group(1))
-
-        commits_since_tag = None
-        if tag:
-            result = pattern.search(git("describe --tags"))
-            if result:
-                commits_since_tag = int(result.group(1))
 
         return compact_dict(
             {
                 "repository": repository,
                 "branch": branch,
                 "commit": commit,
-                "status": status,
-                "tag": tag,
-                "annotated_tag": annotated_tag,
-                "commits_since_tag": commits_since_tag,
-                "commits_since_annotated_tag": commits_since_annotated_tag,
             }
         )
 

_appmap/noappmap.py

@@ -1,5 +1,3 @@
-import sys
-
 _appmap_noappmap = "_appmap_noappmap"
 
 

_appmap/recording.py

@@ -1,3 +1,11 @@
+import atexit
+from datetime import datetime, timezone
+import os
+from tempfile import NamedTemporaryFile
+
+from _appmap import generation
+from _appmap.web_framework import APPMAP_SUFFIX, HASH_LEN, NAME_MAX, name_hash
+
 from .env import Env
 from .recorder import Recorder
 
@@ -44,3 +52,50 @@ 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("writing %s", appmap_file)
+    os.replace(tmp.name, appmap_file)
+
+
+def initialize():
+    if Env.current.enables("process", "false"):
+        r = Recording()
+        r.start()
+
+        def save_at_exit():
+            nonlocal r
+            r.stop()
+            now = datetime.now(timezone.utc)
+            appmap_name = now.isoformat(timespec="seconds").replace("+00:00", "Z")
+            recorder_type = "process"
+            metadata = {
+                "name": appmap_name,
+                "recorder": {
+                    "name": "process",
+                    "type": recorder_type,
+                },
+            }
+            write_appmap(r, appmap_name, recorder_type, metadata)
+
+        atexit.register(save_at_exit)