Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Core] Retryable grpc client #47981

Open
wants to merge 35 commits into
base: master
Choose a base branch
from
Open

Conversation

jjyao
Copy link
Collaborator

@jjyao jjyao commented Oct 10, 2024

Why are these changes needed?

Currently gcs_rpc_client has retries for gcs rpc calls and this PR moves the retry functionality to RetryableGrpcClient so that it can be used by non-gcs rpc client (e.g. core worker client).

Also enable retry for ReportGeneratorItemReturns rpc since it's idempotent.

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

Signed-off-by: Jiajun Yao <[email protected]>
@jjyao jjyao added the go add ONLY when ready to merge, run all tests label Oct 11, 2024
Signed-off-by: Jiajun Yao <[email protected]>
Signed-off-by: Jiajun Yao <[email protected]>
Signed-off-by: Jiajun Yao <[email protected]>
Signed-off-by: Jiajun Yao <[email protected]>
Signed-off-by: Jiajun Yao <[email protected]>
src/ray/rpc/retryable_grpc_client.h Outdated Show resolved Hide resolved
src/ray/rpc/retryable_grpc_client.h Outdated Show resolved Hide resolved
src/ray/rpc/retryable_grpc_client.h Outdated Show resolved Hide resolved
src/ray/rpc/retryable_grpc_client.h Outdated Show resolved Hide resolved
src/ray/rpc/worker/core_worker_client.h Outdated Show resolved Hide resolved
src/ray/rpc/worker/core_worker_client.h Outdated Show resolved Hide resolved
src/ray/rpc/worker/core_worker_client.h Outdated Show resolved Hide resolved
@jjyao jjyao marked this pull request as ready for review October 19, 2024 04:26
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao jjyao requested a review from rynewang October 19, 2024 04:37
@jjyao jjyao assigned jjyao and rynewang and unassigned rkooo567, rynewang and jjyao Oct 28, 2024
grpc_client->template CallMethod<Request, Reply>(
prepare_async_function,
request,
[weak_retryable_grpc_client, retryable_grpc_request, callback](
Copy link
Contributor

Choose a reason for hiding this comment

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

Same here, a lot of the captured variables should be moved, no need for copy.


RAY_CHECK(server_unavailable_timeout_time_.has_value());

auto status = channel_->GetState(false);
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a comment what is false.

Signed-off-by: Jiajun Yao <[email protected]>
* Status::TimedOut. If the whole client does not reconnect within
* server_unavailable_timeout_seconds, server_unavailable_timeout_callback is invoked.
*
* When all callers of the client release the shared_ptr of the client, the client
Copy link
Contributor

Choose a reason for hiding this comment

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

since the destruction logic is the same across all callsites, dtor is better than deleter

Signed-off-by: Jiajun Yao <[email protected]>
@@ -763,7 +791,11 @@ void CoreWorker::Shutdown() {

// Now that gcs_client is not used within io service, we can reset the pointer and clean
// it up.
gcs_client_.reset();
if (gcs_client_) {
Copy link
Contributor

@dentiny dentiny Nov 23, 2024

Choose a reason for hiding this comment

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

If I were you, I would place the disconnection logic into gcs_client_'s deleter.
The benefit of which is: we keep invariant when gcs client is valid, connection is guaranteed to be valid.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'll leave it for a separate PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

If you plan to do that, maybe leave a TODO in case we forget?
Feel free to leave it under my name.

@jjyao jjyao assigned jjyao and unassigned rynewang Nov 25, 2024
@@ -321,6 +321,10 @@ struct GcsServerMocker {
drain_raylet_callbacks.push_back(callback);
};

void IsLocalWorkerDead(
Copy link
Contributor

Choose a reason for hiding this comment

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

This class should be named as Fake, not Mock...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This PR is already big. Let's do these cleanups in a separate PR.

Copy link
Contributor

@dentiny dentiny left a comment

Choose a reason for hiding this comment

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

Chatted offline, most of my prev comments are caused by the wide-spread usage of shared pointer... Let's proceed, I will take another look

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
go add ONLY when ready to merge, run all tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants