Release Notes
Rust
4 8 3 version release release date dec 18, 2024 4 8 3 common release notes 🛠️ fixed ios 18 crashes related to bluetooth le are now resolved (#15351) 🔄 changed added more actionable information to common connection handshake issues (#15298) 4 8 2 version release release date sept 25, 2024 4 8 2 rust specific changes no rust specific changes 4 8 2 common changes 🛠️ fixed setting the minimum log level to warn or error will now correctly filter out very early logger initialization messages (#14451) 🛠️ fixed a bug that could prevent an attachment created with the same data on multiple peers from syncing (#14481) 4 8 1 version release release date sept 5, 2024 4 8 1 rust specific changes no rust specific changes 4 8 1 common changes ➕ added the presence use multihop system parameter can be used to disable replicating presence information to other peers in the mesh, reducing network overhead use only with guidance from the ditto customer experience team (#14128) 🔄 changed when failing to load document data sync (replication) metadata, ditto now attempts to clear and regenerate the metadata this is a behavior change where previously ditto would fail to start this serves to prevent problems after sdk version downgrades (#13111) 🛠️ fixed a rare issue where attachments may not be transferred between two peers (#14158) 🛠️ fixed on disk logs are more robust in situations with unexpected ditto shutdown (#13723) 4 8 0 version release release date aug 28, 2024 the ditto 4 8 0 rust sdk release brings significant reliability enhancements, ensuring that rust now stands on par with our other supported languages this update focuses on stabilizing key features and improving overall performance, making the rust sdk more robust and dependable for developers whether you’re building new projects or maintaining existing ones, these enhancements will provide a smoother and more consistent experience 4 8 0 rust specific changes ⭐️ ➕ added ble support on macos #12639 ⭐️ ➕ added dittologger type, and moved all the ditto logging apis to it #12793 ⭐️ ➕ added function export to file() to dittologger , which exports collected logs to a compressed and json encoded file on the local file system logs returned through this method are at debug log level this new api can be used to do forensic log gathering on a device logs are always collected and restricted to a fixed specific size limit to ensure they don't grow endlessly once the size limit has reached new logs replace the oldest logs #11961 ➕ added store new attachment from bytes function for creating a new attachment from in memory data #12548 ➕ added properties peer key string1 and peer key string2 on connection replacing the deprecated properties peer1 and peer2 #12799 ➕ added partialeq implementation for peer and presencegraph #12943 ➕ added v3connectiontype public type to allow internal access to a presence peer's connection type #12945 ➕ added documentation for start sync() and disable sync with v3() to include a recommendation for performance improvement #13098 performance of initial sync when bootstrapping a new peer can be improved by calling disablesyncwithv3() before calling startsync() only do this when all peers in the mesh are known to be running ditto v4 or higher ➕ added documentation for property peer metadata on peer to add information about how the property behaves over the lifecycle of the presencegraph #13479 ➕ added connection type replacing the undirectedconnection type ➕ added register observer with signal next api to the ditto store namespace to allow for users to control observer callback rate in advanced usage scenarios #13397 🔄 changed the format of logs emitted by the rust sdk is now more consistent #12557 ⭐️ 🛠️ fixed ditto rust sdk no longer requires a fixed version of rust previously users of rust needed to bind their rust version to the version used by ditto going forward this is not longer the case and users need only support the minimum version of rust required by the ditto sdk 🛠️ fixed register observer delivering the same events multiple times #13397 🛠️ fixed static linking issues that used to require setting libditto static amend with=objcopy #12203 🛠️ fixed mdns not advertising on macos #12639 🛠️ fixed various improvements to the error module and types in the api #12793 🛠️ fixed rust sdk may create an extra unneeded tcp listener when peer to peer lan sync is enabled #13497 🛠️ fixed (linux) increased mdns multicast ttl from 1 to 255 to allow for cross vlan announcements #13590 ⚠️ deprecated libditto static amend with build rs script environment variable, since the reason why it was previously needed have been resolved #12203 ⚠️ deprecated errorkind as str() api please use its display implementation instead #12793 ⚠️ deprecated the logging apis on the ditto type use the dittologger instead #12793 ⚠️ deprecated properties peer1 and peer2 on connection , please use peer key string1 and peer key string2 instead #12799 ❗️🗑️ removed a few apis and types unitentially exposed under dittolive ditto error #12793 ❗️⛓️💥 breaking change transports v3 connectiontype moved to transports connectiontype , please update any necessary imports this was necessary because transports v3 connectiontype was a stop gap solution to resolve an immediate customer pain point ❗️⛓️💥 breaking change undirectedconnection type renamed to connection 4 8 0 common changes ❗️🔄 changed the logging output format for ditto sdks has been changed in 4 8 0 as part of our process to improve readablility and observability across the ditto platform customers should validate the new data format in their existing data ingestion pipelines new logging schema yyyy mm ddthh\ mm\ ss ssssss level target message {field1=value1, field2=value2, } timestamp (yyyy mm ddthh\ mm ssssss) format iso 8601 format (e g , 2024 08 16t14 23 05 123456z) description the exact time when the log entry was generated log level (level) format one of the following levels— debug, info, warning, error description indicates the severity or importance of the log entry target (target) format a string, representing the internal module/area description the source of the log entry, often corresponding to the internal module where the error was called (e g ditto init or peer event listener ) message (message) format a human readable string description the main content of the log entry structured fields ({field1=value1, field2=value2, }) format a list of key value pairs enclosed in curly braces description any additional structured data associated with the log entry these fields can include custom data that you attach to the log entry using the tracing info!(field1 = value1, "message") syntax 4 7 and earlier logging format example \[info] 2024 08 02t10 25 39 981z authclient using cached siteid; site id = 16248337916605943930 4 8 0 and later logging format example 2024 08 02t11 32 25 905562+01 00 info ditto init\ new auth client ditto auth using cached siteid site id=16248337916605943930 ⭐️ ➕ added dql support for string functions byte length and char length #12147 ⭐️ ➕ added dql support for inline object and array literal creation #12312 ⭐️ ➕ added object length and deserialize json functions in dql #12605 ⭐️ ➕ added dql insert statements support inlining the construction of an object #12761 ➕ added remote query capability allows big peer to execute read only queries on small peers usagne currently internal to ditto customer experience team members #12268 ➕ added diagnostics are now provided when collecting small peer info on disk logs #12080 ➕ added output version, sdk and build information on startup for easier debugging #12845 ➕ added introduced new internal capabilities ensure a large data payload (e g a large attachment file) cannot use all the bandwidth and prevent other data from being synced ➕ added mdns transport can now be configured with a static port for the tcp server using the tcp server bind mdns server port system parameter #13442 ⭐️ 🔄 changed new logging format that includes detailed information #10794 ⭐️ 🔄 changed the ditto logger is now more verbose by default, with a minimum log level of info instead of warning #11141 ⭐️ 🔄 changed small peer info collection is now enabled by default and its default sync scope is now bigpeeronly #12709 (device dashboard will populate information automatically) ❗️🔄 changed ( experimental ) multihop connections are formed more efficiently, e g , for ditto bus this is an incompatible protocol change from previous versions #12108, #12623 🔄 changed improve performance by avoiding deserializing the entire document if only part of it is required #10887 🔄 changed attachments now sync independently of documents, improving rainbow connection efficiency #11156 🔄 changed updating several depdencies for security patching (patch multiple old packages #12087) 🔄 changed how network os capabilities are internally linked into the library to allow for more relaiable and reusable internal logic #12362 🔄 changed api documentation for execute method to include information about its interaction with sync subscriptions #12365 🔄 changed default to creating backup bluetooth connections when there is an existing wifi connection (default mesh chooser avoid redundant bluetooth to false #13398) 🔄 changed console logging will now output to stderr instead of stdout (\[logs] logging now outputs to stderr instead of stdout #13477) 🛠️ fixed bytes and arrays not being always comparable in the legacy query language #10887 🛠️ fixed legacy query language casting counters and maps with tombstones to the wrong boolean value #10887 🛠️ fixed lowered the log level of a few sqlite3 notices that were being unnecessarily logged as warnings #12032 🛠️ fixed a crash that can occur if a dql query contains a multi byte character #12324 🛠️ fixed an issue with the transports multiplexer that could lead to a hung process this occured when dealing with large messages spanning multiple chunks (>64kb) #12428 🛠️ fixed a rare edge case that could slow down data sync betten peers #12527 🛠️ fixed frequent subscription changes along with eviction calls could cause failure to converge on data leading to inconsistent data state #11431 🛠️ fixed memory leak in third party library used for peer internal messaging #12895 🛠️ fixed transport inactive connection tracking no longer stores identifiers indefinitely this could lead to a slow growth in memory consumption for long lived applications ( 1mb/day on transports with high rate, unreliable discovery such as ble) #13147 🛠️ fixed unexpected failures to obtain a certificate for peer to peer sync are now logged at error level instead of warning #13323 ❗️🗑️ removed ( experimental ) ditto no longer supports the experimental query overlap groups feature and support has been removed this experimental feature has been removed after running a determining a lack of feasability in production scenarios the team is iterating and plan on interoducing improved capabilitites #13075