@splitsoftware/splitio-commons/src/storages/KeyBuilder.ts

Split JavaScript SDK common components

import { ISettings } from '../types';
import { hash } from '../utils/murmur3/murmur3';

const everythingAtTheEnd = /[^.]+$/;

const DEFAULT_PREFIX = 'SPLITIO';

export function validatePrefix(prefix: unknown) {
  return prefix ? prefix + '.SPLITIO' : 'SPLITIO';
}

export class KeyBuilder {

  readonly prefix: string;

  constructor(prefix: string = DEFAULT_PREFIX) {
    this.prefix = prefix;
  }

  buildTrafficTypeKey(trafficType: string) {
    return `${this.prefix}.trafficType.${trafficType}`;
  }

  buildFlagSetKey(flagSet: string) {
    return `${this.prefix}.flagSet.${flagSet}`;
  }

  buildSplitKey(splitName: string) {
    return `${this.prefix}.split.${splitName}`;
  }

  buildSplitsTillKey() {
    return `${this.prefix}.splits.till`;
  }

  buildSplitKeyPrefix() {
    return `${this.prefix}.split.`;
  }

  buildRBSegmentKey(rbsegmentName: string) {
    return `${this.prefix}.rbsegment.${rbsegmentName}`;
  }

  buildRBSegmentsTillKey() {
    return `${this.prefix}.rbsegments.till`;
  }

  buildRBSegmentKeyPrefix() {
    return `${this.prefix}.rbsegment.`;
  }

  buildSegmentNameKey(segmentName: string) {
    return `${this.prefix}.segment.${segmentName}`;
  }

  buildSegmentTillKey(segmentName: string) {
    return `${this.prefix}.segment.${segmentName}.till`;
  }

  extractKey(builtKey: string) {
    const s = builtKey.match(everythingAtTheEnd);

    if (s && s.length) {
      return s[0];
    } else {
      throw new Error('Invalid latency key provided');
    }
  }

  buildHashKey() {
    return `${this.prefix}.hash`;
  }
}

/**
 * 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}::${settings.sync.flagSpecVersion}`).toString(16);
}