-
Notifications
You must be signed in to change notification settings - Fork 151
Hide protocol object behind the Connection #1139
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
Merged
Merged
Conversation
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
The connection in the driver is exposing the protocol object, which is not great. Improve this part of the code can be done by make the connection object have methods to do high level requests to the server. List of calls the core driver does using the protocol, by passing the connection: * `version` * `run` * `beginTransaction` * `commitTransaction` * `rollbackTransaction` Methods is present in the `Connection` interface (used by core in **bold**): * `id` * `database` * `server` * `authToken` * `address` * `version` * `supportsReAuth` * **`isOpen`** * **`protocol`** * `connect` * `write` * **`resetAndFlush`** * **`hasOngoingObservableRequests`** * **`_release`** So, `isOpen`, `resetAndFlush` and `hasOngoingObservableRequests` are the methods which will stay in the connection along with the new methods. The method `release` will move the a `Releasable` interface, which will be composed with `Connection` when returning the connection from the provider. The `Releasable` interface is also defined to enable the `ConnectionProvider` returns a connection which can be released back to the pool. Internally, `bolt-connection` can keep exposing the internal of the connection outside the connection in a first moment. The full encapsulation of the `protocol` should be done in the next phase of refactoring.
2174247
to
ae5043a
Compare
robsdedude
approved these changes
Sep 8, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As an added bonus, I like how the new structure makes the mocking in tests cleaner as well 🙌
Co-authored-by: Robsdedude <[email protected]>
…re connection The method _acquireConnection and _run methods were replicating the same logic. The logic was extracted to a common method avoid duplication.
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.
The connection in the driver is exposing the protocol object, which is not great. Improve this part of the code can be done by make the connection object have methods to do high level requests to the server.
List of calls the core driver does using the protocol, by passing the connection:
version
run
beginTransaction
commitTransaction
rollbackTransaction
Methods is present in the
Connection
interface (used by core in bold):id
database
server
authToken
address
version
supportsReAuth
isOpen
protocol
connect
write
resetAndFlush
hasOngoingObservableRequests
_release
So,
isOpen
,resetAndFlush
andhasOngoingObservableRequests
are the methods which will stay in the connection along with the new methods. The methodrelease
will move the aReleasable
interface, which will be composed withConnection
when returning the connection from the provider.The
Releasable
interface is also defined to enable theConnectionProvider
returns a connection which can be released back to the pool.Internally,
bolt-connection
can keep exposing the internal of the connection outside the connection in a first moment. The full encapsulation of theprotocol
should be done in the next phase of refactoring.