httpdbg 0.29.0__tar.gz → 0.29.2__tar.gz

{httpdbg-0.29.0 → httpdbg-0.29.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: httpdbg
-Version: 0.29.0
+Version: 0.29.2
 Summary: A very simple tool to debug HTTP(S) client requests
 Author-email: cle-b <cle@tictac.pm>
 License: Apache-2.0

{httpdbg-0.29.0 → httpdbg-0.29.2}/httpdbg/__init__.py

@@ -3,6 +3,6 @@ from httpdbg.hooks.all import httprecord
 from httpdbg.records import HTTPRecords
 
 
-__version__ = "0.29.0"
+__version__ = "0.29.2"
 
 __all__ = ["httprecord", "HTTPRecords"]

{httpdbg-0.29.0 → httpdbg-0.29.2}/httpdbg/__main__.py

@@ -35,7 +35,7 @@ def pyhttpdbg(params, subparams, test_mode=False):
             elif params.script:
                 run_script(subparams)
             else:
-                run_console(test_mode)
+                run_console(records, test_mode)
 
         if not (params.force_quit or test_mode):
             print_msg(f"  httpdbg - HTTP(S) requests available at {url}")

{httpdbg-0.29.0 → httpdbg-0.29.2}/httpdbg/hooks/aiohttp.py

@@ -13,20 +13,21 @@ from httpdbg.records import HTTPRecords
 
 def set_hook_for_aiohttp_async(records: HTTPRecords, method: Callable):
     async def hook(*args, **kwargs):
-        initiator = None
+        initiator_and_group = None
         try:
             with httpdbg_initiator(
                 records, traceback.extract_stack(), method, *args, **kwargs
-            ) as initiator:
+            ) as initiator_and_group:
                 ret = await method(*args, **kwargs)
             return ret
         except Exception as ex:
             callargs = getcallargs(method, *args, **kwargs)
 
             if "str_or_url" in callargs:
-                if initiator:
+                if initiator_and_group:
+                    initiator, group = initiator_and_group
                     records.add_new_record_exception(
-                        initiator, str(callargs["str_or_url"]), ex
+                        initiator, group, str(callargs["str_or_url"]), ex
                     )
             raise
 

{httpdbg-0.29.0 → httpdbg-0.29.2}/httpdbg/hooks/httpx.py

@@ -13,20 +13,21 @@ from httpdbg.records import HTTPRecords
 
 def set_hook_for_httpx_async(records: HTTPRecords, method: Callable):
     async def hook(*args, **kwargs):
-        initiator = None
+        initiator_and_group = None
         try:
             with httpdbg_initiator(
                 records, traceback.extract_stack(), method, *args, **kwargs
-            ) as initiator:
+            ) as initiator_and_group:
                 ret = await method(*args, **kwargs)
             return ret
         except Exception as ex:
             callargs = getcallargs(method, *args, **kwargs)
 
             if "url" in callargs:
-                if initiator:
+                if initiator_and_group:
+                    initiator, group = initiator_and_group
                     records.add_new_record_exception(
-                        initiator, str(callargs["url"]), ex
+                        initiator, group, str(callargs["url"]), ex
                     )
             raise
 
@@ -35,20 +36,21 @@ def set_hook_for_httpx_async(records: HTTPRecords, method: Callable):
 
 def set_hook_for_httpx(records: HTTPRecords, method: Callable):
     def hook(*args, **kwargs):
-        initiator = None
+        initiator_and_group = None
         try:
             with httpdbg_initiator(
                 records, traceback.extract_stack(), method, *args, **kwargs
-            ) as initiator:
+            ) as initiator_and_group:
                 ret = method(*args, **kwargs)
             return ret
         except Exception as ex:
             callargs = getcallargs(method, *args, **kwargs)
 
             if "url" in callargs:
-                if initiator:
+                if initiator_and_group:
+                    initiator, group = initiator_and_group
                     records.add_new_record_exception(
-                        initiator, str(callargs["url"]), ex
+                        initiator, group, str(callargs["url"]), ex
                     )
             raise
 

{httpdbg-0.29.0 → httpdbg-0.29.2}/httpdbg/hooks/requests.py

@@ -13,20 +13,21 @@ from httpdbg.records import HTTPRecords
 
 def set_hook_for_requests(records: HTTPRecords, method: Callable):
     def hook(*args, **kwargs):
-        initiator = None
+        initiator_and_group = None
         try:
             with httpdbg_initiator(
                 records, traceback.extract_stack(), method, *args, **kwargs
-            ) as initiator:
+            ) as initiator_and_group:
                 ret = method(*args, **kwargs)
             return ret
         except Exception as ex:
             callargs = getcallargs(method, *args, **kwargs)
 
             if "url" in callargs:
-                if initiator:
+                if initiator_and_group:
+                    initiator, group = initiator_and_group
                     records.add_new_record_exception(
-                        initiator, str(callargs["url"]), ex
+                        initiator, group, str(callargs["url"]), ex
                     )
             raise
 

{httpdbg-0.29.0 → httpdbg-0.29.2}/httpdbg/hooks/urllib3.py

@@ -13,20 +13,21 @@ from httpdbg.records import HTTPRecords
 
 def set_hook_for_urllib3(records: HTTPRecords, method: Callable):
     def hook(*args, **kwargs):
-        initiator = None
+        initiator_and_group = None
         try:
             with httpdbg_initiator(
                 records, traceback.extract_stack(), method, *args, **kwargs
-            ) as initiator:
+            ) as initiator_and_group:
                 ret = method(*args, **kwargs)
             return ret
         except Exception as ex:
             callargs = getcallargs(method, *args, **kwargs)
 
             if "url" in callargs:
-                if initiator:
+                if initiator_and_group:
+                    initiator, group = initiator_and_group
                     records.add_new_record_exception(
-                        initiator, str(callargs["url"]), ex
+                        initiator, group, str(callargs["url"]), ex
                     )
             raise
 

{httpdbg-0.29.0 → httpdbg-0.29.2}/httpdbg/initiator.py

@@ -23,12 +23,11 @@ from httpdbg.log import logger
 class Initiator:
     def __init__(
         self,
-        id: str,
         label: str,
         short_stack: str,
         stack: List[str],
     ):
-        self.id = id
+        self.id = get_new_uuid()
         self.label = label
         self.short_stack = short_stack
         self.stack = stack
@@ -61,10 +60,10 @@ class Initiator:
 
 
 class Group:
-    def __init__(self, id: str, label: str, full_label: str):
-        self.id = id
-        self.label = label
-        self.full_label = full_label
+    def __init__(self, label: str, full_label: str):
+        self.id: str = get_new_uuid()
+        self.label: str = label
+        self.full_label: str = full_label
 
     def to_json(self) -> dict:
         return {"id": self.id, "label": self.label, "full_label": self.full_label}
@@ -195,7 +194,7 @@ def extract_short_stack_from_file(
 @contextmanager
 def httpdbg_initiator(
     records, extracted_stack: traceback.StackSummary, original_method, *args, **kwargs
-) -> Generator[Union[Initiator, None], None, None]:
+) -> Generator[Union[Tuple[Initiator, Group], None], None, None]:
     envname = f"{HTTPDBG_CURRENT_INITIATOR}_{records.id}"
 
     if not os.environ.get(envname):
@@ -215,7 +214,7 @@ def httpdbg_initiator(
             short_stack += f"    {k}={v}\n"
         short_stack += ")"
 
-        current_initiator = Initiator(get_new_uuid(), instruction, short_stack, stack)
+        current_initiator = Initiator(instruction, short_stack, stack)
         records.initiators[current_initiator.id] = current_initiator
 
         os.environ[envname] = current_initiator.id
@@ -223,8 +222,8 @@ def httpdbg_initiator(
         try:
             with httpdbg_group(
                 records, instruction, short_stack
-            ):  # by default we group the requests by initiator
-                yield current_initiator
+            ) as group:  # by default we group the requests by initiator
+                yield current_initiator, group
         except Exception:
             del os.environ[envname]
             raise
@@ -258,21 +257,33 @@ def httpdbg_tag(tag: str) -> Generator[None, None, None]:
 @contextmanager
 def httpdbg_group(
     records: "HTTPRecords", label: str, full_label: str
-) -> Generator[None, None, None]:
-
-    group_already_set = HTTPDBG_CURRENT_GROUP in os.environ
+) -> Generator[Group, None, None]:
+
+    # A group is considered set if the environment variable exists and the group
+    # is recorded.If the environment variable exists but the group is not recorded,
+    # it means httpdbg was called reentrantly, and we need to record the group again
+    # using the same id.
+    group_already_set = (HTTPDBG_CURRENT_GROUP in os.environ) and (
+        os.environ[HTTPDBG_CURRENT_GROUP] in records.groups
+    )
 
     if not group_already_set:
         logger().info("httpdbg_group (new)")
-        group_id = get_new_uuid()
-        records.groups[group_id] = Group(group_id, label, full_label)
-        os.environ[HTTPDBG_CURRENT_GROUP] = group_id
+        group = Group(label, full_label)
+        # in case of a reentrant call to httpdbg, we force the group id to be the same
+        if HTTPDBG_CURRENT_GROUP in os.environ:
+            group.id = os.environ[HTTPDBG_CURRENT_GROUP]
+            logger().info("httpdbg_group (reentrant) keep id {group.id}")
+        records.groups[group.id] = group
+        os.environ[HTTPDBG_CURRENT_GROUP] = group.id
+    else:
+        group = records.groups[os.environ[HTTPDBG_CURRENT_GROUP]]
 
     try:
         logger().info(
             f"httpdbg_group {records.groups} group_id={os.environ[HTTPDBG_CURRENT_GROUP]} label={label} full_label={full_label}"
         )
-        yield
+        yield group
     except Exception:
         if (not group_already_set) and (HTTPDBG_CURRENT_GROUP in os.environ):
             del os.environ[HTTPDBG_CURRENT_GROUP]

httpdbg-0.29.2/httpdbg/mode_console.py

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*-
+import code
+from typing import List
+from typing import Union
+
+from httpdbg.records import HTTPRecords
+from httpdbg.initiator import httpdbg_group
+
+
+def console_exit():
+    raise SystemExit
+
+
+class InteractiveConsoleWithHistory(code.InteractiveConsole):
+
+    def __init__(self, records: HTTPRecords, locals=None):
+        self.records: HTTPRecords = records
+        self.history: List[str] = []
+        self.incomplete_block: bool = False
+        super().__init__(locals)
+
+    def push(self, line):
+        if line:  # if the line is empty, we don't add it in the history
+            if (
+                self.incomplete_block
+            ):  # if the latest instruction is part of a block, we group it with the previous one
+                self.history[-1] += (
+                    "\n          " + line
+                )  # to simulate the block indentation
+            else:
+                self.history.append(line)
+
+        # if the latest instruction is part of a block, the label is generic
+        label = self.history[-1] if not self.incomplete_block else "(block)"
+
+        # in the full label, we keep the last 5 instructions/blocks
+        latest_history = self.history[-5:]
+        if not self.incomplete_block:
+            # in case of a block, we don't know which line within the block is the initiator.
+            # this is why we do not mark it in that case.
+            # this information is displayed in the initiator tooltip of the requests (in console, line X,)
+            latest_history[-1] += " <===="
+
+        full_label = ">>> " + "\n>>> ".join(latest_history)
+
+        with httpdbg_group(self.records, label, full_label):
+            self.incomplete_block = super().push(line)
+
+        return self.incomplete_block
+
+
+def run_console(
+    records: HTTPRecords, test_mode: bool = False
+) -> Union[InteractiveConsoleWithHistory, None]:
+    try:
+        vars = globals()
+        vars.update(locals())
+
+        try:
+            # adds history and autocompletion capabilities
+            import readline
+            import rlcompleter
+
+            readline.set_completer(rlcompleter.Completer(vars).complete)
+            readline.parse_and_bind("tab: complete")
+        except ImportError:  # pragma: no cover
+            # readline is not available on Windows
+            pass
+
+        vars.update({"exit": console_exit})
+
+        new_console = InteractiveConsoleWithHistory(records, vars)
+        if not test_mode:
+            new_console.interact()  # pragma: no cover
+        else:
+            new_console.push("print('test_mode is on')")
+            return new_console
+    except SystemExit:  # pragma: no cover
+        pass
+
+    return None

{httpdbg-0.29.0 → httpdbg-0.29.2}/httpdbg/records.py

@@ -330,7 +330,7 @@ class HTTPRecords:
                 stack.append(line)
             long_label = stack[-1]
             label = long_label.split("\n")[1]
-            initiator = Initiator(get_new_uuid(), label, long_label, stack)
+            initiator = Initiator(label, long_label, stack)
 
         if initiator.id not in self.initiators:
             self.initiators[initiator.id] = initiator
@@ -410,13 +410,14 @@ class HTTPRecords:
             del self._sockets[id(obj)]
 
     def add_new_record_exception(
-        self, initiator: Initiator, url: str, exception: Exception
+        self, initiator: Initiator, group: Group, url: str, exception: Exception
     ) -> HTTPRecord:
         if initiator.id not in self.initiators:
             self.initiators[initiator.id] = initiator
         new_record = HTTPRecord()
         new_record.url = url
         new_record.initiator_id = initiator.id
+        new_record.group_id = group.id
         new_record.exception = exception
         self.requests[new_record.id] = new_record
         return new_record

{httpdbg-0.29.0 → httpdbg-0.29.2}/httpdbg/webapp/api.py

@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
 from json import JSONEncoder
+import traceback
 from typing import Any
 from typing import Dict
 
@@ -53,7 +54,11 @@ class RequestPayload(JSONEncoder):
         if req.exception is not None:
             payload["exception"] = {
                 "type": str(type(req.exception)),
-                "message": str(req.exception),
+                "message": "".join(
+                    traceback.format_exception(
+                        type(req.exception), req.exception, req.exception.__traceback__
+                    )
+                ),
             }
 
         return payload

{httpdbg-0.29.0 → httpdbg-0.29.2}/httpdbg/webapp/static/api.js

@@ -119,6 +119,7 @@ async function get_request(request_id) {
 
             // the full stack is not present in request summary
             global.requests[request_id].initiator_id = data.initiator_id;
+            global.requests[request_id].exception = data.exception;
 
             global.requests[request_id].to_refresh = true;
 

{httpdbg-0.29.0 → httpdbg-0.29.2}/httpdbg/webapp/static/index.htm

@@ -363,8 +363,8 @@
                                     -- no exception --
                                     {{/exception}}
                                     {{#exception}}
-                                        <span>{{exception.type}}</span>
-                                        <pre>{{exception.message}}</pre>
+                                        <span class="header-cookie-value">{{exception.type}}</span>
+                                        <pre class="previewcode">{{exception.message}}</pre>
                                     {{/exception}}
                                 </script>
                             </div>

{httpdbg-0.29.0 → httpdbg-0.29.2}/httpdbg.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: httpdbg
-Version: 0.29.0
+Version: 0.29.2
 Summary: A very simple tool to debug HTTP(S) client requests
 Author-email: cle-b <cle@tictac.pm>
 License: Apache-2.0

{httpdbg-0.29.0 → httpdbg-0.29.2}/tests/test_mode_console.py

@@ -36,7 +36,7 @@ def test_run_console_from_pyhttpdbg_entry_point_default(
 def test_run_console(httpbin, httpdbg_host, httpdbg_port):
     with httpdbg_srv(httpdbg_host, httpdbg_port) as records:
         with httprecord(records):
-            new_console = run_console(test_mode=True)
+            new_console = run_console(records, test_mode=True)
             new_console.push("import requests")
             new_console.push(f"requests.get('{httpbin.url}/get')")
             with pytest.raises(SystemExit):
@@ -48,3 +48,31 @@ def test_run_console(httpbin, httpdbg_host, httpdbg_port):
 
     assert len(reqs) == 1
     assert reqs[list(reqs.keys())[0]]["url"] == httpbin.url + "/get"
+
+
+@pytest.mark.group
+def test_run_console_group(httpbin):
+
+    with httprecord() as records:
+        new_console = run_console(records, test_mode=True)
+        new_console.push("import requests")
+        new_console.push(f"requests.get('{httpbin.url}/get')")
+        new_console.push("if True:")
+        new_console.push(f"    requests.post('{httpbin.url}/post')")
+        new_console.push("")
+        with pytest.raises(SystemExit):
+            new_console.push("exit()")
+
+    assert len(records) == 2
+    assert (
+        records.groups[records[0].group_id].label
+        == f"requests.get('{httpbin.url}/get')"
+    )
+    assert records.groups[records[0].group_id].full_label.endswith(
+        f">>> requests.get('{httpbin.url}/get') <===="
+    )
+
+    assert records.groups[records[1].group_id].label == "(block)"
+    assert records.groups[records[1].group_id].full_label.endswith(
+        f">>> if True:\n              requests.post('{httpbin.url}/post')"
+    )

httpdbg-0.29.0/httpdbg/mode_console.py

@@ -1,37 +0,0 @@
-# -*- coding: utf-8 -*-
-import code
-from typing import Union
-
-
-def console_exit():
-    raise SystemExit
-
-
-def run_console(test_mode: bool = False) -> Union[code.InteractiveConsole, None]:
-    try:
-        vars = globals()
-        vars.update(locals())
-
-        try:
-            # adds history and autocompletion capabilities
-            import readline
-            import rlcompleter
-
-            readline.set_completer(rlcompleter.Completer(vars).complete)
-            readline.parse_and_bind("tab: complete")
-        except ImportError:  # pragma: no cover
-            # readline is not available on Windows
-            pass
-
-        vars.update({"exit": console_exit})
-
-        new_console = code.InteractiveConsole(vars)
-        if not test_mode:
-            new_console.interact()  # pragma: no cover
-        else:
-            new_console.push("print('test_mode is on')")
-            return new_console
-    except SystemExit:  # pragma: no cover
-        pass
-
-    return None