apitally 0.6.3__tar.gz → 0.7.1__tar.gz

{apitally-0.6.3 → apitally-0.7.1}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: apitally
-Version: 0.6.3
-Summary: API monitoring for REST APIs built with FastAPI, Flask, Django, and Starlette.
+Version: 0.7.1
+Summary: API monitoring for REST APIs built with FastAPI, Flask, Django, Starlette and Litestar.
 Home-page: https://apitally.io
 License: MIT
 Author: Apitally
@@ -21,7 +21,6 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware
 Classifier: Typing :: Typed
-Provides-Extra: django
 Provides-Extra: django-ninja
 Provides-Extra: django-rest-framework
 Provides-Extra: fastapi
@@ -29,15 +28,17 @@ Provides-Extra: flask
 Provides-Extra: litestar
 Provides-Extra: starlette
 Requires-Dist: backoff (>=2.0.0)
-Requires-Dist: django (>=2.2) ; extra == "django" or extra == "django-ninja" or extra == "django-rest-framework"
+Requires-Dist: django (>=2.2) ; extra == "django-ninja" or extra == "django-rest-framework"
 Requires-Dist: django-ninja (>=0.18.0) ; extra == "django-ninja"
 Requires-Dist: djangorestframework (>=3.10.0) ; extra == "django-rest-framework"
 Requires-Dist: fastapi (>=0.87.0) ; extra == "fastapi"
 Requires-Dist: flask (>=2.0.0) ; extra == "flask"
 Requires-Dist: httpx (>=0.22.0) ; extra == "fastapi" or extra == "litestar" or extra == "starlette"
+Requires-Dist: inflection (>=0.5.1) ; extra == "django-rest-framework"
 Requires-Dist: litestar (>=2.0.0) ; extra == "litestar"
-Requires-Dist: requests (>=2.26.0) ; extra == "django" or extra == "django-ninja" or extra == "django-rest-framework" or extra == "flask"
+Requires-Dist: requests (>=2.26.0) ; extra == "django-ninja" or extra == "django-rest-framework" or extra == "flask"
 Requires-Dist: starlette (>=0.21.0,<1.0.0) ; extra == "fastapi" or extra == "starlette"
+Requires-Dist: uritemplate (>=3.0.0) ; extra == "django-rest-framework"
 Project-URL: Documentation, https://docs.apitally.io
 Project-URL: Repository, https://github.com/apitally/python-client
 Description-Content-Type: text/markdown
@@ -52,7 +53,7 @@ Description-Content-Type: text/markdown
 
 <p align="center"><b>API monitoring made easy.</b></p>
 
-<p align="center"><i>Apitally is a simple and affordable API monitoring solution with a focus on data privacy. It is easy to set up and use for new and existing API projects using Python or Node.js.</i></p>
+<p align="center"><i>Apitally is a simple and affordable API monitoring tool with a focus on data privacy.<br>It is super easy to use for API projects in Python or Node.js and never collects sensitive data.</i></p>
 
 <p align="center">🔗 <b><a href="https://apitally.io" target="_blank">apitally.io</a></b></p>
 
@@ -95,8 +96,8 @@ example:
 pip install apitally[fastapi]
 ```
 
-The available extras are: `fastapi`, `starlette`, `flask`, `django` and
-`litestar`.
+The available extras are: `fastapi`, `flask`, `django_rest_framework`,
+`django_ninja`, `starlette` and `litestar`.
 
 ## Usage
 

{apitally-0.6.3 → apitally-0.7.1}/README.md

@@ -8,7 +8,7 @@
 
 <p align="center"><b>API monitoring made easy.</b></p>
 
-<p align="center"><i>Apitally is a simple and affordable API monitoring solution with a focus on data privacy. It is easy to set up and use for new and existing API projects using Python or Node.js.</i></p>
+<p align="center"><i>Apitally is a simple and affordable API monitoring tool with a focus on data privacy.<br>It is super easy to use for API projects in Python or Node.js and never collects sensitive data.</i></p>
 
 <p align="center">🔗 <b><a href="https://apitally.io" target="_blank">apitally.io</a></b></p>
 
@@ -51,8 +51,8 @@ example:
 pip install apitally[fastapi]
 ```
 
-The available extras are: `fastapi`, `starlette`, `flask`, `django` and
-`litestar`.
+The available extras are: `fastapi`, `flask`, `django_rest_framework`,
+`django_ninja`, `starlette` and `litestar`.
 
 ## Usage
 

apitally-0.7.1/apitally/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.7.1"

apitally-0.7.1/apitally/common.py

@@ -0,0 +1,31 @@
+import sys
+from importlib.metadata import PackageNotFoundError, version
+from typing import Dict, Optional
+
+
+def get_versions(*packages, app_version: Optional[str] = None) -> Dict[str, str]:
+    versions = _get_common_package_versions()
+    for package in packages:
+        versions[package] = _get_package_version(package)
+    if app_version:
+        versions["app"] = app_version
+    return {n: v for n, v in versions.items() if v is not None}
+
+
+def _get_common_package_versions() -> Dict[str, Optional[str]]:
+    return {
+        "python": f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}",
+        "apitally": _get_package_version("apitally"),
+        "uvicorn": _get_package_version("uvicorn"),
+        "hypercorn": _get_package_version("hypercorn"),
+        "daphne": _get_package_version("daphne"),
+        "gunicorn": _get_package_version("gunicorn"),
+        "uwsgi": _get_package_version("uwsgi"),
+    }
+
+
+def _get_package_version(name: str) -> Optional[str]:
+    try:
+        return version(name)
+    except PackageNotFoundError:
+        return None

apitally-0.7.1/apitally/django.py

@@ -0,0 +1,309 @@
+from __future__ import annotations
+
+import contextlib
+import json
+import re
+import time
+from dataclasses import dataclass
+from importlib import import_module
+from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Set, Union
+
+from django.conf import settings
+from django.urls import URLPattern, URLResolver, get_resolver
+from django.utils.module_loading import import_string
+
+from apitally.client.logging import get_logger
+from apitally.client.threading import ApitallyClient
+from apitally.common import get_versions
+
+
+if TYPE_CHECKING:
+    from django.http import HttpRequest, HttpResponse
+    from ninja import NinjaAPI
+
+
+__all__ = ["ApitallyMiddleware"]
+logger = get_logger(__name__)
+
+
+@dataclass
+class ApitallyMiddlewareConfig:
+    client_id: str
+    env: str
+    app_version: Optional[str]
+    identify_consumer_callback: Optional[Callable[[HttpRequest], Optional[str]]]
+    urlconfs: List[Optional[str]]
+
+
+class ApitallyMiddleware:
+    config: Optional[ApitallyMiddlewareConfig] = None
+
+    def __init__(self, get_response: Callable[[HttpRequest], HttpResponse]) -> None:
+        self.get_response = get_response
+        self.drf_available = _check_import("rest_framework")
+        self.drf_endpoint_enumerator = None
+        self.ninja_available = _check_import("ninja")
+        self.callbacks = set()
+
+        if self.config is None:
+            config = getattr(settings, "APITALLY_MIDDLEWARE", {})
+            self.configure(**config)
+            assert self.config is not None
+
+        if self.drf_available:
+            from rest_framework.schemas.generators import EndpointEnumerator
+
+            self.drf_endpoint_enumerator = EndpointEnumerator()
+            if None not in self.config.urlconfs:
+                self.callbacks.update(_get_drf_callbacks(self.config.urlconfs))
+        if self.ninja_available and None not in self.config.urlconfs:
+            self.callbacks.update(_get_ninja_callbacks(self.config.urlconfs))
+
+        self.client = ApitallyClient(client_id=self.config.client_id, env=self.config.env)
+        self.client.start_sync_loop()
+        self.client.set_app_info(
+            app_info=_get_app_info(
+                app_version=self.config.app_version,
+                urlconfs=self.config.urlconfs,
+            )
+        )
+
+    @classmethod
+    def configure(
+        cls,
+        client_id: str,
+        env: str = "dev",
+        app_version: Optional[str] = None,
+        identify_consumer_callback: Optional[str] = None,
+        urlconf: Optional[Union[List[Optional[str]], str]] = None,
+    ) -> None:
+        cls.config = ApitallyMiddlewareConfig(
+            client_id=client_id,
+            env=env,
+            app_version=app_version,
+            identify_consumer_callback=import_string(identify_consumer_callback)
+            if identify_consumer_callback
+            else None,
+            urlconfs=[urlconf] if urlconf is None or isinstance(urlconf, str) else urlconf,
+        )
+
+    def __call__(self, request: HttpRequest) -> HttpResponse:
+        start_time = time.perf_counter()
+        response = self.get_response(request)
+        response_time = time.perf_counter() - start_time
+        path = self.get_path(request)
+        if request.method is not None and path is not None:
+            consumer = self.get_consumer(request)
+            try:
+                self.client.request_counter.add_request(
+                    consumer=consumer,
+                    method=request.method,
+                    path=path,
+                    status_code=response.status_code,
+                    response_time=response_time,
+                    request_size=request.headers.get("Content-Length"),
+                    response_size=response["Content-Length"]
+                    if response.has_header("Content-Length")
+                    else (len(response.content) if not response.streaming else None),
+                )
+            except Exception:  # pragma: no cover
+                logger.exception("Failed to log request metadata")
+            if (
+                response.status_code == 422
+                and (content_type := response.get("Content-Type")) is not None
+                and content_type.startswith("application/json")
+            ):
+                try:
+                    with contextlib.suppress(json.JSONDecodeError):
+                        body = json.loads(response.content)
+                        if isinstance(body, dict) and "detail" in body and isinstance(body["detail"], list):
+                            # Log Django Ninja / Pydantic validation errors
+                            self.client.validation_error_counter.add_validation_errors(
+                                consumer=consumer,
+                                method=request.method,
+                                path=path,
+                                detail=body["detail"],
+                            )
+                except Exception:  # pragma: no cover
+                    logger.exception("Failed to log validation errors")
+        return response
+
+    def get_path(self, request: HttpRequest) -> Optional[str]:
+        if (match := request.resolver_match) is not None:
+            try:
+                if self.callbacks and match.func not in self.callbacks:
+                    return None
+                if self.drf_endpoint_enumerator is not None:
+                    from rest_framework.schemas.generators import is_api_view
+
+                    if is_api_view(match.func):
+                        return self.drf_endpoint_enumerator.get_path_from_regex(match.route)
+                if self.ninja_available:
+                    from ninja.operation import PathView
+
+                    if hasattr(match.func, "__self__") and isinstance(match.func.__self__, PathView):
+                        path = "/" + match.route.lstrip("/")
+                        return re.sub(r"<(?:[^:]+:)?([^>:]+)>", r"{\1}", path)
+            except Exception:  # pragma: no cover
+                logger.exception("Failed to get path for request")
+        return None
+
+    def get_consumer(self, request: HttpRequest) -> Optional[str]:
+        try:
+            if hasattr(request, "consumer_identifier"):
+                return str(request.consumer_identifier)
+            if self.config is not None and self.config.identify_consumer_callback is not None:
+                consumer_identifier = self.config.identify_consumer_callback(request)
+                if consumer_identifier is not None:
+                    return str(consumer_identifier)
+        except Exception:  # pragma: no cover
+            logger.exception("Failed to get consumer identifier for request")
+        return None
+
+
+def _get_app_info(app_version: Optional[str], urlconfs: List[Optional[str]]) -> Dict[str, Any]:
+    app_info: Dict[str, Any] = {}
+    try:
+        app_info["paths"] = _get_paths(urlconfs)
+    except Exception:  # pragma: no cover
+        app_info["paths"] = []
+        logger.exception("Failed to get paths")
+    try:
+        app_info["openapi"] = _get_openapi(urlconfs)
+    except Exception:  # pragma: no cover
+        logger.exception("Failed to get OpenAPI schema")
+    app_info["versions"] = get_versions("django", "djangorestframework", "django-ninja", app_version=app_version)
+    app_info["client"] = "python:django"
+    return app_info
+
+
+def _get_openapi(urlconfs: List[Optional[str]]) -> Optional[str]:
+    drf_schema = None
+    ninja_schema = None
+    with contextlib.suppress(ImportError):
+        drf_schema = _get_drf_schema(urlconfs)
+    with contextlib.suppress(ImportError):
+        ninja_schema = _get_ninja_schema(urlconfs)
+    if drf_schema is not None and ninja_schema is None:
+        return json.dumps(drf_schema)
+    elif ninja_schema is not None and drf_schema is None:
+        return json.dumps(ninja_schema)
+    return None  # pragma: no cover
+
+
+def _get_paths(urlconfs: List[Optional[str]]) -> List[Dict[str, str]]:
+    paths = []
+    with contextlib.suppress(ImportError):
+        paths.extend(_get_drf_paths(urlconfs))
+    with contextlib.suppress(ImportError):
+        paths.extend(_get_ninja_paths(urlconfs))
+    return paths
+
+
+def _get_drf_paths(urlconfs: List[Optional[str]]) -> List[Dict[str, str]]:
+    from rest_framework.schemas.generators import EndpointEnumerator
+
+    enumerators = [EndpointEnumerator(urlconf=urlconf) for urlconf in urlconfs]
+    return [
+        {
+            "method": method.upper(),
+            "path": path,
+        }
+        for enumerator in enumerators
+        for path, method, _ in enumerator.get_api_endpoints()
+        if method not in ["HEAD", "OPTIONS"]
+    ]
+
+
+def _get_drf_callbacks(urlconfs: List[Optional[str]]) -> Set[Callable]:
+    from rest_framework.schemas.generators import EndpointEnumerator
+
+    enumerators = [EndpointEnumerator(urlconf=urlconf) for urlconf in urlconfs]
+    return {callback for enumerator in enumerators for _, _, callback in enumerator.get_api_endpoints()}
+
+
+def _get_drf_schema(urlconfs: List[Optional[str]]) -> Optional[Dict[str, Any]]:
+    from rest_framework.schemas.openapi import SchemaGenerator
+
+    schemas = []
+    with contextlib.suppress(AssertionError):  # uritemplate and inflection must be installed for OpenAPI schema support
+        for urlconf in urlconfs:
+            generator = SchemaGenerator(urlconf=urlconf)
+            schema = generator.get_schema()
+            if schema is not None and len(schema["paths"]) > 0:
+                schemas.append(schema)
+    return None if len(schemas) != 1 else schemas[0]  # type: ignore[return-value]
+
+
+def _get_ninja_paths(urlconfs: List[Optional[str]]) -> List[Dict[str, str]]:
+    endpoints = []
+    for api in _get_ninja_api_instances(urlconfs=urlconfs):
+        schema = api.get_openapi_schema()
+        for path, operations in schema["paths"].items():
+            for method, operation in operations.items():
+                if method not in ["HEAD", "OPTIONS"]:
+                    endpoints.append(
+                        {
+                            "method": method,
+                            "path": path,
+                            "summary": operation.get("summary"),
+                            "description": operation.get("description"),
+                        }
+                    )
+    return endpoints
+
+
+def _get_ninja_callbacks(urlconfs: List[Optional[str]]) -> Set[Callable]:
+    return {
+        path_view.get_view()
+        for api in _get_ninja_api_instances(urlconfs=urlconfs)
+        for _, router in api._routers
+        for path_view in router.path_operations.values()
+    }
+
+
+def _get_ninja_schema(urlconfs: List[Optional[str]]) -> Optional[Dict[str, Any]]:
+    schemas = []
+    for api in _get_ninja_api_instances(urlconfs=urlconfs):
+        schema = api.get_openapi_schema()
+        if len(schema["paths"]) > 0:
+            schemas.append(schema)
+    return None if len(schemas) != 1 else schemas[0]
+
+
+def _get_ninja_api_instances(
+    urlconfs: Optional[List[Optional[str]]] = None,
+    patterns: Optional[List[Any]] = None,
+) -> Set[NinjaAPI]:
+    from ninja import NinjaAPI
+
+    if urlconfs is None:
+        urlconfs = [None]
+    if patterns is None:
+        patterns = []
+        for urlconf in urlconfs:
+            patterns.extend(get_resolver(urlconf).url_patterns)
+
+    apis: Set[NinjaAPI] = set()
+    for p in patterns:
+        if isinstance(p, URLResolver):
+            if p.app_name != "ninja":
+                apis.update(_get_ninja_api_instances(patterns=p.url_patterns))
+            else:
+                for pattern in p.url_patterns:
+                    if isinstance(pattern, URLPattern) and pattern.lookup_str.startswith("ninja."):
+                        callback_keywords = getattr(pattern.callback, "keywords", {})
+                        if isinstance(callback_keywords, dict):
+                            api = callback_keywords.get("api")
+                            if isinstance(api, NinjaAPI):
+                                apis.add(api)
+                                break
+    return apis
+
+
+def _check_import(name: str) -> bool:
+    try:
+        import_module(name)
+        return True
+    except ImportError:
+        return False

{apitally-0.6.3 → apitally-0.7.1}/apitally/flask.py

@@ -1,8 +1,6 @@
 from __future__ import annotations
 
-import sys
 import time
-from importlib.metadata import version
 from threading import Timer
 from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Tuple
 
@@ -12,6 +10,7 @@ from werkzeug.exceptions import NotFound
 from werkzeug.test import Client
 
 from apitally.client.threading import ApitallyClient
+from apitally.common import get_versions
 
 
 if TYPE_CHECKING:
@@ -103,7 +102,7 @@ def _get_app_info(app: Flask, app_version: Optional[str] = None, openapi_url: Op
         app_info["openapi"] = openapi
     if paths := _get_paths(app.url_map):
         app_info["paths"] = paths
-    app_info["versions"] = _get_versions(app_version)
+    app_info["versions"] = get_versions("flask", app_version=app_version)
     app_info["client"] = "python:flask"
     return app_info
 
@@ -124,14 +123,3 @@ def _get_openapi(app: WSGIApplication, openapi_url: str) -> Optional[str]:
     if response.status_code != 200:
         return None
     return response.get_data(as_text=True)
-
-
-def _get_versions(app_version: Optional[str]) -> Dict[str, str]:
-    versions = {
-        "python": f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}",
-        "apitally": version("apitally"),
-        "flask": version("flask"),
-    }
-    if app_version:
-        versions["app"] = app_version
-    return versions

{apitally-0.6.3 → apitally-0.7.1}/apitally/litestar.py

@@ -1,8 +1,6 @@
 import contextlib
 import json
-import sys
 import time
-from importlib.metadata import version
 from typing import Callable, Dict, List, Optional
 
 from litestar.app import DEFAULT_OPENAPI_CONFIG, Litestar
@@ -15,6 +13,7 @@ from litestar.plugins import InitPluginProtocol
 from litestar.types import ASGIApp, Message, Receive, Scope, Send
 
 from apitally.client.asyncio import ApitallyClient
+from apitally.common import get_versions
 
 
 __all__ = ["ApitallyPlugin"]
@@ -48,7 +47,7 @@ class ApitallyPlugin(InitPluginProtocol):
         app_info = {
             "openapi": _get_openapi(app),
             "paths": [route for route in _get_routes(app) if not self.filter_path(route["path"])],
-            "versions": _get_versions(self.app_version),
+            "versions": get_versions("litestar", app_version=self.app_version),
             "client": "python:litestar",
         }
         self.client.set_app_info(app_info)
@@ -174,14 +173,3 @@ def _get_routes(app: Litestar) -> List[Dict[str, str]]:
         for method in route.methods
         if route.scope_type == ScopeType.HTTP and method != "OPTIONS"
     ]
-
-
-def _get_versions(app_version: Optional[str]) -> Dict[str, str]:
-    versions = {
-        "python": f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}",
-        "apitally": version("apitally"),
-        "litestar": version("litestar"),
-    }
-    if app_version:
-        versions["app"] = app_version
-    return versions

{apitally-0.6.3 → apitally-0.7.1}/apitally/starlette.py

@@ -2,9 +2,7 @@ from __future__ import annotations
 
 import asyncio
 import json
-import sys
 import time
-from importlib.metadata import PackageNotFoundError, version
 from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional, Tuple, Union
 
 from httpx import HTTPStatusError
@@ -17,6 +15,7 @@ from starlette.testclient import TestClient
 from starlette.types import ASGIApp
 
 from apitally.client.asyncio import ApitallyClient
+from apitally.common import get_versions
 
 
 if TYPE_CHECKING:
@@ -145,7 +144,7 @@ def _get_app_info(app: ASGIApp, app_version: Optional[str] = None, openapi_url:
         app_info["openapi"] = openapi
     if endpoints := _get_endpoint_info(app):
         app_info["paths"] = [{"path": endpoint.path, "method": endpoint.http_method} for endpoint in endpoints]
-    app_info["versions"] = _get_versions(app_version)
+    app_info["versions"] = get_versions("fastapi", "starlette", app_version=app_version)
     app_info["client"] = "python:starlette"
     return app_info
 
@@ -179,18 +178,3 @@ def _register_shutdown_handler(app: Union[ASGIApp, Router], shutdown_handler: Ca
         app.add_event_handler("shutdown", shutdown_handler)
     elif hasattr(app, "app"):
         _register_shutdown_handler(app.app, shutdown_handler)
-
-
-def _get_versions(app_version: Optional[str]) -> Dict[str, str]:
-    versions = {
-        "python": f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}",
-        "apitally": version("apitally"),
-        "starlette": version("starlette"),
-    }
-    try:
-        versions["fastapi"] = version("fastapi")
-    except PackageNotFoundError:  # pragma: no cover
-        pass
-    if app_version:
-        versions["app"] = app_version
-    return versions

{apitally-0.6.3 → apitally-0.7.1}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "poetry_dynamic_versioning.backend"
 
 [tool.poetry]
 name = "apitally"
-version = "0.6.3"
-description = "API monitoring for REST APIs built with FastAPI, Flask, Django, and Starlette."
+version = "0.7.1"
+description = "API monitoring for REST APIs built with FastAPI, Flask, Django, Starlette and Litestar."
 readme = "README.md"
 authors = ["Apitally <hello@apitally.io>"]
 license = "MIT License"
@@ -34,9 +34,11 @@ djangorestframework = { version = ">=3.10.0", optional = true }
 fastapi = { version = ">=0.87.0", optional = true }
 flask = { version = ">=2.0.0", optional = true }
 httpx = { version = ">=0.22.0", optional = true }
+inflection = { version = ">=0.5.1", optional = true }
 litestar = { version = ">=2.0.0", optional = true }
 requests = { version = ">=2.26.0", optional = true }
 starlette = { version = ">=0.21.0,<1.0.0", optional = true }
+uritemplate = { version = ">=3.0.0", optional = true }
 
 [tool.poetry.group.dev.dependencies]
 ipykernel = "^6.26.0"
@@ -65,9 +67,14 @@ types-six = "*"
 types-ujson = "*"
 
 [tool.poetry.extras]
-django = ["django", "requests"]
 django_ninja = ["django", "django-ninja", "requests"]
-django_rest_framework = ["django", "djangorestframework", "requests"]
+django_rest_framework = [
+    "django",
+    "djangorestframework",
+    "uritemplate", # required for schema generation
+    "inflection", # required for schema generation
+    "requests",
+]
 fastapi = ["fastapi", "starlette", "httpx"]
 flask = ["flask", "requests"]
 litestar = ["litestar", "httpx"]

apitally-0.6.3/apitally/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.6.3"

apitally-0.6.3/apitally/django.py

@@ -1,272 +0,0 @@
-from __future__ import annotations
-
-import json
-import sys
-import time
-from dataclasses import dataclass
-from importlib.metadata import PackageNotFoundError, version
-from typing import TYPE_CHECKING, Any, Callable, Dict, List, Optional
-
-from django.conf import settings
-from django.core.exceptions import ViewDoesNotExist
-from django.test import RequestFactory
-from django.urls import Resolver404, URLPattern, URLResolver, get_resolver, resolve
-from django.utils.module_loading import import_string
-
-from apitally.client.threading import ApitallyClient
-
-
-if TYPE_CHECKING:
-    from django.http import HttpRequest, HttpResponse
-
-
-__all__ = ["ApitallyMiddleware"]
-
-
-@dataclass
-class ApitallyMiddlewareConfig:
-    client_id: str
-    env: str
-    app_version: Optional[str]
-    openapi_url: Optional[str]
-    identify_consumer_callback: Optional[Callable[[HttpRequest], Optional[str]]]
-
-
-class ApitallyMiddleware:
-    config: Optional[ApitallyMiddlewareConfig] = None
-
-    def __init__(self, get_response: Callable[[HttpRequest], HttpResponse]) -> None:
-        self.get_response = get_response
-        if self.config is None:
-            config = getattr(settings, "APITALLY_MIDDLEWARE", {})
-            self.configure(**config)
-            assert self.config is not None
-        views = _extract_views_from_url_patterns(get_resolver().url_patterns)
-        self.view_lookup = {
-            view.pattern: view for view in reversed(_extract_views_from_url_patterns(get_resolver().url_patterns))
-        }
-        self.client = ApitallyClient(client_id=self.config.client_id, env=self.config.env)
-        self.client.start_sync_loop()
-        self.client.set_app_info(
-            app_info=_get_app_info(
-                views=views,
-                app_version=self.config.app_version,
-                openapi_url=self.config.openapi_url,
-            )
-        )
-
-    @classmethod
-    def configure(
-        cls,
-        client_id: str,
-        env: str = "dev",
-        app_version: Optional[str] = None,
-        openapi_url: Optional[str] = None,
-        identify_consumer_callback: Optional[str] = None,
-    ) -> None:
-        cls.config = ApitallyMiddlewareConfig(
-            client_id=client_id,
-            env=env,
-            app_version=app_version,
-            openapi_url=openapi_url,
-            identify_consumer_callback=import_string(identify_consumer_callback)
-            if identify_consumer_callback
-            else None,
-        )
-
-    def __call__(self, request: HttpRequest) -> HttpResponse:
-        view = self.get_view(request)
-        start_time = time.perf_counter()
-        response = self.get_response(request)
-        if request.method is not None and view is not None and view.is_api_view:
-            consumer = self.get_consumer(request)
-            self.client.request_counter.add_request(
-                consumer=consumer,
-                method=request.method,
-                path=view.pattern,
-                status_code=response.status_code,
-                response_time=time.perf_counter() - start_time,
-                request_size=request.headers.get("Content-Length"),
-                response_size=response["Content-Length"]
-                if response.has_header("Content-Length")
-                else (len(response.content) if not response.streaming else None),
-            )
-            if (
-                response.status_code == 422
-                and (content_type := response.get("Content-Type")) is not None
-                and content_type.startswith("application/json")
-            ):
-                try:
-                    body = json.loads(response.content)
-                    if isinstance(body, dict) and "detail" in body and isinstance(body["detail"], list):
-                        # Log Django Ninja / Pydantic validation errors
-                        self.client.validation_error_counter.add_validation_errors(
-                            consumer=consumer,
-                            method=request.method,
-                            path=view.pattern,
-                            detail=body["detail"],
-                        )
-                except json.JSONDecodeError:  # pragma: no cover
-                    pass
-        return response
-
-    def get_view(self, request: HttpRequest) -> Optional[DjangoViewInfo]:
-        try:
-            resolver_match = resolve(request.path_info)
-            return self.view_lookup.get(resolver_match.route)
-        except Resolver404:  # pragma: no cover
-            return None
-
-    def get_consumer(self, request: HttpRequest) -> Optional[str]:
-        if hasattr(request, "consumer_identifier"):
-            return str(request.consumer_identifier)
-        if self.config is not None and self.config.identify_consumer_callback is not None:
-            consumer_identifier = self.config.identify_consumer_callback(request)
-            if consumer_identifier is not None:
-                return str(consumer_identifier)
-        return None
-
-
-@dataclass
-class DjangoViewInfo:
-    func: Callable
-    pattern: str
-    name: Optional[str] = None
-
-    @property
-    def is_api_view(self) -> bool:
-        return self.is_rest_framework_api_view or self.is_ninja_path_view
-
-    @property
-    def is_rest_framework_api_view(self) -> bool:
-        try:
-            from rest_framework.views import APIView
-
-            return hasattr(self.func, "view_class") and issubclass(self.func.view_class, APIView)
-        except ImportError:  # pragma: no cover
-            return False
-
-    @property
-    def is_ninja_path_view(self) -> bool:
-        try:
-            from ninja.operation import PathView
-
-            return hasattr(self.func, "__self__") and isinstance(self.func.__self__, PathView)
-        except ImportError:  # pragma: no cover
-            return False
-
-    @property
-    def allowed_methods(self) -> List[str]:
-        if hasattr(self.func, "view_class"):
-            return [method.upper() for method in self.func.view_class().allowed_methods]
-        if self.is_ninja_path_view:
-            assert hasattr(self.func, "__self__")
-            return [method.upper() for operation in self.func.__self__.operations for method in operation.methods]
-        return []  # pragma: no cover
-
-
-def _get_app_info(
-    views: List[DjangoViewInfo], app_version: Optional[str] = None, openapi_url: Optional[str] = None
-) -> Dict[str, Any]:
-    app_info: Dict[str, Any] = {}
-    if openapi := _get_openapi(views, openapi_url):
-        app_info["openapi"] = openapi
-    app_info["paths"] = _get_paths(views)
-    app_info["versions"] = _get_versions(app_version)
-    app_info["client"] = "python:django"
-    return app_info
-
-
-def _get_paths(views: List[DjangoViewInfo]) -> List[Dict[str, str]]:
-    return [
-        {"method": method, "path": view.pattern}
-        for view in views
-        if view.is_api_view
-        for method in view.allowed_methods
-        if method not in ["HEAD", "OPTIONS"]
-    ]
-
-
-def _get_openapi(views: List[DjangoViewInfo], openapi_url: Optional[str] = None) -> Optional[str]:
-    openapi_views = [
-        view
-        for view in views
-        if (openapi_url is not None and view.pattern == openapi_url.removeprefix("/"))
-        or (openapi_url is None and view.pattern.endswith("openapi.json") and "<" not in view.pattern)
-    ]
-    if len(openapi_views) == 1:
-        rf = RequestFactory()
-        request = rf.get(openapi_views[0].pattern)
-        response = openapi_views[0].func(request)
-        if response.status_code == 200:
-            return response.content.decode()
-    return None
-
-
-def _extract_views_from_url_patterns(
-    url_patterns: List[Any], base: str = "", namespace: Optional[str] = None
-) -> List[DjangoViewInfo]:
-    # Copied and adapted from django-extensions.
-    # See https://github.com/django-extensions/django-extensions/blob/dd794f1b239d657f62d40f2c3178200978328ed7/django_extensions/management/commands/show_urls.py#L190C34-L190C34
-    views = []
-    for p in url_patterns:
-        if isinstance(p, URLPattern):
-            try:
-                if not p.name:
-                    name = p.name
-                elif namespace:
-                    name = f"{namespace}:{p.name}"
-                else:
-                    name = p.name
-                views.append(DjangoViewInfo(func=p.callback, pattern=base + str(p.pattern), name=name))
-            except ViewDoesNotExist:
-                continue
-        elif isinstance(p, URLResolver):
-            try:
-                patterns = p.url_patterns
-            except ImportError:
-                continue
-            views.extend(
-                _extract_views_from_url_patterns(
-                    patterns,
-                    base + str(p.pattern),
-                    namespace=f"{namespace}:{p.namespace}" if namespace and p.namespace else p.namespace or namespace,
-                )
-            )
-        elif hasattr(p, "_get_callback"):
-            try:
-                views.append(DjangoViewInfo(func=p._get_callback(), pattern=base + str(p.pattern), name=p.name))
-            except ViewDoesNotExist:
-                continue
-        elif hasattr(p, "url_patterns"):
-            try:
-                patterns = p.url_patterns
-            except ImportError:
-                continue
-            views.extend(
-                _extract_views_from_url_patterns(
-                    patterns,
-                    base + str(p.pattern),
-                    namespace=namespace,
-                )
-            )
-    return views
-
-
-def _get_versions(app_version: Optional[str]) -> Dict[str, str]:
-    versions = {
-        "python": f"{sys.version_info.major}.{sys.version_info.minor}.{sys.version_info.micro}",
-        "apitally": version("apitally"),
-        "django": version("django"),
-    }
-    try:
-        versions["djangorestframework"] = version("djangorestframework")
-    except PackageNotFoundError:  # pragma: no cover
-        pass
-    try:
-        versions["django-ninja"] = version("django-ninja")
-    except PackageNotFoundError:  # pragma: no cover
-        pass
-    if app_version:
-        versions["app"] = app_version
-    return versions