docs(proxy): explain the cross-proxy architecture and how to consume it#11
Merged
Conversation
The repo that carries the whole cross-proxy design had no README, and its entry point — ProxyServiceRegistry — had no KDoc at all. Someone debugging "/msg says the player isn't online" at 3am had nowhere to start. Documents what ProxyService answers (and from where), how the pieces fit together, why presence lives in service-player rather than in a registry inside the proxies, and the two rules that fail silently: never shade plugin-proxy-api, and declare the plugin dependency. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01E92vTegZqXd2HqjE7jnDJz
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This repo carries the whole cross-proxy design and had no README, while its entry point —
ProxyServiceRegistry— had no KDoc at all. Someone debugging "/msg says the player isn't online" at 3am had nowhere to start.Adds:
ProxyServiceanswers and from where (local vs. network, a table per method), how plugin-proxy / plugin-player / service-player fit together, the NATS subjects, the env vars, and why presence lives in service-player rather than in a registry inside the proxies (two stores with independent TTLs drift; chat's earlier event-only registry had no memory at all, because core NATS does not replay).ProxyServiceRegistry, including the two rules that fail silently: never shadeplugin-proxy-api(you get your own registry class, a different map nobody writes into — every lookup returns null and cross-proxy degrades to local-only without one error in the log), and declare the plugin dependency so init order is right.PlayerPresence— what emptyproxyId/servermean, and whyjoinedAtis 0 for local players.No behaviour change.
🤖 Generated with Claude Code
https://claude.ai/code/session_01E92vTegZqXd2HqjE7jnDJz