httpdbg 1.2.1__tar.gz → 1.2.3__tar.gz

{httpdbg-1.2.1 → httpdbg-1.2.3}/PKG-INFO

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

{httpdbg-1.2.1 → httpdbg-1.2.3}/httpdbg/__init__.py

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

{httpdbg-1.2.1 → httpdbg-1.2.3}/httpdbg/hooks/generic.py

@@ -1,9 +1,10 @@
 # -*- coding: utf-8 -*-
+import builtins
+from collections.abc import Callable
 from contextlib import contextmanager
-import glob
+import functools
 import importlib
 import inspect
-from pathlib import Path
 import traceback
 from types import ModuleType
 from typing import Any
@@ -50,55 +51,83 @@ def set_hook_for_generic(records: HTTPRecords, method: Any):
 def hook_generic(
     records: HTTPRecords, initiators: Union[List[str], None] = None
 ) -> Generator[None, None, None]:
-    hooks = []
-
-    if not initiators:
-        initiators = []
-
-    for initiator in initiators:
-        logger().info(f"HOOK_GENERIC add initiator - {initiator}")
-        hooks += list_callables_from_package(records, initiator)
+    if initiators:
+        # we add a hook for a generic initiator only if the module is imported
+
+        hooks: List[Callable] = []
+        already_hooked: List[str] = []
+
+        original_builtin_import = builtins.__import__
+
+        def __hook__import__(
+            name,
+            globals=None,
+            locals=None,
+            fromlist=(),
+            level=0,
+            records=None,
+            initiators=None,
+            hooks=None,
+            already_hooked=None,
+        ):
+            if initiators is None:
+                raise Exception("initiators must not be None")
+            if hooks is None:
+                raise Exception("hooks must not be None")
+            if already_hooked is None:
+                raise Exception("already_hooked must not be None")
+
+            if (
+                name not in already_hooked
+            ):  # avoids parsing the same module multiple times
+                if (records is not None) and initiators:
+                    if (name in initiators) or (
+                        any(
+                            [
+                                name.startswith(f"{initiator}.")
+                                for initiator in initiators
+                            ]
+                        )
+                    ):
+                        logger().debug(f"HOOK IMPORT {name} - fromlist={fromlist}")
+                        already_hooked.append(name)
+                        hooks += list_callables_from_module(records, name)
+
+            # we temporarily restore the original built-in import function to avoid infinite recursion during import
+            __custom_import = builtins.__import__
+            builtins.__import__ = original_builtin_import
+            r = original_builtin_import(
+                name=name,
+                globals=globals,
+                locals=locals,
+                fromlist=fromlist,
+                level=level,
+            )
+            builtins.__import__ = __custom_import
+            return r
+
+        __hook__import_with_records_initiators_hooks_alreadyhooked__ = (
+            functools.partial(
+                __hook__import__,
+                records=records,
+                initiators=initiators,
+                hooks=hooks,
+                already_hooked=already_hooked,
+            )
+        )
 
-    try:
-        logger().info(
-            f"HOOK_GENERIC add initiator - hooks - {[hook.__httpdbg__.__name__ for hook in hooks]}"
+        builtins.__import__ = (
+            __hook__import_with_records_initiators_hooks_alreadyhooked__
         )
-    except Exception:
-        pass
 
     yield
 
-    if hooks:
-        for fnc in hooks:
-            fnc = undecorate(fnc)
+    if initiators:
+        builtins.__import__ == original_builtin_import
 
-
-def list_callables_from_package(records: HTTPRecords, package: str) -> List[Any]:
-    callables = []
-
-    try:
-        logger().info(f"LIST_CALLABLES_FROM_PACKAGE {package}")
-
-        callables += list_callables_from_module(records, package)
-
-        imported_package = importlib.import_module(package)
-        if hasattr(imported_package, "__path__"):
-            for p in glob.glob(f"{list(imported_package.__path__)[0]}/*"):
-                file_or_dir = Path(p)
-                if file_or_dir.is_file():
-                    if file_or_dir.name.endswith(".py"):
-                        callables += list_callables_from_module(
-                            records, f"{package}.{file_or_dir.name[:-3]}"
-                        )
-                elif file_or_dir.is_dir():
-                    if not file_or_dir.name.startswith("__"):  # __pycache__
-                        callables += list_callables_from_package(
-                            records, f"{package}.{file_or_dir.name}"
-                        )
-    except Exception as ex:
-        logger().info(f"LIST_CALLABLES_FROM_PACKAGE {package} - error - {str(ex)}")
-
-    return callables
+        if hooks:
+            for fnc in hooks:
+                fnc = undecorate(fnc)
 
 
 def list_callables_from_module(records: HTTPRecords, module: str) -> List[Any]:

{httpdbg-1.2.1 → httpdbg-1.2.3}/httpdbg/hooks/urllib3.py

@@ -52,7 +52,7 @@ def hook_urllib3(records: HTTPRecords) -> Generator[None, None, None]:
             )
         # v2
         if hasattr(urllib3, "request"):
-            urllib3.request = decorate(records, urllib3.request, set_hook_for_urllib3)
+            urllib3.request = decorate(records, urllib3.request, set_hook_for_urllib3)  # type: ignore[arg-type]
 
         hooks = True
     except ImportError:
@@ -70,4 +70,4 @@ def hook_urllib3(records: HTTPRecords) -> Generator[None, None, None]:
             )
         # v2
         if hasattr(urllib3, "request"):
-            urllib3.request = undecorate(urllib3.request)
+            urllib3.request = undecorate(urllib3.request)  # type: ignore[arg-type]

{httpdbg-1.2.1 → httpdbg-1.2.3}/httpdbg/hooks/utils.py

@@ -1,8 +1,13 @@
 # -*- coding: utf-8 -*-
+from collections.abc import Callable
 import inspect
+import typing
 
 from httpdbg.log import logger
 
+if typing.TYPE_CHECKING:
+    from httpdbg.records import HTTPRecords
+
 
 def getcallargs(original_method, *args, **kwargs):
     while hasattr(
@@ -28,12 +33,12 @@ def getcallargs(original_method, *args, **kwargs):
     return callargs
 
 
-def decorate(records, method, hook):
+def decorate(records: "HTTPRecords", method: Callable, hook: Callable):
     ori = method
     method = hook(records, method)
-    method.__httpdbg__ = ori
+    method.__httpdbg__ = ori  # type: ignore[attr-defined]
     return method
 
 
-def undecorate(method):
-    return method.__httpdbg__
+def undecorate(method: Callable):
+    return method.__httpdbg__  # type: ignore[attr-defined]

{httpdbg-1.2.1 → httpdbg-1.2.3}/httpdbg/records.py

@@ -307,6 +307,13 @@ class HTTPRecord:
         else:
             self.response.rawdata += data
 
+    @property
+    def protocol(self) -> str:
+        if self.response.protocol == self.request.protocol:
+            return self.request.protocol
+        else:
+            return f"{self.request.protocol} -> {self.response.protocol}"
+
 
 class HTTPRecordsSessionInfo:
 

{httpdbg-1.2.1 → httpdbg-1.2.3}/httpdbg/webapp/api.py

@@ -90,6 +90,7 @@ class RequestListPayload(JSONEncoder):
                 "netloc": req.netloc,
                 "urlext": req.urlext,
                 "status_code": req.status_code,
+                "protocol": req.protocol,
                 "reason": req.reason,
                 "verb": req.method,
                 "tag": req.tag,

{httpdbg-1.2.1 → httpdbg-1.2.3}/httpdbg/webapp/static/index.htm

@@ -201,7 +201,7 @@
                         data-group="{{group_id}}"
                         data-groupby="{{groupby_id}}"
                         data-orderby="{{tbegin}}"
-                        onclick="select_request(arguments[0], '{{id}}')"
+                        onclick="select_request(event, '{{id}}')"
                         onkeypress="shortcut_request(event, '{{id}}')"
                         class="request"
                         data-qa-request="{{id}}">
@@ -273,19 +273,24 @@
                                 <script id="template_headers" type="x-tmpl-mustache">
                                        <b>{{ method }}</b> <a href="{{ url }}">{{ url }}</a>
                                        <hr>
-                                            <span class="header-cookie-key">status</span>:
+                                            <span class="header-cookie-key">status:</span>
                                             <span class="header-cookie-value">{{ status_code }} {{ reason }}</span>
+                                            <br>
+                                            {{#protocol}}
+                                            <span class="header-cookie-key">protocol:</span>
+                                            <span class="header-cookie-value">{{ protocol }}</span>
+                                            {{/protocol}}
                                             <br><br>
-                                            <span class="header-cookie-key">start</span>:
-                                            <span class="header-cookie-value">{{tbegin}}</span>   
+                                            <span class="header-cookie-key">start:</span>
+                                            <span class="header-cookie-value">{{tbegin}}</span>
                                             <br>
-                                            <span class="header-cookie-key">end</span>:&nbsp;&nbsp;&nbsp;
-                                            <span class="header-cookie-value">{{last_update}}</span>   
+                                            <span class="header-cookie-key">end:&nbsp;&nbsp;</span>
+                                            <span class="header-cookie-value">{{last_update}}</span>
                                        <hr>
                                        <h4>response headers</h4>
                                        {{#response}}
                                            {{#response.headers}}
-                                           <span class="header-cookie-key">{{name}}</span>:
+                                           <span class="header-cookie-key">{{name}}:</span>
                                            <span class="header-cookie-value">{{value}}</span>
                                            <br>
                                            {{/response.headers}}
@@ -293,7 +298,7 @@
                                        <hr>
                                        <h4>request headers</h4>
                                        {{#request.headers}}
-                                       <span class="header-cookie-key">{{name}}</span>:
+                                       <span class="header-cookie-key">{{name}}:</span>
                                        <span class="header-cookie-value">{{value}}</span>
                                        <br>
                                        {{/request.headers}}
@@ -309,12 +314,12 @@
                                        <h4>response cookies</h4>
                                        {{#response}}
                                            {{#response.cookies}}
-                                           <span class="header-cookie-key">{{name}}</span>: 
+                                           <span class="header-cookie-key">{{name}}:</span>
                                            <span class="header-cookie-value">{{value}}</span> 
                                              <ul>
                                                {{#attributes}}
                                                <li>
-                                                <span class="header-cookie-key">{{name}}</span>{{#attr}}: <span class="header-cookie-value">{{attr}}</span>{{/attr}}
+                                                <span class="header-cookie-key">{{name}}:</span>{{#attr}} <span class="header-cookie-value">{{attr}}</span>{{/attr}}
                                                </li>
                                                {{/attributes}}
                                              </ul>
@@ -323,7 +328,7 @@
                                        <hr>
                                        <h4>request cookies</h4>
                                        {{#request.cookies}}
-                                       <span class="header-cookie-key">{{name}}</span>: 
+                                       <span class="header-cookie-key">{{name}}:</span>
                                        <span class="header-cookie-value">{{value}}</span>
                                        <br> 
                                        <br>

{httpdbg-1.2.1 → httpdbg-1.2.3}/httpdbg/webapp/static/table.css

@@ -124,6 +124,7 @@
 .requests-table tbody tr.active-row-compare {
     background-color: var(--compare-url-bgcolor);
     color: var(--selected-url-text);
+    user-select: none;  /* to remove the undesired border in firefox */
 }
 
 #filter-url {

{httpdbg-1.2.1 → httpdbg-1.2.3}/httpdbg.egg-info/PKG-INFO

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

{httpdbg-1.2.1 → httpdbg-1.2.3}/tests/test_api.py

@@ -55,6 +55,19 @@ def test_api_requests_netloc(httpbin, httpdbg_host, httpdbg_port):
     assert reqs[list(reqs.keys())[0]]["urlext"] == "/get?abc"
 
 
+@pytest.mark.api
+def test_api_requests_protocol(httpbin, httpdbg_host, httpdbg_port):
+    with httpdbg_srv(httpdbg_host, httpdbg_port) as records:
+        with httprecord(records):
+            requests.get(httpbin.url + "/get?abc")
+        ret = requests.get(f"http://{httpdbg_host}:{httpdbg_port}/requests")
+
+    reqs = ret.json()["requests"]
+
+    assert len(reqs) == 1
+    assert reqs[list(reqs.keys())[0]]["protocol"] == "HTTP/1.1"
+
+
 @pytest.mark.api
 def test_api_request_by_id(httpbin, httpdbg_host, httpdbg_port):
     with httpdbg_srv(httpdbg_host, httpdbg_port) as records: