Add no-server-header support for Web Socket implementations

[iudeen]

No description provided.

[iudeen]

I am not sure if these features are needed at this point of time, but I went ahead and added as I was not able to conclusively find a reason why server headers were not added to Websocket protocols.

Note: Also, we can keep this in WIP till Websocket library provides an API to disable server header completely.

[Kludex]

I'd prefer to not use the workaround on the websockets implementation 🤔

There's already an issue on websockets about this, and we already documented the limitation. Let's modify the note to specify that it does not work on websockets implementation and add the headers to wsproto.

[iudeen]

@Kludex, agreed will make the changes today! thanks for your feedback

[Kludex]

Thanks 🙏

[iudeen]

implemented request changes

[iudeen]

Test Results:

Code:

# app.py

from fastapi import FastAPI
from starlette.websockets import WebSocket

app = FastAPI()


@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()
    while True:
        data = await websocket.receive_text()
        await websocket.send_text(f"Message text was: {data}")

Websockets implementation without --no-server-header

>uvicorn app:app
INFO:     Started server process [9848]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: bxNWrBsDyxZs3+p8aaNcwTzh6ac=
Sec-WebSocket-Extensions: permessage-deflate
date: Fri, 12 Aug 2022 09:26:02 GMT
server: uvicorn

Websockets implementation with --no-server-header

>uvicorn app:app --no-server-header
INFO:     Started server process [9848]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: voUjj70rAcpXQJnB1yI+0lLZuGg=
Sec-WebSocket-Extensions: permessage-deflate
date: Fri, 12 Aug 2022 09:29:49 GMT
Server: Python/3.10 websockets/10.3

Wsproto implementation with --no-server-header

>uvicorn app:app --no-server-header --ws wsproto
INFO:     Started server process [9848]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

HTTP/1.1 101
Upgrade: WebSocket
Connection: Upgrade
Sec-WebSocket-Accept: u1f5bQpPsn8/VPZAo5ynbrRRkag=
Sec-WebSocket-Extensions: permessage-deflate; client_max_window_bits=15
date: Fri, 12 Aug 2022 17:33:05 GMT

Wsproto implementation without --no-server-header

>uvicorn app:app  --ws wsproto
INFO:     Started server process [9848]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)

HTTP/1.1 101
Upgrade: WebSocket
Connection: Upgrade
Sec-WebSocket-Accept: r0+014Ywn5SbmlY9tNSEPg6FRfg=
Sec-WebSocket-Extensions: permessage-deflate; client_max_window_bits=15
date: Fri, 12 Aug 2022 17:34:04 GMT
server: uvicorn

[iudeen]

--no-date-header is not compatible with Websockets implementation. Added that also as a limitation in documentation.

[Kludex]

We also need tests here, jfyk.

[iudeen]

Closing this request, as it was made from master branch of the forked repo. Sorry!

Please refer to #1606 for further updates.