Skip to content
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.

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

Add ioredis to problematic-modules.md #430

Closed
wants to merge 1 commit into from

Conversation

cupofjoakim
Copy link

No description provided.

Copy link
Member

@Qard Qard left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm...this doc really needs a review, actually. A few things in there I'm fairly certain are working at this point, and AsyncHooks now exists in all supported Node.js versions so the leading paragraphs are inaccurate. 🤔

Anyway, this change LGTM.

Copy link
Member

@RafaelGSS RafaelGSS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@mmarchini
Copy link
Contributor

mmarchini commented Sep 15, 2020

Woah I had no idea we have had that list. that list seems pretty, uhm, problematic (😅)? At least with the wording used, especially in the file name. Honestly I don't think we should have a list unless we're committed to work with package authors to improve the situation. And if we decide to have a list, it should be triaged often and we should have links/examples showing how the library is problematic/breaks async continuity.

@mmarchini
Copy link
Contributor

Added to the agenda so we can discuss what to do with this list

@RafaelGSS
Copy link
Member

RafaelGSS commented Sep 15, 2020

Honestly I don't think we should have a list unless we're committed to work with package authors to improve the situation.

Indeed +1.

@cupofjoakim
Copy link
Author

@mmarchini It's nice that you added it to the agenda, especially since the comments gathered here is more about the existence of the doc than the change.

As a user in the enterprise world with hard requirements that in turn forces us to use async_hooks, there's a huge value in having the document as we often won't see the issues before we're in production. Too bad it's not being actively maintained though - I guess it's better not to have it than having it unmaintained.

@Flarna
Copy link
Member

Flarna commented Sep 15, 2020

I agree that we should remove the list.
By the way, if we keep it we should also add Nodejs 12 and 10...

@@ -18,3 +18,4 @@ Module | Embedder API | Note
[generic-pool](https://github.com/coopernurse/node-pool) | No | Used by a lot of database modules like for instance "pg"
[mongoose](https://github.com/Automattic/mongoose/) | [#5929](https://github.com/Automattic/mongoose/issues/5929) | Most popular MongoDB ORM/ODM that implements its own user-land queueing.
[graphql-subscriptions](https://github.com/apollographql/graphql-subscriptions/blob/26ed503566ecfab086e7530f0daf12b60ee3049c/src/pubsub-async-iterator.ts) | No | De-facto standard for working with GraphQL subscriptions. Custom queueing via an async iterator written in TypeScript and compiled down to ES5.
[ioredis](https://github.com/luin/ioredis) | No | The only commonly used redis client with support for sentinels
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As a question is the other widely used redis package problematic (https://www.npmjs.com/package/redis) as well ?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mhdawson I have no idea actually. It doesn't support sentinels, so I can't really try it out at work.

@mmarchini
Copy link
Contributor

As decided in the meeting we'll remove this file and create separate issues for each module that breaks async continuity, so we can work with module maintainers to fix it.

@cupofjoakim
Copy link
Author

@mmarchini I understand! What does that mean for this PR? Should I close it?

@mmarchini
Copy link
Contributor

Keep it open, we can close it once the issues are created (will try to get it done this week)

@mmarchini
Copy link
Contributor

Issues created for all modules in the file (plus this one): https://github.com/nodejs/diagnostics/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Aasync-continuity

I'll close this PR and remove the file now. @cupofjoakim thank you for bringing it to our attention!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants