@splitsoftware/splitio-commons 1.13.2-rc.2 → 1.13.2-rc.3

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, FLAGS_SPEC } from '../utils/constants';
+import { SPLITS, IMPRESSIONS, IMPRESSIONS_COUNT, EVENTS, TELEMETRY, TOKEN, SEGMENT, MY_SEGMENT } from '../utils/constants';
 import { ERROR_TOO_MANY_SETS } from '../logger/constants';
 
 const noCacheHeaderOptions = { headers: { 'Cache-Control': 'no-cache' } };
@@ -44,16 +44,17 @@ export function splitApiFactory(
     },
 
     fetchAuth(userMatchingKeys?: string[]) {
-      let url = `${urls.auth}/v2/auth?s=${FLAGS_SPEC}`;
-      if (userMatchingKeys) { // `userMatchingKeys` is undefined in server-side
+      let url = `${urls.auth}/v2/auth`;
+      if (userMatchingKeys) { // accounting the possibility that `userMatchingKeys` is undefined (server-side API)
         const queryParams = userMatchingKeys.map(userKeyToQueryParam).join('&');
-        if (queryParams) url += '&' + queryParams;
+        if (queryParams) // accounting the possibility that `userKeys` and thus `queryParams` are empty
+          url += '?' + queryParams;
       }
       return splitHttpClient(url, undefined, telemetryTracker.trackHttp(TOKEN));
     },
 
     fetchSplitChanges(since: number, noCache?: boolean, till?: number) {
-      const url = `${urls.sdk}/splitChanges?s=${FLAGS_SPEC}&since=${since}${till ? '&till=' + till : ''}${filterQueryString || ''}`;
+      const url = `${urls.sdk}/splitChanges?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,5 +1,4 @@
 import { ISettings } from '../types';
-import { FLAGS_SPEC } from '../utils/constants';
 import { startsWith } from '../utils/lang';
 import { hash } from '../utils/murmur3/murmur3';
 
@@ -82,9 +81,9 @@ export class KeyBuilder {
 }
 
 /**
- * Generates a murmur32 hash based on the authorization key, the feature flags filter query, and version of SplitChanges API.
+ * Generates a murmur32 hash based on the authorization key and the feature flags filter query.
  * 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}::${FLAGS_SPEC}`).toString(16);
+  return hash(`${settings.core.authorizationKey}::${settings.sync.__splitFiltersValidation.queryString}`).toString(16);
 }

package/src/utils/Semver.ts

@@ -0,0 +1,107 @@
+const NUMERIC_IDENTIFIER_REGEX = /^[0-9]+$/;
+
+const METADATA_DELIMITER = '+';
+const PRERELEASE_DELIMITER = '-';
+const VALUE_DELIMITER = '.';
+
+/**
+ * Compares two strings. If both strings are numeric identifiers, they are compared numerically. Otherwise, they are compared lexicographically.
+ * This could be implemented using `a.localeCompare(b, undefined, { numeric: true })` but locale options are not broadly supported.
+ */
+function compareStrings(a: string, b: string): number {
+  if (NUMERIC_IDENTIFIER_REGEX.test(a) && NUMERIC_IDENTIFIER_REGEX.test(b)) {
+    const result = a.length - b.length;
+    if (result !== 0) {
+      return result;
+    }
+  }
+  return a < b ? -1 : a > b ? 1 : 0;
+}
+
+// Sanitizes a numeric identifier by removing leading zeros
+function sanitizeNumericIdentifier(value: string): string {
+  return value.replace(/^0+(?=\d)/, '');
+}
+
+function throwError(version: string) {
+  throw new Error('Unable to convert to Semver, incorrect format: ' + version);
+}
+
+export class Semver {
+
+  private readonly _major: string;
+  private readonly _minor: string;
+  private readonly _patch: string;
+  private readonly _preRelease: string[];
+  private readonly _isStable: boolean;
+
+  // Version string for 'equal' and 'in list' comparisons
+  public readonly version: string;
+
+  public constructor(version: string) {
+    // Separate metadata if exists
+    let index = version.indexOf(METADATA_DELIMITER);
+    let [vWithoutMetadata, metadata] = index === -1 ? [version] : [version.slice(0, index), version.slice(index + 1)];
+    if (metadata === '') throwError(version);
+
+    // Set pre-release versions if exists
+    index = vWithoutMetadata.indexOf(PRERELEASE_DELIMITER);
+    if (index === -1) {
+      this._isStable = true;
+      this._preRelease = [];
+    } else {
+      this._isStable = false;
+      this._preRelease = vWithoutMetadata.slice(index + 1).split(VALUE_DELIMITER).map((value) => {
+        if (!value) throwError(version);
+        return NUMERIC_IDENTIFIER_REGEX.test(value) ?
+          sanitizeNumericIdentifier(value) :
+          value;
+      });
+      vWithoutMetadata = vWithoutMetadata.slice(0, index);
+    }
+
+    // Set major, minor, and patch versions
+    const vParts = vWithoutMetadata.split(VALUE_DELIMITER).map((value) => {
+      if (!value || !NUMERIC_IDENTIFIER_REGEX.test(value)) throwError(version);
+      return sanitizeNumericIdentifier(value);
+    });
+
+    if (vParts.length !== 3) throwError(version);
+    this._major = vParts[0];
+    this._minor = vParts[1];
+    this._patch = vParts[2];
+
+    // Set version string
+    this.version = vParts.join(VALUE_DELIMITER);
+    if (this._preRelease.length) this.version += PRERELEASE_DELIMITER + this._preRelease.join(VALUE_DELIMITER);
+    if (metadata) this.version += METADATA_DELIMITER + metadata;
+  }
+
+  /**
+   * Precedence comparision between 2 Semver objects.
+   *
+   * @return `0` if `this === toCompare`, `-1` if `this < toCompare`, and `1` if `this > toCompare`
+   */
+  public compare(toCompare: Semver): number {
+    if (this.version === toCompare.version) return 0;
+
+    let result = compareStrings(this._major, toCompare._major);
+    if (result !== 0) return result;
+
+    result = compareStrings(this._minor, toCompare._minor);
+    if (result !== 0) return result;
+
+    result = compareStrings(this._patch, toCompare._patch);
+    if (result !== 0) return result;
+
+    if (!this._isStable && toCompare._isStable) return -1;
+    if (this._isStable && !toCompare._isStable) return 1;
+
+    for (let i = 0, length = Math.min(this._preRelease.length, toCompare._preRelease.length); i < length; i++) {
+      const result = compareStrings(this._preRelease[i], toCompare._preRelease[i]);
+      if (result !== 0) return result;
+    }
+
+    return this._preRelease.length - toCompare._preRelease.length;
+  }
+}

package/src/utils/constants/index.ts

@@ -104,5 +104,3 @@ 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/settingsValidation/logger/pluggableLogger.ts

@@ -4,7 +4,7 @@ import { LogLevel } from '../../../types';
 import { getLogLevel } from './commons';
 
 function isLogger(log: any): log is ILogger {
-  return log && typeof log.debug === 'function' && typeof log.info === 'function' && typeof log.warn === 'function' && typeof log.error === 'function' && typeof log.setLogLevel === 'function';
+  return log !== null && typeof log === 'object' && typeof log.debug === 'function' && typeof log.info === 'function' && typeof log.warn === 'function' && typeof log.error === 'function' && typeof log.setLogLevel === 'function';
 }
 
 // By default it starts disabled.

package/types/dtos/types.d.ts

@@ -11,6 +11,10 @@ export interface IBetweenMatcherData {
     start: number;
     end: number;
 }
+export interface IBetweenStringMatcherData {
+    start: string;
+    end: string;
+}
 export interface IWhitelistMatcherData {
     whitelist: string[];
 }
@@ -35,6 +39,7 @@ interface ISplitMatcherBase {
     dependencyMatcherData?: null | IDependencyMatcherData;
     booleanMatcherData?: null | boolean;
     stringMatcherData?: null | string;
+    betweenStringMatcherData?: null | IBetweenStringMatcherData;
 }
 interface IAllKeysMatcher extends ISplitMatcherBase {
     matcherType: 'ALL_KEYS';
@@ -103,7 +108,27 @@ interface IMatchesStringMatcher extends ISplitMatcherBase {
     matcherType: 'MATCHES_STRING';
     stringMatcherData: string;
 }
-export declare type ISplitMatcher = IAllKeysMatcher | IInSegmentMatcher | IWhitelistMatcher | IEqualToMatcher | IGreaterThanOrEqualToMatcher | ILessThanOrEqualToMatcher | IBetweenMatcher | IEqualToSetMatcher | IContainsAnyOfSetMatcher | IContainsAllOfSetMatcher | IPartOfSetMatcher | IStartsWithMatcher | IEndsWithMatcher | IContainsStringMatcher | IInSplitTreatmentMatcher | IEqualToBooleanMatcher | IMatchesStringMatcher;
+interface IEqualToSemverMatcher extends ISplitMatcherBase {
+    matcherType: 'EQUAL_TO_SEMVER';
+    stringMatcherData: string;
+}
+interface IGreaterThanOrEqualToSemverMatcher extends ISplitMatcherBase {
+    matcherType: 'GREATER_THAN_OR_EQUAL_TO_SEMVER';
+    stringMatcherData: string;
+}
+interface ILessThanOrEqualToSemverMatcher extends ISplitMatcherBase {
+    matcherType: 'LESS_THAN_OR_EQUAL_TO_SEMVER';
+    stringMatcherData: string;
+}
+interface IBetweenSemverMatcher extends ISplitMatcherBase {
+    matcherType: 'BETWEEN_SEMVER';
+    betweenStringMatcherData: IBetweenStringMatcherData;
+}
+interface IInListSemverMatcher extends ISplitMatcherBase {
+    matcherType: 'IN_LIST_SEMVER';
+    whitelistMatcherData: IWhitelistMatcherData;
+}
+export declare type ISplitMatcher = IAllKeysMatcher | IInSegmentMatcher | IWhitelistMatcher | IEqualToMatcher | IGreaterThanOrEqualToMatcher | ILessThanOrEqualToMatcher | IBetweenMatcher | IEqualToSetMatcher | IContainsAnyOfSetMatcher | IContainsAllOfSetMatcher | IPartOfSetMatcher | IStartsWithMatcher | IEndsWithMatcher | IContainsStringMatcher | IInSplitTreatmentMatcher | IEqualToBooleanMatcher | IMatchesStringMatcher | IEqualToSemverMatcher | IGreaterThanOrEqualToSemverMatcher | ILessThanOrEqualToSemverMatcher | IBetweenSemverMatcher | IInListSemverMatcher;
 /** Split object */
 export interface ISplitPartition {
     treatment: string;

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

@@ -1,3 +1,3 @@
-import { IBetweenMatcherData } from '../../dtos/types';
+import { IBetweenStringMatcherData } from '../../dtos/types';
 import { ILogger } from '../../logger/types';
-export declare function betweenSemverMatcherContext(log: ILogger, ruleVO: IBetweenMatcherData): (key: string) => boolean;
+export declare function betweenSemverMatcherContext(log: ILogger, ruleAttr: IBetweenStringMatcherData): (key: string) => boolean;

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

@@ -0,0 +1,3 @@
+import { ISet } from '../../utils/lang/sets';
+import { ILogger } from '../../logger/types';
+export declare function inListSemverMatcherContext(log: ILogger, ruleAttr: ISet<string>): (runtimeAttr: string) => boolean;

package/types/evaluator/types.d.ts

@@ -1,4 +1,4 @@
-import { IBetweenMatcherData, IDependencyMatcherData, MaybeThenable } from '../dtos/types';
+import { IBetweenMatcherData, IBetweenStringMatcherData, IDependencyMatcherData, MaybeThenable } from '../dtos/types';
 import { IStorageAsync, IStorageSync } from '../storages/types';
 import { ISet } from '../utils/lang/sets';
 import { SplitIO } from '../types';
@@ -9,7 +9,7 @@ export interface IDependencyMatcherValue {
 }
 export interface IMatcherDto {
     type: number;
-    value?: string | number | boolean | string[] | IDependencyMatcherData | ISet<string> | IBetweenMatcherData | null;
+    value?: string | number | boolean | string[] | IDependencyMatcherData | ISet<string> | IBetweenMatcherData | IBetweenStringMatcherData | null;
     attribute: string | null;
     negate: boolean;
     dataType: string;

package/types/storages/KeyBuilder.d.ts

@@ -16,7 +16,7 @@ export declare class KeyBuilder {
     buildHashKey(): string;
 }
 /**
- * Generates a murmur32 hash based on the authorization key, the feature flags filter query, and version of SplitChanges API.
+ * Generates a murmur32 hash based on the authorization key and the feature flags filter query.
  * The hash is in hexadecimal format (8 characters max, 32 bits).
  */
 export declare function getStorageHash(settings: ISettings): string;

package/types/utils/constants/index.d.ts

@@ -78,4 +78,3 @@ export declare const NON_REQUESTED = 1;
 export declare const DISABLED = 0;
 export declare const ENABLED = 1;
 export declare const PAUSED = 2;
-export declare const FLAGS_SPEC = "1.1";

package/types/utils/semVer.d.ts

@@ -1,22 +1,15 @@
 export declare class Semver {
-    private _major;
-    private _minor;
-    private _patch;
-    private _preRelease;
-    private _isStable;
-    private _oVersion;
+    private readonly _major;
+    private readonly _minor;
+    private readonly _patch;
+    private readonly _preRelease;
+    private readonly _isStable;
+    readonly version: string;
     constructor(version: string);
-    private removeMetadataIfExists;
-    isEqualTo(toCompare: Semver): boolean;
-    isGreaterThanOrEqualTo(toCompare: Semver): boolean;
-    isLessThanOrEqualTo(toCompare: Semver): boolean;
-    isBetween(start: Semver, end: Semver): boolean;
     /**
      * Precedence comparision between 2 Semver objects.
      *
-     * @return the value {@code 0} if {@code this == toCompare};
-     *         a value less than {@code 0} if {@code this < toCompare}; and
-     *         a value greater than {@code 0} if {@code this > toCompare}
+     * @return `0` if `this === toCompare`, `-1` if `this < toCompare`, and `1` if `this > toCompare`
      */
-    private compare;
+    compare(toCompare: Semver): number;
 }