Next major version: V5 #1504

luin · 2022-02-06T09:32:08Z

Major changes:

Drop support of Node.js < 12.
Drop support of plugging in third-party Promise Library. (As native Promise is pretty performant and Bluebird is deprecated.)
Upgrade TypeScript to the latest version.
Official TypeScript declarations.
Support ESM + CJS.
Scripts will retry in case of NOSCRIPT in pipeline mode. Pipeline-based script loading and retries #1499
refactor: limit info on readyCheck to persistence section #1293
ISSUE-1024 keyPrefix option support Redis Cluster #1041 (May not merge directly, another approach is to add a warning)

AVVS · 2022-02-06T16:08:37Z

@luin any chance we can squeeze in resp3 (dont remember this being supported, but might be wrong) / client side caching here? glad to help!

AVVS · 2022-02-06T16:09:30Z

and another idea is native opentelemetry instrumentation

luin · 2022-02-06T16:21:51Z

@luin any chance we can squeeze in resp3 (dont remember this being supported, but might be wrong) / client side caching here? glad to help!

It hasn't been supported 🤣 . For myself, I don't feel that resp3 will bring a lot of real value, and I'm not sure as a driver, what kind of API needs to be provided to support the new features that resp3 brings. Similarly, client side caching does not seem to be as meaningful for a language that uses GC.

But I haven't thought much about this, so open to suggestions! If we want to support resp3, v5 seems to be a good chance to do so.

and another idea is native opentelemetry instrumentation

Can you elaborate a little bit more on this? Does it mean to provide an interface to get the average command execution time or something similar?

AVVS · 2022-02-06T16:31:29Z

Can you elaborate a little bit more on this? Does it mean to provide an interface to get the average command execution time or something similar?

it sort of allows you to perform diagnostics better and get a complete trace of a request when every part of your request chain is instrumented, typically you'd use async_hooks, but can be anything

https://github.com/elastic/apm-agent-nodejs/blob/main/lib/instrumentation/modules/ioredis.js is an example of an existing instrumentation, which can be bridged to opentracing/opentelementry, fed to something like https://github.com/jaegertracing/jaeger for visualization/search

AVVS · 2022-02-06T16:34:09Z

It hasn't been supported 🤣 . For myself, I don't feel that resp3 will bring a lot of real value, and I'm not sure as a driver, what kind of API needs to be provided to support the new features that resp3 brings. Similarly, client side caching does not seem to be as meaningful for a language that uses GC.

I don;t think GC is relevant in terms of client-side caching here, in my opinion main benefit here is lower latency to access information, along with guarantees that information is still what server has. https://redis.io/topics/client-side-caching
for certain queries you can opt-in to cache the response. when server-side data changes - server will notify clients about that and clients will get new info

marcbachmann · 2022-02-08T10:42:52Z

Resp3 changes response formats and we should mention that. eg. booleans are converted to true/false instead of 1/0: https://redis.io/topics/lua-api#lua-to-resp3-type-conversion

Therefore I'd schedule resp3 with another version later or support opt-out (maybe opt-in using HELLO 3 as resp2 is still the default in redis).

BREAKING CHANGE: 1. We now require Node.js v10.12.0 or newer. 2. We now only work with Redis v3.0.0 or newer. 3. `Redis` can't be called as a function anymore as it's now a class. Please change `Redis()` to `new Redis()`. Note that `Redis()` was already deprecated in the previous version.

marcbachmann · 2022-02-19T18:01:52Z

lib/Redis.ts

+    } else if (!this.stream.writable) {
+      writable = false;
+      // @ts-expect-error
+    } else if (this.stream._writableState && this.stream._writableState.ended) {


Is this still needed with node 10? 😉

marcbachmann · 2022-03-12T21:08:33Z

lib/cluster/index.ts

-      // TODO WeakMap
-      // @ts-expect-error
-      command.__is_reject_overwritten = true;
+    if (!node && !REJECT_OVERWRITTEN_COMMANDS.has(command)) {


Keep in mind that the command.promise & command.reject could get overwritten in some cases.
But at the moment it's only done in the pipeline and for that node should be present here.
It's probably good enough at the moment, but .has(command.promise) might be better.

Good point. Will think about it!

BREAKING CHANGE: `slotsRefreshInterval` is disabled by default, previously, the default value was 5000.

luin · 2022-03-14T04:53:12Z

Renamed to the main branch. Published v5.0.0-beta.1.

luin · 2022-03-14T04:54:26Z

The biggest thing I could think of for a major version would be changing the default to enableAutoPipelining: true to avoid the potential bottleneck.

Things it would affect:

select to manually select a db number (1505)

applications where failures due to networking errors are important to avoid? When not to use enableAutoPipelining? #1377 (comment)
(In practice, I assume the number of in flight commands would be low if redis is in the same local network)

Yeah I think that makes sense. Let's delay this to the next major release.

luin · 2022-03-14T05:12:23Z

Hey @marcbachmann @TysonAndre 👋 , thanks for the contributions to ioredis. I've just invited you to become collaborators on this repository. Feel free to help review new pull requests in the future if you have time (and it doesn't matter at all if you don't have time 😄). Appreciate it 🙏. You can refer to https://github.com/luin/ioredis/blob/main/.github/CONTRIBUTING.md for some notes.

luin · 2022-03-14T07:56:14Z

Why disable it by default?

Hey @shaharmor , The option at some level introduces side effects as it consumes resources, especially during a failover, that by default every 5 seconds all nodes may have to be recreated (if cluster slots gives different results). Given that, I think developers need to be aware of this option and only enable it explicitly when they are aware of its purpose. WDYT?

luin force-pushed the v5 branch 11 times, most recently from 50a4525 to f4a4c03 Compare February 6, 2022 12:30

luin force-pushed the v5 branch from f4a4c03 to dc39a10 Compare February 6, 2022 16:23

luin mentioned this pull request Feb 6, 2022

Pipeline-based script loading and retries #1499

Merged

luin force-pushed the v5 branch from dc39a10 to 28f0a75 Compare February 6, 2022 16:29

luin mentioned this pull request Feb 8, 2022

FEATURE: Add typescript declaration file output #1206

Closed

eugene1g mentioned this pull request Feb 9, 2022

Is there a plan for supporting client caching? #1161

Open

luin force-pushed the v5 branch 4 times, most recently from 0db3906 to 8649114 Compare February 19, 2022 14:33

luin force-pushed the v5 branch from 8649114 to 64a50dc Compare February 19, 2022 14:49

marcbachmann reviewed Feb 19, 2022

View reviewed changes

luin force-pushed the v5 branch from 64a50dc to 99d9371 Compare February 20, 2022 01:46

docs: do not override existing command echo

99a51f7

github-pages bot temporarily deployed to github-pages March 12, 2022 05:41 Inactive

test: make test:cluster more reliable

ee463f1

github-pages bot temporarily deployed to github-pages March 12, 2022 05:44 Inactive

feat: support defining custom commands via constructor options

65082d6

github-pages bot temporarily deployed to github-pages March 12, 2022 12:54 Inactive

refactor: use WeakMap to avoid attaching properties

b45a3e8

github-pages bot temporarily deployed to github-pages March 12, 2022 13:41 Inactive

marcbachmann mentioned this pull request Mar 12, 2022

smismember is not a function #1473

Closed

marcbachmann reviewed Mar 12, 2022

View reviewed changes

fix: remove unused Command#isCustomCommand

c8794d3

github-pages bot temporarily deployed to github-pages March 13, 2022 01:22 Inactive

refactor: clean types warnings

6cacf32

github-pages bot temporarily deployed to github-pages March 13, 2022 02:36 Inactive

github-pages bot temporarily deployed to github-pages March 13, 2022 04:04 Inactive

test: add code coverage

d4a8116

luin force-pushed the v5 branch from 4b8070e to d4a8116 Compare March 13, 2022 04:07

github-pages bot temporarily deployed to github-pages March 13, 2022 04:07 Inactive

github-pages bot temporarily deployed to github-pages March 13, 2022 04:51 Inactive

luin added 2 commits March 14, 2022 10:03

docs: add examples for Redis operations

1fdb918

fix: disable slotsRefreshInterval by default

d24676c

BREAKING CHANGE: `slotsRefreshInterval` is disabled by default, previously, the default value was 5000.

luin force-pushed the v5 branch from c504f5f to d24676c Compare March 14, 2022 03:11

github-pages bot temporarily deployed to github-pages March 14, 2022 03:11 Inactive

luin marked this pull request as ready for review March 14, 2022 03:17

luin closed this Mar 14, 2022

luin deleted the v5 branch March 14, 2022 04:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Next major version: V5 #1504

Next major version: V5 #1504

luin commented Feb 6, 2022 •

edited

Loading

AVVS commented Feb 6, 2022

AVVS commented Feb 6, 2022

luin commented Feb 6, 2022

AVVS commented Feb 6, 2022

AVVS commented Feb 6, 2022

marcbachmann commented Feb 8, 2022 •

edited

Loading

marcbachmann Feb 19, 2022 •

edited

Loading

marcbachmann Mar 12, 2022

luin Mar 14, 2022

luin commented Mar 14, 2022

luin commented Mar 14, 2022

luin commented Mar 14, 2022

luin commented Mar 14, 2022

Next major version: V5 #1504

Next major version: V5 #1504

Conversation

luin commented Feb 6, 2022 • edited Loading

AVVS commented Feb 6, 2022

AVVS commented Feb 6, 2022

luin commented Feb 6, 2022

AVVS commented Feb 6, 2022

AVVS commented Feb 6, 2022

marcbachmann commented Feb 8, 2022 • edited Loading

marcbachmann Feb 19, 2022 • edited Loading

Choose a reason for hiding this comment

marcbachmann Mar 12, 2022

Choose a reason for hiding this comment

luin Mar 14, 2022

Choose a reason for hiding this comment

luin commented Mar 14, 2022

luin commented Mar 14, 2022

luin commented Mar 14, 2022

luin commented Mar 14, 2022

luin commented Feb 6, 2022 •

edited

Loading

marcbachmann commented Feb 8, 2022 •

edited

Loading

marcbachmann Feb 19, 2022 •

edited

Loading