airtai · Lancetnik · Aug 7, 2024 · Aug 3, 2024 · Aug 3, 2024 · Aug 3, 2024
diff --git a/.github/workflows/pr_tests.yaml b/.github/workflows/pr_tests.yaml
@@ -82,7 +82,7 @@ jobs:
         run: pip install --pre "pydantic>=2.0.0b2,<3.0.0"
       - run: mkdir coverage
       - name: Test
-        run: bash scripts/test.sh -m "(slow and (not nats and not kafka and not confluent and not rabbit and not redis)) or (not nats and not kafka and not confluent and not rabbit and not redis)"
+        run: bash scripts/test.sh -vv -m "(slow and (not nats and not kafka and not confluent and not rabbit and not redis)) or (not nats and not kafka and not confluent and not rabbit and not redis)"
         env:
           COVERAGE_FILE: coverage/.coverage.${{ runner.os }}-py${{ matrix.python-version }}-${{ matrix.pydantic-version }}
           CONTEXT: ${{ runner.os }}-py${{ matrix.python-version }}-${{ matrix.pydantic-version }}

diff --git a/docs/create_api_docs.py b/docs/create_api_docs.py
@@ -22,6 +22,8 @@
 
 
 PUBLIC_API_FILES = [
+    "faststream/opentelemetry/__init__.py",
+    "faststream/asgi/__init__.py",
     "faststream/asyncapi/__init__.py",
     "faststream/__init__.py",
     "faststream/nats/__init__.py",

diff --git a/docs/docs/SUMMARY.md b/docs/docs/SUMMARY.md
@@ -41,6 +41,7 @@ search:
         - [FastAPI Plugin](getting-started/integrations/fastapi/index.md)
         - [Django](getting-started/integrations/django/index.md)
     - [CLI commands](getting-started/cli/index.md)
+    - [ASGI](getting-started/asgi.md)
     - [OpenTelemetry](getting-started/opentelemetry/index.md)
     - [Logging](getting-started/logging.md)
     - [Config Management](getting-started/config/index.md)
@@ -120,6 +121,12 @@ search:
             - [Response](public_api/faststream/Response.md)
             - [TestApp](public_api/faststream/TestApp.md)
             - [apply_types](public_api/faststream/apply_types.md)
+            - asgi
+                - [AsgiFastStream](public_api/faststream/asgi/AsgiFastStream.md)
+                - [AsgiResponse](public_api/faststream/asgi/AsgiResponse.md)
+                - [get](public_api/faststream/asgi/get.md)
+                - [make_asyncapi_asgi](public_api/faststream/asgi/make_asyncapi_asgi.md)
+                - [make_ping_asgi](public_api/faststream/asgi/make_ping_asgi.md)
             - asyncapi
                 - [get_app_schema](public_api/faststream/asyncapi/get_app_schema.md)
                 - [get_asyncapi_html](public_api/faststream/asyncapi/get_asyncapi_html.md)
@@ -164,6 +171,9 @@ search:
                 - [StreamSource](public_api/faststream/nats/StreamSource.md)
                 - [TestApp](public_api/faststream/nats/TestApp.md)
                 - [TestNatsBroker](public_api/faststream/nats/TestNatsBroker.md)
+            - opentelemetry
+                - [TelemetryMiddleware](public_api/faststream/opentelemetry/TelemetryMiddleware.md)
+                - [TelemetrySettingsProvider](public_api/faststream/opentelemetry/TelemetrySettingsProvider.md)
             - rabbit
                 - [ExchangeType](public_api/faststream/rabbit/ExchangeType.md)
                 - [RabbitBroker](public_api/faststream/rabbit/RabbitBroker.md)
@@ -200,6 +210,23 @@ search:
             - [apply_types](api/faststream/apply_types.md)
             - app
                 - [FastStream](api/faststream/app/FastStream.md)
+            - asgi
+                - [AsgiFastStream](api/faststream/asgi/AsgiFastStream.md)
+                - [AsgiResponse](api/faststream/asgi/AsgiResponse.md)
+                - [get](api/faststream/asgi/get.md)
+                - [make_asyncapi_asgi](api/faststream/asgi/make_asyncapi_asgi.md)
+                - [make_ping_asgi](api/faststream/asgi/make_ping_asgi.md)
+                - app
+                    - [AsgiFastStream](api/faststream/asgi/app/AsgiFastStream.md)
+                - factories
+                    - [make_asyncapi_asgi](api/faststream/asgi/factories/make_asyncapi_asgi.md)
+                    - [make_ping_asgi](api/faststream/asgi/factories/make_ping_asgi.md)
+                - handlers
+                    - [get](api/faststream/asgi/handlers/get.md)
+                - response
+                    - [AsgiResponse](api/faststream/asgi/response/AsgiResponse.md)
+                - websocket
+                    - [WebSocketClose](api/faststream/asgi/websocket/WebSocketClose.md)
             - asyncapi
                 - [get_app_schema](api/faststream/asyncapi/get_app_schema.md)
                 - [get_asyncapi_html](api/faststream/asyncapi/get_asyncapi_html.md)
@@ -214,6 +241,7 @@ search:
                     - [get_response_schema](api/faststream/asyncapi/message/get_response_schema.md)
                     - [parse_handler_params](api/faststream/asyncapi/message/parse_handler_params.md)
                 - proto
+                    - [AsyncAPIApplication](api/faststream/asyncapi/proto/AsyncAPIApplication.md)
                     - [AsyncAPIProto](api/faststream/asyncapi/proto/AsyncAPIProto.md)
                 - schema
                     - [Channel](api/faststream/asyncapi/schema/Channel.md)

diff --git a/docs/docs/en/api/faststream/asgi/AsgiFastStream.md b/docs/docs/en/api/faststream/asgi/AsgiFastStream.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.asgi.AsgiFastStream
diff --git a/docs/docs/en/api/faststream/asgi/AsgiResponse.md b/docs/docs/en/api/faststream/asgi/AsgiResponse.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.asgi.AsgiResponse
diff --git a/docs/docs/en/api/faststream/asgi/app/AsgiFastStream.md b/docs/docs/en/api/faststream/asgi/app/AsgiFastStream.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.asgi.app.AsgiFastStream
diff --git a/docs/docs/en/api/faststream/asgi/factories/make_asyncapi_asgi.md b/docs/docs/en/api/faststream/asgi/factories/make_asyncapi_asgi.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.asgi.factories.make_asyncapi_asgi
diff --git a/docs/docs/en/api/faststream/asgi/factories/make_ping_asgi.md b/docs/docs/en/api/faststream/asgi/factories/make_ping_asgi.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.asgi.factories.make_ping_asgi
diff --git a/docs/docs/en/api/faststream/asgi/get.md b/docs/docs/en/api/faststream/asgi/get.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.asgi.get
diff --git a/docs/docs/en/api/faststream/asgi/handlers/get.md b/docs/docs/en/api/faststream/asgi/handlers/get.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.asgi.handlers.get
diff --git a/docs/docs/en/api/faststream/asgi/make_asyncapi_asgi.md b/docs/docs/en/api/faststream/asgi/make_asyncapi_asgi.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.asgi.make_asyncapi_asgi
diff --git a/docs/docs/en/api/faststream/asgi/make_ping_asgi.md b/docs/docs/en/api/faststream/asgi/make_ping_asgi.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.asgi.make_ping_asgi
diff --git a/docs/docs/en/api/faststream/asgi/response/AsgiResponse.md b/docs/docs/en/api/faststream/asgi/response/AsgiResponse.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.asgi.response.AsgiResponse
diff --git a/docs/docs/en/api/faststream/asgi/websocket/WebSocketClose.md b/docs/docs/en/api/faststream/asgi/websocket/WebSocketClose.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.asgi.websocket.WebSocketClose
diff --git a/docs/docs/en/api/faststream/asyncapi/proto/AsyncAPIApplication.md b/docs/docs/en/api/faststream/asyncapi/proto/AsyncAPIApplication.md
@@ -0,0 +1,11 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 0.5
+---
+
+::: faststream.asyncapi.proto.AsyncAPIApplication
diff --git a/docs/docs/en/getting-started/asgi.md b/docs/docs/en/getting-started/asgi.md
@@ -0,0 +1,145 @@
+---
+# 0.5 - API
+# 2 - Release
+# 3 - Contributing
+# 5 - Template Page
+# 10 - Default
+search:
+  boost: 10
+---
+
+# ASGI support
+
+Often you need to not just run your application to consume messages, but make it the real part of your services ecosystem: with *Prometheus metrics*, K8S *leviness* and *readiness probes*, *traces* and other observability staff.
+
+Unfortunately, such functional can't be implemented by broker-features only and you have to provide several **HTTP** endpoints in your app.
+
+For sure, you can use **FastStream** as a part of your any **ASGI** frameworks ([integrations](./integrations/frameworks/index.md){.internal-link}), but the fewer dependencies, the better, right?
+
+## AsgiFastStream
+
+Helpfully, we have built-in **ASGI** support. It is very limited, but good enough to provides you with basic functional for metrics and healthcheks endpoints implementation.
+
+Let's take a look at the following example:
+
+```python linenums="1" hl_lines="2 5" title="main.py"
+from faststream.nats import NatsBroker
+from faststream.asgi import AsgiFastStream
+
+broker = NatsBroker()
+app = AsgiFastStream(broker)
+```
+
+This simple example just provides you with an ability to run the app using regular **ASGI** servers:
+
+```shell
+uvicorn main:app
+```
+
+Now it does nothing but launches the app itself as a **ASGI lifespan**.
+
+
+### ASGI routes
+
+It doesn't look really helpful, so let's add some **HTTP** endpoints.
+
+At first, we have already written wrapper on top of broker to make ready-to-use **ASGI** healthcheck endpoint for you
+
+```python linenums="1" hl_lines="2 9"
+from faststream.nats import NatsBroker
+from faststream.asgi import AsgiFastStream, make_ping_asgi
+
+broker = NatsBroker()
+
+app = AsgiFastStream(
+    broker,
+    asgi_routes=[
+        ("/health", make_ping_asgi(broker, timeout=5.0)),
+    ]
+)
+```
+
+!!! note
+    This `/health` endpoint calls `#!python broker.ping()` method and return **HTTP 204** or **HTTP 500** statuses.
+
+### Custom ASGI routes
+
+**AsgiFastStream** is able to call any **ASGI**-compatible callable objects, so you can use any endpoints from other libraries if they are compatible with the protocol.
+
+But, if you need to write you own simple **HTTP**-endpoint you can use our `#!python @get` decorator as in the following example:
+
+```python linenums="1" hl_lines="2 6-8 12"
+from faststream.nats import NatsBroker
+from faststream.asgi import AsgiFastStream, AsgiResponse, get
+
+broker = NatsBroker()
+
+@get
+async def liveness_ping(scope):
+    return AsgiResponse(b"", status_code=200)
+
+app = AsgiFastStream(
+    broker,
+    asgi_routes=[("/health", liveness_ping)]
+)
+```
+
+Or you can write **ASGI** endpoint by yourself
+
+```python
+async def liveness_ping(scope, receive, send):
+    return AsgiResponse(b"", status_code=200)
+```
+
+!!! tip
+    You need no to setup all routes by `asgi_routes=[]` initial option.<br/>
+    You can use `#!python app.mount("/healh", asgi_endpoint)` method instead.
+
+### AsyncAPI documentation
+
+Also, you can host your **AsyncAPI** documentation without new process, run by [`#!shell faststream docs serve ...`](./asyncapi/hosting.md){.internal-link}, but in the same container and runtime.
+
+Just create `AsgiFastStream` object with a special option:
+
+```python linenums="1" hl_lines="8"
+from faststream.nats import NatsBroker
+from faststream.asgi import AsgiFastStream
+
+broker = NatsBroker()
+
+app = AsgiFastStream(
+    broker,
+    asyncapi_path="/docs",
+)
+```
+
+Now, your **AsyncAPI HTML** representation can be founded in the net by `/docs` url.
+
+## Another ASGI compatibility
+
+Moreover, our wrappers can be used as a ready-to-use endpoins for other **ASGI** frameworks. It can be very helpful in cases, then you are running **FastStream** in the same runtime with any **ASGI** framework.
+
+Just follow the example in such cases:
+
+```python linenums="1" hl_lines="6 19-20"
+from contextlib import asynccontextmanager
+
+from fastapi import FastAPI
+from faststream import FastStream
+from faststream.nats import NatsBroker
+from faststream.asgi import make_ping_asgi, make_asyncapi_asgi
+
+broker = NatsBroker()
+
+@asynccontextmanager
+async def start_broker(app):
+    """Start the broker with the app."""
+    async with broker:
+        await broker.start()
+        yield
+
+app = FastAPI(lifespan=start_broker)
+
+app.mount("/health", make_ping_asgi(broker, timeout=5.0))
+app.mount("/asyncapi", make_asyncapi_asgi(FastStream(broker)))
+```
diff --git a/docs/docs/navigation_template.txt b/docs/docs/navigation_template.txt
@@ -41,6 +41,7 @@ search:
         - [FastAPI Plugin](getting-started/integrations/fastapi/index.md)
         - [Django](getting-started/integrations/django/index.md)
     - [CLI commands](getting-started/cli/index.md)
+    - [ASGI](getting-started/asgi.md)
     - [OpenTelemetry](getting-started/opentelemetry/index.md)
     - [Logging](getting-started/logging.md)
     - [Config Management](getting-started/config/index.md)

diff --git a/faststream/_compat.py b/faststream/_compat.py
@@ -45,8 +45,6 @@ def json_dumps(*a: Any, **kw: Any) -> bytes:
 try:
     from fastapi import __version__ as FASTAPI_VERSION  # noqa: N812
 
-    HAS_FASTAPI = True
-
     major, minor, *_ = map(int, FASTAPI_VERSION.split("."))
     FASTAPI_V2 = major > 0 or minor > 100
     FASTAPI_V106 = major > 0 or minor >= 106
@@ -70,7 +68,7 @@ def raise_fastapi_validation_error(errors: List[Any], body: AnyDict) -> Never:
             raise RequestValidationError(errors, ROUTER_VALIDATION_ERROR_MODEL)  # type: ignore[misc]
 
 except ImportError:
-    HAS_FASTAPI = False
+    pass
 
 JsonSchemaValue = Mapping[str, Any]