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.

Sign up for GitHub

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

Jump to bottom

Split client construction and connection validation #422

Merged
merged 9 commits into from
Jun 2, 2023
Merged

Split client construction and connection validation #422

merged 9 commits into from
Jun 2, 2023

Conversation

flyingsilverfin
Copy link
Member

@flyingsilverfin flyingsilverfin commented Jun 2, 2023 •
edited
Loading

What is the goal of this PR?

To prevent null pointer errors during failover tasks being executed, we go back to the previous model of first creating a client, then opening and validating the connection.

What are the changes implemented in this PR?

  • Split client constructor and client opening internally, so that cluster-server-client can be retained and opened even if the connection is not available at the time.

@typedb-bot
Copy link
Member

typedb-bot commented Jun 2, 2023 •
edited by flyingsilverfin
Loading

PR Review Checklist

Do not edit the content of this comment. The PR reviewer should simply update this comment by ticking each review item below, as they get completed.

Trivial Change

  • This change is trivial and does not require a code or architecture review.

Code

  • Packages, classes, and methods have a single domain of responsibility.
  • Packages, classes, and methods are grouped into cohesive and consistent domain model.
  • The code is canonical and the minimum required to achieve the goal.
  • Modules, libraries, and APIs are easy to use, robust (foolproof and not errorprone), and tested.
  • Logic and naming has clear narrative that communicates the accurate intent and responsibility of each module (e.g. method, class, etc.).
  • The code is algorithmically efficient and scalable for the whole application.

Architecture

  • Any required refactoring is completed, and the architecture does not introduce technical debt incidentally.
  • Any required build and release automations are updated and/or implemented.
  • Any new components follows a consistent style with respect to the pre-existing codebase.
  • The architecture intuitively reflects the application domain, and is easy to understand.
  • The architecture has a well-defined hierarchy of encapsulated components.
  • The architecture is extensible and scalable.

@flyingsilverfin flyingsilverfin changed the title We refactor the cluster client open to extract open connection valida… Split client creation and open/validation calls Jun 2, 2023
@flyingsilverfin flyingsilverfin marked this pull request as ready for review June 2, 2023 12:45
flyingsilverfin
flyingsilverfin commented Jun 2, 2023
View reviewed changes
connection/TypeDBClientImpl.java Outdated

@Override
public boolean isOpen() {
return !channel().isShutdown() && connectionValidated;
Copy link
Member Author

Choose a reason for hiding this comment

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

"open" now means the channel is available and the connection has been validated

Copy link
Member

Choose a reason for hiding this comment

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

I think these should be in different accessors now. There's currently no way to check whether the client is in a "destroyed" state (i.e. .close() was explicitly called), or if it's in a "not yet validated" state where it can be reopened.

connection/TypeDBClientImpl.java Outdated
transmitter.close();
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
if (isOpen()) {
Copy link
Member Author

Choose a reason for hiding this comment

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

this "Close" method can ever only be called once by the user, and does not auto-recover the way that a network interrupt does.

Copy link
Member

Choose a reason for hiding this comment

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

See my previous comment. If the client has been opened but not validated (network error, whatever else) the channel will not be shut down.

connection/cluster/ClusterClient.java Outdated
@@ -320,6 +322,12 @@ private void waitForPrimaryReplicaSelection() {
}
}

private ClusterServerClient fetchOpenServerClient(String address) {
ClusterServerClient serverClient = clusterServerClient(address);
if (!serverClient.isOpen()) serverClient.validateConnection(); // may throw exception
Copy link
Member Author

Choose a reason for hiding this comment

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

since we can't use clients until we validate the connection, we attempt to validate until the validation succeeds

Copy link
Member

Choose a reason for hiding this comment

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

Here too, isOpen() represents both transient network failures, for which we want to reattempt a handshake, and a forcibly closed client, for which we don't.

connection/cluster/ClusterServerClient.java Show resolved Hide resolved
dmitrii-ubskii
dmitrii-ubskii requested changes Jun 2, 2023
View reviewed changes
connection/TypeDBClientImpl.java Outdated

@Override
public boolean isOpen() {
return !channel().isShutdown() && connectionValidated;
Copy link
Member

Choose a reason for hiding this comment

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

I think these should be in different accessors now. There's currently no way to check whether the client is in a "destroyed" state (i.e. .close() was explicitly called), or if it's in a "not yet validated" state where it can be reopened.

connection/TypeDBClientImpl.java Outdated
transmitter.close();
} catch (InterruptedException e) {
Thread.currentThread().interrupt();
if (isOpen()) {
Copy link
Member

Choose a reason for hiding this comment

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

See my previous comment. If the client has been opened but not validated (network error, whatever else) the channel will not be shut down.

connection/cluster/ClusterClient.java Outdated
@@ -320,6 +322,12 @@ private void waitForPrimaryReplicaSelection() {
}
}

private ClusterServerClient fetchOpenServerClient(String address) {
ClusterServerClient serverClient = clusterServerClient(address);
if (!serverClient.isOpen()) serverClient.validateConnection(); // may throw exception
Copy link
Member

Choose a reason for hiding this comment

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

Here too, isOpen() represents both transient network failures, for which we want to reattempt a handshake, and a forcibly closed client, for which we don't.

@flyingsilverfin flyingsilverfin changed the title Split client creation and open/validation calls Split client construction and connection validation Jun 2, 2023
@typedb-bot typedb-bot requested a review from dmitrii-ubskii June 2, 2023 18:00
@flyingsilverfin flyingsilverfin merged commit 33881a7 into typedb:master Jun 2, 2023
@flyingsilverfin flyingsilverfin deleted the fix-cluster-server-client-open branch June 2, 2023 18:55
@dmitrii-ubskii dmitrii-ubskii mentioned this pull request Aug 9, 2023
Merged
dmitrii-ubskii added a commit that referenced this pull request Aug 22, 2023
@dmitrii-ubskii @benjaminasmall
@flyingsilverfin @krishnangovindraj
Implement expressions and top-level values in client-rust (#434)
5fdec21 
## What is the goal of this PR?

We update the Rust driver to support the features introduced in driver
Java since v2.19 in effort to preserve the feature set when
transitioning from the JVM-native implementation to the Rust JNI
implementation.

## What are the changes implemented in this PR?

Changes in master since branching (#417):

Reimplemented in Rust and made available in Java over JNI:
- #409 
- #421 
- 1f396a6 Improve method unavailable error message
- #430 
- #431: partial, since `tonic` does not report SSL errors to the same
granularity

Cherry-picked directly:
- #415
- 42800e7 Update VERSION to 2.18.1
- 7cd0a5a Add eclipsesource-minimal-json to maven dependencies (#423)
- 63614ec Update CODEOWNERS
- #424

Dropped entirely (Java-specific or obsolete):
- #422 
- 8c0caa1 Update VERSION and release notes

---------

Co-authored-by: Benjamin Small <benjaminasmall@gmail.com>
Co-authored-by: joshua <joshua@vaticle.com>
Co-authored-by: Krishnan Govindraj <krishnangovindraj@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dmitrii-ubskii dmitrii-ubskii Awaiting requested review from dmitrii-ubskii

Assignees

@flyingsilverfin flyingsilverfin

@dmitrii-ubskii dmitrii-ubskii

Labels
priority: blocker type: bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@flyingsilverfin @typedb-bot @dmitrii-ubskii