Wrap ably-java in a set of interfaces and add example unit test for DefaultAbly
#868
Conversation
This file contains 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
lawrence-forooghian
force-pushed
the
862-add-mocks-for-realtime
branch
from
97a2e06 to
66d13a8
Compare
lawrence-forooghian
force-pushed
the
862-add-mocks-for-realtime
branch
from
66d13a8 to
3e75bad
Compare
lawrence-forooghian
changed the title
ably-java in a set of interfaces and add example unit test for DefaultAbly
KacperKluka
suggested changes
Dec 29, 2022
common/src/main/java/com/ably/tracking/common/DefaultAblySDK.kt
Outdated
Show resolved
Hide resolved
The DefaultAbly class already has quite a bit of logic (e.g. retries) and I intend to add further logic to it. It would be good to be able to unit test this class. It sounds like we haven’t done this so far because we didn’t want to try and mock the AblyRealtime class. But I think we need to be able to unit test DefaultAbly (which I’ve created issue #869 for), so I’m putting the ably-java library behind a set of AblySdk* interfaces. This will allow us to provide mock implementations of the Ably client library when testing DefaultAbly. (I’ve taken this approach from the asset-tracking-swift codebase.) One thing worth noticing is the new use of the !! operator when extracting the `reason` from a connection that’s in a failed state. This looks like it’s introducing a new unsafe behaviour, but it’s actually just making explicit a previous assumption, namely that when a connection is in a failed state its `reason` will be non-null. The previous version of the code - in which the connection’s `reason` was of platform type ErrorInfo! – would equally have thrown a NullPointerException if this assumption were violated.
This is just to check that the interfaces created in 934ec93 are fit for purpose.
lawrence-forooghian
force-pushed
the
862-add-mocks-for-realtime
branch
from
3e75bad to
9b76214
Compare
Don't worry, you'll have plenty of opportunity to critique my tests when I write some for #862 😁 |
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.
This introduces a set of interfaces,
AblySDK*, which represent all of the functionality ofably-javaused by this SDK.This allows us to mock out
ably-javain unit tests and hence to write unit tests forDefaultAbly, which is currently untested (I've created #869 for writing tests for all the existing behaviour of that class).I’ve also added one example unit test for
DefaultAbly, just to confirm the new interfaces are fit for purpose.See commit messages for more details.