Response Event Info, Step Function Meta Data

.circleci/config.yml

@@ -47,9 +47,9 @@ jobs:
       - run:
           name: Check code style
           command: |
-            pip install black==18.6b2
-            black --check --line-length=88 --safe iopipe
-            black --check --line-length=88 --safe tests
+            pip install black==19.3b0
+            black iopipe
+            black tests
 
   coverage:
     working_directory: ~/iopipe-python

.pre-commit-config.yaml

@@ -1,8 +1,5 @@
-repos:
--   repo: https://github.com/ambv/black
-    rev: 18.6b2
-
+-   repo: https://github.com/psf/black
+    rev: stable
     hooks:
     - id: black
-      args: [--line-length=88, --safe]
-      python_version: python3.6
+      language_version: python3.7

README.md

@@ -497,6 +497,9 @@ class MyPlugin(Plugin):
     def post_invoke(self, event, context):
         pass
 
+    def post_response(self, response):
+        pass
+
     def pre_report(self, report):
         pass
 
@@ -519,12 +522,13 @@ A plugin has the following properties defined:
 
 A plugin has the following methods defined:
 
-- `pre_setup`: Is called once prior to the agent initialization. Is passed the `iopipe` instance.
-- `post_setup`: Is called once after the agent is initialized, is passed the `iopipe` instance.
-- `pre_invoke`: Is called prior to each invocation, is passed the `event` and `context` of the invocation.
-- `post_invoke`: Is called after each invocation, is passed the `event` and `context` of the invocation.
-- `pre_report`: Is called prior to each report being sent, is passed the `report` instance.
-- `post_report`: Is called after each report is sent, is passed the `report` instance.
+- `pre_setup`: Is called once prior to the agent initialization; is passed the `iopipe` instance.
+- `post_setup`: Is called once after the agent is initialized; is passed the `iopipe` instance.
+- `pre_invoke`: Is called prior to each invocation; is passed the `event` and `context` of the invocation.
+- `post_invoke`: Is called after each invocation; is passed the `event` and `context` of the invocation.
+- `post_response`: Is called after the invocation response; is passed the `response`value.
+- `pre_report`: Is called prior to each report being sent; is passed the `report` instance.
+- `post_report`: Is called after each report is sent; is passed the `report` instance.
 
 ## Supported Python Versions
 

iopipe/agent.py

@@ -84,7 +84,7 @@ def error(self, error):
 
     err = error
 
-    def __call__(self, func):
+    def __call__(self, func, **kwargs):
         @functools.wraps(func)
         def wrapped(event, context):
             # Skip if function is already instrumented
@@ -96,7 +96,7 @@ def wrapped(event, context):
 
             logger.debug("Wrapping %s with IOpipe decorator" % repr(func))
 
-            self.context = context = ContextWrapper(context, self)
+            self.context = context = ContextWrapper(context, self, **kwargs)
 
             # if env var IOPIPE_ENABLED is set to False skip reporting
             if self.config["enabled"] is False:
@@ -197,6 +197,9 @@ def wrapped(event, context):
 
     decorator = __call__
 
+    def step(self, func):
+        return self(func, step_function=True)
+
     def load_plugins(self, plugins):
         """
         Loads plugins that match the `Plugin` interface and are instantiated.

iopipe/context.py

@@ -1,6 +1,7 @@
 import decimal
 import logging
 import numbers
+import uuid
 import warnings
 
 from . import constants
@@ -25,20 +26,22 @@ def __getattr__(self, name):
 
 
 class ContextWrapper(object):
-    def __init__(self, base_context, instance):
+    def __init__(self, base_context, instance, **kwargs):
         self.base_context = base_context
         self.instance = instance
-        self.iopipe = IOpipeContext(self.instance)
+        self.iopipe = IOpipeContext(self.instance, **kwargs)
 
     def __getattr__(self, name):
         return getattr(self.base_context, name)
 
 
 class IOpipeContext(object):
-    def __init__(self, instance):
+    def __init__(self, instance, **kwargs):
         self.instance = instance
         self.log = LogWrapper(self)
         self.disabled = False
+        self.is_step_function = kwargs.pop("step_function", False)
+        self.step_meta = None
 
     def metric(self, key, value):
         if self.instance.report is None:
@@ -129,3 +132,12 @@ def unregister(self, name):
 
     def disable(self):
         self.disabled = True
+
+    def collect_step_meta(self, event):
+        if self.is_step_function:
+            self.step_meta = event.get("iopipe", {"id": str(uuid.uuid4()), "step": 0})
+
+    def inject_step_meta(self, response):
+        if self.step_meta and isinstance(response, dict):
+            self.step_meta["step"] += 1
+            response["iopipe"] = self.step_meta

iopipe/contrib/eventinfo/event_types.py

@@ -3,6 +3,7 @@
 
 class EventType(object):
     keys = []
+    response_keys = []
     exclude_keys = []
     required_keys = []
     source = None
@@ -266,3 +267,9 @@ def metrics_for_event_type(event, context):
             event_info = event_type.collect()
             [context.iopipe.metric(k, v) for k, v in event_info.items()]
             break
+
+    if context.iopipe.is_step_function:
+        context.iopipe.collect_step_meta(event)
+        if context.iopipe.step_meta:
+            for key, value in context.iopipe.step_meta.items():
+                context.iopipe.metric("@iopipe/event-info.stepFunction.%s" % key, value)

iopipe/contrib/eventinfo/plugin.py

@@ -35,14 +35,15 @@ def post_setup(self, iopipe):
         pass
 
     def pre_invoke(self, event, context):
-        pass
+        self.context = context
 
     def post_invoke(self, event, context):
         if self.enabled:
             metrics_for_event_type(event, context)
 
     def post_response(self, response):
-        pass
+        if self.enabled:
+            self.context.iopipe.inject_step_meta(response)
 
     def pre_report(self, report):
         pass

pyproject.toml

@@ -0,0 +1,18 @@
+[tool.black]
+line-length = 88
+target-version = ['py27', 'py36', 'py37', 'py38']
+include = '\.pyi?$'
+exclude = '''
+/(
+    \.eggs
+  | \.git
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+)/
+'''

setup.py

@@ -39,7 +39,7 @@
     packages=find_packages(exclude=("tests", "tests.*")),
     extras_require={
         "coverage": coverage_requires,
-        "dev": tests_require + ["black==18.6b2", "pre-commit"],
+        "dev": tests_require + ["black==19.3b0", "pre-commit"],
     },
     install_requires=install_requires,
     setup_requires=["pytest-runner==4.2"],

tests/contrib/logger/conftest.py

@@ -29,7 +29,7 @@ def _handler(event, context):
         except Exception as e:
             context.iopipe.log.exception(e)
 
-        print("This is not a misprint.")
+        print ("This is not a misprint.")
 
     return iopipe_with_logger, _handler
 

tests/contrib/logger/test_plugin.py

@@ -161,7 +161,7 @@ def test__logger_plugin__use_tmp__disk_used(
         pytest.skip("this test requires linux, skipping")
 
     disk_usage = read_disk()
-    print(disk_usage)
+    print (disk_usage)
 
     iopipe, handler = handler_with_logger_use_tmp
     handler({}, mock_context)