[borisalekseev]

Description

Fixes #1798

TODO:

• Depends tests
• remove hasattr
• check if possible move "Scope" to type checking import

Backward compatibility with old HTTP handlers that receive a scope argument is preserved.

Example usage:

import logging

from faststream.asgi import AsgiFastStream, get, AsgiResponse, post, Request, Header, Query
from faststream.nats import NatsBroker

logger = logging.getLogger("faststream")


@get
async def access_request(request: Request):
    logger.info("Received request %s", request)
    # Received request <faststream.asgi.request.AsgiRequest object at 0x7cda02c674d0>
    return AsgiResponse(status_code=200)


@get
async def access_query(faststream: list[str] | None = Query(default=None)):
    logger.info("Faststream is %s", faststream)
    # Faststream is ['cool']
    return AsgiResponse()


# curl -X POST http://127.0.0.1:8000/access_header --header "X-auth-token: secret-token" -d '{"field": "val"}'
@post
async def access_header(request: Request, token: str = Header("X-auth-token")):
    if token != "secret-token":
        return AsgiResponse(status_code=401)
    data = await request.json()
    logger.info(data)  # {'field': 'val'}
    return AsgiResponse(status_code=200)


broker = NatsBroker()
app = AsgiFastStream(broker, asgi_routes=[
    ("/access_request", access_request),
    ("/access_query", access_query),
])
app.mount("/access_header", access_header)

Type of change

Please delete options that are not relevant.

• Documentation (typos, code examples, or any documentation updates)
• Bug fix (a non-breaking change that resolves an issue)
• New feature (a non-breaking change that adds functionality)
• Breaking change (a fix or feature that would disrupt existing functionality)
• This change requires a documentation update

Checklist

• My code adheres to the style guidelines of this project (just lint shows no errors)
• I have conducted a self-review of my own code
• I have made the necessary changes to the documentation
• My changes do not generate any new warnings
• I have added tests to validate the effectiveness of my fix or the functionality of my new feature
• Both new and existing unit tests pass successfully on my local environment by running just test-coverage
• I have ensured that static analysis tests are passing by running just static-analysis
• I have included code examples to illustrate the modifications

[Lancetnik]

Should we use this logger or from the context? Also, I suggest to add an exception traceback by logger.error(..., exc_info=exception)

[borisalekseev]

Here I replaced the logger with the application logger and also added the logger forwarding to the context so it could be used in the handler.

[Lancetnik]

@Sehat1137 can you review, please?

[Sehat1137]

I think we need support new features into AsyncAPI schema, because right now we don't see any information about required headers or query params

[Sehat1137]

I think we need support new features into AsyncAPI schema, because right now we don't see any information about required headers or query params

next pr

[Lancetnik]

It is already set in super.__init__, there is no need to double this logic here

[borisalekseev]

The problem is that I need access to context.app when registering the handler, which happens before the parent class installs the app in the context. In this case, can I change the behavior in faststream._internal.application.Application?