Merge pull request #306 from splitio/SDKS_8273_reuse_matchers_debug_logs

EmilianoSanchez · web-flow · commit 791aa25eaf38 · 2024-05-06T10:53:48.000-03:00
[SDKS-8273] Reuse and polish debug logs
diff --git a/src/evaluator/matchers/all.ts b/src/evaluator/matchers/all.ts
@@ -1,10 +1,6 @@
-import { ENGINE_MATCHER_ALL } from '../../logger/constants';
-import { ILogger } from '../../logger/types';
+export function allMatcherContext() {
 
-export function allMatcherContext(log: ILogger) {
   return function allMatcher(runtimeAttr: string): boolean {
-    log.debug(ENGINE_MATCHER_ALL);
-
     return runtimeAttr != null;
   };
 }
diff --git a/src/evaluator/matchers/between.ts b/src/evaluator/matchers/between.ts
@@ -1,13 +1,9 @@
 import { IBetweenMatcherData } from '../../dtos/types';
-import { ENGINE_MATCHER_BETWEEN } from '../../logger/constants';
-import { ILogger } from '../../logger/types';
 
-export function betweenMatcherContext(log: ILogger, ruleVO: IBetweenMatcherData) {
-  return function betweenMatcher(runtimeAttr: number): boolean {
-
-    let isBetween = runtimeAttr >= ruleVO.start && runtimeAttr <= ruleVO.end;
+export function betweenMatcherContext(ruleVO: IBetweenMatcherData) {
 
-    log.debug(ENGINE_MATCHER_BETWEEN, [runtimeAttr, ruleVO.start, ruleVO.end, isBetween]);
+  return function betweenMatcher(runtimeAttr: number): boolean {
+    const isBetween = runtimeAttr >= ruleVO.start && runtimeAttr <= ruleVO.end;
 
     return isBetween;
   };
diff --git a/src/evaluator/matchers/boolean.ts b/src/evaluator/matchers/boolean.ts
@@ -1,11 +1,7 @@
-import { ENGINE_MATCHER_BOOLEAN } from '../../logger/constants';
-import { ILogger } from '../../logger/types';
+export function booleanMatcherContext(ruleAttr: boolean) {
 
-export function booleanMatcherContext(log: ILogger, ruleAttr: boolean) {
   return function booleanMatcher(runtimeAttr: boolean): boolean {
-    let booleanMatches = ruleAttr === runtimeAttr;
-
-    log.debug(ENGINE_MATCHER_BOOLEAN, [ruleAttr, runtimeAttr]);
+    const booleanMatches = ruleAttr === runtimeAttr;
 
     return booleanMatches;
   };
diff --git a/src/evaluator/matchers/cont_all.ts b/src/evaluator/matchers/cont_all.ts
@@ -1,8 +1,6 @@
-import { ENGINE_MATCHER_CONTAINS_ALL } from '../../logger/constants';
-import { ILogger } from '../../logger/types';
 import { findIndex } from '../../utils/lang';
 
-export function containsAllSetMatcherContext(log: ILogger, ruleAttr: string[]) {
+export function containsAllSetMatcherContext(ruleAttr: string[]) {
   return function containsAllMatcher(runtimeAttr: string[]): boolean {
     let containsAll = true;
 
@@ -15,8 +13,6 @@ export function containsAllSetMatcherContext(log: ILogger, ruleAttr: string[]) {
       }
     }
 
-    log.debug(ENGINE_MATCHER_CONTAINS_ALL, [runtimeAttr, ruleAttr, containsAll]);
-
     return containsAll;
   };
 }
diff --git a/src/evaluator/matchers/cont_any.ts b/src/evaluator/matchers/cont_any.ts
@@ -1,17 +1,13 @@
-import { ENGINE_MATCHER_CONTAINS_ANY } from '../../logger/constants';
-import { ILogger } from '../../logger/types';
 import { findIndex } from '../../utils/lang';
 
-export function containsAnySetMatcherContext(log: ILogger, ruleAttr: string[]) {
+export function containsAnySetMatcherContext(ruleAttr: string[]) {
   return function containsAnyMatcher(runtimeAttr: string[]): boolean {
     let containsAny = false;
 
     for (let i = 0; i < ruleAttr.length && !containsAny; i++) {
       if (findIndex(runtimeAttr, e => e === ruleAttr[i]) >= 0) containsAny = true;
     }
 
-    log.debug(ENGINE_MATCHER_CONTAINS_ANY, [runtimeAttr, ruleAttr, containsAny]);
-
     return containsAny;
   };
 }
diff --git a/src/evaluator/matchers/cont_str.ts b/src/evaluator/matchers/cont_str.ts
@@ -1,12 +1,8 @@
 import { isString } from '../../utils/lang';
-import { ILogger } from '../../logger/types';
-import { ENGINE_MATCHER_CONTAINS_STRING } from '../../logger/constants';
 
-export function containsStringMatcherContext(log: ILogger, ruleAttr: string[]) {
+export function containsStringMatcherContext(ruleAttr: string[]) {
   return function containsStringMatcher(runtimeAttr: string): boolean {
-    let contains = ruleAttr.some(e => isString(runtimeAttr) && runtimeAttr.indexOf(e) > -1);
-
-    log.debug(ENGINE_MATCHER_CONTAINS_STRING, [runtimeAttr, ruleAttr, contains]);
+    const contains = ruleAttr.some(e => isString(runtimeAttr) && runtimeAttr.indexOf(e) > -1);
 
     return contains;
   };
diff --git a/src/evaluator/matchers/dependency.ts b/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(log: ILogger, { split, treatments }: IDependencyMatcherData, storage: IStorageSync | IStorageAsync) {
+export function dependencyMatcherContext({ split, treatments }: IDependencyMatcherData, storage: IStorageSync | IStorageAsync, log: ILogger) {
 
   function checkTreatment(evaluation: IEvaluation, acceptableTreatments: string[], parentName: string) {
     let matches = false;
diff --git a/src/evaluator/matchers/eq.ts b/src/evaluator/matchers/eq.ts
@@ -1,11 +1,7 @@
-import { ENGINE_MATCHER_EQUAL } from '../../logger/constants';
-import { ILogger } from '../../logger/types';
+export function equalToMatcherContext(ruleAttr: number) {
 
-export function equalToMatcherContext(log: ILogger, ruleAttr: number) {
   return function equalToMatcher(runtimeAttr: number): boolean {
-    let isEqual = runtimeAttr === ruleAttr;
-
-    log.debug(ENGINE_MATCHER_EQUAL, [runtimeAttr, ruleAttr, isEqual]);
+    const isEqual = runtimeAttr === ruleAttr;
 
     return isEqual;
   };
diff --git a/src/evaluator/matchers/eq_set.ts b/src/evaluator/matchers/eq_set.ts
@@ -1,8 +1,6 @@
-import { ENGINE_MATCHER_EQUAL_TO_SET } from '../../logger/constants';
-import { ILogger } from '../../logger/types';
 import { findIndex } from '../../utils/lang';
 
-export function equalToSetMatcherContext(log: ILogger, ruleAttr: string[]) {
+export function equalToSetMatcherContext(ruleAttr: string[]) {
   return function equalToSetMatcher(runtimeAttr: string[]): boolean {
     // Length being the same is the first condition.
     let isEqual = runtimeAttr.length === ruleAttr.length;
@@ -12,8 +10,6 @@ export function equalToSetMatcherContext(log: ILogger, ruleAttr: string[]) {
       if (findIndex(ruleAttr, e => e === runtimeAttr[i]) < 0) isEqual = false;
     }
 
-    log.debug(ENGINE_MATCHER_EQUAL_TO_SET, [runtimeAttr, ruleAttr, isEqual]);
-
     return isEqual;
   };
 }
diff --git a/src/evaluator/matchers/ew.ts b/src/evaluator/matchers/ew.ts
@@ -1,12 +1,8 @@
-import { ENGINE_MATCHER_ENDS_WITH } from '../../logger/constants';
-import { ILogger } from '../../logger/types';
 import { endsWith } from '../../utils/lang';
 
-export function endsWithMatcherContext(log: ILogger, ruleAttr: string[]) {
+export function endsWithMatcherContext(ruleAttr: string[]) {
   return function endsWithMatcher(runtimeAttr: string): boolean {
-    let strEndsWith = ruleAttr.some(e => endsWith(runtimeAttr, e));
-
-    log.debug(ENGINE_MATCHER_ENDS_WITH, [runtimeAttr, ruleAttr, strEndsWith]);
+    const strEndsWith = ruleAttr.some(e => endsWith(runtimeAttr, e));
 
     return strEndsWith;
   };
diff --git a/src/evaluator/matchers/gte.ts b/src/evaluator/matchers/gte.ts
@@ -1,11 +1,7 @@
-import { ENGINE_MATCHER_GREATER } from '../../logger/constants';
-import { ILogger } from '../../logger/types';
+export function greaterThanEqualMatcherContext(ruleAttr: number) {
 
-export function greaterThanEqualMatcherContext(log: ILogger, ruleAttr: number) {
   return function greaterThanEqualMatcher(runtimeAttr: number): boolean {
-    let isGreaterThanEqual = runtimeAttr >= ruleAttr;
-
-    log.debug(ENGINE_MATCHER_GREATER, [runtimeAttr, ruleAttr, isGreaterThanEqual]);
+    const isGreaterThanEqual = runtimeAttr >= ruleAttr;
 
     return isGreaterThanEqual;
   };
diff --git a/src/evaluator/matchers/index.ts b/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](log, value, storage); // There is no index-out-of-bound exception in JavaScript
+  if (matchers[type]) matcherFn = matchers[type](value, storage, log); // There is no index-out-of-bound exception in JavaScript
   return matcherFn;
 }
diff --git a/src/evaluator/matchers/lte.ts b/src/evaluator/matchers/lte.ts
@@ -1,11 +1,7 @@
-import { ENGINE_MATCHER_LESS } from '../../logger/constants';
-import { ILogger } from '../../logger/types';
+export function lessThanEqualMatcherContext(ruleAttr: number) {
 
-export function lessThanEqualMatcherContext(log: ILogger, ruleAttr: number) {
   return function lessThanEqualMatcher(runtimeAttr: number): boolean {
-    let isLessThanEqual = runtimeAttr <= ruleAttr;
-
-    log.debug(ENGINE_MATCHER_LESS, [runtimeAttr, ruleAttr, isLessThanEqual]);
+    const isLessThanEqual = runtimeAttr <= ruleAttr;
 
     return isLessThanEqual;
   };
diff --git a/src/evaluator/matchers/part_of.ts b/src/evaluator/matchers/part_of.ts
@@ -1,8 +1,6 @@
 import { findIndex } from '../../utils/lang';
-import { ILogger } from '../../logger/types';
-import { ENGINE_MATCHER_PART_OF } from '../../logger/constants';
 
-export function partOfSetMatcherContext(log: ILogger, ruleAttr: string[]) {
+export function partOfSetMatcherContext(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;
@@ -12,8 +10,6 @@ export function partOfSetMatcherContext(log: ILogger, ruleAttr: string[]) {
       if (findIndex(ruleAttr, e => e === runtimeAttr[i]) < 0) isPartOf = false;
     }
 
-    log.debug(ENGINE_MATCHER_PART_OF, [runtimeAttr, ruleAttr, isPartOf]);
-
     return isPartOf;
   };
 }
diff --git a/src/evaluator/matchers/segment.ts b/src/evaluator/matchers/segment.ts
@@ -1,25 +1,18 @@
 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(log: ILogger, segmentName: string, storage: { segments: ISegmentsCacheBase }) {
+export function segmentMatcherContext(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;
   };
-
 }
diff --git a/src/evaluator/matchers/semver_between.ts b/src/evaluator/matchers/semver_between.ts
@@ -1,8 +1,7 @@
 import { IBetweenStringMatcherData } from '../../dtos/types';
-import { ILogger } from '../../logger/types';
 import { Semver } from '../../utils/Semver';
 
-export function betweenSemverMatcherContext(log: ILogger, ruleAttr: IBetweenStringMatcherData) {
+export function betweenSemverMatcherContext(ruleAttr: IBetweenStringMatcherData) {
   const startSemver = new Semver(ruleAttr.start);
   const endSemver = new Semver(ruleAttr.end);
 
diff --git a/src/evaluator/matchers/semver_eq.ts b/src/evaluator/matchers/semver_eq.ts
@@ -1,7 +1,6 @@
-import { ILogger } from '../../logger/types';
 import { Semver } from '../../utils/Semver';
 
-export function equalToSemverMatcherContext(log: ILogger, ruleAttr: string) {
+export function equalToSemverMatcherContext(ruleAttr: string) {
   const ruleSemver = new Semver(ruleAttr);
 
   return function equalToSemverMatcher(runtimeAttr: string): boolean {
diff --git a/src/evaluator/matchers/semver_gte.ts b/src/evaluator/matchers/semver_gte.ts
@@ -1,7 +1,6 @@
-import { ILogger } from '../../logger/types';
 import { Semver } from '../../utils/Semver';
 
-export function greaterThanEqualToSemverMatcherContext(log: ILogger, ruleAttr: string) {
+export function greaterThanEqualToSemverMatcherContext(ruleAttr: string) {
   const ruleSemver = new Semver(ruleAttr);
 
   return function greaterThanEqualToSemverMatcher(runtimeAttr: string): boolean {
diff --git a/src/evaluator/matchers/semver_inlist.ts b/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(log: ILogger, ruleAttr: string[]) {
+export function inListSemverMatcherContext(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;
diff --git a/src/evaluator/matchers/semver_lte.ts b/src/evaluator/matchers/semver_lte.ts
@@ -1,7 +1,6 @@
-import { ILogger } from '../../logger/types';
 import { Semver } from '../../utils/Semver';
 
-export function lessThanEqualToSemverMatcherContext(log: ILogger, ruleAttr: string) {
+export function lessThanEqualToSemverMatcherContext(ruleAttr: string) {
   const ruleSemver = new Semver(ruleAttr);
 
   return function lessThanEqualToSemverMatcher(runtimeAttr: string): boolean {
diff --git a/src/evaluator/matchers/string.ts b/src/evaluator/matchers/string.ts
@@ -1,14 +1,9 @@
-import { ENGINE_MATCHER_STRING } from '../../logger/constants';
-import { ILogger } from '../../logger/types';
-
-export function stringMatcherContext(log: ILogger, ruleAttr: string) {
+export function stringMatcherContext(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;
   };
 }
diff --git a/src/evaluator/matchers/sw.ts b/src/evaluator/matchers/sw.ts
@@ -1,12 +1,8 @@
-import { ENGINE_MATCHER_STARTS_WITH } from '../../logger/constants';
-import { ILogger } from '../../logger/types';
 import { startsWith } from '../../utils/lang';
 
-export function startsWithMatcherContext(log: ILogger, ruleAttr: string[]) {
+export function startsWithMatcherContext(ruleAttr: string[]) {
   return function startsWithMatcher(runtimeAttr: string): boolean {
-    let matches = ruleAttr.some(e => startsWith(runtimeAttr, e));
-
-    log.debug(ENGINE_MATCHER_STARTS_WITH, [runtimeAttr, ruleAttr, matches]);
+    const matches = ruleAttr.some(e => startsWith(runtimeAttr, e));
 
     return matches;
   };
diff --git a/src/evaluator/matchers/whitelist.ts b/src/evaluator/matchers/whitelist.ts
@@ -1,15 +1,11 @@
 import { _Set } from '../../utils/lang/sets';
-import { ILogger } from '../../logger/types';
-import { ENGINE_MATCHER_WHITELIST } from '../../logger/constants';
 
-export function whitelistMatcherContext(log: ILogger, ruleAttr: string[]) {
+export function whitelistMatcherContext(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;
   };
 }
diff --git a/src/evaluator/parser/index.ts b/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 } from '../../logger/constants';
+import { ENGINE_MATCHER_ERROR, ENGINE_MATCHER_RESULT } from '../../logger/constants';
 
 export function parser(log: ILogger, conditions: ISplitCondition[], storage: IStorageSync | IStorageAsync): IEvaluator {
   let predicates = [];
@@ -49,10 +49,14 @@ export function parser(log: ILogger, conditions: ISplitCondition[], storage: ISt
           }
         }
 
-        if (thenable(result)) { // @ts-ignore
-          return result.then(res => Boolean(res ^ matcherDto.negate));
-        } // @ts-ignore
-        return Boolean(result ^ matcherDto.negate);
+        function handleResult(result: boolean) {
+          log.debug(ENGINE_MATCHER_RESULT, [matcherDto.name, result, matcherDto.value, value]); // @ts-ignore
+          return Boolean(result ^ matcherDto.negate);
+        }
+
+        return thenable(result) ?
+          result.then(handleResult) :
+          handleResult(result);
       };
     });
 
diff --git a/src/logger/constants.ts b/src/logger/constants.ts
@@ -9,24 +9,8 @@ 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;
@@ -44,6 +28,7 @@ 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;
diff --git a/src/logger/messages/debug.ts b/src/logger/messages/debug.ts
diff --git a/src/logger/messages/warn.ts b/src/logger/messages/warn.ts

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,6 @@`
`1`		`-import { ENGINE_MATCHER_CONTAINS_ALL } from '../../logger/constants';`
`2`		`-import { ILogger } from '../../logger/types';`
`3`	`1`	`import { findIndex } from '../../utils/lang';`
`4`	`2`
`5`		`-export function containsAllSetMatcherContext(log: ILogger, ruleAttr: string[]) {`
	`3`	`+export function containsAllSetMatcherContext(ruleAttr: string[]) {`
`6`	`4`	`return function containsAllMatcher(runtimeAttr: string[]): boolean {`
`7`	`5`	`let containsAll = true;`
`8`	`6`
`@@ -15,8 +13,6 @@ export function containsAllSetMatcherContext(log: ILogger, ruleAttr: string[]) {`
`15`	`13`	`}`
`16`	`14`	`}`
`17`	`15`
`18`		`- log.debug(ENGINE_MATCHER_CONTAINS_ALL, [runtimeAttr, ruleAttr, containsAll]);`
`19`		`-`
`20`	`16`	`return containsAll;`
`21`	`17`	`};`
`22`	`18`	`}`