micronaut-projects / micronaut-projects/micronaut-rxjava3

Document examples of how to use the PropagatedContext API with RxJava

Open
#336 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: docs type: improvement
Dominant language
Java
Stars
5
Forks
4
Avg merge
3h 36m
Merged PRs (30d)
8

Description

Issue description

We are doing what we can to pass any available values in the PropagatedContext along to RxJava flows, but the ability to do so automatically for all cases is limited due to RxJava not having integrated support for the Micrometer Context Propagation SPI. There are inevitably going to be some cases where a user of RxJava with Micronaut may need to directly use the PropagatedContext API if they want context values to be available within their reactive flow. Some general documentation examples should be provided that shows how to do this, and some more general tests exercising these techniques should be added to the module.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the RxJava 3 integration module and the PropagatedContext API usage points. Add general documentation examples showing direct context use in reactive flows, then add module tests exercising those techniques. Done means the examples cover the intended cases and the new tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation, testing
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.