1.7.0

Full Changelog

Implemented enhancements:

• Improved Publisher Presence: Improved API for tracking publisher presence #1038 #1037 #1036 #1035

Fixed bugs:

• Extended disconnection after long period of connectivity #1039

Closed issues:

• Add Status to Readme #1048
• Subscriber NetworkConnectivityTests: EnterFailedWithNonFatalNack #1017
• Subscriber NetworkConnectivityTests: UpdateFailedWithNonFatalNack #1018
• Subscriber NetworkConnectivityTests: TCPConnectionUnresponsive #1016

Merged pull requests:

• Add beta notice to readme #1049 (AndyTWF)
• additional faults enabled in subscribers NetworkConnectivityTests #1046 (davyskiba)
• Extended publisher presence API #1045 (AndyTWF)
• Bump ably-java to 1.2.27 #1044 (AndyTWF)
• Publisher presence events #1042 (AndyTWF)
• Disallow online state for subscriber active fatal fault #1041 (lawrence-forooghian)
• Error info constants #1040 (AndyTWF)
• Add network connectivity tests assertions on new publisher presence state API #1034 (lawrence-forooghian)
• Fetch history #1033 (davyskiba)
• Subscriber extended publisher presence #1032 (AndyTWF)
• Subscriber connection unresponsive #1031 (davyskiba)
• Subscriber enter failed fault #1023 (davyskiba)

1.6.4

Full Changelog

Breaking changes:

• Subscriber: do not attempt to update presence data when channel is suspended #980

Fixed bugs:

• ErrorInformation must not enforce non-nullability #1014
• Memory leak connected to the Mapbox SDK #810

Closed issues:

• Handling invalid values from mapbox #1004
• Remove ConnectionException from docstrings of Publisher.add/track #995
• Handle update presence retries in the WorkerQueue #962
• Fix memory leaks on publisher example apps #815
• Modify AddTrackableFailedWorker implementation to provide a result #546

Merged pull requests:

• Upgrade to Mapbox Navigation SDK 2.11.0 #1027 (lawrence-forooghian)
• Fix subscriber app crashes #1026 (AndyTWF)
• Update ably_core_version to 1.2.26 #1022 (ikbalkaya)
• Unify invalid mapbox values handling #1011 (davyskiba)
• Update resolution retry #1000 (davyskiba)
• Fix memory leak issue #812 (ikbalkaya)

1.6.3

1.6.3

Full Changelog

Fixed bugs:

• Re-adding a trackable results in trackable being offline #989
• Re-added trackable does not enter or subscribe to presenc #988
• Re-adding trackable immediately after removing it causes NullPointerException #984
• Exceptions thrown inside a block passed to DefaultAbly’s scope.launch() are suppressed #909

Closed issues:

• Remove ConnectionException from docstrings of Publisher.add/track #995
• Improve the version 1.5.1 to 1.6.0 migration guide #974
• Remove workaround for handling failed connection when adding a trackable #898

Merged pull requests:

• Remove ConnectionException from docstrings of Publisher.add/track #997 (lawrence-forooghian)
• Add migration guides for 1.6.0 and 1.6.1 #996 (lawrence-forooghian)
• Test exceptions #994 (davyskiba)
• Fix issues re-adding trackable #990 (AndyTWF)

1.6.2

What's Changed

• Downgrade google-play-services-location version to 17.1.0 by @davyskiba in #991

Full Changelog: v1.6.1...v1.6.2

1.6.1

This release adds additional enhancements to operational stability, for publishers in particular, when running on a devices with unreliable network connectivity.

Please see:

Full Changelog

Implemented enhancements:

• Wait for Ably connection to leave the "suspended" state before performing operations on Ably #973
• Make publisher.track() and publisher.add() return instantly #966

Fixed bugs:

• Handle presence.enter() retries in a special way #972
• Remove connect() and attach() timeouts from DefaultAbly #948
• Non-fatal errors responses for presence.enter() cause Publisher to throw exceptions #907
• Publisher can get into a bad state if offline for > 2 minutes #906
• Publisher apps reporting "Timeout was thrown when waiting for channel to attach" #859

Closed issues:

• Flakey test: faultBeforeAddingTrackable[DisconnectWithFailedResume] #961
• Presence operations are invalidly reattempted after a failed resume #951
• Add Publisher.start() and Publisher.stop() coverage to NetworkConnectivityTest #939
• Adding trackable just before fallback reconnection results in multiple exceptions #863

Merged pull requests:

• Increase ably-java core version to 1.2.24 #982 (ikbalkaya)
• 973 check channel state #981 (davyskiba)
• Configure the Subscribing Example Project for Firebase App Distribution #979 (QuintinWillison)
• Fix minor issue in the adhoc example app publishing workflow #978 (QuintinWillison)
• Make some fixes and improvements to recent DefaultAbly test changes #977 (lawrence-forooghian)
• Add pointers to sites that can be used to verify Maven Central releases #976 (QuintinWillison)
• Add workflow to allow us to adhoc-publish the example apps #969 (QuintinWillison)
• Remove timeouts from attach and connect #965 (KacperKluka)

1.6.0

This release enhances operational stability, for publishers in particular, when running on a devices with unreliable network connectivity.

Please see:
Upgrade / Migration Guide from v.1.5.1

Full Changelog

Implemented enhancements:

• Upgrade to Mapbox Nav SDK 2.10.0 #882
• Consider supporting static token authentication #730

Fixed bugs:

• Exceptions thrown for new publishing requests when offline #871
• Retry behaviour improvements for Ably API calls #927
• Publisher.remove\(\) fails during several connectivity faults #905
• Adding a trackable stalls forever if presence.enter() is interrupted by a disconnection #896
• Publisher crashes when location data has NaN value #861
• Subscriber, upon losing connectivity, continues to show the Publisher as online #835
• Subscriber, upon losing connectivity, continues to show the Publisher as online #833
• Unexpected exceptions fail the worker queue and silently break the SDK #830
• Fix the logic responsible for deciding if an enhanced location update is predicted #828
• Java users cannot build a publisher due to type issue #826
• NPE from ably-java SDK #809

Closed issues:

• Investigate TODO comment in DropAction fault regarding "limit" #934
• Reduce publisher location check polling interval #946
• Flakey test: com.ably.tracking.publisher.NetworkConnectivityTests > faultDuringTracking[NullTransportFault] #943
• Make NetworkConnectivityTests verify expected side-effects of operations publisher SDK claims was successful #925
• Reduce complexity of state transition assertions in NetworkConnectivityTests #901
• connect - when channel fetched is in DETACHED state and attach fails causes emulator to hang #900
• createAndStartPublisherAndSubscriberAndWaitUntilDataEnds IndexOutOfBoundsException #899
• Flakey test: when an unexpected exception is thrown by worker's async work, the queue should call worker's unexpected async exception method #888
• Investigate documented ConnectionException thrown by Publisher.Builder.start and how users are meant to handle it #876
• Investigate ConnectionException thrown by Publisher.stop and whether we can remove it #873
• Try simulating networking problems during core use cases #865
• Sending presence leave event times out whilst still connected #862
• shouldNotEmitPublisherPresenceFalseIfPublisherIsPresentFromTheStart (PublisherAndSubscriberTests) failing with "first publisherPresence value should be true" #845
• staticTokenAuthenticationShouldCreateWorkingConnectionBetweenPublisherAndSubscriber (AuthenticationTests) failing with "Expectation 'subscriber received a location update' unfulfilled." #844
• Replace deprecated package attribute in manifest file #837
• Test issue for sync #834
• Enable logging in the example apps by default #818
• Update workflows to stop using the set-output command #817
• Update workflows to stop using Node.js 12 actions #816
• Refactor Publisher EventQueue to match Subscriber #781
• Consider if we should allow to create multiple publisher instances #464
• Flakey Test: createAndStartPublisherAndSubscriberAndWaitUntilDataEnds (PublisherAndSubscriberTests) #259

Merged pull requests:

• 871 add exceptions #938 (davyskiba)
• Use random trackable ids in integration tests #968 (AndyTWF)
• NetworkingConnectivityTest fixes #960 (jaley)
• Example App Distribution documentation #959 (QuintinWillison)
• Release/1.6.0 beta.1 #956 (QuintinWillison)
• Upload Publishing Example App to Firebase for Distribution to Testers #955 (QuintinWillison)
• Fix publish.stop\(\) hang when no trackables added #952 (jaley)
• Increase back-off when querying history in test #949 (AndyTWF)
• Reenable disconnect failed resume faults #947 (ikbalkaya)
• Change publisher and subscriber stop operation to always succeed #945 (KacperKluka)
• Fix flakey publisher test #944 (AndyTWF)
• Change publisher's remove operation to always succeed #942 (KacperKluka)
• Reset fault state for each test function #941 (jaley)
• Upgrade core Ably SDK dependency to version 1.2.23 #940 (QuintinWillison)
• Switch to CIO ktor engine #937 (jaley)
• Improve testing in respect of JVM version underlying Gradle #936 (QuintinWillison)
• setting log level for test location source AblyRealtime instance #935 (davyskiba)
• Improve NetworkingConnectivityTest assertions #933 (jaley)
• Fix swapped error codes when creating the malformed message exception #930 (KacperKluka)
• Add methods for detecting retriable and fatal Ably exceptions #929 (KacperKluka)
• 901 simplify transition assertions #916 (davyskiba)
• Upgrade build tools to make Layer 7 proxy branch work #915 (QuintinWillison)
• Write further unit tests for DefaultAbly #914 (lawrence-forooghian)
• wait for publisher emissions before performing test assertion #911 (AndyTWF)
• Update workflow status badges #904 (QuintinWillison)
• Add mapbox testing information to contributing guide [#895...

1.6.0, Beta 1

NOT FOR PRODUCTION USE

This is a BETA release, to be used for testing only.

Full Changelog

Implemented enhancements:

• Upgrade to Mapbox Nav SDK 2.10.0 #882
• Consider supporting static token authentication #730

Fixed bugs:

• Retry behaviour improvements for Ably API calls #927
• Publisher.remove() fails during several connectivity faults #905
• Adding a trackable stalls forever if presence.enter() is interrupted by a disconnection #896
• Publisher crashes when location data has NaN value #861
• Subscriber, upon losing connectivity, continues to show the Publisher as online #833
• Unexpected exceptions fail the worker queue and silently break the SDK #830
• Fix the logic responsible for deciding if an enhanced location update is predicted #828
• Java users cannot build a publisher due to type issue #826
• NPE from ably-java SDK #809

Closed issues:

• Reduce publisher location check polling interval #946
• Flakey test: com.ably.tracking.publisher.NetworkConnectivityTests > faultDuringTracking[NullTransportFault] #943
• Make NetworkConnectivityTests verify expected side-effects of operations publisher SDK claims was successful #925
• Reduce complexity of state transition assertions in NetworkConnectivityTests #901
• connect - when channel fetched is in DETACHED state and attach fails causes emulator to hang #900
• createAndStartPublisherAndSubscriberAndWaitUntilDataEnds IndexOutOfBoundsException #899
• Flakey test: when an unexpected exception is thrown by worker's async work, the queue should call worker's unexpected async exception method #888
• Investigate documented ConnectionException thrown by Publisher.Builder.start and how users are meant to handle it #876
• Investigate ConnectionException thrown by Publisher.stop and whether we can remove it #873
• Try simulating networking problems during core use cases #865
• Sending presence leave event times out whilst still connected #862
• shouldNotEmitPublisherPresenceFalseIfPublisherIsPresentFromTheStart (PublisherAndSubscriberTests) failing with "first publisherPresence value should be true" #845
• staticTokenAuthenticationShouldCreateWorkingConnectionBetweenPublisherAndSubscriber (AuthenticationTests) failing with "Expectation 'subscriber received a location update' unfulfilled." #844
• Replace deprecated package attribute in manifest file #837
• Test issue for sync #834
• Enable logging in the example apps by default #818
• Update workflows to stop using the set-output command #817
• Update workflows to stop using Node.js 12 actions #816
• Refactor Publisher EventQueue to match Subscriber #781
• Consider if we should allow to create multiple publisher instances #464
• Flakey Test: createAndStartPublisherAndSubscriberAndWaitUntilDataEnds (PublisherAndSubscriberTests) #259

Merged pull requests:

• Fix publish.stop() hang when no trackables added #952 (jaley)
• Increase back-off when querying history in test #949 (AndyTWF)
• Reenable disconnect failed resume faults #947 (ikbalkaya)
• Change publisher and subscriber stop operation to always succeed #945 (KacperKluka)
• Fix flakey publisher test #944 (AndyTWF)
• Change publisher's remove operation to always succeed #942 (KacperKluka)
• Reset fault state for each test function #941 (jaley)
• Upgrade core Ably SDK dependency to version 1.2.23 #940 (QuintinWillison)
• Switch to CIO ktor engine #937 (jaley)
• Improve testing in respect of JVM version underlying Gradle #936 (QuintinWillison)
• setting log level for test location source AblyRealtime instance #935 (davyskiba)
• Improve NetworkingConnectivityTest assertions #933 (jaley)
• Fix swapped error codes when creating the malformed message exception #930 (KacperKluka)
• Add methods for detecting retriable and fatal Ably exceptions #929 (KacperKluka)
• 901 simplify transition assertions #916 (davyskiba)
• Upgrade build tools to make Layer 7 proxy branch work #915 (QuintinWillison)
• Write further unit tests for DefaultAbly #914 (lawrence-forooghian)
• wait for publisher emissions before performing test assertion #911 (AndyTWF)
• Update workflow status badges #904 (QuintinWillison)
• Add mapbox testing information to contributing guide #895 (AndyTWF)
• Wrap ably-java’s ChannelStateChange in our own type #894 (lawrence-forooghian)
• Publisher and Subscriber builders start method throws exception descr… #893 (davyskiba)
• Use different locations in test data file #892 (AndyTWF)
• Add timeout on verification in WorkerQueueTest #890 (AndyTWF)
• Document Java version requirements for running ./gradlew #889 (lawrence-forooghian)
• coroutines and coroutines-test dependency updated to 1.6.4 #887 (davyskiba)
• Layer 7 Proxy for Network Connectivity Tests #886 (jaley)
• Subscriber gets immediate publisher online state flakey test #884 (QuintinWillison)
• Upgrade Mapbox Nav SDK to version 2.10.0 [#881](https://github.com...

1.5.1

Full Changelog

Implemented enhancements:

• Provide a fix/option for intermittent connection issue on publisher #803

Fixed bugs:

• Fix crash when publisher tries to modify its internal state after being stopped #808
• Fix not re-entering presence after connection is recovered via "Upgrade ably-java to 1.2.20" #822 (KacperKluka)

Merged pull requests:

• Check publisher state before emitting state on flow #820 (ikbalkaya)
• Allow to specify the remainPresentFor Ably transport parameter #806 (KacperKluka)

1.5.0

Full Changelog

Implemented enhancements:

• Missing interface for tokenRequest Authentication instance creation in the Java facade #297, in #787 (KacperKluka)
• Add LocationAnimator for the Java API #790, in #791 (KacperKluka)
• Add missing methods to the Subscriber Java API #788, in #789 (KacperKluka)
• Update documentation regarding the Java verision of the AAT #707, in #793 (KacperKluka)
• Add logs connected to the lifecycle of publisher and subscriber SDKs #804, in #813 (KacperKluka)
• Add token-based auth configuration that do not require to specify client ID #768 (KacperKluka)

Fixed bugs:

• Fix NPE related to ably-java usage #805, in #807 (KacperKluka)
• Publisher failing with IllegalStateException: Already resumed, but proposed with update kotlin.Unit #799, in #800 (KacperKluka)
• Refactor the Ably wrapper to be more secure and error-proof #440, in #782 (davyskiba)

1.4.1

Full Changelog

Improved Subscriber behaviour:

• Wait for the presence data sync before returning a subscriber instance #792, implemented in #794 (KacperKluka)