@react-native-firebase/perf/lib/Trace.js

React Native Firebase - React Native Firebase provides native integration with Performance Monitoring to gain insight into key performance characteristics within your React Native application.

/*
 * Copyright (c) 2016-present Invertase Limited & Contributors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this library except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */

import { hasOwnProperty, isNumber, isString } from '@react-native-firebase/app/lib/common';
import MetricWithAttributes from './MetricWithAttributes';

export default class Trace extends MetricWithAttributes {
  constructor(native, identifier) {
    super(native);
    this._identifier = identifier;

    this._metrics = {};

    this._started = false;
    this._stopped = false;
  }

  getMetric(metricName) {
    if (!isString(metricName)) {
      throw new Error("firebase.perf.Trace.getMetric(*) 'metricName' must be a string.");
    }

    return hasOwnProperty(this._metrics, metricName) ? this._metrics[metricName] : 0;
  }

  getMetrics() {
    return Object.assign({}, this._metrics);
  }

  putMetric(metricName, value) {
    // TODO(VALIDATION): metricName: no leading or trailing whitespace, no leading underscore '_' character, max length is 32 characters
    // TODO(VALIDATION): value: >= 0
    if (!isString(metricName)) {
      throw new Error("firebase.perf.Trace.putMetric(*, _) 'metricName' must be a string.");
    }

    if (!isNumber(value)) {
      throw new Error("firebase.perf.Trace.putMetric(_, *) 'value' must be a number.");
    }

    this._metrics[metricName] = value;
  }

  incrementMetric(metricName, incrementBy) {
    // TODO(VALIDATION): metricName: no leading or trailing whitespace, no leading underscore '_' character, max length is 32 characters
    // TODO(VALIDATION): value: >= 0
    if (!isString(metricName)) {
      throw new Error("firebase.perf.Trace.incrementMetric(*, _) 'metricName' must be a string.");
    }

    if (!isNumber(incrementBy)) {
      throw new Error("firebase.perf.Trace.incrementMetric(_, *) 'incrementBy' must be a number.");
    }

    this._metrics[metricName] = this.getMetric(metricName) + incrementBy;
  }

  removeMetric(metric) {
    if (!isString(metric)) {
      throw new Error("firebase.perf.Trace.removeMetric(*) 'metric' must be a string.");
    }

    delete this._metrics[metric];
  }

  start() {
    if (this._started) {
      return Promise.resolve(null);
    }
    this._started = true;

    return this.native.startTrace(this._id, this._identifier);
  }

  stop() {
    if (this._stopped) {
      return Promise.resolve(null);
    }
    this._stopped = true;

    const traceData = {
      metrics: Object.assign({}, this._metrics),
      attributes: Object.assign({}, this._attributes),
    };

    return this.native.stopTrace(this._id, traceData);
  }
}