httpdbg 1.2.6__tar.gz → 2.0.0__tar.gz

{httpdbg-1.2.6 → httpdbg-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: httpdbg
-Version: 1.2.6
+Version: 2.0.0
 Summary: A very simple tool to debug HTTP(S) client and server requests.
 Author-email: cle-b <cle@tictac.pm>
 License: Apache-2.0
@@ -32,6 +32,8 @@ To use it, execute your program using the `pyhttpdbg` command instead of `python
 
 ![](https://github.com/cle-b/httpdbg/blob/main/ui.png?raw=true)
 
+Supports `HTTP/1.0`, `HTTP/1.1`, and `HTTP/2`.
+
 Full documentation => [https://httpdbg.readthedocs.io/](https://httpdbg.readthedocs.io/en/latest/)
 
 ## installation 
@@ -156,6 +158,16 @@ The requests are grouped by tests.
 | pytest         | supported                           | -         | yes       |
 | unittest       | supported                           | -         | yes       |
 
+### supported HTTP version
+
+| version        | status                                                      |     
+|----------------|-------------------------------------------------------------|
+| 1.0            | supported                                                   |
+| 1.1            | supported                                                   |
+| 2              | supported (only through the `h2` lib)                       |
+
+
+
 ## configuration
 
 No configuration is necessary to start but some few settings are available for particular use.

{httpdbg-1.2.6 → httpdbg-2.0.0}/README.md

@@ -6,6 +6,8 @@ To use it, execute your program using the `pyhttpdbg` command instead of `python
 
 ![](https://github.com/cle-b/httpdbg/blob/main/ui.png?raw=true)
 
+Supports `HTTP/1.0`, `HTTP/1.1`, and `HTTP/2`.
+
 Full documentation => [https://httpdbg.readthedocs.io/](https://httpdbg.readthedocs.io/en/latest/)
 
 ## installation 
@@ -130,6 +132,16 @@ The requests are grouped by tests.
 | pytest         | supported                           | -         | yes       |
 | unittest       | supported                           | -         | yes       |
 
+### supported HTTP version
+
+| version        | status                                                      |     
+|----------------|-------------------------------------------------------------|
+| 1.0            | supported                                                   |
+| 1.1            | supported                                                   |
+| 2              | supported (only through the `h2` lib)                       |
+
+
+
 ## configuration
 
 No configuration is necessary to start but some few settings are available for particular use.

{httpdbg-1.2.6 → httpdbg-2.0.0}/httpdbg/__init__.py

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

{httpdbg-1.2.6 → httpdbg-2.0.0}/httpdbg/args.py

@@ -1,12 +1,11 @@
 # -*- coding: utf-8 -*-
 import argparse
 from pathlib import Path
-from typing import List, Tuple
 
 from httpdbg.log import LogLevel
 
 
-def read_args(args: List[str]) -> Tuple[argparse.Namespace, List[str]]:
+def read_args(args: list[str]) -> tuple[argparse.Namespace, list[str]]:
     httpdbg_args = args
     client_args = []
     for action in ["--console", "--module", "-m", "--script"]:

{httpdbg-1.2.6 → httpdbg-2.0.0}/httpdbg/hooks/all.py

@@ -1,8 +1,5 @@
-# -*- coding: utf-8 -*-
 from contextlib import contextmanager
 from typing import Generator
-from typing import List
-from typing import Tuple
 from typing import Union
 
 from httpdbg.hooks.aiohttp import hook_aiohttp
@@ -10,6 +7,7 @@ from httpdbg.hooks.external import watcher_external
 from httpdbg.hooks.fastapi import hook_fastapi
 from httpdbg.hooks.flask import hook_flask
 from httpdbg.hooks.generic import hook_generic
+from httpdbg.hooks.h2 import hook_h2
 from httpdbg.hooks.http import hook_http
 from httpdbg.hooks.httpx import hook_httpx
 from httpdbg.hooks.pytest import hook_pytest
@@ -26,10 +24,10 @@ from httpdbg.records import HTTPRecords
 @contextmanager
 def httprecord(
     records: HTTPRecords = None,
-    initiators: Union[List[str], None] = None,
+    initiators: Union[list[str], None] = None,
     client: bool = True,
     server: bool = False,
-    ignore: Union[List[Tuple[str, int]], None] = None,
+    ignore: tuple[tuple[str, int], ...] = (),
     multiprocess: bool = True,
 ) -> Generator[HTTPRecords, None, None]:
     if records is None:
@@ -37,25 +35,26 @@ def httprecord(
 
     with hook_flask(records):
         with hook_socket(records):
-            with hook_fastapi(records):
-                with hook_starlette(records):
-                    with hook_uvicorn(records):
-                        with hook_http(records):
-                            with hook_httpx(records):
-                                with hook_requests(records):
-                                    with hook_urllib3(records):
-                                        with hook_aiohttp(records):
-                                            with hook_pytest(records):
-                                                with hook_unittest(records):
-                                                    with hook_generic(
-                                                        records, initiators
-                                                    ):
-                                                        if multiprocess:
-                                                            with watcher_external(
-                                                                records,
-                                                                initiators,
-                                                                server,
-                                                            ):
+            with hook_h2(records):
+                with hook_fastapi(records):
+                    with hook_starlette(records):
+                        with hook_uvicorn(records):
+                            with hook_http(records):
+                                with hook_httpx(records):
+                                    with hook_requests(records):
+                                        with hook_urllib3(records):
+                                            with hook_aiohttp(records):
+                                                with hook_pytest(records):
+                                                    with hook_unittest(records):
+                                                        with hook_generic(
+                                                            records, initiators
+                                                        ):
+                                                            if multiprocess:
+                                                                with watcher_external(
+                                                                    records,
+                                                                    initiators,
+                                                                    server,
+                                                                ):
+                                                                    yield records
+                                                            else:
                                                                 yield records
-                                                        else:
-                                                            yield records

{httpdbg-1.2.6 → httpdbg-2.0.0}/httpdbg/hooks/external.py

@@ -7,7 +7,6 @@ import pickle
 import tempfile
 import time
 import threading
-from typing import List
 from typing import Union
 
 from httpdbg.env import HTTPDBG_MULTIPROCESS_DIR
@@ -18,7 +17,7 @@ from httpdbg.records import HTTPRecords
 @contextmanager
 def watcher_external(
     records: HTTPRecords,
-    initiators: Union[List[str], None] = None,
+    initiators: Union[list[str], None] = None,
     server: bool = False,
 ) -> Generator[HTTPRecords, None, None]:
     if HTTPDBG_MULTIPROCESS_DIR not in os.environ:

{httpdbg-1.2.6 → httpdbg-2.0.0}/httpdbg/hooks/fastapi.py

@@ -3,9 +3,7 @@ from collections.abc import Callable
 from contextlib import contextmanager
 import functools
 from functools import wraps
-from typing import Dict
 from typing import Generator
-from typing import Union
 
 import datetime
 
@@ -37,7 +35,7 @@ def set_hook_fastapi_endpoint(records: HTTPRecords, method: Callable):
 def set_hook_fastapi_apirouter_add_api_route(
     records: HTTPRecords,
     method: Callable,
-    already_mapped: Union[Dict[Callable, Callable], None] = None,
+    already_mapped: dict[Callable, Callable],
 ):
 
     @wraps(method)
@@ -56,7 +54,9 @@ def set_hook_fastapi_apirouter_add_api_route(
             else:
                 callargs[param] = already_mapped[original_view_func]
 
-            args = [callargs[param] if x == original_view_func else x for x in args]
+            args = tuple(
+                callargs[param] if x == original_view_func else x for x in args
+            )
             if param in kwargs:
                 kwargs[param] = callargs[param]
 
@@ -85,12 +85,15 @@ def set_hook_fastapi_app(records: HTTPRecords, method: Callable):
             *args,
             **kwargs,
         ) as group:
-            if group and (group.id in records.groups):
-                if socketdata_id and (socketdata_id in records._sockets):
-                    records.groups[group.id].tbegin = records._sockets[
-                        socketdata_id
-                    ].record.tbegin - datetime.timedelta(milliseconds=1)
-                    records._sockets[socketdata_id].record.group_id = group.id
+            if group and socketdata_id:
+                sock = records._tracerhttp1.sockets.get(socketdata_id)
+                if (sock is not None) and (sock.record is not None):
+                    record = records.groups.get(group.id)
+                    if record is not None:
+                        record.tbegin = sock.record.tbegin - datetime.timedelta(
+                            milliseconds=1
+                        )
+                        sock.record.group_id = group.id
 
             ret = await method(*args, **kwargs)
 
@@ -121,7 +124,7 @@ def hook_fastapi(records: HTTPRecords) -> Generator[None, None, None]:
     try:
         import fastapi.routing
 
-        already_mapped: Dict[Callable, Callable] = {}
+        already_mapped: dict[Callable, Callable] = {}
 
         set_hook_fastapi_apirouter_add_api_route_with_already_mapped = (
             functools.partial(

{httpdbg-1.2.6 → httpdbg-2.0.0}/httpdbg/hooks/flask.py

@@ -3,9 +3,8 @@ from collections.abc import Callable
 from contextlib import contextmanager
 import functools
 from functools import wraps
-from typing import Dict
 from typing import Generator
-from typing import Union
+
 
 from httpdbg.hooks.utils import getcallargs
 from httpdbg.hooks.utils import decorate
@@ -36,7 +35,7 @@ def set_hook_flask_endpoint(records: HTTPRecords, method: Callable):
 def set_hook_flask_add_url_rule(
     records: HTTPRecords,
     method: Callable,
-    already_mapped: Union[Dict[Callable, Callable], None] = None,
+    already_mapped: dict[Callable, Callable],
 ):
 
     def hook(*args, **kwargs):
@@ -55,7 +54,9 @@ def set_hook_flask_add_url_rule(
             else:
                 callargs[param] = already_mapped[original_view_func]
 
-            args = [callargs[param] if x == original_view_func else x for x in args]
+            args = tuple(
+                callargs[param] if x == original_view_func else x for x in args
+            )
             if param in kwargs:
                 kwargs[param] = callargs[param]
 
@@ -67,7 +68,7 @@ def set_hook_flask_add_url_rule(
 def set_hook_flask_register_error_handler(
     records: HTTPRecords,
     method: Callable,
-    already_mapped: Union[Dict[Callable, Callable], None] = None,
+    already_mapped: dict[Callable, Callable],
 ):
 
     def hook(*args, **kwargs):
@@ -86,7 +87,9 @@ def set_hook_flask_register_error_handler(
             else:
                 callargs[param] = already_mapped[original_view_func]
 
-            args = [callargs[param] if x == original_view_func else x for x in args]
+            args = tuple(
+                callargs[param] if x == original_view_func else x for x in args
+            )
             if param in kwargs:
                 kwargs[param] = callargs[param]
 
@@ -103,7 +106,7 @@ def hook_flask(records: HTTPRecords) -> Generator[None, None, None]:
 
         # we must not apply the hook more than once on a mapped endpoint function
         # AssertionError: View function mapping is overwriting an existing endpoint function: xxxx
-        already_mapped: Dict[Callable, Callable] = {}
+        already_mapped: dict[Callable, Callable] = {}
 
         set_hook_flask_add_url_rule_with_already_mapped = functools.partial(
             set_hook_flask_add_url_rule, already_mapped=already_mapped

{httpdbg-1.2.6 → httpdbg-2.0.0}/httpdbg/hooks/generic.py

@@ -9,7 +9,6 @@ import traceback
 from types import ModuleType
 from typing import Any
 from typing import Generator
-from typing import List
 from typing import Union
 
 from httpdbg.hooks.utils import decorate
@@ -49,13 +48,13 @@ def set_hook_for_generic(records: HTTPRecords, method: Any):
 
 @contextmanager
 def hook_generic(
-    records: HTTPRecords, initiators: Union[List[str], None] = None
+    records: HTTPRecords, initiators: Union[list[str], None] = None
 ) -> Generator[None, None, None]:
     if initiators:
         # we add a hook for a generic initiator only if the module is imported
 
-        hooks: List[Callable] = []
-        already_hooked: List[str] = []
+        hooks: list[Callable] = []
+        already_hooked: list[str] = []
 
         original_builtin_import = builtins.__import__
 
@@ -130,7 +129,7 @@ def hook_generic(
                 fnc = undecorate(fnc)
 
 
-def list_callables_from_module(records: HTTPRecords, module: str) -> List[Any]:
+def list_callables_from_module(records: HTTPRecords, module: str) -> list[Any]:
     callables = []
 
     try:
@@ -180,7 +179,7 @@ def list_callables_from_class(
     imported_module: ModuleType,
     module: str,
     classname: str,
-) -> List[Any]:
+) -> list[Any]:
     callables = []
 
     try:

httpdbg-2.0.0/httpdbg/hooks/h2.py

@@ -0,0 +1,220 @@
+from collections.abc import Callable
+from contextlib import contextmanager
+import random
+import traceback
+from typing import Generator
+from typing import Union
+
+from httpdbg.hooks.recordhttp2 import HTTP2Record
+from httpdbg.hooks.utils import decorate
+from httpdbg.hooks.utils import getcallargs
+from httpdbg.hooks.utils import undecorate
+from httpdbg.initiator import httpdbg_initiator
+from httpdbg.log import logger
+from httpdbg.records import HTTPRecords
+
+
+class TracerHTTP2:
+
+    def __init__(
+        self,
+        ignore: tuple[tuple[str, int], ...] = (),
+    ):
+        self.sockets: dict[str, HTTP2Record] = dict()
+        self.ignore: tuple[tuple[str, int], ...] = ignore
+
+    def send_headers(
+        self,
+        initiator_id: str,
+        group_id: str,
+        socket_id: int,
+        stream_id: int,
+        headers: list[tuple[bytes, bytes]],
+    ) -> HTTP2Record:
+
+        if f"{socket_id}-{stream_id}" in self.sockets:
+            record = self.sockets[f"{socket_id}-{stream_id}"]
+            if record.is_client:
+                # this is a new request: we "close" the previous one
+                self.sockets.pop(f"{socket_id}-{stream_id}")
+
+                record = HTTP2Record(initiator_id, group_id)
+                record.request.headers = headers
+                self.sockets[f"{socket_id}-{stream_id}"] = record
+            else:
+                record.response.headers = headers
+        else:
+            record = HTTP2Record(initiator_id, group_id)
+            record.request.headers = headers
+            self.sockets[f"{socket_id}-{stream_id}"] = record
+
+        return record
+
+    def send_data(
+        self,
+        socket_id: int,
+        stream_id: int,
+        data: bytes,
+    ):
+        record = self.sockets.get(f"{socket_id}-{stream_id}")
+        if record:
+            record.send_data(data)
+
+    def receive_headers(
+        self,
+        initiator_id: str,
+        group_id: str,
+        socket_id: int,
+        stream_id: int,
+        headers: list[tuple[bytes, bytes]],
+        is_client: bool = True,
+    ) -> Union[HTTP2Record, None]:
+        record = None
+        if not is_client:
+            if f"{socket_id}-{stream_id}" in self.sockets:
+                # this is a new request received by the server: we "close" the previous one
+                self.sockets.pop(f"{socket_id}-{stream_id}")
+            record = HTTP2Record(initiator_id, group_id, is_client=False)
+            record.request.headers = headers
+            self.sockets[f"{socket_id}-{stream_id}"] = record
+        else:
+            if f"{socket_id}-{stream_id}" in self.sockets:
+                record = self.sockets[f"{socket_id}-{stream_id}"]
+                record.response.headers = headers
+        return record
+
+    def receive_data(
+        self,
+        socket_id: int,
+        stream_id: int,
+        data: bytes,
+    ):
+        record = self.sockets.get(f"{socket_id}-{stream_id}")
+        if record:
+            record.receive_data(data)
+
+
+def set_hook_for_h2_send_headers(records: HTTPRecords, method: Callable):
+    def hook(*args, **kwargs):
+        callargs = getcallargs(method, *args, **kwargs)
+        self = callargs.get("self")
+        stream_id = callargs.get("stream_id")
+        headers = callargs.get("headers")
+
+        with httpdbg_initiator(
+            records, traceback.extract_stack(), method, *args, **kwargs
+        ) as initiator_and_group:
+            initiator, group, _ = initiator_and_group
+            if all(x is not None for x in (self, stream_id, headers)):
+                logger().debug(
+                    f"H2 send_headers - self={id(self)} steam_id={stream_id} headers={headers}"
+                )
+                record = records._tracerhttp2.send_headers(
+                    initiator.id, group.id, id(self), stream_id, headers
+                )
+                if record.is_client and records.client:
+                    records.requests[record.id] = record
+            ret = method(*args, **kwargs)
+        return ret
+
+    return hook
+
+
+def set_hook_for_h2_send_data(records: HTTPRecords, method: Callable):
+    def hook(*args, **kwargs):
+        callargs = getcallargs(method, *args, **kwargs)
+        self = callargs.get("self")
+        stream_id = callargs.get("stream_id")
+        data = callargs.get("data")
+
+        with httpdbg_initiator(
+            records, traceback.extract_stack(), method, *args, **kwargs
+        ):
+            if all(x is not None for x in (self, stream_id, data)):
+                logger().debug(
+                    f"H2 send_data - self={id(self)} steam_id={stream_id} data={data[:20]!r}"
+                )
+                records._tracerhttp2.send_data(id(self), stream_id, data)
+            ret = method(*args, **kwargs)
+        return ret
+
+    return hook
+
+
+def set_hook_for_h2_receive_data(records: HTTPRecords, method: Callable):
+    def hook(*args, **kwargs):
+        callargs = getcallargs(method, *args, **kwargs)
+        self = callargs.get("self")
+
+        with httpdbg_initiator(
+            records, traceback.extract_stack(), method, *args, **kwargs
+        ) as initiator_and_group:
+            initiator, group, _ = initiator_and_group
+            ret = method(*args, **kwargs)
+
+        for event in ret:
+            import h2.events
+
+            if isinstance(event, h2.events.RequestReceived):
+                stream_id = event.stream_id
+                headers = event.headers
+                if all(x is not None for x in (self, stream_id, headers)):
+                    logger().debug(
+                        f"H2 receive_data headers RequestReceived {random.random()} - self={id(self)} steam_id={stream_id} headers={headers}"
+                    )
+                    record = records._tracerhttp2.receive_headers(
+                        initiator.id,
+                        group.id,
+                        id(self),
+                        stream_id,
+                        headers,
+                        is_client=False,
+                    )
+                    if record and (record.is_client is False) and records.server:
+                        records.requests[record.id] = record
+
+            elif isinstance(event, h2.events.ResponseReceived):
+                stream_id = event.stream_id
+                headers = event.headers
+                if all(x is not None for x in (self, stream_id, headers)):
+                    logger().debug(
+                        f"H2 receive_data headers ResponseReceived {random.random()} - self={id(self)} steam_id={stream_id} headers={headers}"
+                    )
+                    records._tracerhttp2.receive_headers(
+                        initiator.id, group.id, id(self), stream_id, headers
+                    )
+
+            elif isinstance(event, h2.events.DataReceived):
+                stream_id = event.stream_id
+                data = event.data
+                if all(x is not None for x in (self, stream_id, data)):
+                    logger().debug(
+                        f"H2 receive_data data - self={id(self)} steam_id={stream_id} data={data[:20]!r}"
+                    )
+                    records._tracerhttp2.receive_data(id(self), stream_id, data)
+
+        return ret
+
+    return hook
+
+
+@contextmanager
+def hook_h2(records: HTTPRecords) -> Generator[None, None, None]:
+    hooks = False
+    try:
+        import h2.connection
+
+        h2.connection.H2Connection.send_headers = decorate(records, h2.connection.H2Connection.send_headers, set_hook_for_h2_send_headers)  # type: ignore[arg-type]
+        h2.connection.H2Connection.send_data = decorate(records, h2.connection.H2Connection.send_data, set_hook_for_h2_send_data)  # type: ignore[arg-type]
+        h2.connection.H2Connection.receive_data = decorate(records, h2.connection.H2Connection.receive_data, set_hook_for_h2_receive_data)  # type: ignore[arg-type]
+
+        hooks = True
+    except ImportError:
+        pass
+
+    yield
+
+    if hooks:
+        h2.connection.H2Connection.send_headers = undecorate(h2.connection.H2Connection.send_headers)  # type: ignore[arg-type]
+        h2.connection.H2Connection.send_data = undecorate(h2.connection.H2Connection.send_data)  # type: ignore[arg-type]
+        h2.connection.H2Connection.receive_data = undecorate(h2.connection.H2Connection.receive_data)  # type: ignore[arg-type]

{httpdbg-1.2.6 → httpdbg-2.0.0}/httpdbg/hooks/httpx.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 from collections.abc import Callable
 from contextlib import contextmanager
 import traceback
@@ -90,6 +89,19 @@ def hook_httpx(records: HTTPRecords) -> Generator[None, None, None]:
             records, httpx.AsyncClient.request, set_hook_for_httpx_async
         )
 
+        httpx.Client.get = decorate(records, httpx.Client.get, set_hook_for_httpx)
+        httpx.Client.post = decorate(records, httpx.Client.post, set_hook_for_httpx)
+        httpx.Client.patch = decorate(records, httpx.Client.patch, set_hook_for_httpx)
+        httpx.Client.put = decorate(records, httpx.Client.put, set_hook_for_httpx)
+        httpx.Client.delete = decorate(records, httpx.Client.delete, set_hook_for_httpx)
+        httpx.Client.head = decorate(records, httpx.Client.head, set_hook_for_httpx)
+        httpx.Client.options = decorate(
+            records, httpx.Client.options, set_hook_for_httpx
+        )
+        httpx.Client.request = decorate(
+            records, httpx.Client.request, set_hook_for_httpx
+        )
+
         httpx.get = decorate(records, httpx.get, set_hook_for_httpx)
         httpx.post = decorate(records, httpx.post, set_hook_for_httpx)
         httpx.patch = decorate(records, httpx.patch, set_hook_for_httpx)
@@ -115,6 +127,15 @@ def hook_httpx(records: HTTPRecords) -> Generator[None, None, None]:
         httpx.AsyncClient.options = undecorate(httpx.AsyncClient.options)
         httpx.AsyncClient.request = undecorate(httpx.AsyncClient.request)
 
+        httpx.Client.get = undecorate(httpx.Client.get)
+        httpx.Client.post = undecorate(httpx.Client.post)
+        httpx.Client.patch = undecorate(httpx.Client.patch)
+        httpx.Client.put = undecorate(httpx.Client.put)
+        httpx.Client.delete = undecorate(httpx.Client.delete)
+        httpx.Client.head = undecorate(httpx.Client.head)
+        httpx.Client.options = undecorate(httpx.Client.options)
+        httpx.Client.request = undecorate(httpx.Client.request)
+
         httpx.get = undecorate(httpx.get)
         httpx.post = undecorate(httpx.post)
         httpx.patch = undecorate(httpx.patch)