xds: add internal ResourceNameFunc server option by ran-su · Pull Request #9288 · grpc/grpc-go

ran-su · 2026-08-03T21:51:46Z

Adds an internal ResourceNameFunc server option that allows override the LDS listener resource name.

RELEASE NOTES: none

codecov · 2026-08-03T21:55:59Z

Codecov Report

❌ Patch coverage is 91.11111% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 83.08%. Comparing base (a620350) to head (e9b5060).
⚠️ Report is 28 commits behind head on master.

Files with missing lines	Patch %	Lines
xds/server.go	82.60%	4 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #9288      +/-   ##
==========================================
+ Coverage   83.00%   83.08%   +0.08%     
==========================================
  Files         422      424       +2     
  Lines       35085    35252     +167     
==========================================
+ Hits        29121    29289     +168     
- Misses       4441     4448       +7     
+ Partials     1523     1515       -8

Files with missing lines	Coverage Δ
internal/xds/server/server_options.go	`100.00% <100.00%> (ø)`
xds/server_options.go	`100.00% <100.00%> (ø)`
xds/server.go	`82.55% <82.60%> (ø)`

... and 59 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Introduces `ResourceNameFunc` callback option to `NewGRPCServer` for overriding server listener resource name generation. Exposes `UnderlyingServer()` method to retrieve the inner target server for chaining.

eshitachandwani · 2026-08-12T19:37:23Z

+//
+// Notice: This API is EXPERIMENTAL and may be changed or removed in a
+// later release.
+func ResourceNameFunc(f func(net.Addr) string) grpc.ServerOption {


Instead of providing an option for anyone to change the listener resource name for server, we only want it to be internal, so we have a few options here :

Move the ResourceNameFunc option to an internal package.

Pass a listener to the Serve method which has a function for the override and we can define an interface for it (or do it inline) and type check if the listener implements that interface , if it does, we use the provided function for populating the listener name.

Have a variable function , something like var CustomResourceTemplatePopulator func(template, target string) string inside a internal package , like internal/xds/bootstrap.

Then PopulateResourceTemplate can check if the variable is not nil, return the CustomResourceTemplatePopulator

For the cfg.ServerListenerResourceNameTemplate() == "" , we can do the check if CustomResourceTemplatePopulator is nil.

WDYT ?

Thanks, I think option 1 works better for us. I moved ResourceNameFunc to internal/xds/server as an internal grpc.ServerOption. We do want to keep the resource name override per-server and avoid changing the xds bootstrap as bootstrap could be shared. I also updated the test.

eshitachandwani · 2026-08-12T19:38:20Z

+//
+// Notice: This API is EXPERIMENTAL and may be changed or removed in a
+// later release.
+func (s *GRPCServer) UnderlyingServer() *grpc.Server {


We should hold of on exposing the underlying server until we have a discussion and reach a conclusion on the best way to achieve this.

I moved underlying server part out of this PR. We can continue discuss and explore other options without blocking review/submission the resource name part.

eshitachandwani

LGTM modulo 2 comments. Adding @easwars for a second review.

eshitachandwani · 2026-08-18T12:59:38Z

 type serverOptions struct {
 	modeCallback         ServingModeCallbackFunc
 	clientPoolForTesting *xdsclient.Pool
+	resourceNameFunc     func(net.Addr) string


Can we change this resourceNameFunc variable here too...and everywhere else?

eshitachandwani · 2026-08-18T13:00:26Z

+// OverrideListenerResourceNameFromServerOption returns the resource name
+// function carried by opt, if opt was created by OverrideListenerResourceName.
+func OverrideListenerResourceNameFromServerOption(opt grpc.ServerOption) (func(net.Addr) string, bool) {
+	o, ok := opt.(*overrideListenerResourceNameOption)


Can we change this to just return func(net.Addr) string and the user can check for nil value instead of returning an extra bool. WDYT ?

easwars · 2026-08-18T21:22:46Z

 type serverOptions struct {
-	modeCallback         ServingModeCallbackFunc
-	clientPoolForTesting *xdsclient.Pool
+	modeCallback                 ServingModeCallbackFunc
+	clientPoolForTesting         *xdsclient.Pool
+	overrideListenerResourceName func(net.Addr) string
 }


How about we move this whole struct to internal/xds/server? What this would mean is that the existing public server options' implementation would modify this ServerOptions struct defined in the internal package.

This would also unify the handling in xds/server.go where you currently have separate handling for the public server options and the newly added internal server option.

I made some changes. Could you please take a look and see if I understand it correctly? Thanks

xds: add ResourceNameFunc server option and UnderlyingServer method

5c0a214

Introduces `ResourceNameFunc` callback option to `NewGRPCServer` for overriding server listener resource name generation. Exposes `UnderlyingServer()` method to retrieve the inner target server for chaining.

ran-su force-pushed the xds-server-resource-name-func branch from 726a5b4 to 5c0a214 Compare August 3, 2026 21:56

easwars assigned eshitachandwani Aug 4, 2026

easwars added Area: xDS Includes everything xDS related, including LB policies used with xDS. Type: Feature New features or improvements in behavior labels Aug 4, 2026

easwars added this to the 1.84 Release milestone Aug 4, 2026

eshitachandwani self-requested a review August 12, 2026 16:06

eshitachandwani reviewed Aug 12, 2026

View reviewed changes

eshitachandwani assigned ran-su and unassigned eshitachandwani Aug 12, 2026

eshitachandwani added Status: Requires Reporter Clarification and removed Status: Requires Reporter Clarification labels Aug 12, 2026

ran-su added 2 commits August 15, 2026 19:30

xds: make ResourceNameFunc an internal option

0c20730

xds: remove UnderlyingServer

7cb4ac1

ran-su changed the title ~~xds: add ResourceNameFunc server option and UnderlyingServer method~~ xds: add internal ResourceNameFunc server option Aug 16, 2026

eshitachandwani reviewed Aug 17, 2026

View reviewed changes

Comment thread internal/xds/server/server_options.go Outdated

Comment thread xds/server_test.go Outdated

Comment thread xds/server_test.go Outdated

Comment thread xds/server_test.go

eshitachandwani assigned eshitachandwani and ran-su and unassigned ran-su and eshitachandwani Aug 17, 2026

xds: address listener resource name review comments

030ae4e

eshitachandwani modified the milestones: 1.84 Release, 1.85 Release Aug 18, 2026

eshitachandwani assigned eshitachandwani and unassigned ran-su Aug 18, 2026

eshitachandwani approved these changes Aug 18, 2026

View reviewed changes

eshitachandwani assigned ran-su and unassigned eshitachandwani Aug 18, 2026

eshitachandwani requested a review from easwars August 18, 2026 13:02

simplify listener resource name override option

40bf6d9

eshitachandwani assigned easwars and unassigned ran-su Aug 18, 2026

easwars reviewed Aug 18, 2026

View reviewed changes

easwars assigned ran-su and unassigned easwars Aug 18, 2026

easwars added the Status: Requires Reporter Clarification label Aug 18, 2026

ran-su added 2 commits August 18, 2026 20:02

xds: unify server option handling

214a6f9

xds: fix server options lint naming

e9b5060

eshitachandwani requested a review from easwars August 19, 2026 08:10

eshitachandwani assigned easwars and unassigned ran-su Aug 19, 2026

eshitachandwani removed the Status: Requires Reporter Clarification label Aug 19, 2026

Uh oh!

Conversation

ran-su commented Aug 3, 2026 • edited by easwars Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov Bot commented Aug 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

eshitachandwani Aug 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eshitachandwani left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ran-su commented Aug 3, 2026 •

edited by easwars

Loading

codecov Bot commented Aug 3, 2026 •

edited

Loading

eshitachandwani Aug 12, 2026 •

edited

Loading