@splitsoftware/splitio-commons/src/storages/pluggable/TelemetryCachePluggable.ts

Split JavaScript SDK common components

import { ILogger } from '../../logger/types';
import { Method, MultiConfigs, MultiMethodExceptions, MultiMethodLatencies } from '../../sync/submitters/types';
import { KeyBuilderSS } from '../KeyBuilderSS';
import { IPluggableStorageWrapper, ITelemetryCacheAsync } from '../types';
import { findLatencyIndex } from '../findLatencyIndex';
import { getTelemetryConfigStats } from '../../sync/submitters/telemetrySubmitter';
import { CONSUMER_MODE, STORAGE_PLUGGABLE } from '../../utils/constants';
import { isString, isNaNNumber } from '../../utils/lang';
import { MAX_LATENCY_BUCKET_COUNT, newBuckets } from '../inMemory/TelemetryCacheInMemory';
import { parseLatencyField, parseExceptionField, parseMetadata } from '../utils';

export class TelemetryCachePluggable implements ITelemetryCacheAsync {

  /**
   * Create a Telemetry cache that uses a storage wrapper.
   * @param log -  Logger instance.
   * @param keys -  Key builder.
   * @param wrapper -  Adapted wrapper storage.
   */
  constructor(private readonly log: ILogger, private readonly keys: KeyBuilderSS, private readonly wrapper: IPluggableStorageWrapper) { }

  recordLatency(method: Method, latencyMs: number) {
    return this.wrapper.incr(this.keys.buildLatencyKey(method, findLatencyIndex(latencyMs)))
      .catch(() => { /* Handle rejections for telemetry */ });
  }
  recordException(method: Method) {
    return this.wrapper.incr(this.keys.buildExceptionKey(method))
      .catch(() => { /* Handle rejections for telemetry */ });
  }

  recordConfig() {
    const value = JSON.stringify(getTelemetryConfigStats(CONSUMER_MODE, STORAGE_PLUGGABLE));
    return this.wrapper.set(this.keys.buildInitKey(), value).catch(() => { /* Handle rejections for telemetry */ });
  }

  /**
   * Pop telemetry latencies.
   * The returned promise rejects if wrapper operations fail.
   */
  popLatencies(): Promise<MultiMethodLatencies> {
    return this.wrapper.getKeysByPrefix(this.keys.latencyPrefix).then(latencyKeys => {
      return latencyKeys.length ?
        this.wrapper.getMany(latencyKeys).then(latencies => {

          const result: MultiMethodLatencies = new Map();

          for (let i = 0; i < latencyKeys.length; i++) {
            const field = latencyKeys[i].split('::')[1];

            const parsedField = parseLatencyField(field);
            if (isString(parsedField)) {
              this.log.error(`Ignoring invalid latency field: ${field}: ${parsedField}`);
              continue;
            }

            // @ts-ignore
            const count = parseInt(latencies[i]);
            if (isNaNNumber(count)) {
              this.log.error(`Ignoring latency with invalid count: ${latencies[i]}`);
              continue;
            }

            const [metadata, method, bucket] = parsedField;

            if (bucket >= MAX_LATENCY_BUCKET_COUNT) {
              this.log.error(`Ignoring latency with invalid bucket: ${bucket}`);
              continue;
            }

            const methodLatencies = result.get(metadata) || {};
            methodLatencies[method] = methodLatencies[method] || newBuckets();
            methodLatencies[method]![bucket] = count;
            result.set(metadata, methodLatencies);
          }

          return Promise.all(latencyKeys.map((latencyKey) => this.wrapper.del(latencyKey))).then(() => result);
        }) :
        // If latencyKeys is empty, return an empty map.
        new Map();
    });
  }

  /**
   * Pop telemetry exceptions.
   * The returned promise rejects if wrapper operations fail.
   */
  popExceptions(): Promise<MultiMethodExceptions> {
    return this.wrapper.getKeysByPrefix(this.keys.exceptionPrefix).then(exceptionKeys => {
      return exceptionKeys.length ?
        this.wrapper.getMany(exceptionKeys).then(exceptions => {

          const result: MultiMethodExceptions = new Map();

          for (let i = 0; i < exceptionKeys.length; i++) {
            const field = exceptionKeys[i].split('::')[1];

            const parsedField = parseExceptionField(field);
            if (isString(parsedField)) {
              this.log.error(`Ignoring invalid exception field: ${field}: ${parsedField}`);
              continue;
            }

            // @ts-ignore
            const count = parseInt(exceptions[i]);
            if (isNaNNumber(count)) {
              this.log.error(`Ignoring exception with invalid count: ${exceptions[i]}`);
              continue;
            }

            const [metadata, method] = parsedField;

            if (!result.has(metadata)) result.set(metadata, {});
            result.get(metadata)![method] = count;
          }

          return Promise.all(exceptionKeys.map((exceptionKey) => this.wrapper.del(exceptionKey))).then(() => result);
        }) :
        // If exceptionKeys is empty, return an empty map.
        new Map();
    });
  }

  /**
   * Pop telemetry configs.
   * The returned promise rejects if wrapper operations fail.
   */
  popConfigs(): Promise<MultiConfigs> {
    return this.wrapper.getKeysByPrefix(this.keys.initPrefix).then(configKeys => {
      return configKeys.length ?
        this.wrapper.getMany(configKeys).then(configs => {

          const result: MultiConfigs = new Map();

          for (let i = 0; i < configKeys.length; i++) {
            const field = configKeys[i].split('::')[1];

            const parsedField = parseMetadata(field);
            if (isString(parsedField)) {
              this.log.error(`Ignoring invalid config field: ${field}: ${parsedField}`);
              continue;
            }

            const [metadata] = parsedField;

            try { // @ts-ignore
              const config = JSON.parse(configs[i]);
              result.set(metadata, config);
            } catch (e) {
              this.log.error(`Ignoring invalid config: ${configs[i]}`);
            }
          }

          return Promise.all(configKeys.map((configKey) => this.wrapper.del(configKey))).then(() => result);
        }) :
        // If configKeys is empty, return an empty map.
        new Map();
    });
  }
}