Changelog: Twilio Sync Android SDK

The latest release of the Sync SDK for Android is v4.0.0. Separate artifacts for utilizing the SDK with Kotlin and Java are published on Maven Central.

• [Documentation for Kotlin]
• [Documentation for Java]

• [Documentation]
• gradle: implementation "com.twilio:sync-android-kt:4.0.0"

• [Documentation]
• gradle: implementation "com.twilio:sync-android-java:4.0.0"

• The SDK has been completely reworked. Interfaces have changed significantly, providing a more streamlined and efficient user experience.

• We've added a persistent cache. Now, the SDK can start and provide previously cached data even when the device is offline. Once the device comes online, all updates from the backend will be received.

Starting from v4.0.0, Sync SDK provides two modules:

• sync-android-kt is targeted to be used from Kotlin apps. SyncClient exposes suspend methods to perform async operations. To use SyncClient from your Kotlin app, add the following dependency to your project:

1
dependencies {
2
    implementation "com.twilio:sync-android-kt:4.0.0"
3
}

See SyncClient documentation for details on how to create a SyncClient.

• sync-android-java is targeted to be used from Java apps. SyncClientJava exposes methods which receive listeners to perform async operations. To use SyncClientJava from your Java app, add the following dependency to your project:

1
dependencies {
2
    implementation "com.twilio:sync-android-java:4.0.0"
3
}

See SyncClientJava documentation for details on how to create a SyncClientJava.

The Sync SDK now exposes dates using kotlinx.datetime.Instant. If you are targeting Android devices running below API 26, you will need to enable coreLibraryDesugaring to ensure compatibility. Follow the steps below:

1
android { 
2
    compileOptions { 
3
        coreLibraryDesugaringEnabled true 
4
    } 
5
}
6

7
dependencies {
8
    "com.android.tools:desugar_jdk_libs:1.2.2"
9
}

For more information on using kotlinx.datetime in your projects, visit the official documentation.

Here's an example of how to use the new SDK:

1
    val syncClient = SyncClient(applicationContext) { requestToken() }
2

3
    // Create a new map
4
    val map = syncClient.maps.create()
5

6
    // Listen for item-added events flow
7
    map.events.onItemAdded
8
        .onEach { println("Item added: ${it.key}") }
9
        .launchIn(MainScope())
10

11
    // Declare custom data type
12
    @kotlinx.serialization.Serializable
13
    data class MyData(val data: Int)
14

15
    // Add 10 items to the map
16
    repeat(10) { index ->
17
        map.setItem("key$index", MyData(index))
18
    }
19

20
    // Read all items from the map
21
    for (item in map) {
22
        val myData = item.data<MyData>()
23
        println("Key: ${item.key}, Value: ${myData.data}")
24
    }
25

26
    // Remove the map
27
    map.removeMap()

Please note that these changes may require modifications to your existing codebase to ensure compatibility with the new version of the SDK. We recommend thoroughly testing your application after updating to Sync SDK v4.0.0.

We hope you enjoy the new features and improvements in Sync SDK v4.0.0!

• [aar] sha256:5edd0a6c2abad43681b54425dadddd71ee5c6b019c62a12e821c17343fd34465
• [Documentation]
• gradle: implementation "com.twilio:sync-android:3.0.3"

• Fixed a memory leak when client creation fails.

• [aar] sha256:fae097470c70fec1b5f967028abc74c9c12d9c89bc0ec4b51e5112bcbcee7663
• [Documentation]
• gradle: implementation "com.twilio:sync-android:3.0.2"

• Fixed a crash which could occur on client creation.
• Fixed issues in transport protocol handling.
• Starting with this release the Gradle Module Metadata file is published to maven central. Now binary incompatibility between SyncSDK and ConversationsSDK will be automatically reported at compile time.

• [aar] sha256:c7a4470785cae0e3b2771d003d3b3a011e5ac2cd3aa14fbd8ccf5767269e8877
• [Documentation]
• gradle: implementation "com.twilio:sync-android:3.0.1"

• Fixed a crash when both Sync SDK and Conversations SDK are in the same app.

• [aar] sha256:30b32eaa4248b0e15405001867359ddf1a0d848bb205140998ffdebf6bd8d2b2
• [Documentation]
• gradle: implementation "com.twilio:sync-android:3.0.0"

• Bumped kotlin version to 1.8.0

• Bumped Android minSdkVersion to 21

• [aar] sha256:44e140754fd7e41f0dddc16d3fd0ad507c78b3d01ef123f8a6f0cf65b5687feb
• [Documentation]
• gradle: implementation "com.twilio:sync-android:2.0.2"

• Bump the ktor dependency to v2.1.2

• [aar] sha256:cb51f8c153741dcc8b05af5770fc17683219e57e85f659fbea19502fccd98c63
• [Documentation]
• gradle: implementation "com.twilio:sync-android:2.0.1"

• Fixed crash on device connectivity changes
• targetSdkVersion bumped to android-33

• [aar] sha256:5e4c0afc5c688e832c2afe6e342febdefd9328afb93c80c717a5ef369d0f74c8
• [Documentation]
• gradle: implementation "com.twilio:sync-android:2.0.0"

• Reduced the SDK footprint: AAR library has decreased in size by 6,86 %
• Significantly improved stability by refactoring transport layer to eliminate race conditions by design

• For the UNAUTHORIZED error the ErrorInfo.code is now 5 (was 1)
• In edge cases error codes and messages changed to more informative. So if your app relies on any specific error codes and/or messages - these cases should be double checked after updating to this version.

• [aar] sha256:e4cfe5f38e13a73fdda9815699546a7b7b8cedfc644f3568b3795dcd2cd21f1d
• [Documentation]
• gradle: implementation "com.twilio:sync-android:1.1.0"

• Improved performance in use cases where the user subscribes to thousands of objects.

• [aar] sha256:293868bd9e4f1b70898df1376728ec771a7befda8a8c7955bca59c2a12000f5c
• [Documentation]
• gradle: implementation "com.twilio:sync-android:1.0.3"

• Fixed compilation errors when sync and conversations SDKs are used together in an application.

• [aar] sha256:a8e474a9ce48daf40b1f4d444a52580848fad3e649b4d8240b6a41b1721805f3
• [Documentation]
• gradle: implementation "com.twilio:sync-android:1.0.2"

• Fixed a reconnection issue after restoring application from background.

• [aar] sha256:afb799129b7860e19e3060d3c36aad5ca5f490bc16669287d454c3ca88be752e
• [Documentation]
• gradle: implementation "com.twilio:sync-android:1.0.1"

• Reduced SDK footprint

Starting from this release all artifacts are published on mavenCentral instead of jcenter. Root build.gradle have to be updated by adding mavenCentral() repository:

1
allprojects {
2
    repositories {
3
        mavenCentral()
4
    }
5
}

• [aar] sha256:bc416e2aa08aafbb148de797e6d633950640edefe6bb7740b1d52e66a08704b7
• [Documentation]
• gradle: implementation "com.twilio:sync-android:1.0.0"

• Java 8 required. Add to your project's build.gradle the following compile options, necessary to use Java8 syntax features:

1
compileOptions {
2
    sourceCompatibility JavaVersion.VERSION_1_8
3
    targetCompatibility JavaVersion.VERSION_1_8
4
}
5

6
// Also if kotlin is used in the project
7
kotlinOptions {
8
    jvmTarget = '1.8'
9
}

• List of renamed entities:

  • List -> SyncList
  • ListIterator -> SyncListIterator
  • ListObserver -> SyncListObserver
  • ListPaginator -> SyncListPaginator
  • Map -> SyncMap
  • MapIterator -> SyncMapIterator
  • MapObserver -> SyncMapObserver
  • MapPaginator -> SyncMapPaginator
  • Document -> SyncDocument
  • DocumentObserver -> SyncDocumentObserver
  • Stream -> SyncStream
  • StreamObserver -> SyncStreamObserver
  • Mutator -> SyncMutator
  • Options -> SyncOptions
  • ConnectionStateListener -> SyncClientListener
  • SyncClient.setConnectionStateListener() -> SyncClient.setListener()
  • InfiniteDuration -> INFINITE_DURATION

• SuccessListener is interface now. So remove constructor invocation in Kotlin code to make it compile.

• SyncOptions is interface now. Use SyncOptions.create() for creating new instance.

• previousData parameter added to SyncDocumentObserver.onRemoved() callback.

• Removed PageSort parameter while querying items from SyncList or SyncMap. The order of items within the page is not guaranteed. Implement necessary sorting in application code if needed.

• Returned error codes changed in number of cases.

• Exposed dateUpdated for all sync objects (SyncList, SyncMap, SyncMap.Item etc).
• Added onTokenAboutToExpire and onTokenExpired callbacks to SyncClientListener.
• Fixed a bug when previousData/previousItemData is null in updated/removed callbacks for client who made the modification.
• Fixed a bug when client didn't call onError() callback after initialisation with invalid token.
• Improved documentation.

• Recovery takes more time after network loss compared to 0.8.7.
• Update to v1.0.1 or newer, if you got runtime error: java.lang.NoClassDefFoundError: Failed resolution of: Lcom/getkeepsafe/relinker/ReLinker

• [aar]
• [Documentation]
• gradle: implementation "com.twilio:sync-android:0.9.0"

• SDK has switched to android native SSLSocket implementation (javax.net.ssl.SSLSocket), resulting in a noticeable decrease in final application size compared to previous release 0.8.7.

• Recovery takes more time after network loss compared to previous release 0.8.7.

• [aar]
• [Documentation]
• gradle: implementation "com.twilio:sync-android:0.8.7"

• Minor bugfixes and stability improvements

• [aar]
• [Documentation]
• gradle: implementation "com.twilio:sync-android:0.8.6"

• Decreased the minimum Android SDK version to 19.
• Included the Proguard rules for Twilio classes with SDK package.

• [aar]
• [Documentation]
• gradle: implementation "com.twilio:sync-android:0.8.5"

• Fixed stack dump symbolication on Сrashlytics.
• Reduced SDK footprint, resulting in a noticeable decrease in final application size compared to release 0.8.2
• Fixed an issue where a completion handler is called more than once when publishing messages to a deleted stream.
• Fixed an bug where the StreamObserver.onRemoved() event is received twice.

• [aar]
• [Documentation]
• gradle: implementation "com.twilio:sync-android:0.8.2"

• Improved stability on shutdown, fixed crash issue

• [aar]
• [Documentation]
• gradle: implementation "com.twilio:sync-android:0.8.1"

• Improved connection reliability under bad network conditions.
• Fixed unexpected connectivity errors with code 1401: Unable to establish connection to Twilio Sync service.
• Increased targetSdkVersion to 28 in preparation for Google SDK policy targeted in August; minSdkVersion remains 21.

• [aar]
• [Documentation]
• gradle: implementation "com.twilio:sync-android:0.8.0"

• Overhauled transport and communication layer, significantly improving network traffic overhead and client performance
• SDK size reduction - it gained over the course of the year, so we sent it to the gym. Native libraries are now repackaged and optimized for size.

• [aar]
• [Documentation]
• gradle: compile "com.twilio:sync-android:0.7.2"

• Improve privacy compliance: by default use log level SILENT to not output anything from SDK by default. Switch to higher debug level using SyncClient.setLogLevel() to receive log messages.

• [aar]
• [Documentation]
• gradle: compile "com.twilio:sync-android:0.7.1"

• Observer interfaces will no longer receive onErrorOccurred events when a failure to open Document, List, Map or Stream occurs. The SuccessListener for such operations is the best way to check for success or failure on open/creation.
• Resolved issue with connection state listener, where onConnectionStateChanged event was not called on the user thread.
• Resolved issue with SuccessListeners where events for openDocument, openMap, openList, openStream were not called on the user thread.
• Resolved issue where remote update events may not be received after the same object got opened multiple times concurrently.

• [aar]
• [Documentation]
• gradle: compile "com.twilio:sync-android:0.7.0"

Synopsis of enhancements:

• FlowId has been deprecated in favor of passing the resulting object to the listeners now, where previously arguments to listeners were Void.
• The distinction between remote (for remotely initiated operations) and result (for locally initiated operations) has been transitioned to EventContext's isLocal() flag. The callback interfaces are thus simplified, by combining onResultXYZ and onRemoteXYZ events under the same method.
• Documents, Lists (and their items), Maps (and their items) and Streams may now all have an optional max time to live specified. This number is expressed in seconds and is relative to when the TTL is set. After the TTL expires, the object will be destroyed on the backend in the near future. Options has been expanded to allow specifying a TTL during object creation (this property is ignored when opening preexisting objects.) The Metadata classes taken as a parameter for some methods on Document, List and Map are optional and can be specified as null.

Migration tips:

FlowId has been removed globally; most methods that previously accepted a flowID now also accept metadata which can be null today if you are not specifying a TTL.

Most observer methods have changed signature. The individual remote and local observer methods have been combined into a single observer method for operations. Observers which previously received only an index or key will now also receive the full value. Most observer methods now also provide a EventContext object which will indicate whether the operation was locally or remotely initiated.

Update squashing:

Individual local operations will continue to return the status of each operation via their SuccessListener interface but updates sent to the server may be batched for efficiency. This means remote clients may not see every state update performed individually, but will instead see updates with the object's final updated state.

If you require updates to be treated as individual operations for purposes of notifying remote clients, it is recommended you schedule subsequent updates to occur after the completion of each operation.

Other enhancements and bugfixes:

• Enabled returning null from mutator functions, gracefully abandoning data change operations.
• Added SDK version logging on startup, with "Twilio Sync SDK version {VERSION}" text.
• Added SyncClient.setLogLevel() method to configure the SDK log level for troubleshooting purposes.
• Fixed a race condition with an early arriving collection item remote update events.
• Fixed support for multicasting events to observers attached to de-duplicated instances of objects, i.e. where the same object SID is opened multiple times.
• Provided a fix against crash on Android Oreo.
• Listeners added via SyncClient.setConnectionStateListener() will now receive callbacks in the correct thread.

• [aar]
• [Documentation]
• gradle: compile "com.twilio:sync-android:0.6.3"

• Updated internal certificate store for upcoming certificate authority changes.

• [aar]
• [Documentation]
• gradle: compile "com.twilio:sync-android:0.6.2"

• Optimized SDK speed
• Optimized SDK size
• Improved SDK stability