js-ssr-sdk

Improvements:

• Make naming of UserComparator members consistent. (https://github.com/configcat/common-js/pull/102)
• Make line terminator character sequence configurable in log messages.
• Adjust the terminology used in JSDoc comments to the main documentation.
• Minor performance improvements.

Bug fixes:

• 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.)

New features/improvements:

• Add an optional parameter named watchChanges to createFlagOverridesFromMap which controls whether the client should detect changes to the flag override map after client initialization. (https://github.com/configcat/common-js/pull/101)

Bug fixes:

• Reference a fixed version of configcat-common to avoid issues in case the "pubternal" API of configcat-common changes. (https://github.com/configcat/js-ssr-sdk/pull/79)

Improvements:

• Upgrade to configcat-common v9.1.0.
• Send ETag as a query string parameter when running in browser (because browsers don't send it automatically in every case).
• Upon client initialization test for the availability of the local storage and use LocalStorageCache only if it's available. Otherwise, use the default (in-memory) cache implementation.
• Don't swallow exceptions which are thrown in the LocalStorageCache.get/set methods so the outer exception handlers can catch and log them.

Improvements:

• Upgrade TypeScript version to 4.8.4

Security:

• Upgrade axios library to 1.6.2

Fixed a cache issue with non Latin 1 characters in the config.json.

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. (https://github.com/configcat/common-js/pull/96)
• Overhaul setting evaluation-related logging and make it consistent across SDKs.
• Performance improvements to setting evaluation (building of evaluation log is expensive, so it is skipped when info level logging is turned off).

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. (https://github.com/configcat/common-js/pull/97)
• Prevent potential issues with weak references when awaiting IConfigCatClient.waitForReady. Also, make observable if the initial cache sync-up fails.

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

• Rename the matchedEvaluationRule property to matchedTargetingRule and the matchedEvaluationPercentageRule property to matchedPercentageOption in IEvaluationDetails.
• Throw Error 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).
• Remove the deprecated ClientReadyState enum (it was renamed to ClientCacheState).
• 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. (https://github.com/configcat/common-js/pull/94)

Improvements:

• For better compatibility, restrict the TypeScript language features used to those which are available in v4.0 by downgrading the TypeScript compiler version.

New features and improvements:

• Provide a way to synchronously evaluate of feature flags/settings: consumers can create a snapshot of the client by IConfigCatClient.snapshot(), which captures the client's state (including the latest config fetched), then, using the returned object, they can execute synchronous evaluation operations.
• Add a state parameter to the clientReady hook, by means of which consumers can get information about the initialization state of the client.
• Minor performance improvements.

Bug fixes:

• Fix error logging of getValueAsync/getValueDetailsAsync calls.
• Fix JSDoc documentation of Comparator.Contains/NotContains.

• Update configcat-common dependency to v8.0.2.
  Release notes for configcat-common v8.0.2

Bug fixes:

• Fix return value of getAllValues when one or more settings evaluate with error.

Please note that this version comes with several breaking changes, so you may need to adjust your code when upgrading, especially if you're using deprecated APIs or a custom logger and/or cache implementation. You can find the detailed list of breaking changes below.

New features and improvements:

• Complete overhaul of SDK logging:
  • Simplify the logger interface (IConfigCatLogger) to make it easier to write custom implementations/adapters to logger frameworks.
  • Enable structured logging.
  • Include event IDs in log messages to make identification of log events easier.
  • Revise log messages and make them consistent across the ConfigCat SDKs.
• Revise caching of downloaded config data:
  • Change the cache interface (IConfigCatCache, formerly ICache) to get and set the cache payload as a plain string to make it easier to write custom implementations by removing the burden of data serialization from implementers.
  • Use a standardized config cache key generation algorithm and cache payload format to allow shared caches to be used by SDKs of different platforms.
• Revise JSDoc documentation.
• Improve the performance of the "IS (NOT) ONE OF (sensitive)" operators by hashing the value once (https://github.com/configcat/common-js/pull/80).

Bug fixes:

• Fix checks which ensure that IAutoPollOptions.pollIntervalSeconds, IAutoPollOptions.maxInitWaitTimeSeconds and ILazyLoadingOptions.cacheTimeToLiveSeconds settings are in the valid range. (Also, make infinite init wait possible in the case of Auto Polling.)
• Fix ... is not a function bug which can occur in Auto Polling mode, when IAutoPollOptions.maxInitWaitTimeSeconds is set to 0.

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

• Remove the createClient, createClientWithAutoPoll, createClientWithManualPoll and createClientWithLazyLoad factory functions. Alternative: getClient.
• Remove all callback-style evaluation methods (e.g. getValue, getValueDetails, etc.) from IConfigCatClient. Alternative: get*Async(...).then(result => ...)
• Remove the callback-style forceRefresh method from IConfigCatClient. Alternative: forceRefreshAsync(...).then(result => ...)
• Remove the IAutoPollOptions.configChanged callback. Alternative: options.setupHooks = hooks => hooks.on("configChanged", ...).
• Changes the type of the newConfig argument from ProjectConfig to IConfig in the configChanged hook.
• Remove the debug, info, warn and error methods from IConfigCatLogger and change the signature of the log method, which is now the single method that needs to be implemented for custom logging.
• Remove the ICache interface. Alternative: IConfigCatCache.
• Remove the getVariationIdAsync and getAllVariationIdsAsync methods from IConfigCatClient/ConfigCatClient. Alternative: getValueDetailsAsync and getAllValueDetailsAsync.
• Slightly change the behavior of flag overrides so default value is returned instead of an unsupported value.
• Slightly change the behavior of getValuesAsync and getValuesDetailsAsync to fail early with exception when these methods are called with invalid parameters:
  • Error when key is empty.
  • TypeError when defaultValue is not of an allowed type (string, boolean, number, null and undefined).
• Remove the IOverrideDataSource interface and the FlagOverrides and MapOverrideDataSource classes from the public API.
• Remove the ProjectConfig, RolloutRule and RolloutPercentageItem classes from the public API.
• Change the type of the MatchedEvaluationRule to ITargetingRule and MatchedEvaluationPercentageRule to IPercentageOption in IEvaluationDetails.
• Change the algorithm used to generate the config cache key and the format of the cache payload.

Fix client setup in getClient to use the correct cache implementation. (Potentially, this will reduce the number of necessary config JSON downloads, so it's highly recommended to upgrade to this version in case you've started to use the new getClient API).

• Update library to the new major version (v7.0) of configcat-common. You can find the detailed list of changes here.
• Re-export all public API types from configcat-common.

Fixed

• When the flagOverrides was set, the { [name: string]: Setting } map transformation of the remote settings didn't work properly.

• Add the If-None-Match header back to the request headers when the SDK is not running in browser.

• Move SDK version to query parameter.
• Let the browser send the If-None-Match and If-Modified-Since headers.

Adding polyfill for Object.fromEntries to support older browsers.
Adding tests for multiple browsers with different versions.

Passing the real SDK version to common-js instead of using common-js version.
I had to increase the version of this package with 2 major versions as it has to be greater than the current common-js version.

• Export factory function for flag overrides.

Updating configcat-common and axios deps to latest.