How to send cookies when connecting to socket.io via WebSockets?

When connecting to a Socket.io server via WebSockets, you can send cookies during the initial handshake using several methods. This is critical because cookies are typically used to store session information, authentication tokens, and other critical data, which are essential for maintaining state and controlling access permissions. Here are some key steps and examples demonstrating how to send cookies when establishing a WebSocket connection:

1. Using Browser JavaScript API

In a browser environment, if you use socket.io-client to connect to a Socket.io server, cookies are automatically sent with the request (assuming they match the domain of the request). This occurs because browsers adhere to the same-origin policy and automatically include cookies that align with the server's domain.

javascript
const socket = io('http://example.com');

In this scenario, as long as the browser has cookies for example.com, they will be automatically transmitted during the WebSocket connection establishment.

2. Manually Setting Cookies

If you need to manually set cookies on the client side and ensure they are sent to the server, you can configure them using JavaScript's document.cookie API before initiating the connection.

javascript
document.cookie = "session_token=abcdef12345; path=/";
const socket = io('http://example.com');

3. Sending Cookies in a Node.js Environment

When using socket.io-client in a Node.js environment, you must manually set cookies in the connection options because Node.js does not handle cookies automatically.

javascript
const io = require("socket.io-client");

const socket = io('http://example.com', {
    extraHeaders: {
        Cookie: "session_token=abcdef12345"
    }
});

In this example, we explicitly set the Cookie header via the extraHeaders option to send cookie information during the initial handshake with the Socket.io server.

Summary

By implementing these methods, you can ensure cookies are appropriately transmitted when using WebSockets and Socket.io, enabling critical functionalities such as authentication and session management. In practical development, the method you choose depends on your application environment (browser or Node.js) and specific security and architectural requirements.