Skip to content

Add support for sharded PubSub #2344

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 21 commits into from
Closed

Add support for sharded PubSub #2344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
5dfd673
refactor pubsub, add support for sharded pub sub
leibale Dec 11, 2022
af03ba0
run tests in redis 7 only, fix PUBSUB SHARDCHANNELS test
leibale Dec 11, 2022
0b69a25
add some comments and fix some bugs
leibale Dec 12, 2022
29e43c7
PubSubType, not PubSubTypes 🤦‍♂️
leibale Dec 12, 2022
f7ce533
remove test.txt
leibale Dec 12, 2022
b74f6d4
fix some bugs, add tests
leibale Dec 12, 2022
de12812
add some tests
leibale Dec 12, 2022
811b554
fix #2345 - allow PING in PubSub mode (remove client side validation)
leibale Dec 12, 2022
d3cbd0d
remove .only
leibale Dec 12, 2022
877e57a
revert changes in cluster/index.ts
leibale Dec 12, 2022
52465d5
fix tests minimum version
leibale Dec 12, 2022
b82fcf5
handle server sunsubscribe
leibale Dec 13, 2022
2aab6eb
add 'sharded-channel-moved' event to docs, improve the events section…
leibale Dec 13, 2022
9419fef
exit "resubscribe" if pubsub not active
leibale Dec 13, 2022
298697a
Update commands-queue.ts
leibale Dec 13, 2022
8ea2123
Merge branch 'master' of github.com:redis/node-redis into sharded-pubusb
leibale Dec 26, 2022
d4bb5f3
Release client@1.5.0-rc.0
leibale Dec 26, 2022
59cea35
Merge branch 'master' of github.com:redis/node-redis into sharded-pubusb
leibale Dec 26, 2022
d7ec781
Merge branch 'sharded-pubusb' of github.com:leibale/node-redis into s…
leibale Jan 4, 2023
4d6c65a
WIP
leibale Jan 10, 2023
fa52217
use `node:util` instead of `node:util/types` (to support node 14)
leibale Jan 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -365,15 +365,18 @@ Check out the [Clustering Guide](./docs/clustering.md) when using Node Redis to

The Node Redis client class is an Nodejs EventEmitter and it emits an event each time the network status changes:

| Event name | Scenes | Arguments to be passed to the listener |
|----------------|-------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|
| `connect` | The client is initiating a connection to the server. | _No argument_ |
| `ready` | The client successfully initiated the connection to the server. | _No argument_ |
| `end` | The client disconnected the connection to the server via `.quit()` or `.disconnect()`. | _No argument_ |
| `error` | When a network error has occurred, such as unable to connect to the server or the connection closed unexpectedly. | 1 argument: The error object, such as `SocketClosedUnexpectedlyError: Socket closed unexpectedly` or `Error: connect ECONNREFUSED [IP]:[PORT]` |
| `reconnecting` | The client is trying to reconnect to the server. | _No argument_ |

The client will not emit [any other events](./docs/v3-to-v4.md#all-the-removed-events) beyond those listed above.
| Name | When | Listener arguments |
|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| `connect` | Initiating a connection to the server | *No arguments* |
| `ready` | Client is ready to use | *No arguments* |
| `end` | Connection has been closed (via `.quit()` or `.disconnect()`) | *No arguments* |
| `error` | An error has occurred—usually a network issue such as "Socket closed unexpectedly" | `(error: Error)` |
| `reconnecting` | Client is trying to reconnect to the server | *No arguments* |
| `sharded-channel-moved` | The ["cluster slot"](https://redis.io/docs/reference/cluster-spec/#key-distribution-model) of a subscribed [sharded PubSub](https://redis.io/docs/manual/pubsub/#sharded-pubsub) channel has been moved | `(channel: string, listeners: { buffers: Set<Listener<Buffer>>, strings: Set<Listener<string>> })` |

> :warning: You **MUST** listen to `error` events. If a client doesn't have at least one `error` listener registered and an `error` occurs, that error will be thrown and the Node.js process will exit. See the [`EventEmitter` docs](https://nodejs.org/api/events.html#events_error_events) for more details.

> The client will not emit [any other events](./docs/v3-to-v4.md#all-the-removed-events) beyond those listed above.

## Supported Redis versions

Expand Down
4 changes: 3 additions & 1 deletion docs/client-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,11 @@

## Reconnect Strategy

TODO: `false | number | (retries: number, cause: unknown) => number | Error`

You can implement a custom reconnect strategy as a function:

- Receives the number of retries attempted so far.
- Receives the number of retries attempted so far and the causing error.
- Returns `number | Error`:
- `number`: wait time in milliseconds prior to attempting a reconnect.
- `Error`: closes the client and flushes internal command queues.
Expand Down
1 change: 1 addition & 0 deletions docs/clustering.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ const value = await cluster.get('key');
| rootNodes | | An array of root nodes that are part of the cluster, which will be used to get the cluster topology. Each element in the array is a client configuration object. There is no need to specify every node in the cluster, 3 should be enough to reliably connect and obtain the cluster configuration from the server |
| defaults | | The default configuration values for every client in the cluster. Use this for example when specifying an ACL user to connect with |
| useReplicas | `false` | When `true`, distribute load by executing readonly commands (such as `GET`, `GEOSEARCH`, etc.) across all cluster nodes. When `false`, only use master nodes |
| minimizeConnections | `false` | When `true`, `.connect()` will only discover the cluster topology, without actually connecting to all the nodes. Useful for short-term or PubSub-only connections. |
| maxCommandRedirections | `16` | The maximum number of times a command will be redirected due to `MOVED` or `ASK` errors |
| nodeAddressMap | | Defines the [node address mapping](#node-address-map) |
| modules | | Included [Redis Modules](../README.md#packages) |
Expand Down
Loading