xds: a myriad of cleanups #4479

dfawley · 2021-05-21T23:24:36Z

The first commit is branched from #4476

mv xds/internal/client xds/internal/xdsclient
- most import aliased to xdsclient; those that didn't were confusing. Some double imported because of this (cdsbalancer_test.go and eds_impl_test.go, maybe others).
remove Interface from the names of some interfaces. Types aren't supposed to be named by their types, generally.
standardize xds balancer receivers to b
standardize xds balancer xds client field names to xdsClient (was: xdsC or client in some)
made balancer builders that didn't have fields register by value instead of pointer; removed receiver vars

RELEASE NOTES: none

sergiitk · 2021-05-26T15:30:53Z

I love this title.

menghanl · 2021-06-03T04:25:27Z

xds/internal/balancer/cdsbalancer/cdsbalancer.go

@@ -408,9 +409,6 @@ func (b *cdsBalancer) run() {
 				b.edsLB.Close()
 				b.edsLB = nil
 			}
-			if newXDSClient != nil {


Is this an intended change, or merge conflict?

I think I know why this change is here.

I would say don't make this change, or at least, don't mix it in this XL PR.

And it's an incomplete test cleanup. It leaves the balancers in an inconsistent state (if the balancer creates the client, it should call close, even though we know close is a noop)

And it only changes the easy part, but leaves the hard part behind. We should modify the tests to use attributes to pass the fake xDS client, so we can completely get rid of newXDSClient.
But that's going to be a semi big change, it requires changing signature of xds.SetClient() to take an interface instead of *Client, so it can be the fakeClient.

I will make it, I need it to fix the tests in my other PR.

And it's an incomplete test cleanup. It leaves the balancers in an inconsistent state (if the balancer creates the client, it should call close, even though we know close is a noop)

It's for tests only, so I don't think it's important to call Close only for tests, which don't need it to be called. Many types don't need a Close method to be called when they're done being used. Our xdsClient interface is one of those.

You could also consider this half of the cleanup (removing the method from the interface and the call to it in b.Close), with the other half being changing how it's injected. I can add all this back if you want, but I do see it as a step in the right direction.

I still think this doesn't give us enough benefit, to justify itself.
At least should not be mixed in a 84-file (trivial) change PR.
This diff really stick out when I was scanning the changes.

menghanl · 2021-06-03T04:29:45Z

xds/internal/balancer/edsbalancer/eds.go

-			x.edsImpl.updateState(u.priority, u.s)
-		case <-x.closed.Done():
-			x.cancelWatch()
-			if newXDSClient != nil {


Is this intended?

menghanl · 2021-06-03T04:35:13Z

xds/internal/balancer/lrs/balancer.go

@@ -256,7 +255,4 @@ func (w *xdsClientWrapper) close() {
 		w.cancelLoadReport()
 		w.cancelLoadReport = nil
 	}
-	if newXDSClient != nil {
-		w.c.Close()


menghanl · 2021-06-03T04:57:26Z

xds/internal/testutils/fakeclient/client.go

-
-// WaitForClose waits for Close to be invoked on this client and returns
-// context.DeadlineExceeded otherwise.
-func (xdsC *Client) WaitForClose(ctx context.Context) error {


This isn't right.

The actual question is, why is this method not used in any tests (it should be all the tests, but not only the resolver tests would matter).

The right fix is to call and check for this in the xds resolver tests, not to delete this.

The actual question is, why is this method not used in any tests (it should be all the tests, but not only the resolver tests would matter).

I had assumed this was once here for some kind of synchronization, then the usage was removed because it wasn't necessary.

This doesn't seem like the right way to test that the resolver closes the client. We should be ensuring that by the time xdsResolver.Close() returns, xdsClient.Close() has been called -- not "block until it happens".

I can add this test case in another PR immediately after this if you want.

Same as the other comment. This change should be moved to the other PR.

I'll just close this PR and open a series of other PRs, one for each change.

menghanl · 2021-06-03T05:01:46Z

xds/internal/balancer/clusterimpl/clusterimpl.go

 	}
-	if newXDSClient != nil {


This is same as the others.

dfawley added Type: Internal Cleanup Refactors, etc no release notes labels May 21, 2021

dfawley changed the title ~~xds: add test-only injection of xds config to client and server~~ xds: a myriad of cleanups May 21, 2021

dfawley force-pushed the cleanups branch 2 times, most recently from 21296fb to d6f1d66 Compare May 21, 2021 23:30

dfawley added the Status: Blocked label May 26, 2021

dfawley mentioned this pull request May 26, 2021

xds: add test-only injection of xds config to client and server #4476

Merged

dfawley requested a review from menghanl June 2, 2021 17:48

dfawley assigned menghanl Jun 2, 2021

dfawley added this to the 1.39 Release milestone Jun 2, 2021

xds: a myriad of cleanups

b694b71

dfawley force-pushed the cleanups branch from d6f1d66 to b694b71 Compare June 2, 2021 21:42

menghanl suggested changes Jun 3, 2021

View reviewed changes

xds/internal/balancer/clusterimpl/clusterimpl.go

}

if newXDSClient != nil {

Copy link

Contributor

menghanl Jun 3, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is same as the others.

menghanl assigned dfawley and unassigned menghanl Jun 3, 2021

dfawley assigned menghanl and unassigned dfawley Jun 3, 2021

dfawley mentioned this pull request Jun 3, 2021

xds/resolver: test xds client closed by resolver Close #4509

Merged

dfawley removed the Status: Blocked label Jun 3, 2021

menghanl assigned dfawley and unassigned menghanl Jun 3, 2021

dfawley closed this Jun 3, 2021

dfawley mentioned this pull request Jun 3, 2021

cleanup: remove "Interface" as suffix of (almost all) interface names #4512

Merged

dfawley deleted the cleanups branch June 9, 2021 16:53

github-actions bot locked as resolved and limited conversation to collaborators Dec 7, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

xds: a myriad of cleanups #4479

xds: a myriad of cleanups #4479

dfawley commented May 21, 2021 •

edited

Loading

sergiitk commented May 26, 2021

menghanl Jun 3, 2021

menghanl Jun 3, 2021 •

edited

Loading

dfawley Jun 3, 2021

menghanl Jun 3, 2021

menghanl Jun 3, 2021

menghanl Jun 3, 2021

menghanl Jun 3, 2021

menghanl Jun 3, 2021

dfawley Jun 3, 2021

dfawley Jun 3, 2021

menghanl Jun 3, 2021

dfawley Jun 3, 2021

menghanl Jun 3, 2021

xds: a myriad of cleanups #4479

xds: a myriad of cleanups #4479

Conversation

dfawley commented May 21, 2021 • edited Loading

sergiitk commented May 26, 2021

Choose a reason for hiding this comment

menghanl Jun 3, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dfawley commented May 21, 2021 •

edited

Loading

menghanl Jun 3, 2021 •

edited

Loading