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.

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

Jump to bottom

Clarify RxJava 3+ support #66

Merged
merged 1 commit into from
Nov 6, 2019
Merged

Clarify RxJava 3+ support #66

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ Although BlockHound supports [the SPI mechanism to integrate with](https://githu
1. [Project Reactor](https://projectreactor.io)
Version 3.2.x is supported out of the box.
Starting with `reactor-core` version 3.3.0, there is [a built-in integration in Reactor itself](https://github.com/reactor/reactor-core/blob/v3.3.0.RELEASE/reactor-core/src/main/java/reactor/core/scheduler/ReactorBlockHoundIntegration.java) that uses [the SPI](https://github.com/reactor/BlockHound/blob/master/docs/custom_integrations.md).
2. [RxJava 2](https://github.com/ReactiveX/RxJava/)
2. [RxJava 2](https://github.com/ReactiveX/RxJava/) is supported.
RxJava 3 and further versions of RxJava will require an SPI to be implemented, either by the framework or user. See [this PR to RxJava](https://github.com/ReactiveX/RxJava/pull/6692) with an example of the SPI's implementation.
Copy link

Choose a reason for hiding this comment

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

I think this is a little misleading and implies RxJava itself needs to implement an SPI. Blockhound could offer an extension artifact for rx3 too

Copy link
Contributor Author

@bsideup bsideup Nov 4, 2020 •
edited by ericbottard
Loading

Choose a reason for hiding this comment

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

BlockHound team has no intention of implementing nor maintaining the extension for RxJava3. One of the reasons is a need to work with internal implementation details of the framework that may change.
Even Reactor's integration lives in reactor-core, not BlockHound.

If Netty, Kotlin Coroutines and a few more projects were able to implement the SPI, I see no reason why RxJava should not do the same.

Copy link

Choose a reason for hiding this comment

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

You're still implying in the wording here that it requires rxjava to implement something in order for it to work, which isn't true. Not every project is willing to add dependencies, rxjava is historically focused on having zero dependencies.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

rxjava is historically focused on having zero dependencies.

As well as Netty.
But, implementing SPI does not require having BlockHound as a dependency - it can be optional or compileOnly.

Also, anyone can integrate BlockHound with RxJava in their project, as per the docs:
https://github.com/reactor/BlockHound/blob/master/docs/custom_integrations.md

Copy link

Choose a reason for hiding this comment

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

Yes. My point is that the line I commented on here is ambiguous and implies that RxJava requires a change to be implemented first

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It doesn't. It explicitly states "an SPI to be implemented, either by the framework or user". It does not say that RxJava needs to do anything on its side to make the detection work.

It would be better if they accepted my PR, so that BlockHound is supported OOTB by RxJava (similar to Kotlin, Netty and other libraries that integrated with BlockHound), but, if the maintainers of RxJava don't want to, it is up to their users to integrate, either in their projects or by working on a 3rd party library that with glue both.


# Quick Start
See [the docs](./docs/README.md).
Expand Down