notes for version: v0.15.0 - perf optimizations, protocol change

[friflo]

version: 0.15.0

Main focus of release was optimization. Especially for Unity Netcode Optimization goals:

• removing heap allocation if possible. E.g. be using buffers

• remove async method calls if possible

• replacing Protocol task "patch" by "merge". See below

• Breaking API changes

  • Client: removed EntitySet<,>.Patch() methods. see: 01184976235660642cfa7e79cdf1a719f0889098 reasons:
  • methods were too complex in usage
  • implementation is inherent slow due to massive heap allocations
  • Host: FlioxHub.ExecuteRequestAsync() and .ExecuteRequest() requires now a preceding call to FlioxHub.InitSyncRequest()
  • changed EventDisptacher constructor: EventDispatcher(bool background) -> EventDispatcher(EventDispatching) EventDispatcher(false) -> (EventDispatching.Direct) EventDispatcher(true) -> (EventDispatching.QueueSend) new: EventDispatcher(EventDispatching.Queue)

• Breaking Protocol changes

  • replaced sync request task "patch" by "merge" PatchEntities -> MergeEntities. "merge" [RFC 7386: JSON Merge Patch] https://www.rfc-editor.org/rfc/rfc7386 "patch" [RFC 6902: JavaScript Object Notation (JSON) Patch] https://www.rfc-editor.org/rfc/rfc6902 reasons:
  • simplicity
    • a "merge" is easy to understand and compact in usage
    • a "merge" is always idempotent
    • a "patch" is not always idempotent. e.g. Remove by index
    • a full "patch" implementation is complex and not required by Fliox
  • performance - a "merge" outperforms a "patch" by magnitudes.

• New features / API's

  • introduced JsonMerger as an efficient implementation of [RFC 7386: JSON Merge Patch] https://www.rfc-editor.org/rfc/rfc7386
  • introduced JsonAstReader to create a tree representation from a given JSON value. Used by JsonMerger
  • add new button 'Patch' to Hub Explorer additional to 'Delete' and 'Save'
  • add FlioxClient.SyncTasksSynchronous() - can be used if all tasks can be executed synchronously throws an exception if execution cannot be executed synchronously
  • add synchronous versions of EntityContainer methods for databases supporting synchronous execution like a MemoryDatabase

• Unity

  • dropped support for compiling with preprocessor directive: JSON_BURST
  • optimize string equality test for Unity by introducing struct SmallString

• CLR

  • update all nuget dependencies
  • NUnit3TestAdapter 4.3.1
  • Microsoft.NET.Test.Sdk 17.4.0
  • FluentAssertions 6.8.0
  • Microsoft.Azure.Cosmos 3.31.2
  • Microsoft.Extensions.Configuration.Json 7.0.0
  • dropped support IL code generation -> replaced by source code generation

• Optimizations

  • avoid async calls when execution requests to avoid task allocation and reduce callstack depth in case a requests can be executed synchronously no async method is called
  • reuse object instances if possible to avoid memory allocations
  • reuse objects in ObjectReader using an InstanceBuffer
  • reuse objects of FlioxClient.SyncTasks() with SyncResult.Reuse()
  • minimize heap allocations when creating tasks with a FlioxClient
  • reduce size of JsonKey by 8 bytes
  • removed redundant byte[] copies when using an ObjectReader
  • Pub-Sub optimizations
  • minimize CPU usage when filtering tasks by subscribers
  • optimize sync event creation: reduce heap allocations
  • introduced Deque<> for queueing events without heap allocation
  • avoid heap allocations and byte[] copy when ReadAsync from Stream's
  • support reusing of byte[] values in MemoryContainer for small values
  • removed all async calls when executing a query on a MemoryContainer
  • optimize reading polymorphic types in ObjectReader
  • generate source code to Write() JSON and reading JSON fields This removes heap allocation caused by PropertyInfo / FieldInfo .GetValue() and .SetValue()