https://github.com/hyperlink/socket.io-sticky-headers

Use custom header to maintain sticky sessions with socket.io
https://github.com/hyperlink/socket.io-sticky-headers

socket-io sticky-headers

Last synced: 6 days ago
JSON representation

Use custom header to maintain sticky sessions with socket.io

• Host: GitHub
• URL: https://github.com/hyperlink/socket.io-sticky-headers
• Owner: hyperlink
• License: mit
• Created: 2017-04-06T13:34:53.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-20T19:28:30.000Z (about 7 years ago)
• Last Synced: 2025-01-22T12:37:06.410Z (8 days ago)
• Topics: socket-io, sticky-headers
• Language: JavaScript
• Size: 6.84 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# socket.io-sticky-headers

[![Greenkeeper badge](https://badges.greenkeeper.io/hyperlink/socket.io-sticky-headers.svg)](https://greenkeeper.io/)

Use custom header to maintain sticky sessions with socket.io

## Problem

For cluster of socket.io servers Socket.io connections made by the client requires a handshake process that involves sending several XHR requests. If any of those requests fail to connect to the same instance the handshake will fail and socket.io will be in a reconnect loop (failing with 401 errors).

Sticky sessions are need to successfully connect to a cluster of socket.io servers. Usually this can be managed with a Cookie. However browsers such as Safari has very strict third party cookie rules which could prevent this from working. An example could be a chat client placed on a customers site.

This module patches the engine.io XHR polling to capture a custom http header response of your choosing. Any future requests made will use the same http header. Future requests will update the header if that header ever changed.

## Install

```bash

npm install socket.io-sticky-headers --save

```

## Usage

### Socket.io

```javascript

require('socket.io-sticky-headers')(require('socket.io-client/node_modules/engine.io-client/lib/transports/polling-xhr'), 'My-Session-Id')

```

### Engine.io

```javascript

require('socket.io-sticky-headers')(require('engine.io-client/lib/transports/polling-xhr'), 'My-Session-Id')

```

Pass `true` as the third argument if you wish to send the header as query param instead (which maybe more desirable for CORS reasons). You will need to provide a socket as shown below:

```javascript

const stickyHeader = require('socket.io-sticky-headers')

stickyHeader(require('engine.io-client/lib/transports/polling-xhr'), 'My-Session-Id', true)

var io = require('socket.io-client')

var socket = io('http://localhost:3000', {

  reconnection: false,

  'force new connection': true

})

stickyHeader.setSocket(socket)

```