@splitsoftware/splitio-commons 1.13.2-rc.6 → 1.13.2-rc.8

package/src/evaluator/matchers/boolean.ts

@@ -1,7 +1,11 @@
-export function booleanMatcherContext(ruleAttr: boolean) {
+import { ENGINE_MATCHER_BOOLEAN } from '../../logger/constants';
+import { ILogger } from '../../logger/types';
 
+export function booleanMatcherContext(log: ILogger, ruleAttr: boolean) {
   return function booleanMatcher(runtimeAttr: boolean): boolean {
-    const booleanMatches = ruleAttr === runtimeAttr;
+    let booleanMatches = ruleAttr === runtimeAttr;
+
+    log.debug(ENGINE_MATCHER_BOOLEAN, [ruleAttr, runtimeAttr]);
 
     return booleanMatches;
   };

package/src/evaluator/matchers/cont_all.ts

@@ -1,6 +1,8 @@
+import { ENGINE_MATCHER_CONTAINS_ALL } from '../../logger/constants';
+import { ILogger } from '../../logger/types';
 import { findIndex } from '../../utils/lang';
 
-export function containsAllSetMatcherContext(ruleAttr: string[]) {
+export function containsAllSetMatcherContext(log: ILogger, ruleAttr: string[]) {
   return function containsAllMatcher(runtimeAttr: string[]): boolean {
     let containsAll = true;
 
@@ -13,6 +15,8 @@ export function containsAllSetMatcherContext(ruleAttr: string[]) {
       }
     }
 
+    log.debug(ENGINE_MATCHER_CONTAINS_ALL, [runtimeAttr, ruleAttr, containsAll]);
+
     return containsAll;
   };
 }

package/src/evaluator/matchers/cont_any.ts

@@ -1,6 +1,8 @@
+import { ENGINE_MATCHER_CONTAINS_ANY } from '../../logger/constants';
+import { ILogger } from '../../logger/types';
 import { findIndex } from '../../utils/lang';
 
-export function containsAnySetMatcherContext(ruleAttr: string[]) {
+export function containsAnySetMatcherContext(log: ILogger, ruleAttr: string[]) {
   return function containsAnyMatcher(runtimeAttr: string[]): boolean {
     let containsAny = false;
 
@@ -8,6 +10,8 @@ export function containsAnySetMatcherContext(ruleAttr: string[]) {
       if (findIndex(runtimeAttr, e => e === ruleAttr[i]) >= 0) containsAny = true;
     }
 
+    log.debug(ENGINE_MATCHER_CONTAINS_ANY, [runtimeAttr, ruleAttr, containsAny]);
+
     return containsAny;
   };
 }

package/src/evaluator/matchers/cont_str.ts

@@ -1,8 +1,12 @@
 import { isString } from '../../utils/lang';
+import { ILogger } from '../../logger/types';
+import { ENGINE_MATCHER_CONTAINS_STRING } from '../../logger/constants';
 
-export function containsStringMatcherContext(ruleAttr: string[]) {
+export function containsStringMatcherContext(log: ILogger, ruleAttr: string[]) {
   return function containsStringMatcher(runtimeAttr: string): boolean {
-    const contains = ruleAttr.some(e => isString(runtimeAttr) && runtimeAttr.indexOf(e) > -1);
+    let contains = ruleAttr.some(e => isString(runtimeAttr) && runtimeAttr.indexOf(e) > -1);
+
+    log.debug(ENGINE_MATCHER_CONTAINS_STRING, [runtimeAttr, ruleAttr, contains]);
 
     return contains;
   };

package/src/evaluator/matchers/dependency.ts

@@ -5,7 +5,7 @@ import { thenable } from '../../utils/promise/thenable';
 import { IDependencyMatcherValue, IEvaluation, ISplitEvaluator } from '../types';
 import { ENGINE_MATCHER_DEPENDENCY, ENGINE_MATCHER_DEPENDENCY_PRE } from '../../logger/constants';
 
-export function dependencyMatcherContext({ split, treatments }: IDependencyMatcherData, storage: IStorageSync | IStorageAsync, log: ILogger) {
+export function dependencyMatcherContext(log: ILogger, { split, treatments }: IDependencyMatcherData, storage: IStorageSync | IStorageAsync) {
 
   function checkTreatment(evaluation: IEvaluation, acceptableTreatments: string[], parentName: string) {
     let matches = false;

package/src/evaluator/matchers/eq.ts

@@ -1,7 +1,11 @@
-export function equalToMatcherContext(ruleAttr: number) {
+import { ENGINE_MATCHER_EQUAL } from '../../logger/constants';
+import { ILogger } from '../../logger/types';
 
+export function equalToMatcherContext(log: ILogger, ruleAttr: number) {
   return function equalToMatcher(runtimeAttr: number): boolean {
-    const isEqual = runtimeAttr === ruleAttr;
+    let isEqual = runtimeAttr === ruleAttr;
+
+    log.debug(ENGINE_MATCHER_EQUAL, [runtimeAttr, ruleAttr, isEqual]);
 
     return isEqual;
   };

package/src/evaluator/matchers/eq_set.ts

@@ -1,6 +1,8 @@
+import { ENGINE_MATCHER_EQUAL_TO_SET } from '../../logger/constants';
+import { ILogger } from '../../logger/types';
 import { findIndex } from '../../utils/lang';
 
-export function equalToSetMatcherContext(ruleAttr: string[]) {
+export function equalToSetMatcherContext(log: ILogger, ruleAttr: string[]) {
   return function equalToSetMatcher(runtimeAttr: string[]): boolean {
     // Length being the same is the first condition.
     let isEqual = runtimeAttr.length === ruleAttr.length;
@@ -10,6 +12,8 @@ export function equalToSetMatcherContext(ruleAttr: string[]) {
       if (findIndex(ruleAttr, e => e === runtimeAttr[i]) < 0) isEqual = false;
     }
 
+    log.debug(ENGINE_MATCHER_EQUAL_TO_SET, [runtimeAttr, ruleAttr, isEqual]);
+
     return isEqual;
   };
 }

package/src/evaluator/matchers/ew.ts

@@ -1,8 +1,12 @@
+import { ENGINE_MATCHER_ENDS_WITH } from '../../logger/constants';
+import { ILogger } from '../../logger/types';
 import { endsWith } from '../../utils/lang';
 
-export function endsWithMatcherContext(ruleAttr: string[]) {
+export function endsWithMatcherContext(log: ILogger, ruleAttr: string[]) {
   return function endsWithMatcher(runtimeAttr: string): boolean {
-    const strEndsWith = ruleAttr.some(e => endsWith(runtimeAttr, e));
+    let strEndsWith = ruleAttr.some(e => endsWith(runtimeAttr, e));
+
+    log.debug(ENGINE_MATCHER_ENDS_WITH, [runtimeAttr, ruleAttr, strEndsWith]);
 
     return strEndsWith;
   };

package/src/evaluator/matchers/gte.ts

@@ -1,7 +1,11 @@
-export function greaterThanEqualMatcherContext(ruleAttr: number) {
+import { ENGINE_MATCHER_GREATER } from '../../logger/constants';
+import { ILogger } from '../../logger/types';
 
+export function greaterThanEqualMatcherContext(log: ILogger, ruleAttr: number) {
   return function greaterThanEqualMatcher(runtimeAttr: number): boolean {
-    const isGreaterThanEqual = runtimeAttr >= ruleAttr;
+    let isGreaterThanEqual = runtimeAttr >= ruleAttr;
+
+    log.debug(ENGINE_MATCHER_GREATER, [runtimeAttr, ruleAttr, isGreaterThanEqual]);
 
     return isGreaterThanEqual;
   };

package/src/evaluator/matchers/index.ts

@@ -61,6 +61,6 @@ export function matcherFactory(log: ILogger, matcherDto: IMatcherDto, storage?:
 
   let matcherFn;
   // @ts-ignore
-  if (matchers[type]) matcherFn = matchers[type](value, storage, log); // There is no index-out-of-bound exception in JavaScript
+  if (matchers[type]) matcherFn = matchers[type](log, value, storage); // There is no index-out-of-bound exception in JavaScript
   return matcherFn;
 }

package/src/evaluator/matchers/lte.ts

@@ -1,7 +1,11 @@
-export function lessThanEqualMatcherContext(ruleAttr: number) {
+import { ENGINE_MATCHER_LESS } from '../../logger/constants';
+import { ILogger } from '../../logger/types';
 
+export function lessThanEqualMatcherContext(log: ILogger, ruleAttr: number) {
   return function lessThanEqualMatcher(runtimeAttr: number): boolean {
-    const isLessThanEqual = runtimeAttr <= ruleAttr;
+    let isLessThanEqual = runtimeAttr <= ruleAttr;
+
+    log.debug(ENGINE_MATCHER_LESS, [runtimeAttr, ruleAttr, isLessThanEqual]);
 
     return isLessThanEqual;
   };

package/src/evaluator/matchers/part_of.ts

@@ -1,6 +1,8 @@
 import { findIndex } from '../../utils/lang';
+import { ILogger } from '../../logger/types';
+import { ENGINE_MATCHER_PART_OF } from '../../logger/constants';
 
-export function partOfSetMatcherContext(ruleAttr: string[]) {
+export function partOfSetMatcherContext(log: ILogger, ruleAttr: string[]) {
   return function partOfMatcher(runtimeAttr: string[]): boolean {
     // To be part of the length should be minor or equal.
     let isPartOf = runtimeAttr.length <= ruleAttr.length;
@@ -10,6 +12,8 @@ export function partOfSetMatcherContext(ruleAttr: string[]) {
       if (findIndex(ruleAttr, e => e === runtimeAttr[i]) < 0) isPartOf = false;
     }
 
+    log.debug(ENGINE_MATCHER_PART_OF, [runtimeAttr, ruleAttr, isPartOf]);
+
     return isPartOf;
   };
 }

package/src/evaluator/matchers/segment.ts

@@ -1,18 +1,25 @@
 import { MaybeThenable } from '../../dtos/types';
 import { ISegmentsCacheBase } from '../../storages/types';
+import { ILogger } from '../../logger/types';
 import { thenable } from '../../utils/promise/thenable';
+import { ENGINE_MATCHER_SEGMENT } from '../../logger/constants';
 
-export function segmentMatcherContext(segmentName: string, storage: { segments: ISegmentsCacheBase }) {
+export function segmentMatcherContext(log: ILogger, segmentName: string, storage: { segments: ISegmentsCacheBase }) {
 
   return function segmentMatcher(key: string): MaybeThenable<boolean> {
     const isInSegment = storage.segments.isInSegment(segmentName, key);
 
     if (thenable(isInSegment)) {
       isInSegment.then(result => {
+        log.debug(ENGINE_MATCHER_SEGMENT, [segmentName, key, isInSegment]);
+
         return result;
       });
+    } else {
+      log.debug(ENGINE_MATCHER_SEGMENT, [segmentName, key, isInSegment]);
     }
 
     return isInSegment;
   };
+
 }

package/src/evaluator/matchers/semver_between.ts

@@ -1,7 +1,8 @@
 import { IBetweenStringMatcherData } from '../../dtos/types';
+import { ILogger } from '../../logger/types';
 import { Semver } from '../../utils/Semver';
 
-export function betweenSemverMatcherContext(ruleAttr: IBetweenStringMatcherData) {
+export function betweenSemverMatcherContext(log: ILogger, ruleAttr: IBetweenStringMatcherData) {
   const startSemver = new Semver(ruleAttr.start);
   const endSemver = new Semver(ruleAttr.end);
 

package/src/evaluator/matchers/semver_eq.ts

@@ -1,6 +1,7 @@
+import { ILogger } from '../../logger/types';
 import { Semver } from '../../utils/Semver';
 
-export function equalToSemverMatcherContext(ruleAttr: string) {
+export function equalToSemverMatcherContext(log: ILogger, ruleAttr: string) {
   const ruleSemver = new Semver(ruleAttr);
 
   return function equalToSemverMatcher(runtimeAttr: string): boolean {

package/src/evaluator/matchers/semver_gte.ts

@@ -1,6 +1,7 @@
+import { ILogger } from '../../logger/types';
 import { Semver } from '../../utils/Semver';
 
-export function greaterThanEqualToSemverMatcherContext(ruleAttr: string) {
+export function greaterThanEqualToSemverMatcherContext(log: ILogger, ruleAttr: string) {
   const ruleSemver = new Semver(ruleAttr);
 
   return function greaterThanEqualToSemverMatcher(runtimeAttr: string): boolean {

package/src/evaluator/matchers/semver_inlist.ts

@@ -1,15 +1,15 @@
 import { _Set } from '../../utils/lang/sets';
+import { ILogger } from '../../logger/types';
 import { Semver } from '../../utils/Semver';
 
-export function inListSemverMatcherContext(ruleAttr: string[]) {
-  // @TODO move eventually to `matchersTransform` and validate for all matchers
+export function inListSemverMatcherContext(log: ILogger, ruleAttr: string[]) {
+  // @TODO ruleAttr validation should be done at the `parser` or `matchersTransform` level to reuse for all matchers
   if (!ruleAttr || ruleAttr.length === 0) throw new Error('whitelistMatcherData is required for IN_LIST_SEMVER matcher type');
 
   const listOfSemvers = new _Set(ruleAttr.map((version) => new Semver(version).version));
 
   return function inListSemverMatcher(runtimeAttr: string): boolean {
     const runtimeSemver = new Semver(runtimeAttr).version;
-
     const isInList = listOfSemvers.has(runtimeSemver);
 
     return isInList;

package/src/evaluator/matchers/semver_lte.ts

@@ -1,6 +1,7 @@
+import { ILogger } from '../../logger/types';
 import { Semver } from '../../utils/Semver';
 
-export function lessThanEqualToSemverMatcherContext(ruleAttr: string) {
+export function lessThanEqualToSemverMatcherContext(log: ILogger, ruleAttr: string) {
   const ruleSemver = new Semver(ruleAttr);
 
   return function lessThanEqualToSemverMatcher(runtimeAttr: string): boolean {

package/src/evaluator/matchers/string.ts

@@ -1,9 +1,14 @@
-export function stringMatcherContext(ruleAttr: string) {
+import { ENGINE_MATCHER_STRING } from '../../logger/constants';
+import { ILogger } from '../../logger/types';
+
+export function stringMatcherContext(log: ILogger, ruleAttr: string) {
   const regex = new RegExp(ruleAttr);
 
   return function stringMatcher(runtimeAttr: string): boolean {
     const regexMatches = regex.test(runtimeAttr);
 
+    log.debug(ENGINE_MATCHER_STRING, [runtimeAttr, ruleAttr, regexMatches ? 'yes' : 'no']);
+
     return regexMatches;
   };
 }

package/src/evaluator/matchers/sw.ts

@@ -1,8 +1,12 @@
+import { ENGINE_MATCHER_STARTS_WITH } from '../../logger/constants';
+import { ILogger } from '../../logger/types';
 import { startsWith } from '../../utils/lang';
 
-export function startsWithMatcherContext(ruleAttr: string[]) {
+export function startsWithMatcherContext(log: ILogger, ruleAttr: string[]) {
   return function startsWithMatcher(runtimeAttr: string): boolean {
-    const matches = ruleAttr.some(e => startsWith(runtimeAttr, e));
+    let matches = ruleAttr.some(e => startsWith(runtimeAttr, e));
+
+    log.debug(ENGINE_MATCHER_STARTS_WITH, [runtimeAttr, ruleAttr, matches]);
 
     return matches;
   };

package/src/evaluator/matchers/whitelist.ts

@@ -1,11 +1,15 @@
 import { _Set } from '../../utils/lang/sets';
+import { ILogger } from '../../logger/types';
+import { ENGINE_MATCHER_WHITELIST } from '../../logger/constants';
 
-export function whitelistMatcherContext(ruleAttr: string[]) {
+export function whitelistMatcherContext(log: ILogger, ruleAttr: string[]) {
   const whitelistSet = new _Set(ruleAttr);
 
   return function whitelistMatcher(runtimeAttr: string): boolean {
     const isInWhitelist = whitelistSet.has(runtimeAttr);
 
+    log.debug(ENGINE_MATCHER_WHITELIST, [runtimeAttr, ruleAttr.join(','), isInWhitelist]);
+
     return isInWhitelist;
   };
 }

package/src/evaluator/matchersTransform/index.ts

@@ -31,7 +31,7 @@ export function matchersTransform(matchers: ISplitMatcher[]): IMatcherDto[] {
     let type = matcherTypesMapper(matcherType);
     // As default input data type we use string (even for ALL_KEYS)
     let dataType = matcherDataTypes.STRING;
-    let value: IMatcherDto['value'] = undefined;
+    let value = undefined;
 
     if (type === matcherTypes.IN_SEGMENT) {
       value = segmentTransform(userDefinedSegmentMatcherData as IInSegmentMatcherData);
@@ -98,6 +98,7 @@ export function matchersTransform(matchers: ISplitMatcher[]): IMatcherDto[] {
       attribute,        // attribute over we should do the matching, undefined means 'use the key'
       negate,           // should we negate the result?
       type,             // which kind of matcher we should evaluate
+      name: matcherType,// name of the matcher for logging purposes
       value,            // metadata used for the matching
       dataType          // runtime input data type
     };

package/src/evaluator/matchersTransform/whitelist.ts

@@ -1,7 +1,7 @@
 import { ISplitMatcher } from '../../dtos/types';
 
 /**
- * Extract whitelist as a set. Used by 'WHITELIST' matcher.
+ * Extract whitelist array.
  */
 export function whitelistTransform(whitelistObject: ISplitMatcher['whitelistMatcherData']) {
   return whitelistObject && whitelistObject.whitelist;

package/src/evaluator/parser/index.ts

@@ -11,7 +11,7 @@ import { ISplitCondition, MaybeThenable } from '../../dtos/types';
 import { IStorageAsync, IStorageSync } from '../../storages/types';
 import { SplitIO } from '../../types';
 import { ILogger } from '../../logger/types';
-import { ENGINE_MATCHER_ERROR, ENGINE_MATCHER_RESULT } from '../../logger/constants';
+import { ENGINE_MATCHER_ERROR } from '../../logger/constants';
 
 export function parser(log: ILogger, conditions: ISplitCondition[], storage: IStorageSync | IStorageAsync): IEvaluator {
   let predicates = [];
@@ -28,12 +28,12 @@ export function parser(log: ILogger, conditions: ISplitCondition[], storage: ISt
     const matchers = matchersTransform(matcherGroup.matchers);
 
     // create a set of pure functions from the matcher's dto
-    const expressions = matchers.map((matcherDto: IMatcherDto, index: number) => {
+    const expressions = matchers.map((matcherDto: IMatcherDto) => {
       let matcher: ReturnType<typeof matcherFactory>;
       try {
         matcher = matcherFactory(log, matcherDto, storage);
       } catch (error) {
-        log.error(ENGINE_MATCHER_ERROR, [matcherGroup.matchers[index].matcherType, error]);
+        log.error(ENGINE_MATCHER_ERROR, [matcherDto.name, error]);
       }
 
       // Evaluator function.
@@ -45,19 +45,14 @@ export function parser(log: ILogger, conditions: ISplitCondition[], storage: ISt
           try {
             result = matcher(value, splitEvaluator);
           } catch (error) {
-            // @TODO should we propagate the error, to create impressions with label EXCEPTION?
-            log.error(ENGINE_MATCHER_ERROR, [matcherGroup.matchers[index].matcherType, error]);
+            log.error(ENGINE_MATCHER_ERROR, [matcherDto.name, error]);
           }
         }
 
-        function handleResult(result: boolean) {
-          log.debug(ENGINE_MATCHER_RESULT, [matcherGroup.matchers[index].matcherType, result, matcherDto.value, value]); // @ts-ignore
-          return Boolean(result ^ matcherDto.negate);
-        }
-
-        return thenable(result) ?
-          result.then(handleResult) :
-          handleResult(result);
+        if (thenable(result)) { // @ts-ignore
+          return result.then(res => Boolean(res ^ matcherDto.negate));
+        } // @ts-ignore
+        return Boolean(result ^ matcherDto.negate);
       };
     });
 

package/src/evaluator/types.ts

@@ -10,6 +10,7 @@ export interface IDependencyMatcherValue {
 
 export interface IMatcherDto {
   type: number
+  name: string
   value?: string | number | boolean | string[] | IDependencyMatcherData | IBetweenMatcherData | IBetweenStringMatcherData | null
 
   attribute: string | null

package/src/logger/constants.ts

@@ -9,8 +9,24 @@ export const ENGINE_COMBINER_AND = 0;
 export const ENGINE_COMBINER_IFELSEIF = 1;
 export const ENGINE_COMBINER_IFELSEIF_NO_TREATMENT = 2;
 export const ENGINE_BUCKET = 3;
+export const ENGINE_MATCHER_ALL = 4;
+export const ENGINE_MATCHER_BETWEEN = 5;
+export const ENGINE_MATCHER_BOOLEAN = 6;
+export const ENGINE_MATCHER_CONTAINS_ALL = 7;
+export const ENGINE_MATCHER_CONTAINS_ANY = 8;
+export const ENGINE_MATCHER_CONTAINS_STRING = 9;
 export const ENGINE_MATCHER_DEPENDENCY = 10;
 export const ENGINE_MATCHER_DEPENDENCY_PRE = 11;
+export const ENGINE_MATCHER_EQUAL = 12;
+export const ENGINE_MATCHER_EQUAL_TO_SET = 13;
+export const ENGINE_MATCHER_ENDS_WITH = 14;
+export const ENGINE_MATCHER_GREATER = 15;
+export const ENGINE_MATCHER_LESS = 16;
+export const ENGINE_MATCHER_PART_OF = 17;
+export const ENGINE_MATCHER_SEGMENT = 18;
+export const ENGINE_MATCHER_STRING = 19;
+export const ENGINE_MATCHER_STARTS_WITH = 21;
+export const ENGINE_MATCHER_WHITELIST = 22;
 export const ENGINE_VALUE = 23;
 export const ENGINE_SANITIZE = 24;
 export const CLEANUP_REGISTERING = 25;
@@ -28,7 +44,6 @@ export const SYNC_TASK_START = 36;
 export const SYNC_TASK_EXECUTE = 37;
 export const SYNC_TASK_STOP = 38;
 export const SETTINGS_SPLITS_FILTER = 39;
-export const ENGINE_MATCHER_RESULT = 40;
 
 export const CLIENT_READY_FROM_CACHE = 100;
 export const CLIENT_READY = 101;

package/src/logger/messages/debug.ts

@@ -7,11 +7,26 @@ export const codesDebug: [number, string][] = codesInfo.concat([
   [c.ENGINE_COMBINER_IFELSEIF, c.LOG_PREFIX_ENGINE_COMBINER + 'Treatment found: %s'],
   [c.ENGINE_COMBINER_IFELSEIF_NO_TREATMENT, c.LOG_PREFIX_ENGINE_COMBINER + 'All predicates evaluated, no treatment found.'],
   [c.ENGINE_BUCKET, c.LOG_PREFIX_ENGINE + ': using algo "murmur" bucket %s for key %s using seed %s - treatment %s'],
-  [c.ENGINE_MATCHER_DEPENDENCY, c.LOG_PREFIX_ENGINE_MATCHER + '[dependencyMatcher] parent feature flag "%s" evaluated to "%s" with label "%s". %s evaluated treatment is part of %s ? %s.'],
+  [c.ENGINE_MATCHER_ALL, c.LOG_PREFIX_ENGINE_MATCHER + '[allMatcher] is always true'],
+  [c.ENGINE_MATCHER_BETWEEN, c.LOG_PREFIX_ENGINE_MATCHER + '[betweenMatcher] is %s between %s and %s? %s'],
+  [c.ENGINE_MATCHER_BOOLEAN, c.LOG_PREFIX_ENGINE_MATCHER + '[booleanMatcher] %s === %s'],
+  [c.ENGINE_MATCHER_CONTAINS_ALL, c.LOG_PREFIX_ENGINE_MATCHER + '[containsAllMatcher] %s contains all elements of %s? %s'],
+  [c.ENGINE_MATCHER_CONTAINS_ANY, c.LOG_PREFIX_ENGINE_MATCHER + '[containsAnyMatcher] %s contains at least an element of %s? %s'],
+  [c.ENGINE_MATCHER_CONTAINS_STRING, c.LOG_PREFIX_ENGINE_MATCHER + '[containsStringMatcher] %s contains %s? %s'],
+  [c.ENGINE_MATCHER_DEPENDENCY, c.LOG_PREFIX_ENGINE_MATCHER + '[dependencyMatcher] parent feature flag "%s" evaluated to "%s" with label "%s". %s evaluated treatment is part of [%s] ? %s.'],
   [c.ENGINE_MATCHER_DEPENDENCY_PRE, c.LOG_PREFIX_ENGINE_MATCHER + '[dependencyMatcher] will evaluate parent feature flag: "%s" with key: %s %s'],
-  [c.ENGINE_VALUE, c.LOG_PREFIX_ENGINE_VALUE + 'Extracted attribute `%s`. %s will be used for matching.'],
-  [c.ENGINE_SANITIZE, c.LOG_PREFIX_ENGINE + ':sanitize: Attempted to sanitize %s which should be of type %s. Sanitized and processed value => %s'],
-  [c.ENGINE_MATCHER_RESULT, c.LOG_PREFIX_ENGINE_MATCHER + '[%s] Result: %s. Rule value: %s. Evaluation value: %s'],
+  [c.ENGINE_MATCHER_EQUAL, c.LOG_PREFIX_ENGINE_MATCHER + '[equalToMatcher] is %s equal to %s? %s'],
+  [c.ENGINE_MATCHER_EQUAL_TO_SET, c.LOG_PREFIX_ENGINE_MATCHER + '[equalToSetMatcher] is %s equal to set %s? %s'],
+  [c.ENGINE_MATCHER_ENDS_WITH, c.LOG_PREFIX_ENGINE_MATCHER + '[endsWithMatcher] %s ends with %s? %s'],
+  [c.ENGINE_MATCHER_GREATER, c.LOG_PREFIX_ENGINE_MATCHER + '[greaterThanEqualMatcher] is %s greater than %s? %s'],
+  [c.ENGINE_MATCHER_LESS, c.LOG_PREFIX_ENGINE_MATCHER + '[lessThanEqualMatcher] is %s less than %s? %s'],
+  [c.ENGINE_MATCHER_PART_OF, c.LOG_PREFIX_ENGINE_MATCHER + '[partOfMatcher] %s is part of %s? %s'],
+  [c.ENGINE_MATCHER_SEGMENT, c.LOG_PREFIX_ENGINE_MATCHER + '[segmentMatcher] evaluated %s / %s => %s'],
+  [c.ENGINE_MATCHER_STRING, c.LOG_PREFIX_ENGINE_MATCHER + '[stringMatcher] does %s matches with %s? %s'],
+  [c.ENGINE_MATCHER_STARTS_WITH, c.LOG_PREFIX_ENGINE_MATCHER + '[startsWithMatcher] %s starts with %s? %s'],
+  [c.ENGINE_MATCHER_WHITELIST, c.LOG_PREFIX_ENGINE_MATCHER + '[whitelistMatcher] evaluated %s in [%s] => %s'],
+  [c.ENGINE_VALUE, c.LOG_PREFIX_ENGINE_VALUE + 'Extracted attribute [%s], [%s] will be used for matching.'],
+  [c.ENGINE_SANITIZE, c.LOG_PREFIX_ENGINE + ':sanitize: Attempted to sanitize [%s] which should be of type [%s]. Sanitized and processed value => [%s]'],
   // SDK
   [c.CLEANUP_REGISTERING, c.LOG_PREFIX_CLEANUP + 'Registering cleanup handler %s'],
   [c.CLEANUP_DEREGISTERING, c.LOG_PREFIX_CLEANUP + 'Deregistering cleanup handler %s'],

package/src/logger/messages/error.ts

@@ -2,7 +2,7 @@ import * as c from '../constants';
 
 export const codesError: [number, string][] = [
   // evaluator
-  [c.ERROR_ENGINE_COMBINER_IFELSEIF, c.LOG_PREFIX_ENGINE_COMBINER + 'Invalid feature flag, no valid rules or unsupported matcher type found'],
+  [c.ERROR_ENGINE_COMBINER_IFELSEIF, c.LOG_PREFIX_ENGINE_COMBINER + 'Invalid feature flag, no valid rules or unsupported targeting rule type found'],
   [c.ENGINE_MATCHER_ERROR, c.LOG_PREFIX_ENGINE_MATCHER + '[%s] %s'],
   // SDK
   [c.ERROR_LOGLEVEL_INVALID, 'logger: Invalid Log Level - No changes to the logs will be applied.'],

package/src/logger/messages/warn.ts

@@ -4,7 +4,7 @@ import { codesError } from './error';
 export const codesWarn: [number, string][] = codesError.concat([
   // evaluator
   [c.ENGINE_VALUE_INVALID, c.LOG_PREFIX_ENGINE_VALUE + 'Value %s doesn\'t match with expected type.'],
-  [c.ENGINE_VALUE_NO_ATTRIBUTES, c.LOG_PREFIX_ENGINE_VALUE + 'Defined attribute `%s`. No attributes received.'],
+  [c.ENGINE_VALUE_NO_ATTRIBUTES, c.LOG_PREFIX_ENGINE_VALUE + 'Defined attribute [%s], no attributes received.'],
   // synchronizer
   [c.SYNC_MYSEGMENTS_FETCH_RETRY, c.LOG_PREFIX_SYNC_MYSEGMENTS + 'Retrying download of segments #%s. Reason: %s'],
   [c.SYNC_SPLITS_FETCH_FAILS, c.LOG_PREFIX_SYNC_SPLITS + 'Error while doing fetch of feature flags. %s'],

package/src/services/splitApi.ts

@@ -4,7 +4,7 @@ import { splitHttpClientFactory } from './splitHttpClient';
 import { ISplitApi } from './types';
 import { objectAssign } from '../utils/lang/objectAssign';
 import { ITelemetryTracker } from '../trackers/types';
-import { SPLITS, IMPRESSIONS, IMPRESSIONS_COUNT, EVENTS, TELEMETRY, TOKEN, SEGMENT, MY_SEGMENT } from '../utils/constants';
+import { SPLITS, IMPRESSIONS, IMPRESSIONS_COUNT, EVENTS, TELEMETRY, TOKEN, SEGMENT, MY_SEGMENT, FLAGS_SPEC } from '../utils/constants';
 import { ERROR_TOO_MANY_SETS } from '../logger/constants';
 
 const noCacheHeaderOptions = { headers: { 'Cache-Control': 'no-cache' } };
@@ -44,17 +44,16 @@ export function splitApiFactory(
     },
 
     fetchAuth(userMatchingKeys?: string[]) {
-      let url = `${urls.auth}/v2/auth`;
-      if (userMatchingKeys) { // accounting the possibility that `userMatchingKeys` is undefined (server-side API)
+      let url = `${urls.auth}/v2/auth?s=${FLAGS_SPEC}`;
+      if (userMatchingKeys) { // `userMatchingKeys` is undefined in server-side
         const queryParams = userMatchingKeys.map(userKeyToQueryParam).join('&');
-        if (queryParams) // accounting the possibility that `userKeys` and thus `queryParams` are empty
-          url += '?' + queryParams;
+        if (queryParams) url += '&' + queryParams;
       }
       return splitHttpClient(url, undefined, telemetryTracker.trackHttp(TOKEN));
     },
 
     fetchSplitChanges(since: number, noCache?: boolean, till?: number) {
-      const url = `${urls.sdk}/splitChanges?since=${since}${till ? '&till=' + till : ''}${filterQueryString || ''}`;
+      const url = `${urls.sdk}/splitChanges?s=${FLAGS_SPEC}&since=${since}${till ? '&till=' + till : ''}${filterQueryString || ''}`;
       return splitHttpClient(url, noCache ? noCacheHeaderOptions : undefined, telemetryTracker.trackHttp(SPLITS))
         .catch((err) => {
           if (err.statusCode === 414) settings.log.error(ERROR_TOO_MANY_SETS);

package/src/storages/KeyBuilder.ts

@@ -1,4 +1,5 @@
 import { ISettings } from '../types';
+import { FLAGS_SPEC } from '../utils/constants';
 import { startsWith } from '../utils/lang';
 import { hash } from '../utils/murmur3/murmur3';
 
@@ -81,9 +82,9 @@ export class KeyBuilder {
 }
 
 /**
- * Generates a murmur32 hash based on the authorization key and the feature flags filter query.
+ * Generates a murmur32 hash based on the authorization key, the feature flags filter query, and version of SplitChanges API.
  * The hash is in hexadecimal format (8 characters max, 32 bits).
  */
 export function getStorageHash(settings: ISettings) {
-  return hash(`${settings.core.authorizationKey}::${settings.sync.__splitFiltersValidation.queryString}`).toString(16);
+  return hash(`${settings.core.authorizationKey}::${settings.sync.__splitFiltersValidation.queryString}::${FLAGS_SPEC}`).toString(16);
 }

package/src/storages/inLocalStorage/SplitsCacheInLocal.ts

@@ -146,7 +146,7 @@ export class SplitsCacheInLocal extends AbstractSplitsCacheSync {
 
     // when using a new split query, we must update it at the store
     if (this.updateNewFilter) {
-      this.log.info(LOG_PREFIX + 'SDK key or feature flag filter criteria was modified. Updating cache');
+      this.log.info(LOG_PREFIX + 'SDK key, flags filter criteria or flags spec version was modified. Updating cache');
       const storageHashKey = this.keys.buildHashKey();
       try {
         localStorage.setItem(storageHashKey, this.storageHash);

package/src/storages/pluggable/index.ts

@@ -96,7 +96,7 @@ export function PluggableStorage(options: PluggableStorageOptions): IStorageAsyn
         return wrapper.get(keys.buildHashKey()).then((hash) => {
           const currentHash = getStorageHash(settings);
           if (hash !== currentHash) {
-            log.info(LOG_PREFIX + 'Storage HASH has changed (SDK key or feature flag filter criteria was modified). Clearing cache');
+            log.info(LOG_PREFIX + 'Storage HASH has changed (SDK key, flags filter criteria or flags spec version was modified). Clearing cache');
             return wrapper.getKeysByPrefix(`${keys.prefix}.`).then(storageKeys => {
               return Promise.all(storageKeys.map(storageKey => wrapper.del(storageKey)));
             }).then(() => wrapper.set(keys.buildHashKey(), currentHash));

package/src/utils/constants/index.ts

@@ -104,3 +104,5 @@ export const NON_REQUESTED = 1;
 export const DISABLED = 0;
 export const ENABLED = 1;
 export const PAUSED = 2;
+
+export const FLAGS_SPEC = '1.1';

package/src/utils/labels/index.ts

@@ -5,4 +5,4 @@ export const SDK_NOT_READY = 'not ready';
 export const EXCEPTION = 'exception';
 export const SPLIT_ARCHIVED = 'archived';
 export const NOT_IN_SPLIT = 'not in split';
-export const UNSUPPORTED_MATCHER_TYPE = 'unsupported matcher type';
+export const UNSUPPORTED_MATCHER_TYPE = 'targeting rule type unsupported by sdk';

package/types/evaluator/matchers/all.d.ts

@@ -1 +1,2 @@
-export declare function allMatcherContext(): (runtimeAttr: string) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function allMatcherContext(log: ILogger): (runtimeAttr: string) => boolean;

package/types/evaluator/matchers/between.d.ts

@@ -1,2 +1,3 @@
 import { IBetweenMatcherData } from '../../dtos/types';
-export declare function betweenMatcherContext(ruleVO: IBetweenMatcherData): (runtimeAttr: number) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function betweenMatcherContext(log: ILogger, ruleVO: IBetweenMatcherData): (runtimeAttr: number) => boolean;

package/types/evaluator/matchers/boolean.d.ts

@@ -1 +1,2 @@
-export declare function booleanMatcherContext(ruleAttr: boolean): (runtimeAttr: boolean) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function booleanMatcherContext(log: ILogger, ruleAttr: boolean): (runtimeAttr: boolean) => boolean;

package/types/evaluator/matchers/cont_all.d.ts

@@ -1 +1,2 @@
-export declare function containsAllSetMatcherContext(ruleAttr: string[]): (runtimeAttr: string[]) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function containsAllSetMatcherContext(log: ILogger, ruleAttr: string[]): (runtimeAttr: string[]) => boolean;

package/types/evaluator/matchers/cont_any.d.ts

@@ -1 +1,2 @@
-export declare function containsAnySetMatcherContext(ruleAttr: string[]): (runtimeAttr: string[]) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function containsAnySetMatcherContext(log: ILogger, ruleAttr: string[]): (runtimeAttr: string[]) => boolean;

package/types/evaluator/matchers/cont_str.d.ts

@@ -1 +1,2 @@
-export declare function containsStringMatcherContext(ruleAttr: string[]): (runtimeAttr: string) => boolean;
+import { ILogger } from '../../logger/types';
+export declare function containsStringMatcherContext(log: ILogger, ruleAttr: string[]): (runtimeAttr: string) => boolean;