aio-libs / aio-libs/aiohttp

Add custom header support to websocket client

Open
#2,053 8 comments 0 reactions 0 assignees View on GitHub
enhancement pr-available
Dominant language
Python
Stars
16.5k
Forks
2.4k
Avg merge
17h 22m
Merged PRs (30d)
212

Description

## Feature

Websocket protocol actually supports custom headers. They are not widely used (afair you cannot access them in webbrowser JS in any reasonable way), but may be important.

I've encountered this issue while developing a WS proxy on aiohttp - proxy naturally wants to achieve best
content 'forwarding' possible.

Current state in aiohttp:

* Server side websocket handler can set headers nicely (as `WebSocketResponse` is inherited from `StreamResponse`);
* Client side `ws_connect()` can pass headers, but it is not documented;
* Websocket response (`ClientWebSocketResponse` class) doesn't allow to access them.

So, it looks like there are 2 things to do:

* Add `.headers` property to ClientWebSocketResponse
* Document `headers` kwarg to `ClientSession.ws_connect()`

**Upd** Motivational example:
Setting cookies in WS handler actually works in chrome, but cannot be proxied by aiohttp for now.

**Upd** about ws_connect
`ws_connect(headers=...)` seems to differ from other `ClientSession` methods as it does not accept list of pairs.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.