@socket.io/redis-adapter

v8.3.0

The Socket.IO Redis adapter, allowing to broadcast events between several Socket.IO servers For more information about how to use this package see README

Latest version published 8 months ago

License: MIT

NPM

GitHub

Package Health Score

71 / 100

security
No known security issues
popularity
Influential project
maintenance
Inactive
community
Sustainable

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
8.3.0	\|	03/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
8.2.1	\|	05/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.2.0	\|	05/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.1.0	\|	11/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
7.0.1	\|	11/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Influential project

Weekly Downloads (155,103)

GitHub Stars: 2.74K
Forks: 487
Contributors: 60

Direct Usage Popularity

The npm package @socket.io/redis-adapter receives a total of 155,103 downloads a week. As such, we scored @socket.io/redis-adapter popularity level to be Influential project.

Based on project statistics from the GitHub repository for the npm package @socket.io/redis-adapter, we found that it has been starred 2,740 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 60
Funding: No

With more than 10 contributors for the @socket.io/redis-adapter repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like @socket.io/redis-adapter is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 30
Open PR: 5
Last Release: 8 months ago
Last Commit: 8 months ago

Further analysis of the maintenance status of @socket.io/redis-adapter based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that @socket.io/redis-adapter demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=10.0.0

Age: 3 years
Dependencies: 3 Direct
Versions: 11
Install Size: 54.1 kB
Dist-tags: 1
# of Files: 9
Maintainers: 1
TS Typings: No

@socket.io/redis-adapter has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Socket.IO Redis adapter

The @socket.io/redis-adapter package allows broadcasting packets between multiple Socket.IO servers.

Diagram of Socket.IO packets forwarded through Redis

Table of contents

Supported features

Feature	`socket.io` version	Support
Socket management	`4.0.0`	✅ YES (since version `6.1.0`)
Inter-server communication	`4.1.0`	✅ YES (since version `7.0.0`)
Broadcast with acknowledgements	`4.5.0`	✅ YES (since version `7.2.0`)
Connection state recovery	`4.6.0`	❌ NO

Installation

npm install @socket.io/redis-adapter

Compatibility table

Redis Adapter version	Socket.IO server version
4.x	1.x
5.x	2.x
6.0.x	3.x
6.1.x	4.x
7.x and above	4.3.1 and above

Usage

With the `redis` package

import { createClient } from "redis";
import { Server } from "socket.io";
import { createAdapter } from "@socket.io/redis-adapter";

const pubClient = createClient({ url: "redis://localhost:6379" });
const subClient = pubClient.duplicate();

await Promise.all([
  pubClient.connect(),
  subClient.connect()
]);

const io = new Server({
  adapter: createAdapter(pubClient, subClient)
});

io.listen(3000);

With the `redis` package and a Redis cluster

import { createCluster } from "redis";
import { Server } from "socket.io";
import { createAdapter } from "@socket.io/redis-adapter";

const pubClient = createCluster({
  rootNodes: [
    {
      url: "redis://localhost:7000",
    },
    {
      url: "redis://localhost:7001",
    },
    {
      url: "redis://localhost:7002",
    },
  ],
});
const subClient = pubClient.duplicate();

await Promise.all([
  pubClient.connect(),
  subClient.connect()
]);

const io = new Server({
  adapter: createAdapter(pubClient, subClient)
});

io.listen(3000);

With the `ioredis` package

import { Redis } from "ioredis";
import { Server } from "socket.io";
import { createAdapter } from "@socket.io/redis-adapter";

const pubClient = new Redis();
const subClient = pubClient.duplicate();

const io = new Server({
  adapter: createAdapter(pubClient, subClient)
});

io.listen(3000);

With the `ioredis` package and a Redis cluster

import { Cluster } from "ioredis";
import { Server } from "socket.io";
import { createAdapter } from "@socket.io/redis-adapter";

const pubClient = new Cluster([
  {
    host: "localhost",
    port: 7000,
  },
  {
    host: "localhost",
    port: 7001,
  },
  {
    host: "localhost",
    port: 7002,
  },
]);
const subClient = pubClient.duplicate();

const io = new Server({
  adapter: createAdapter(pubClient, subClient)
});

io.listen(3000);

With Redis sharded Pub/Sub

Sharded Pub/Sub was introduced in Redis 7.0 in order to help scaling the usage of Pub/Sub in cluster mode.

Reference: https://redis.io/docs/interact/pubsub/#sharded-pubsub

A dedicated adapter can be created with the createShardedAdapter() method:

import { Server } from "socket.io";
import { createClient } from "redis";
import { createShardedAdapter } from "@socket.io/redis-adapter";

const pubClient = createClient({ host: "localhost", port: 6379 });
const subClient = pubClient.duplicate();

await Promise.all([
  pubClient.connect(),
  subClient.connect()
]);

const io = new Server({
  adapter: createShardedAdapter(pubClient, subClient)
});

io.listen(3000);

Minimum requirements:

Redis 7.0
redis@4.6.0

Note: it is not currently possible to use the sharded adapter with the ioredis package and a Redis cluster (reference).

Options

Default adapter

Name	Description	Default value
`key`	The prefix for the Redis Pub/Sub channels.	`socket.io`
`requestsTimeout`	After this timeout the adapter will stop waiting from responses to request.	`5_000`
`publishOnSpecificResponseChannel`	Whether to publish a response to the channel specific to the requesting node.	`false`
`parser`	The parser to use for encoding and decoding messages sent to Redis.	`-`

Sharded adapter

Name	Description	Default value
`channelPrefix`	The prefix for the Redis Pub/Sub channels.	`socket.io`
`subscriptionMode`	The subscription mode impacts the number of Redis Pub/Sub channels used by the adapter.	`dynamic`

License

MIT

@socket.io/redis-adapter dependencies

debug notepack.io uid2

@socket.io/redis-adapter development dependencies

@types/expect.js @types/mocha @types/node expect.js ioredis mocha nyc prettier redis redis-v3 rimraf socket.io socket.io-client ts-node typescript

FAQs

What is @socket.io/redis-adapter?

The Socket.IO Redis adapter, allowing to broadcast events between several Socket.IO servers. Visit Snyk Advisor to see a full health score report for @socket.io/redis-adapter, including popularity, security, maintenance & community analysis.

Is @socket.io/redis-adapter popular?

The npm package @socket.io/redis-adapter receives a total of 155,103 weekly downloads. As such, @socket.io/redis-adapter popularity was classified as an influential project. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @socket.io/redis-adapter well maintained?

We found indications that @socket.io/redis-adapter is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is @socket.io/redis-adapter safe to use?

The npm package @socket.io/redis-adapter was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 7 November-2024, at 06:46 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (155,103)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Socket.IO Redis adapter

Supported features

Installation

Compatibility table

Usage

With the redis package

With the redis package and a Redis cluster

With the ioredis package

With the ioredis package and a Redis cluster

With Redis sharded Pub/Sub

Options

Default adapter

Sharded adapter

License

@socket.io/redis-adapter dependencies

@socket.io/redis-adapter development dependencies

FAQs

What is @socket.io/redis-adapter?

Is @socket.io/redis-adapter popular?

Is @socket.io/redis-adapter well maintained?

Is @socket.io/redis-adapter safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

With the `redis` package

With the `redis` package and a Redis cluster

With the `ioredis` package

With the `ioredis` package and a Redis cluster