feat(xray): merge user-provided API services instead of overwriting#60
Open
Multi-Engineer-dev wants to merge 5 commits into
Open
feat(xray): merge user-provided API services instead of overwriting#60Multi-Engineer-dev wants to merge 5 commits into
Multi-Engineer-dev wants to merge 5 commits into
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
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.
What
Config.ApplyAPIpreviously hard-coded the Xray gRPC API services toHandlerService,LoggerService,StatsServiceand discarded anything set onapi.services. It now merges the node's required services with any validuser-provided extras instead of overwriting them.
Why
Operators want to enable optional Xray API services (e.g.
RoutingService,ObservatoryService) from their core config. The node needsHandlerService/StatsServicefor user and traffic management andLoggerServicefor currentbehavior, so those stay mandatory — but extras should be honored rather than
silently dropped.
How
sanitizeAPIServices: starts from the required set, then appends validuser extras canonicalized against an allowlist mirrored from xray-core
(
infra/conf/api.go), deduped case-insensitively, and sorted fordeterministic output.
the backend, consistent with the rest of
ApplyAPI's defensive normalization.api.listenis intentionally left empty: the API is exposed only via theloopback, source-restricted
API_INBOUND. Honoring a user-supplied listenwould open a second, unguarded gRPC entry point.
TestSanitizeAPIServicespins the expected names so drift breaks the testdeliberately.
Tests
backend/xray/config_test.go: merging valid extras, dedupe, droppingunknowns, and that a config with no
apisection still yields exactly therequired services.
make testpasses locally.Related
Backend half of the Xray API services feature. The dashboard UI that lets
operators select these optional services lives in Panel PR 662.