Skip to content

Releases: configcat/.net-sdk

v9.3.2

09 Oct 13:53
53af703
Compare
Choose a tag to compare

Security fixes:

  • Upgrade vulnerable version of System.Text.Json to patched version (see also dotnet/announcements#329). Affected target frameworks: net461, netstandard2.0, netstandard2.1, net5.0. (#100)

v9.3.1

11 Sep 09:03
c589c37
Compare
Choose a tag to compare

Bug fixes:

  • Check cache expiration in every poll iteration, not just the first one in Auto Polling mode to reduce network traffic when the SDK uses a shared cache. (#98)
  • Synchronize in-memory cache with the external cache in every poll iteration, not just the first one in Auto Polling mode regardless of offline mode to keep in-memory cache up-to-date when the SDK uses a shared cache.

v9.3.0

28 Aug 13:46
9d4acd7
Compare
Choose a tag to compare

New features:

  • Provide a new, more convenient way (ConfigCatClientOptions.LogFilter) for consumers to specify custom log event filter logic. (#95)

Improvements:

  • Make the SDK trimmable and AOT-friendly by switching to source generated JSON serialization. Now it is compatible with AOT deployment models like NativeAOT, wasm-tools, IL2CPP, etc. (#94)
  • Add support for Unity WebGL. (See ConfigCatClient.PlatformCompatibilityOptions and sample script files.)
  • Switch to source generated regular expressions for improving performance in .NET 8+ applications.
  • Minor performance improvements (reduced memory allocation) around log messages and evaluation log building. (#95)
  • Include additional clues in log messages when config fetching from CDN servers fails to make it easier to investigate issues. (#96)

v9.2.0

13 May 11:57
4325672
Compare
Choose a tag to compare

New features and improvements:

  • Add methods ("snapshot API") which make it possible to synchronously evaluate feature flags/settings without block waiting for potential underlying I/O operations. At the same time, deprecate synchronous methods that may involve block waiting. (#81)
  • Add a parameter named CacheState to the event args of the ClientReady event, by means of which consumers can get information about the initialization state of the client.
  • Define error codes (EvaluationErrorCode, RefreshErrorCode) and expose them (EvaluationDetails.ErrorCode, RefreshResult.ErrorCode) to consumers so they can reliably identify the error type without resorting to guess it by checking the error message. (#86)
  • Introduce a new hook named ConfigFetched which can be used to observe config fetching-related errors even when refreshing is done by the SDK.
  • Add the missing GetKeyAndValue/GetKeyAndValueAsync method to improve consistency with other SDKs. (#91)

Bug fixes:

  • Make subscription to hook events thread-safe.

v9.1.0

21 Mar 10:34
ed0a54d
Compare
Choose a tag to compare

Improvements:

  • Make naming of UserComparator members consistent. (#89)
  • Adjust the terminology used in XML comments to the main documentation.
  • Minor performance improvements. (#88)

Bug fixes:

  • Use HttpClientHandler.AutomaticDecompression only when it's available (to support Blazor WASM). (#90)
  • Fix a few edge cases where user attribute values was not converted to their canonical string representations. (#88)
  • Don't accept string arrays that contain null values in the case of ARRAY (NOT) CONTAINS ANY OF comparators.
  • Allow leading/trailing whitespace in length prefix for (NOT) STARTS/ENDS WITH ANY OF comparators to align behavior with other SDKs. (#89)
  • Align evaluation logging and evaluator error reporting in some edge cases where the config JSON contains errors.
  • Correct grammar mistakes in error messages.

Breaking changes:

  • Change the name of some UserComparator members: Is(Not)OneOf -> TextIs(Not)OneOf, SensitiveIs(Not)OneOf -> SensitiveTextIs(Not)OneOf, (Not)ContainsAnyOf -> Text(Not)ContainsAnyOf. (Low impact expected.)

v9.0.1

09 Jan 14:03
71f21c0
Compare
Choose a tag to compare

Improvements:

  • Don't swallow but log exceptions when config JSON deserialization fails so users can get a clue about what went wrong with the deserialization.
  • Improve the message of log event 1103.
  • Minor code quality improvements.

v9.0.0

21 Nov 16:29
70c1d69
Compare
Choose a tag to compare

New features and improvements:

  • Add support for the new Config JSON v6 format: update the config model and implement new features in setting evaluation logic. (#75)
  • Overhaul setting evaluation-related logging and make it consistent across SDKs.
  • Significant performance improvements to setting evaluation, especially when info level logging is turned off:
Method LogInfo Mean Error StdDev Gen0 Allocated
MatrixTests_ConfigV5 False 47.31 ms 1.741 ms 0.095 ms 9909.0909 39.61 MB
MatrixTests_ConfigV6 False 17.25 ms 3.376 ms 0.185 ms 3468.7500 13.84 MB

Bug fixes:

  • Hook event handlers which close over the client instance should not prevent the client from being collected by the GC when user has no more references to the client instance. (#82)
  • Fix a minor bug in the Task.WaitAsync polyfill: potential cancellation or exception needs to be propagated in every case. (#83)
  • Avoid making an unnecessary copy of the input string when deserializing JSON in .NET 4.5.

Breaking changes (listed in the order of expected impact):

  • Change the type of the User.Custom property from IDictionary<string, string?> to IDictionary<string, object> to allow other values than string but disallow null values. (#75)
  • The config JSON v5 format is no longer accepted by flag overrides. If you use this feature, you will need to convert your override JSON file(s) to the v6 format. You can do this using the config-json convert v5-to-v6 command of the ConfigCat CLI tool.
  • Rename the MatchedEvaluationRule property to MatchedTargetingRule and the MatchedEvaluationPercentageRule property to MatchedPercentageOption in EvaluationDetails.
  • Throw ArgumentException when the SDK key passed to ConfigCatClient.Get is in invalid format (unless the client is set up to use local-only flag override behavior).
  • Change config model (IConfig and related interfaces/enums).
  • Slightly change the behavior of the ClientReady hook in Auto Poll mode to fire after the completion of the first fetch operation - regardless of success or failure - to make the behavior consistent with other SDKs. (#79)
  • Change the User.AllAttributes property into a method (GetAllAttributes) as it allocates under the hood.
  • Revert EvaluationDetails and RefreshResult from records to plain types as value equality is not implemented correctly (and it would not be really useful anyway).

v8.2.0

26 Jul 10:31
57f08f2
Compare
Choose a tag to compare

Bug fixes:

  • Fix reported SDK version (removes Git commit hash from the version string).
  • Fix error logging of GetValue(Async)/GetValueDetails(Async) calls.
  • Fix XML documentation of Comparator.Contains/NotContains.

Breaking changes:

  • Remove unintended setter of IPercentageOption.VariationId. (Very low impact expected.)

v8.1.1

23 Jun 15:45
939f897
Compare
Choose a tag to compare

Bug fixes:

  • Fix return value of GetAllValues/GetAllValuesAsync when one or more settings evaluate with error.
  • Add missing unsupported value check when evaluating multiple settings.

v8.1.0

12 Jun 16:31
19d647a
Compare
Choose a tag to compare

New features and improvements:

  • Remove unnecessary package references (#71).
  • Use a standardized config cache key generation algorithm and cache payload format to allow shared caches to be used by SDKs of different platforms.
  • Enable deterministic (a.k.a. reproducible) build.
  • Minor improvements to the XML documentation.