Merge pull request #294 from splitio/unsupported_matcher_type

Add new `unsupported matcher type` label

Author: EmilianoSanchez

CHANGES.txt

@@ -1,3 +1,6 @@
+1.14.0 (April XX, 2024)
+ - Updated impression label to 'unsupported matcher type' when the matcher type is not supported by the SDK.
+
 1.13.1 (January 10, 2024)
  - Updated client `destroy` method to release SDK key immediately and avoid unexpected warning logs when a factory is created with the same SDK key after the previous one was destroyed.
 

src/evaluator/combiners/ifelseif.ts

@@ -14,7 +14,7 @@ export function ifElseIfCombinerContext(log: ILogger, predicates: IEvaluator[]):
 
     return {
       treatment: CONTROL,
-      label: LabelsConstants.EXCEPTION
+      label: LabelsConstants.UNSUPPORTED_MATCHER_TYPE
     };
   }
 
@@ -50,7 +50,7 @@ export function ifElseIfCombinerContext(log: ILogger, predicates: IEvaluator[]):
   }
 
   // if there is none predicates, then there was an error in parsing phase
-  if (!Array.isArray(predicates) || Array.isArray(predicates) && predicates.length === 0) {
+  if (!Array.isArray(predicates) || predicates.length === 0) {
     return unexpectedInputHandler;
   } else {
     return ifElseIfCombiner;

src/evaluator/matchers/matcherTypes.ts

@@ -1,5 +1,5 @@
 export const matcherTypes: Record<string, number> = {
-  UNDEFINED: 0,
+  UNDEFINED: 0, // Value for unsupported or invalid matchers
   ALL_KEYS: 1,
   IN_SEGMENT: 2,
   WHITELIST: 3,

src/evaluator/parser/__tests__/invalidMatcher.spec.ts

@@ -29,7 +29,7 @@ test('PARSER / handle invalid matcher as control', async function () {
   let evaluation = await evaluator('aaaaa', 31);
 
   expect(evaluation.treatment).toBe('control'); // return control when invalid matcher
-  expect(evaluation.label).toBe('exception'); // track invalid as an exception
+  expect(evaluation.label).toBe('unsupported matcher type'); // track invalid as unsupported matcher type
 });
 
 test('PARSER / handle invalid matcher as control (complex example)', async function () {
@@ -128,7 +128,7 @@ test('PARSER / handle invalid matcher as control (complex example)', async funct
 
   for (let ev of [ev1, ev2, ev3]) {
     expect(ev.treatment).toBe('control'); // return control when invalid matcher
-    expect(ev.label).toBe('exception'); // track invalid as an exception
+    expect(ev.label).toBe('unsupported matcher type'); // track invalid as unsupported matcher type
   }
 });
 
@@ -254,6 +254,6 @@ test('PARSER / handle invalid matcher as control (complex example mixing invalid
 
   for (let ev of [ev1, ev2, ev3]) {
     expect(ev.treatment).toBe('control'); // return control when invalid matcher
-    expect(ev.label).toBe('exception'); // track invalid as an exception
+    expect(ev.label).toBe('unsupported matcher type'); // track invalid as unsupported matcher type
   }
 });

src/evaluator/parser/index.ts

@@ -44,8 +44,7 @@ export function parser(log: ILogger, conditions: ISplitCondition[], storage: ISt
       };
     });
 
-    // if matcher's factory can't instanciate the matchers, the expressions array
-    // will be empty
+    // if matcher's factory can't instantiate the matchers, the expressions array will be empty
     if (expressions.length === 0) {
       // reset any data collected during parsing
       predicates = [];

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 found'],
+  [c.ERROR_ENGINE_COMBINER_IFELSEIF, c.LOG_PREFIX_ENGINE_COMBINER + 'Invalid feature flag, no valid rules or unsupported matcher type found'],
   // SDK
   [c.ERROR_LOGLEVEL_INVALID, 'logger: Invalid Log Level - No changes to the logs will be applied.'],
   [c.ERROR_CLIENT_CANNOT_GET_READY, 'The SDK will not get ready. Reason: %s'],

src/types.ts

@@ -353,7 +353,7 @@ interface INodeBasicSettings extends ISharedSettings {
     IPAddressesEnabled?: boolean
   },
   /**
-   * Defines which kind of storage we should instanciate.
+   * Defines which kind of storage we should instantiate.
    * @property {Object} storage
    */
   storage?: (params: any) => any,
@@ -918,7 +918,7 @@ export namespace SplitIO {
      */
     features?: MockedFeaturesMap,
     /**
-     * Defines which kind of storage we should instanciate.
+     * Defines which kind of storage we should instantiate.
      * @property {Object} storage
      */
     storage?: (params: IStorageFactoryParams) => IStorageSync | IStorageAsync,
@@ -944,7 +944,7 @@ export namespace SplitIO {
      */
     urls?: UrlSettings,
     /**
-     * Defines which kind of storage we should instanciate.
+     * Defines which kind of storage we should instantiate.
      * @property {Object} storage
      */
     storage?: (params: IStorageFactoryParams) => IStorageSync,

src/utils/labels/index.ts

@@ -5,3 +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';

src/utils/settingsValidation/index.ts

@@ -61,7 +61,7 @@ export const base = {
     telemetry: 'https://telemetry.split.io/api',
   },
 
-  // Defines which kind of storage we should instanciate.
+  // Defines which kind of storage we should instantiate.
   storage: undefined,
 
   // Defines if the logs are enabled, SDK wide.