@react-native-firebase/perf 25.1.0 → 26.0.0

package/lib/modular.ts

@@ -1,116 +0,0 @@
-/*
- * 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 { getApp } from '@react-native-firebase/app';
-import { MODULAR_DEPRECATION_ARG } from '@react-native-firebase/app/dist/module/common';
-
-import type { FirebaseApp } from '@react-native-firebase/app';
-import type {
-  FirebasePerformance,
-  HttpMetric,
-  HttpMethod,
-  PerformanceSettings,
-  PerformanceTrace,
-  ScreenTrace,
-} from './types/perf';
-
-import type { PerfInternal } from './types/internal';
-
-function perfInternal(performance: FirebasePerformance): PerfInternal {
-  return performance as PerfInternal;
-}
-
-/**
- * Returns a {@link FirebasePerformance} instance for the given app.
- * @param app - The FirebaseApp to use. Optional; defaults to the default app.
- */
-export function getPerformance(app?: FirebaseApp): FirebasePerformance {
-  if (app) {
-    return getApp(app.name).perf() as FirebasePerformance;
-  }
-
-  return getApp().perf() as FirebasePerformance;
-}
-
-/**
- * Returns a {@link FirebasePerformance} instance for the given app (aligned with the Firebase JS SDK).
- * Can only be called once per app during initialization in typical usage.
- *
- * @param app - The FirebaseApp to use.
- * @param settings - Optional {@link PerformanceSettings}.
- */
-export function initializePerformance(
-  app: FirebaseApp,
-  settings?: PerformanceSettings,
-): FirebasePerformance {
-  const perf = getPerformance(app);
-
-  if (settings?.dataCollectionEnabled !== undefined) {
-    perf.dataCollectionEnabled = settings.dataCollectionEnabled;
-  }
-  if (settings?.instrumentationEnabled !== undefined) {
-    perf.instrumentationEnabled = settings.instrumentationEnabled;
-  }
-
-  return perf;
-}
-
-/**
- * Returns a new {@link PerformanceTrace} instance.
- * @param performance - The {@link FirebasePerformance} instance to use.
- * @param name - The name of the trace.
- */
-export function trace(performance: FirebasePerformance, name: string): PerformanceTrace {
-  return perfInternal(performance).newTrace(name, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * Creates an {@link HttpMetric} for a URL and HTTP method (React Native).
- * @param performance - The {@link FirebasePerformance} instance to use.
- * @param url - Request URL.
- * @param httpMethod - HTTP method.
- */
-export function httpMetric(
-  performance: FirebasePerformance,
-  url: string,
-  httpMethod: HttpMethod,
-): HttpMetric {
-  return perfInternal(performance).newHttpMetric(url, httpMethod, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * Creates a {@link ScreenTrace} with the given screen name.
- * Android only; throws if hardware acceleration is disabled or if Android is 9.0 or 9.1.
- * @param performance - The {@link FirebasePerformance} instance to use.
- * @param screenName - Screen name; no leading/trailing whitespace, no leading `_`, max length 100.
- */
-export function newScreenTrace(performance: FirebasePerformance, screenName: string): ScreenTrace {
-  return perfInternal(performance).newScreenTrace(screenName, MODULAR_DEPRECATION_ARG);
-}
-
-/**
- * Creates a {@link ScreenTrace} and starts it immediately.
- * Android only; throws if hardware acceleration is disabled or if Android is 9.0 or 9.1.
- * @param performance - The {@link FirebasePerformance} instance to use.
- * @param screenName - Name of the screen.
- */
-export function startScreenTrace(
-  performance: FirebasePerformance,
-  screenName: string,
-): Promise<ScreenTrace> {
-  return perfInternal(performance).startScreenTrace(screenName, MODULAR_DEPRECATION_ARG);
-}

package/lib/namespaced.ts

@@ -1,200 +0,0 @@
-/*
- * 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 { isBoolean, isOneOf, isString } from '@react-native-firebase/app/dist/module/common';
-import {
-  createModuleNamespace,
-  FirebaseModule,
-  getFirebaseRoot,
-  type ModuleConfig,
-} from '@react-native-firebase/app/dist/module/internal';
-import { Platform } from 'react-native';
-
-import HttpMetric from './HttpMetric';
-import ScreenTrace from './ScreenTrace';
-import Trace from './Trace';
-import { version } from './version';
-
-import type { ReactNativeFirebase } from '@react-native-firebase/app';
-import type { FirebasePerformanceTypes } from './types/namespaced';
-
-const statics: FirebasePerformanceTypes.Statics = {
-  SDK_VERSION: version,
-};
-
-const namespace = 'perf';
-
-const nativeModuleName = 'RNFBPerfModule' as const;
-
-const VALID_HTTP_METHODS: FirebasePerformanceTypes.HttpMethod[] = [
-  'CONNECT',
-  'DELETE',
-  'GET',
-  'HEAD',
-  'OPTIONS',
-  'PATCH',
-  'POST',
-  'PUT',
-  'TRACE',
-];
-
-class FirebasePerfModule extends FirebaseModule<typeof nativeModuleName> {
-  private _isPerformanceCollectionEnabled: boolean;
-  private _instrumentationEnabled: boolean;
-
-  constructor(
-    app: ReactNativeFirebase.FirebaseAppBase,
-    config: ModuleConfig,
-    customUrlOrRegion?: string | null,
-  ) {
-    super(app, config, customUrlOrRegion);
-    this._isPerformanceCollectionEnabled = this.native.isPerformanceCollectionEnabled;
-    this._instrumentationEnabled = this.native.isInstrumentationEnabled;
-  }
-
-  get isPerformanceCollectionEnabled(): boolean {
-    return this._isPerformanceCollectionEnabled;
-  }
-
-  get instrumentationEnabled(): boolean {
-    return this._instrumentationEnabled;
-  }
-
-  set instrumentationEnabled(enabled: boolean) {
-    if (!isBoolean(enabled)) {
-      throw new Error("firebase.perf().instrumentationEnabled = 'enabled' must be a boolean.");
-    }
-    if (Platform.OS === 'ios') {
-      // We don't change for android as it cannot be set from code, it is set at gradle build time.
-      this._instrumentationEnabled = enabled;
-      // No need to await, as it only takes effect on the next app run.
-      this.native.instrumentationEnabled(enabled);
-    }
-  }
-
-  get dataCollectionEnabled(): boolean {
-    return this._isPerformanceCollectionEnabled;
-  }
-
-  set dataCollectionEnabled(enabled: boolean) {
-    if (!isBoolean(enabled)) {
-      throw new Error("firebase.perf().dataCollectionEnabled = 'enabled' must be a boolean.");
-    }
-    this._isPerformanceCollectionEnabled = enabled;
-    // Keep setter behavior fire-and-forget; callers that need completion should use setPerformanceCollectionEnabled().
-    void this.native.setPerformanceCollectionEnabled(enabled);
-  }
-
-  async setPerformanceCollectionEnabled(enabled: boolean): Promise<null> {
-    if (!isBoolean(enabled)) {
-      throw new Error(
-        "firebase.perf().setPerformanceCollectionEnabled(*) 'enabled' must be a boolean.",
-      );
-    }
-
-    if (Platform.OS === 'ios') {
-      // '_instrumentationEnabled' is updated here as well to maintain backward compatibility. See:
-      // https://github.com/invertase/react-native-firebase/commit/b705622e64d6ebf4ee026d50841e2404cf692f85
-      this._instrumentationEnabled = enabled;
-      await this.native.instrumentationEnabled(enabled);
-    }
-
-    this._isPerformanceCollectionEnabled = enabled;
-    return this.native.setPerformanceCollectionEnabled(enabled);
-  }
-
-  newTrace(identifier: string): Trace {
-    // TODO(VALIDATION): identifier: no leading or trailing whitespace, no leading underscore '_'
-    if (!isString(identifier) || identifier.length > 100) {
-      throw new Error(
-        "firebase.perf().newTrace(*) 'identifier' must be a string with a maximum length of 100 characters.",
-      );
-    }
-
-    return new Trace(this.native, identifier);
-  }
-
-  startTrace(identifier: string): Promise<Trace> {
-    const traceInstance = this.newTrace(identifier);
-    return traceInstance.start().then(() => traceInstance);
-  }
-
-  newScreenTrace(identifier: string): ScreenTrace {
-    if (!isString(identifier) || identifier.length > 100) {
-      throw new Error(
-        "firebase.perf().newScreenTrace(*) 'identifier' must be a string with a maximum length of 100 characters.",
-      );
-    }
-
-    return new ScreenTrace(this.native, identifier);
-  }
-
-  startScreenTrace(identifier: string): Promise<ScreenTrace> {
-    const screenTrace = this.newScreenTrace(identifier);
-    return screenTrace.start().then(() => screenTrace);
-  }
-
-  newHttpMetric(url: string, httpMethod: FirebasePerformanceTypes.HttpMethod): HttpMetric {
-    if (!isString(url)) {
-      throw new Error("firebase.perf().newHttpMetric(*, _) 'url' must be a string.");
-    }
-
-    if (!isOneOf(httpMethod, VALID_HTTP_METHODS)) {
-      throw new Error(
-        `firebase.perf().newHttpMetric(_, *) 'httpMethod' must be one of ${VALID_HTTP_METHODS.join(
-          ', ',
-        )}.`,
-      );
-    }
-
-    return new HttpMetric(this.native, url, httpMethod);
-  }
-}
-
-// import { SDK_VERSION } from '@react-native-firebase/perf';
-export const SDK_VERSION = version;
-
-export type PerfNamespace = ReactNativeFirebase.FirebaseModuleWithStaticsAndApp<
-  FirebasePerformanceTypes.Module,
-  FirebasePerformanceTypes.Statics
-> & {
-  firebase: ReactNativeFirebase.Module;
-  app(name?: string): ReactNativeFirebase.FirebaseApp;
-};
-
-const defaultExport = createModuleNamespace({
-  statics,
-  version,
-  namespace,
-  nativeModuleName,
-  nativeEvents: false,
-  hasMultiAppSupport: false,
-  hasCustomUrlOrRegionSupport: false,
-  ModuleClass: FirebasePerfModule,
-}) as unknown as PerfNamespace;
-
-export default defaultExport;
-
-// import perf, { firebase } from '@react-native-firebase/perf';
-// perf().X(...);
-// firebase.perf().X(...);
-export const firebase =
-  getFirebaseRoot() as unknown as ReactNativeFirebase.FirebaseNamespacedExport<
-    'perf',
-    FirebasePerformanceTypes.Module,
-    FirebasePerformanceTypes.Statics
-  >;

package/lib/types/namespaced.ts

@@ -1,162 +0,0 @@
-/*
- * 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 type { ReactNativeFirebase } from '@react-native-firebase/app';
-
-/**
- * Firebase Performance Monitoring package for React Native.
- *
- * #### Example 1
- *
- * Access the firebase export from the `perf` package:
- *
- * ```js
- * import { firebase } from '@react-native-firebase/perf';
- *
- * // firebase.perf().X
- * ```
- *
- * #### Example 2
- *
- * Using the default export from the `perf` package:
- *
- * ```js
- * import perf from '@react-native-firebase/perf';
- *
- * // perf().X
- * ```
- *
- * #### Example 3
- *
- * Using the default export from the `app` package:
- *
- * ```js
- * import firebase from '@react-native-firebase/app';
- * import '@react-native-firebase/perf';
- *
- * // firebase.perf().X
- * ```
- *
- * @firebase perf
- */
-/**
- * @deprecated Use the modular type exports from `@react-native-firebase/perf` instead.
- * `FirebasePerformanceTypes` is kept for backwards compatibility with the namespaced API.
- */
-/* eslint-disable @typescript-eslint/no-namespace */
-export namespace FirebasePerformanceTypes {
-  type FirebaseModule = ReactNativeFirebase.FirebaseModule;
-
-  /**
-   * @deprecated Use the `HttpMethod` type from the modular package exports instead.
-   */
-  export type HttpMethod =
-    | 'GET'
-    | 'HEAD'
-    | 'PUT'
-    | 'POST'
-    | 'PATCH'
-    | 'TRACE'
-    | 'DELETE'
-    | 'CONNECT'
-    | 'OPTIONS';
-
-  /**
-   * @deprecated Use the `PerformanceTrace` type from the modular package exports instead.
-   */
-  export interface Trace {
-    getAttribute(attribute: string): string | undefined;
-    putAttribute(attribute: string, value: string): void;
-    getMetric(metricName: string): number;
-    getMetrics(): { [key: string]: number };
-    putMetric(metricName: string, value: number): void;
-    incrementMetric(metricName: string, incrementBy?: number): void;
-    removeMetric(metricName: string): void;
-    start(): Promise<null>;
-    stop(): Promise<null>;
-  }
-
-  /**
-   * @deprecated Use the `ScreenTrace` type from the modular package exports instead.
-   */
-  export interface ScreenTrace {
-    start(): Promise<null>;
-    stop(): Promise<null>;
-  }
-
-  /**
-   * @deprecated Use the `HttpMetric` type from the modular package exports instead.
-   */
-  export interface HttpMetric {
-    getAttribute(attribute: string): string | undefined;
-    getAttributes(): { [key: string]: string };
-    putAttribute(attribute: string, value: string): void;
-    removeAttribute(attribute: string): void;
-    setHttpResponseCode(code: number | null): void;
-    setRequestPayloadSize(bytes: number | null): void;
-    setResponsePayloadSize(bytes: number | null): void;
-    setResponseContentType(contentType: string | null): void;
-    start(): Promise<null>;
-    stop(): Promise<null>;
-  }
-
-  /**
-   * @deprecated Use static exports from the package root instead.
-   */
-  export interface Statics {
-    SDK_VERSION: string;
-  }
-
-  /**
-   * @deprecated Use the `FirebasePerformance` type from the modular package exports instead.
-   */
-  export interface Module extends FirebaseModule {
-    app: ReactNativeFirebase.FirebaseApp;
-    isPerformanceCollectionEnabled: boolean;
-    instrumentationEnabled: boolean;
-    dataCollectionEnabled: boolean;
-    /**
-     * @deprecated prefer setting `dataCollectionEnabled = boolean`.
-     */
-    setPerformanceCollectionEnabled(enabled: boolean): Promise<null>;
-    newTrace(identifier: string): Trace;
-    startTrace(identifier: string): Promise<Trace>;
-    newScreenTrace(identifier: string): ScreenTrace;
-    startScreenTrace(identifier: string): Promise<ScreenTrace>;
-    newHttpMetric(url: string, httpMethod: HttpMethod): HttpMetric;
-  }
-}
-/* eslint-enable @typescript-eslint/no-namespace */
-
-/**
- * Attach namespace to `firebase.` and `FirebaseApp.`.
- */
-declare module '@react-native-firebase/app' {
-  // eslint-disable-next-line @typescript-eslint/no-namespace
-  namespace ReactNativeFirebase {
-    import FirebaseModuleWithStatics = ReactNativeFirebase.FirebaseModuleWithStatics;
-    interface Module {
-      perf: FirebaseModuleWithStatics<
-        FirebasePerformanceTypes.Module,
-        FirebasePerformanceTypes.Statics
-      >;
-    }
-    interface FirebaseApp {
-      perf(): FirebasePerformanceTypes.Module;
-    }
-  }
-}