Config v6

[adams85]

Implements config v6 support.

Features/improvements:

• Fetch new config json version (config_v6.json) and update config model
• SDK key format validation (when client is not set up to use local-only flag overrides)
• AND conditions
• New condition types
  • Prerequisite flag condition
  • Segment condition
• Changed comparison operators
  • (NOT) CONTAINS ANY OF
• New comparison operators
  • BEFORE/AFTER
  • TEXT (NOT) EQUALS (both hashed and cleartext)
  • TEXT (NOT) STARTS/ENDS WITH ANY OF (both hashed and cleartext)
  • ARRAY CONTAINS ANY OF (both hashed and cleartext)
• Percentage options within targeting rules
• Percentage options based on custom attributes
• Custom User Object attribute handling (don't force string values + autoconversions under the hood)
• User Object attribute/comparison value trimming
• Comparison value hashing changes (SHA256, salting)
• Flag overrides vs. config json salt and segments
• EvaluationDetails.getMatchedTargetingRule/getMatchedPercentageOption properties (rename + set combinations correctly)
• Update ConfigCatClient.getKeyAndValue

Tests:

• Update cache key/payload tests
• Evaluation matrix tests
  • Config v1 features (both V1 & V2)
  • Config v2 features
• Evaluation log tests
• SDK key format validation
• Custom User Object attribute handling (don't force string values + autoconversions under the hood)
• Flag overrides vs. prerequisite flags (circular dependency, comparison value type mismatch, dependent/prereq flag overriding)
• Flag overrides vs. config json salt and segments
• EvaluationDetails.getMatchedTargetingRule/getMatchedPercentageOption properties (rename + set combinations correctly)
• Special character tests (https://trello.com/c/qh4jHrvm)
• Comparison attribute and comparison value trimming tests (https://trello.com/c/vt8FFrSZ)
• Comparison attribute conversion to canonical string representation tests (https://trello.com/c/CZgGrrcb)

Related improvements/fixes:

• Dynamically typed languages should log a warning when default value doesn't match the setting type (see https://trello.com/c/Le6vimGu)
• We should go to the cache in all polling modes instead of using the in memory variable (see https://trello.com/c/rreKm64A) (PHP SDK doesn't support polling modes)
• Improve message of log event 1103 (https://trello.com/c/Mb7rvm64)

Additional fixes:

• Fix inconsistent logging of error 1000 in the case of flag overrides.

Additional improvements:

• Improve consistency of config JSON deserialization error reporting.
• Add exception message and stack trace to the log format of the default logger.
• When evaluation fails and there is a related Throwable object, also expose it EvaluationDetails via the new getErrorException property.

Breaking changes:

• Rename the getError property to getErrorMessage in EvaluationDetails.
• Rename the getMatchedEvaluationRule property to getMatchedTargetingRule and the getMatchedEvaluationPercentageRule property to getMatchedPercentageOption in EvaluationDetails.
• Move config JSON attribute descriptor classes from the ConfigCat\Attributes to the ConfigCat\ConfigJson namespace and update them to support config JSON schema v6.

Requirement checklist (only if applicable)

• I have covered the applied changes with automated tests.
• I have executed the full automated test set against my changes.
• I have validated my changes against all supported platform versions.
• I have read and accepted the contribution agreement.

[codecov]

Codecov Report

Attention: Patch coverage is 89.11672% with 138 lines in your changes are missing coverage. Please review.

Project coverage is 87.98%. Comparing base (7cb49a4) to head (3db0359).

Files	Patch %	Lines
src/RolloutEvaluator.php	92.91%	47 Missing ⚠️
src/EvaluateLogBuilder.php	89.77%	23 Missing ⚠️
src/ConfigCatClient.php	80.28%	14 Missing ⚠️
src/Utils.php	83.13%	14 Missing ⚠️
src/ConfigJson/SettingValue.php	73.17%	11 Missing ⚠️
src/Override/LocalFileDataSource.php	50.00%	10 Missing ⚠️
src/ConfigJson/Setting.php	87.17%	5 Missing ⚠️
src/ConfigJson/TargetingRule.php	73.68%	5 Missing ⚠️
src/Cache/ConfigCache.php	0.00%	2 Missing ⚠️
src/ConfigJson/ConditionContainer.php	86.66%	2 Missing ⚠️
... and 3 more

Additional details and impacted files

@@             Coverage Diff              @@
##             master      #44      +/-   ##
============================================
+ Coverage     86.13%   87.98%   +1.85%     
- Complexity      352      782     +430     
============================================
  Files            28       35       +7     
  Lines           981     1890     +909     
============================================
+ Hits            845     1663     +818     
- Misses          136      227      +91     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[kp-cat]

I'd prefer a more descriptive function name here: like for example inlineSaltAndSegments

[sonarcloud]

Quality Gate failed

Failed conditions
1 Security Hotspot

See analysis details on SonarCloud