-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Put the ably-java client library behind an interface
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.
- Loading branch information
1 parent
63c5295
commit 36a33be
Showing
5 changed files
with
284 additions
and
29 deletions.
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| package com.ably.tracking.common | ||
|
|
||
| import io.ably.lib.realtime.Channel.MessageListener | ||
| import io.ably.lib.realtime.ChannelState | ||
| import io.ably.lib.realtime.ChannelStateListener | ||
| import io.ably.lib.realtime.CompletionListener | ||
| import io.ably.lib.realtime.ConnectionState | ||
| import io.ably.lib.realtime.ConnectionStateListener | ||
| import io.ably.lib.realtime.Presence.PresenceListener | ||
| import io.ably.lib.rest.Auth.RenewAuthResult | ||
| import io.ably.lib.types.ChannelOptions | ||
| import io.ably.lib.types.ClientOptions | ||
| import io.ably.lib.types.ErrorInfo | ||
| import io.ably.lib.types.Message | ||
| import io.ably.lib.types.PresenceMessage | ||
|
|
||
| interface AblySDKRealtimeFactory { | ||
| fun create(clientOptions: ClientOptions): AblySDKRealtime | ||
| } | ||
|
|
||
| /** | ||
| * An set of interfaces that represent the parts of the Ably client library which are used by the Ably Asset Tracking SDKs. | ||
| * | ||
| * These exist so that we can mock out the Ably client library when testing the [DefaultAbly] class. The interfaces here are more or less a direct copy of the corresponding `ably-java` classes, and are expected to exhibit the same behaviour. They do remove some details that would be overkill here, such as class hierarchies and interface conformances, instead opting to add these inherited properties and methods directly on the interfaces. | ||
| * | ||
| * The aim here is _not_ to remove the usage of all `ably-java` types; we continue using types from that codebase if they are just interfaces or are easy to construct. We just intend to use interfaces to replace `ably-java` classes that would be hard to mock. | ||
| * | ||
| * `ably-java` doesn’t currently have nullability annotations (see [issue #639](https://github.com/ably/ably-java/issues/639) there), so when writing these interfaces we need to make our own judgements about nullability, based on our knowledge of the behaviour of the Ably client libraries. | ||
| */ | ||
| interface AblySDKRealtime { | ||
| val auth: Auth | ||
| val connection: Connection | ||
| val channels: Channels | ||
|
|
||
| fun connect() | ||
| fun close() | ||
|
|
||
| interface Auth { | ||
| fun renewAuth(result: RenewAuthResult) | ||
| } | ||
|
|
||
| interface Channel { | ||
| val name: String | ||
| val state: ChannelState | ||
| val presence: Presence | ||
|
|
||
| fun attach(listener: CompletionListener) | ||
| fun publish(message: Message?, listener: CompletionListener) | ||
| fun on(listener: ChannelStateListener) | ||
| fun off(listener: ChannelStateListener) | ||
| fun off() | ||
| fun subscribe(name: String, listener: MessageListener) | ||
| fun unsubscribe() | ||
| fun setConnectionFailed(reason: ErrorInfo) | ||
| } | ||
|
|
||
| interface Presence { | ||
| fun subscribe(listener: PresenceListener) | ||
| fun unsubscribe() | ||
| fun get(wait: Boolean): Array<PresenceMessage> | ||
| fun enter(data: Any, listener: CompletionListener) | ||
| fun update(data: Any, listener: CompletionListener) | ||
| fun leave(data: Any, listener: CompletionListener) | ||
| } | ||
|
|
||
| interface Channels { | ||
| fun get(channelName: String, channelOptions: ChannelOptions?): Channel | ||
| fun get(channelName: String): Channel | ||
| fun entrySet(): Iterable<Map.Entry<String, Channel>> | ||
| fun containsKey(key: Any): Boolean | ||
| fun release(channelName: String) | ||
| } | ||
|
|
||
| interface Connection { | ||
| val state: ConnectionState | ||
| val reason: ErrorInfo? | ||
|
|
||
| fun on(listener: ConnectionStateListener) | ||
| fun off(listener: ConnectionStateListener) | ||
| } | ||
| } |
Oops, something went wrong.