JavaScript | Web and Node.js | React Native

4.9.3 JavaScript & React Native Specific Changes

Fixed: renamed a misspelled property in the Peer type to the correct spelling dittoSdkVersion from the previous, incorrect spelling dittoSDKVersion. (#SDKS-176)

4.9.3 Common Changes

Changed: Added more actionable information to common connection handshake issues. (#15298)

Fixed: Fixed: Some Android devices could fail to export logs to the portal due to a file permissions error (#15582)

4.9.1 JavaScript & React Native Specific Changes

Changed: Enhanced the efficiency of our memory management processes on React Native. (#15126)

Changed: Optimized JSI runtime object management for greater efficiency and responsiveness on React Native. (#15170)

4.9.1 Common Changes

Fixed: iOS 18 crashes related to Bluetooth LE are now resolved. (#15351)

Fixed: Disk usage stats are now reported in small peer info on android devices

4.9.0 JavaScript Release Notes

Added: login() method to Authenticator which enables access to userInfo provided by the configured authentication webhook. (#12354)

Added: new methods PendingIDSpecificOperation.updateV2(), and WriteTransactionPendingIDSpecificOperation.updateV2() to replace the deprecated update() methods. These methods do not throw when the document with the given ID can not be found, and call the given closure with null instead. Additionally, these methods throw when given an unsupported async closure argument. (#14504)

Added: (React Native) React Native apps can now also set a logging callback using Logger.setCustomLogCallback(). This API was previously not available in React Native environments. (#14658)

Added: CFBundleShortVersionString inside the React Native framework. (#14845)

Changed: Error messages and documentation for APIs not supported in React Native environments. Some parts of the SDK’s API, in particular the original query builder APIs, are not supported and throw errors when called from a React Native app. In these cases, error message wording and documentation has been improved to make it easier to find the right replacement APIs to use instead. (#14612)

Changed**: (React Native)** Transitioned from static to shared libraries to improve load times and reduce overall application size. This change requires updates to build configurations to ensure dynamic linking is correctly handled. See our integration guide for detailed instructions on updating your project settings. (#15018)

Fixed: Passing an unsupported async closure to any cursor operation’s update() method now logs a warning. This includes PendingIDSpecificOperation.update(), PendingCursorOperation.update(), WriteTransactionPendingIDSpecificOperation.update(), and WriteTransactionPendingCursorOperation.update(). (#14504)

Fixed**: (React Native)** Sporadic Android BLE crash when syncing with other peers. (#15018)

Deprecated: Method loginWithToken() from Authenticator. Use the newly added login() method instead. (#12354)

Deprecated: PendingIDSpecificOperation.update(), and WriteTransactionPendingIDSpecificOperation.update() whose behavior did not match their documentation. Use each class’s new updateV2() method instead. (#14504)

Removed:

4.9.0 Logging Clarity Improvements

This release comes with a number of logging clarity improvements. The goal of these changes are to make Ditto logs more consumable and actionable for end users. While there are wide ranging changes one of the principal goals of this work is to make our INFO level logs contain the right information to understand the state and health of the Ditto SDK.

• More information is included when physical connections start and end (such as the type of connection and the remote peer’s key)

• Devices that try to connect to themselves now say “device has connected to itself” instead of an error about the remote site ID being the same as the local peer

• Authentication client logs have been made more human readable. In particular:

• Recoverable errors are logged together with information about the recovery actions that are being undertaken

• Several abbreviations have been replaced with human-readable descriptions

• Errors are printed using their descriptions rather than by dumping debug representations

• Abbreviated jargon has been replaced with clearer wording in various log lines

• “phy ended” has become “physical connection ended”

• “error getting char” has become “required Ditto BLE characteristic not found”

• “error getting radio state” has become “error getting Windows Bluetooth radio state”

• Peer events that represent a transport starting or stopping are now logged with the message “transport started”/”transport ended” rather than as a raw peer_event=… log

• Reduced the noisiness of “starting” log lines around Ditto initialization time

• Noise from long peer keys in logs has been reduced in some places by replacing them with their truncated form

• Noise from duplicated peer ID/peer key information in replication logs has been reduced by consolidating the information

• “starting compression and export” is now followed by a “completed export” log at the same level

• Successful SQLite WAL recovery logs were further lowered from INFO to DEBUG

4.9.0 Common Changes

Added: regexp_like function in DQL. (#12129)

Added: peer_metadata and identity_service_metadata to the small peer info document (#12477)

Added: WebSocket connections now send X-DITTO-PEERPUBKEY and X-DITTO-ROUTING-HINT headers as part of the client connect handshake on all platforms except wasm32 (#13171)

Added: Small Peer Info now includes information about the current logger configuration (#14317)

Added: Permission rules can be written in DQL. (#14563)

Added: Ditto logs clearly indicate if a device has established a connection to itself. (#14634)

Added: the ability for DQL select statement to produce arbitrary projection lists. (#7979)

Added: local subscription info to small peer info (#9412)

Added: “device_disk_usage” information to small peer info (#9784)

Added: “store” information to small peer info (#9785)

Changed: Internal sync metadata format changed. Peers that downgrade to a previous SDK version after upgrading may require full resynchronization. (#14799)

Changed: Improved (de)serialization performance and reduced its contribution to the library size (#11545)

Changed: In updated replication protocol, verification of a received update file no longer requires both peers to use the same approach to subscription hashing. (#12672)

Changed: Experimental multihop connectivity is more resilient to mesh disruptions (#13648)

Changed: Synchronization protocol enhanced to reduce the amount of redundant data sent from small peers to big peers. (#13737)

Changed: Failed certificate verification due to a lagging device clock now results in a clearer error message (#14035)

Changed: Multicast peer-to-peer transport is no longer deprecated to improve support for environments where mDNS is unavailable (#14188)

Changed: Replication no longer redundantly re-transmits unchanged subscriptions after eviction. (#14290)

Changed: truncated peer keys are now logged in lieu of site IDs. (#14362)

Changed: improved logging in the authentication code to provide more useful error context. (#15038)

Changed: made the small peer “log request” feature much more responsive (#9777)

Fixed: Windows P2P LAN now can connect to IPv6 peers (#11468)

Fixed: In certain rare cases, resetting the same replication session multiple times could cause failure to converge. (#12616)

Fixed: Internal connection TLS caches are now bounded in size. This prevents a long living peer from holding onto more memory than required. (#13801)

Fixed: small peer info “metadata” is now persisted across app launches. (#13987)

Fixed: Bluetooth peers are handled better when disconnections occur, fixing a possible loop where a device might repeatedly try and fail to connect. (#14018)

Fixed: When replication sessions time out, write transactions on the document store may be blocked for a long period. (#14148)

Fixed: Multicast peer-to-peer transport (non-MDNS) is no longer influenced by TCP listen configuration in DittoTransportConfig (#14187)

Fixed: an issue preventing attachment transfers under high document sync load is now resolved. (#14189)

Fixed: A race condition that could cause attachments to unexpectedly crash under heavy load. (#14342)

Fixed: device name no longer incorrectly defaults to “ditto” in small peer info, when a named device first starts syncing (#14674)

Fixed: presence observers are now less-likely to fire when there is no observable change to presence data. (#14807)

Fixed: Logs report blocked_by=“no blocking transaction” when blocking transaction is known (#14966)

Fixed: In-band authentication data is now cleared on logout. (#15039)

Fixed: switching appIDs now invalidates cached authentication material correctly. (#15040)

Fixed: Transport conditions are now reported for a wider range of failures when starting Bluetooth and mDNS transports. (#8729)

Fixed: documentation for the stopSync() method to clarify that the Ditto store can be used locally after stopping sync. (#8849)

Fixed: Auth Client would hang when cached X.509 was expired. (#15110)

Deprecated:

Removed: