Skip to content

DOC-6836 Rename resolveCredentials() to resolveCredentialsAsync() in Lettuce AMR docs [PARKED]#3623

Open
andy-stark-redis wants to merge 1 commit into
mainfrom
DOC-6836-lettuce-credentials-provider-migration-pr-3837-3838
Open

DOC-6836 Rename resolveCredentials() to resolveCredentialsAsync() in Lettuce AMR docs [PARKED]#3623
andy-stark-redis wants to merge 1 commit into
mainfrom
DOC-6836-lettuce-credentials-provider-migration-pr-3837-3838

Conversation

@andy-stark-redis

@andy-stark-redis andy-stark-redis commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Updates the Lettuce Azure Managed Redis (AMR) / Entra ID auth page for the upcoming
credential-provider SPI rename in Lettuce: RedisCredentialsProvider
CredentialsProvider, and its resolveCredentials() method → resolveCredentialsAsync().
Two call sites in amr.md are updated to the new
async name.

⚠️ DO NOT MERGE YET. This is written against unmerged upstream PRs
(redis/lettuce#3838,
#3829,
#3837) that currently target a
feature/reactor-optional-1 branch, not main. The rename only reaches our readers once
the separate redis-authx-entraid artifact rebuilds against the new Lettuce SPI and
releases. Merging now would leave the page documenting a method name that no released
artifact exposes. Pick up with /pickup <this PR> when the trigger fires.

Park manifest

Ticket: DOC-6836
Parked at: 2026-07-13
Trigger to pick up: redis-authx-entraid publishes a release (tag > v0.1.1-beta2) whose
TokenBasedRedisCredentialsProvider exposes resolveCredentialsAsync() — i.e. it has adopted
the renamed Lettuce SPI. (Precursor: the Lettuce PRs below merge to main and ship in a Lettuce release.)
Labels: parked, do not merge yet

Pinned sources (state observed at park time)

Source State @ park (2026-07-13) Re-fetch
lettuce#3838 — "Remove RedisCredentialsProvider and promote CredentialsProvider as primary" open, not merged; base feature/reactor-optional-1; head 625a413; milestone none; updated 2026-07-13 gh api repos/redis/lettuce/pulls/3838 --jq '{state,merged,head_sha:.head.sha,base:.base.ref,milestone:.milestone.title,updated_at}'
lettuce#3829 — "Make clean transition from reactive to async credentials provider" open, not merged; base feature/reactor-optional-1; head f558dbb; milestone none; updated 2026-07-09 gh api repos/redis/lettuce/pulls/3829 --jq '{state,merged,head_sha:.head.sha,base:.base.ref,milestone:.milestone.title,updated_at}'
lettuce#3837 — "Deprecate RedisCredentialsProvider interface in favor of CredentialsProvider" open, not merged; base main; head b8b2a25; milestone none; updated 2026-07-13 gh api repos/redis/lettuce/pulls/3837 --jq '{state,merged,head_sha:.head.sha,base:.base.ref,milestone:.milestone.title,updated_at}'
jvm-redis-authx-entraid — the artifact our page actually pins no formal releases; latest tag v0.1.1-beta2; page pins 0.1.1-beta1 (still exposes resolveCredentials()) gh api repos/redis/jvm-redis-authx-entraid/tags --jq '.[0:5][].name'

Observed shape the page assumes (confidence: LOW)

  • The credential-provider SPI method is renamed resolveCredentials()resolveCredentialsAsync()
    (return type unchanged: CompletionStage<RedisCredentials> / reactive Mono chain still .doOnNext(...).block()).
    LOW — taken from the unmerged #3838 diff against a feature branch, not a released artifact.
  • TokenBasedRedisCredentialsProvider (the class our page uses) keeps its name; only its
    method is renamed. LOW — same source; the class in the diff lives in Lettuce core
    (io.lettuce.authx), whereas our page consumes it from the separate redis-authx-entraid
    package (redis.clients.authentication). The rename must propagate across that repo boundary
    before it's real for us; that propagation is unverified.
  • Three overlapping PRs with divergent verbs (#3837 deprecate on main, #3838 remove on
    the feature branch): the end-state exposed to users — remove vs. deprecate-with-alias — is not
    yet settled.

Re-check checklist

  • (highest risk) Confirm which redis-authx-entraid release exposes resolveCredentialsAsync(), and bump the pinned version at amr.md lines ~43 and ~51 (currently 0.1.1-beta1) to match. The page is intentionally inconsistent while parked — new method name, old version.
  • Confirm the method rename resolveCredentials()resolveCredentialsAsync() actually landed (not renamed again, e.g. resolveAsync()), and that the return-type / .doOnNext(...).block() usage in the two snippets still compiles.
  • Determine whether resolveCredentials() survives as a deprecated alias (#3837 "deprecate") or is removed (#3838 "remove"). If it survives, our edit is preferred-not-required and there's no reader-facing break — note this in the finalize commit.
  • Confirm TokenBasedRedisCredentialsProvider (and EntraIDTokenAuthConfigBuilder) class names are unchanged in the released artifact; the page uses them ~10 times.
  • Sweep the rest of content/develop/clients/lettuce/ for any newly-relevant SPI mentions (CredentialsProvider, subscribeToCredentials, supportsStreaming) introduced by the wider "reactor-optional" refactor — none today, but the umbrella change is broad.

On pickup, then

When the trigger fires, run /pickup <this PR>: it re-fetches each pinned source, diffs it
against the snapshots above, reconciles the docs, and takes the PR through the normal
/reflect/finalize pipeline to merge. The do not merge yet guard holds until
/finalize completes.


Note

Low Risk
Documentation-only renames in example snippets with no runtime or security impact; merge timing depends on matching released client APIs.

Overview
Updates the Lettuce Azure Managed Redis (AMR) / Entra ID page so sample code matches the upcoming Lettuce credential-provider SPI rename: resolveCredentials()resolveCredentialsAsync().

Both Java snippets in amr.md are touched—the standalone “test credentials” example and the commented optional test in the full connection sample. The reactive chain (.doOnNext(...).block()) is unchanged.

Note: The PR description marks this as parked until redis-authx-entraid ships against the new SPI; the doc still pins dependency version 0.1.1-beta1, so method names and artifact version may be intentionally out of sync until pickup.

Reviewed by Cursor Bugbot for commit 2d032d8. Bugbot is set up for automated code reviews on this repo. Configure here.

…Lettuce AMR docs

Lettuce PRs #3837/#3829/#3838 rename the credential-provider SPI: the
RedisCredentialsProvider interface becomes CredentialsProvider and its
resolveCredentials() method becomes resolveCredentialsAsync(). Updated the two
call sites in the Entra ID / AMR page (one live snippet, one commented-out test
line) to the new async name.

Written against unmerged upstream diffs that target a "reactor-optional" feature
branch, not main, so this is provisional. Parking until the rename actually ships
in a released redis-authx-entraid artifact. The subtlety: our page uses
redis-authx-entraid's TokenBasedRedisCredentialsProvider, not the lettuce-core
class the PR diff edits, so the rename only reaches our readers once that separate
artifact rebuilds against the new lettuce SPI and releases.

Learned: the rename is a lettuce-core SPI change; it only affects our docs once redis-authx-entraid adopts the new lettuce and re-releases
Recheck: when redis-authx-entraid releases a version whose TokenBasedRedisCredentialsProvider exposes resolveCredentialsAsync()
Gaps: pinned redis-authx-entraid version left at 0.1.1-beta1 (lines 43/51) — page is intentionally inconsistent while parked; bump to the release that ships the rename on pickup
Gaps: unverified whether resolveCredentials() survives as a deprecated alias (#3837 "deprecate" vs #3838 "remove") — if it does, our edit is preferred not strictly required
Directive: do not merge until the rename ships in a released artifact AND the dependency version on this page is bumped to match
Ticket: DOC-6836
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@andy-stark-redis andy-stark-redis added do not merge yet parked PR speculatively added based on pre-release info. Check validity when release goes ahead. labels Jul 13, 2026
@github-actions

github-actions Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

DOC-6836

@github-actions

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do not merge yet parked PR speculatively added based on pre-release info. Check validity when release goes ahead.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant