django-jsonrpc-framework 0.2.0__tar.gz → 0.2.1__tar.gz

{django_jsonrpc_framework-0.2.0 → django_jsonrpc_framework-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: django-jsonrpc-framework
-Version: 0.2.0
+Version: 0.2.1
 Summary: Django jsonrpc implementation
 Classifier: Framework :: Django
 Classifier: Programming Language :: Python :: 3
@@ -9,11 +9,15 @@ Requires-Dist: django>=6.0.5
 Requires-Dist: pydantic>=2.13.4
 Provides-Extra: jwt
 Requires-Dist: pyjwt>=2.13.0; extra == 'jwt'
+Provides-Extra: prometheus
+Requires-Dist: prometheus-client>=0.21; extra == 'prometheus'
+Provides-Extra: sentry
+Requires-Dist: sentry-sdk>=2.0; extra == 'sentry'
 Description-Content-Type: text/markdown
 
 # Django jsonrpc implementation
 
-## install
+## Install
 
 ```
 pip install django-jsonrpc-framework
@@ -21,18 +25,18 @@ pip install django-jsonrpc-framework
 
 ## Advantages
 
-- Complete support jsonrpc 2.0 (Request, Notificatin, Batch)
-- Auto generation openrpc.json 1.3.2 version
-- Auto generation OpenRPC documentation (like swagger)
+- Complete support for JSON-RPC 2.0 (Request, Notification, Batch)
+- Auto-generation of `openrpc.json` (OpenRPC 1.3.2)
+- Auto-generation of OpenRPC documentation (like Swagger)
 - Async support
 
 ## Create methods
 
-We provide several methods creating methods. 
+We provide several ways to create methods.
 
 - Using `method_` prefix
 - Using `jsonrpc_method` decorator
-- Rename existing func to new name
+- Rename an existing function to a new name
 
 ``` python
 from jsonrpc_framework import BaseController
@@ -49,7 +53,7 @@ class EchoController(BaseController):
 
     @jsonrpc_method("echo_see_you")
     def wrong_name(self, name) -> str:
-        return "See you fron echo_see_you method"
+        return "See you from echo_see_you method"
 ```
 
 ## Adding several controllers to one controller
@@ -76,7 +80,7 @@ route = RouteController(
 )
 ```
 
-## Generation openrpc.json and OpenRpc documentation
+## Generating openrpc.json and OpenRPC documentation
 
 ``` python
 from jsonrpc_framework.controller.openrpc.collectors import OpenRpcCollector
@@ -94,10 +98,10 @@ urlpatterns = [
 ]
 ```
 
-### Openrpc.json example
+### OpenRPC.json example
 
 ![OpenRPC docs](docs/docs/openrpcjson.png)
 
-## Openrpc doc example
+## OpenRPC doc example
 
 ![OpenRPC docs](docs/docs/docs.png)

{django_jsonrpc_framework-0.2.0 → django_jsonrpc_framework-0.2.1}/README.md

@@ -1,6 +1,6 @@
 # Django jsonrpc implementation
 
-## install
+## Install
 
 ```
 pip install django-jsonrpc-framework
@@ -8,18 +8,18 @@ pip install django-jsonrpc-framework
 
 ## Advantages
 
-- Complete support jsonrpc 2.0 (Request, Notificatin, Batch)
-- Auto generation openrpc.json 1.3.2 version
-- Auto generation OpenRPC documentation (like swagger)
+- Complete support for JSON-RPC 2.0 (Request, Notification, Batch)
+- Auto-generation of `openrpc.json` (OpenRPC 1.3.2)
+- Auto-generation of OpenRPC documentation (like Swagger)
 - Async support
 
 ## Create methods
 
-We provide several methods creating methods. 
+We provide several ways to create methods.
 
 - Using `method_` prefix
 - Using `jsonrpc_method` decorator
-- Rename existing func to new name
+- Rename an existing function to a new name
 
 ``` python
 from jsonrpc_framework import BaseController
@@ -36,7 +36,7 @@ class EchoController(BaseController):
 
     @jsonrpc_method("echo_see_you")
     def wrong_name(self, name) -> str:
-        return "See you fron echo_see_you method"
+        return "See you from echo_see_you method"
 ```
 
 ## Adding several controllers to one controller
@@ -63,7 +63,7 @@ route = RouteController(
 )
 ```
 
-## Generation openrpc.json and OpenRpc documentation
+## Generating openrpc.json and OpenRPC documentation
 
 ``` python
 from jsonrpc_framework.controller.openrpc.collectors import OpenRpcCollector
@@ -81,10 +81,10 @@ urlpatterns = [
 ]
 ```
 
-### Openrpc.json example
+### OpenRPC.json example
 
 ![OpenRPC docs](docs/docs/openrpcjson.png)
 
-## Openrpc doc example
+## OpenRPC doc example
 
 ![OpenRPC docs](docs/docs/docs.png)

{django_jsonrpc_framework-0.2.0 → django_jsonrpc_framework-0.2.1}/jsonrpc_framework/controller/auth/bearer.py

@@ -1,6 +1,5 @@
-from typing import Generic, TypeVar, Any, ClassVar, Protocol
+from typing import Generic, TypeVar, Protocol
 
-from jwt import algorithms
 from pydantic import BaseModel, ValidationError
 
 from jsonrpc_framework.controller.auth import AuthResult, INVALID_AUTH

{django_jsonrpc_framework-0.2.0 → django_jsonrpc_framework-0.2.1}/jsonrpc_framework/controller/openrpc/collectors/_method_collector.py

@@ -19,17 +19,6 @@ from jsonrpc_framework.openrpc.document.common import (
 )
 
 from jsonrpc_framework.core.error import RpcError
-from jsonrpc_framework.openrpc.document.common import (
-    OpenRcpContentDescriptorObject,
-    OpenRcpTypeSchema,
-    OpenRpcDataSchema,
-    OpenRpcErrorObject,
-    OpenRpcRefSchema,
-    OpenRpcTag,
-    validate_type_name,
-)
-from jsonrpc_framework.openrpc.document.components import OpenRpcComponents
-from jsonrpc_framework.openrpc.document.method._method import OpenRpcMethod
 
 
 class ExampleCollector: ...

{django_jsonrpc_framework-0.2.0 → django_jsonrpc_framework-0.2.1}/jsonrpc_framework/core/error.py

@@ -3,6 +3,20 @@ from typing import Any
 from pydantic import BaseModel
 
 
+__all__ = [
+    "RpcError",
+    "ParseError",
+    "InvalidRequestError",
+    "MethodNotFoundError",
+    "InvalidParamsError",
+    "InternalError",
+    "ParseExcError",
+    "InvalidRequestExcError",
+    "UnauthorizedError",
+    "ForbiddenError",
+]
+
+
 class RpcError(BaseModel):
     code: int
     message: str
@@ -46,7 +60,7 @@ class InvalidRequestExcError(Exception): ...
 
 class UnauthorizedError(RpcError):
     code: int = -32001
-    message: str = "Unauthorized"
+    message: str = "Unauthenticated"
 
 
 class ForbiddenError(RpcError):

django_jsonrpc_framework-0.2.1/jsonrpc_framework/integration/prometheus/__init__.py

@@ -0,0 +1,3 @@
+from ._prometheus import enable_prometheus, reset_prometheus, MetricsView
+
+__all__ = ["enable_prometheus", "reset_prometheus", "MetricsView"]

django_jsonrpc_framework-0.2.1/jsonrpc_framework/integration/prometheus/_prometheus.py

@@ -0,0 +1,229 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+import time
+
+from jsonrpc_framework.logic.dispatcher import RpcDispatcher
+from jsonrpc_framework.core.error import RpcError
+from jsonrpc_framework.core.models import ErrorResponse
+from django.views import View
+from django.http import HttpResponse
+
+try:
+    from prometheus_client import (
+        CONTENT_TYPE_LATEST,
+        REGISTRY,
+        CollectorRegistry,
+        Counter,
+        Histogram,
+        generate_latest,
+    )
+except ImportError:
+    raise ImportError(
+        "prometheus-client is not installed, please install it with "
+        "`pip install django-jsonrpc-framework[prometheus]`"
+    ) from None
+
+
+if TYPE_CHECKING:
+    from django.http import HttpRequest
+
+    from jsonrpc_framework.logic.validator import BatchType, RequestType
+    from jsonrpc_framework.core.models import MethodType
+    from jsonrpc_framework.logic.dispatcher import (
+        BatchResponseType,
+        HandlerType,
+        ResponseType,
+    )
+
+__all__ = ["enable_prometheus", "reset_prometheus", "MetricsView"]
+
+
+_enabled: bool = False
+_registry: CollectorRegistry | None = None
+_original_dispatch_single = None
+_original_dispatch = None
+
+
+def enable_prometheus(*, registry: CollectorRegistry | None = None) -> None:
+    global _enabled, _registry, _original_dispatch_single, _original_dispatch
+
+    if _enabled:
+        return
+
+    if registry is None:
+        registry = REGISTRY
+
+    _registry = registry
+
+    requests_total = Counter(
+        "jsonrpc_requests_total",
+        "Total JSON-RPC requests",
+        labelnames=("method", "result"),
+        registry=_registry,
+    )
+    request_duration = Histogram(
+        "jsonrpc_request_duration_seconds",
+        "JSON-RPC request duration in seconds",
+        labelnames=("method",),
+        registry=_registry,
+    )
+    errors_total = Counter(
+        "jsonrpc_errors_total",
+        "Total JSON-RPC errors",
+        labelnames=("method", "code"),
+        registry=_registry,
+    )
+
+    _original_dispatch_single = RpcDispatcher._dispatch_single
+    _original_dispatch = RpcDispatcher.dispatch
+
+    _patch_dispatch_single(
+        RpcDispatcher,
+        requests_total=requests_total,
+        request_duration=request_duration,
+        errors_total=errors_total,
+    )
+    _patch_dispatch(
+        RpcDispatcher,
+        requests_total=requests_total,
+        request_duration=request_duration,
+        errors_total=errors_total,
+    )
+    _enabled = True
+
+
+def reset_prometheus() -> None:
+    global _enabled, _registry
+    global _original_dispatch_single, _original_dispatch
+
+    if _original_dispatch_single is not None:
+        setattr(RpcDispatcher, "_dispatch_single", _original_dispatch_single)
+    if _original_dispatch is not None:
+        setattr(RpcDispatcher, "dispatch", _original_dispatch)
+
+    _original_dispatch_single = None
+    _original_dispatch = None
+    _registry = None
+    _enabled = False
+
+
+def _patch_dispatch_single(
+    dispatcher: type[RpcDispatcher],
+    *,
+    requests_total: Counter,
+    request_duration: Histogram,
+    errors_total: Counter,
+) -> None:
+    old = dispatcher._dispatch_single
+
+    async def patched(
+        self: RpcDispatcher,
+        request: RequestType,
+        registry: dict[MethodType, HandlerType],
+        http_request: HttpRequest,
+    ) -> ResponseType:
+        method = request.method
+        start = time.perf_counter()
+
+        try:
+            result = await old(self, request, registry, http_request)
+        except Exception:
+            duration = time.perf_counter() - start
+            request_duration.labels(method=method).observe(duration)
+            requests_total.labels(method=method, result="error").inc()
+            raise
+
+        duration = time.perf_counter() - start
+
+        _observe_outcome(
+            method=method,
+            duration=duration,
+            result=result,
+            requests_total=requests_total,
+            request_duration=request_duration,
+            errors_total=errors_total,
+        )
+
+        return result
+
+    setattr(dispatcher, "_dispatch_single", patched)
+
+
+def _patch_dispatch(
+    dispatcher: type[RpcDispatcher],
+    *,
+    requests_total: Counter,
+    request_duration: Histogram,
+    errors_total: Counter,
+) -> None:
+    old = dispatcher.dispatch
+
+    async def patched(
+        self: RpcDispatcher,
+        body: RequestType | BatchType | RpcError,
+        registry: dict[MethodType, HandlerType],
+        http_request: HttpRequest,
+    ) -> ResponseType | BatchResponseType:
+        if not isinstance(body, RpcError):
+            return await old(self, body, registry, http_request)
+
+        start = time.perf_counter()
+        result = await old(self, body, registry, http_request)
+        duration = time.perf_counter() - start
+
+        _observe_outcome(
+            method="_invalid",
+            duration=duration,
+            result=result,
+            requests_total=requests_total,
+            request_duration=request_duration,
+            errors_total=errors_total,
+        )
+
+        return result
+
+    setattr(dispatcher, "dispatch", patched)
+
+
+def _observe_outcome(
+    method: str,
+    duration: float,
+    result: ResponseType | BatchResponseType,
+    requests_total: Counter,
+    request_duration: Histogram,
+    errors_total: Counter,
+) -> None:
+    request_duration.labels(method=method).observe(duration)
+
+    if result is None:
+        result_label = "notification"
+    elif isinstance(result, ErrorResponse):
+        result_label = "error"
+        errors_total.labels(
+            method=method,
+            code=str(result.error.code),
+        ).inc()
+    else:
+        result_label = "success"
+
+    requests_total.labels(method=method, result=result_label).inc()
+
+
+class MetricsView(View):
+    http_method_names = ["get"]
+
+    def get(
+        self,
+        request: HttpRequest,
+        *args: tuple[Any],
+        **kwargs: dict[str, Any],
+    ) -> HttpResponse:
+        return HttpResponse(
+            generate_latest(_active_registry()),
+            content_type=CONTENT_TYPE_LATEST,
+        )
+
+
+def _active_registry() -> CollectorRegistry:
+    return REGISTRY if _registry is None else _registry

django_jsonrpc_framework-0.2.1/jsonrpc_framework/integration/sentry.py

@@ -0,0 +1,125 @@
+from __future__ import annotations
+
+import logging
+from typing import Any
+import inspect
+
+import sentry_sdk
+from sentry_sdk.integrations import Integration
+from sentry_sdk.utils import (
+    capture_internal_exceptions,
+    ensure_integration_enabled,
+)
+
+from jsonrpc_framework.logic.dispatcher import RpcDispatcher
+
+logger = logging.getLogger("django.server")
+
+
+class JsonRpcIntegration(Integration):
+    identifier = "jsonrpc"
+    origin = "auto.rpc.jsonrpc"
+
+    def __init__(
+        self,
+        *,
+        capture_internal_errors: bool = True,
+        set_transaction_name: bool = True,
+        mechanism_handled: bool = True,
+    ) -> None:
+        self.capture_internal_errors = capture_internal_errors
+        self.set_transaction_name = set_transaction_name
+        self.mechanism_handled = mechanism_handled
+
+    @staticmethod
+    def setup_once() -> None:
+        _patch_dispatch_single(RpcDispatcher)
+        _patch_call_handler(RpcDispatcher)
+
+
+def _patch_dispatch_single(RpcDispatcher: type) -> None:
+    old = getattr(RpcDispatcher, "_dispatch_single")
+
+    @ensure_integration_enabled(JsonRpcIntegration, old)
+    async def patched(
+        self: Any,
+        request: Any,
+        registry: Any,
+        http_request: Any,
+    ) -> Any:
+        integration = sentry_sdk.get_client().get_integration(
+            JsonRpcIntegration
+        )
+        method = request.method
+        scope = sentry_sdk.get_current_scope()
+
+        if integration and integration.set_transaction_name:
+            scope.set_transaction_name(
+                f"jsonrpc.{method}",
+                source="custom",
+            )
+
+        scope.set_tag("jsonrpc.method", method)
+
+        if request.id is not None:
+            scope.set_tag("jsonrpc.id", str(request.id))
+
+        with sentry_sdk.start_span(
+            op="rpc.server",
+            name=method,
+            origin=JsonRpcIntegration.origin,
+        ):
+            return await old(self, request, registry, http_request)
+
+    setattr(RpcDispatcher, "_dispatch_single", patched)
+
+
+def _patch_call_handler(RpcDispatcher: type) -> None:
+    old = getattr(RpcDispatcher, "_call_handler")
+
+    @ensure_integration_enabled(JsonRpcIntegration, old)
+    async def patched(
+        self: Any,
+        handler: Any,
+        bound: Any,
+    ) -> Any:
+        try:
+            return await old(self, handler, bound)
+        except Exception:
+            raise
+
+    @ensure_integration_enabled(JsonRpcIntegration, old)
+    async def patched_call_handler(
+        self: Any,
+        handler: Any,
+        bound: Any,
+    ) -> Any:
+        try:
+            if bound is None:
+                result = handler()
+            else:
+                result = handler(*bound.args, **bound.kwargs)
+            if inspect.isawaitable(result):
+                result = await result
+            return result
+        except Exception as exc:
+            integration = sentry_sdk.get_client().get_integration(
+                JsonRpcIntegration
+            )
+            if integration and integration.capture_internal_errors:
+                with capture_internal_exceptions():
+                    sentry_sdk.capture_exception(
+                        exc,
+                        hint={
+                            "mechanism": {
+                                "type": "jsonrpc",
+                                "handled": integration.mechanism_handled,
+                            }
+                        },
+                    )
+            logger.exception(exc)
+            from jsonrpc_framework.core.error import InternalError
+
+            return InternalError()
+
+    setattr(RpcDispatcher, "_call_handler", patched_call_handler)

{django_jsonrpc_framework-0.2.0 → django_jsonrpc_framework-0.2.1}/jsonrpc_framework/logic/dispatcher.py

@@ -7,7 +7,6 @@ from typing import Any
 from django.http import HttpRequest
 
 from jsonrpc_framework.core.models import MethodType, ParamType
-from jsonrpc_framework.logic.validator import RequestType, BatchType
 from jsonrpc_framework.core.error import (
     RpcError,
     InternalError,
@@ -25,20 +24,6 @@ from jsonrpc_framework.controller.auth import (
     ANONYMOUS_AUTH,
 )
 
-from jsonrpc_framework.core.error import (
-    InternalError,
-    InvalidParamsError,
-    MethodNotFoundError,
-    RpcError,
-)
-from jsonrpc_framework.core.models import (
-    ErrorResponse,
-    MethodType,
-    Notification,
-    ParamType,
-    Request,
-    SuccessResponse,
-)
 from jsonrpc_framework.logic.validator import BatchType, RequestType
 
 type ResponseType = SuccessResponse | ErrorResponse | None

{django_jsonrpc_framework-0.2.0 → django_jsonrpc_framework-0.2.1}/jsonrpc_framework/openrpc/document/components/_components.py

@@ -21,18 +21,9 @@ from jsonrpc_framework.openrpc.document.common._example import (
     _OpenRpcExampleObjectTD,
 )
 from jsonrpc_framework.openrpc.document.common._link import _OpenRpcLinkObjectTD
-from jsonrpc_framework.openrpc.document.common._error import (
-    _OpenRpcErrorObjectTD,
-)
-from jsonrpc_framework.openrpc.document.common._example import (
-    _OpenRpcExampleObjectTD,
-)
 from jsonrpc_framework.openrpc.document.common._pairing_object import (
     _OpenRpcExamplePairingObjectTD,
 )
-from jsonrpc_framework.openrpc.document.common._descriptor import (
-    _OpenRcpContentDescriptorObjectTD,
-)
 from jsonrpc_framework.openrpc.document.common._tag import _OpenRpcTagTD
 
 

{django_jsonrpc_framework-0.2.0 → django_jsonrpc_framework-0.2.1}/jsonrpc_framework/openrpc/tests/_conftest/components_conftest.py

@@ -14,16 +14,6 @@ from jsonrpc_framework.openrpc.document.components import OpenRpcComponents
 from jsonrpc_framework.openrpc.document.components._components import (
     _OpenRpcComponentsTD,
 )
-from jsonrpc_framework.openrpc.document.common import (
-    OpenRpcLinkObject,
-    OpenRpcErrorObject,
-    OpenRpcExamplePairingObject,
-    OpenRcpContentDescriptorObject,
-    OpenRpcTag,
-    OpenRpcDataSchema,
-    OpenRpcExampleObject,
-)
-from jsonrpc_framework.openrpc.document.common import OpenRcpTypeSchema
 
 
 @pytest.fixture

{django_jsonrpc_framework-0.2.0 → django_jsonrpc_framework-0.2.1}/jsonrpc_framework/openrpc/tests/_conftest/info_conftest.py

@@ -7,13 +7,6 @@ from jsonrpc_framework.openrpc.document.info._info import _OpenRpcInfoTD
 
 import pytest
 
-from jsonrpc_framework.openrpc.document.info import (
-    OpenRpcContact,
-    OpenRpcInfo,
-    OpenRpcLicense,
-)
-from jsonrpc_framework.openrpc.document.info._info import _OpenRpcInfoTD
-
 
 @pytest.fixture
 def openrpc_info() -> OpenRpcInfo:

{django_jsonrpc_framework-0.2.0 → django_jsonrpc_framework-0.2.1}/jsonrpc_framework/openrpc/tests/_conftest/method_conftest.py

@@ -22,38 +22,10 @@ from jsonrpc_framework.openrpc.document.info import (
     OpenRpcContact,
     OpenRpcLicense,
 )
-from jsonrpc_framework.openrpc.document.method._method import (
-    OpenRpcMethod,
-    _OpenRpcMethodTD,
-)
-from jsonrpc_framework.openrpc.document.server import (
-    OpenRpcServer,
-    OpenRpcServerObjectVariable,
-)
 
 from jsonrpc_framework.openrpc.builder.builder import OpenRpcBuilder
 from jsonrpc_framework.openrpc.document.common import (
-    OpenRcpContentDescriptorObject,
     OpenRcpTypeSchema,
-    OpenRpcErrorObject,
-    OpenRpcExampleObject,
-    OpenRpcExamplePairingObject,
-    OpenRpcLinkObject,
-    OpenRpcLinkObjectServer,
-    OpenRpcTag,
-)
-from jsonrpc_framework.openrpc.document.external_docs import OpenRpcExternalDoc
-from jsonrpc_framework.openrpc.document.info import (
-    OpenRpcContact,
-    OpenRpcLicense,
-)
-from jsonrpc_framework.openrpc.document.method._method import (
-    OpenRpcMethod,
-    _OpenRpcMethodTD,
-)
-from jsonrpc_framework.openrpc.document.server import (
-    OpenRpcServer,
-    OpenRpcServerObjectVariable,
 )
 
 

{django_jsonrpc_framework-0.2.0 → django_jsonrpc_framework-0.2.1}/jsonrpc_framework/openrpc/tests/test_builder.py

@@ -13,9 +13,7 @@ from jsonrpc_framework.openrpc.document.components._components import (
 from jsonrpc_framework.openrpc.document.external_docs import OpenRpcExternalDoc
 from jsonrpc_framework.openrpc.document.info._info import _OpenRpcInfoTD
 from jsonrpc_framework.openrpc.document.method import OpenRpcMethod
-from jsonrpc_framework.openrpc.document.method._method import _OpenRpcMethodTD
 from jsonrpc_framework.openrpc.document.server import OpenRpcServer
-from jsonrpc_framework.openrpc.document.server._server import _OpenRpcServerTD
 
 
 def test_builder(

{django_jsonrpc_framework-0.2.0 → django_jsonrpc_framework-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-jsonrpc-framework"
-version = "0.2.0"
+version = "0.2.1"
 description = "Django jsonrpc implementation"
 readme = "README.md"
 requires-python = ">=3.13"
@@ -16,9 +16,9 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-jwt = [
-    "pyjwt>=2.13.0",
-]
+jwt = ["pyjwt>=2.13.0"]
+sentry = ["sentry-sdk>=2.0"]
+prometheus = ["prometheus-client>=0.21"]
 
 [dependency-groups]
 dev = [