@react-native-firebase/perf 17.0.0 → 17.1.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [17.1.0](https://github.com/invertase/react-native-firebase/compare/v17.0.0...v17.1.0) (2023-02-09)
+
+### Features
+
+- **perf:** Expose modular API that matches the Firebase web JS SDK v9 API ([#6771](https://github.com/invertase/react-native-firebase/issues/6771)) ([4e170ea](https://github.com/invertase/react-native-firebase/commit/4e170ead24035cd0154b153dcf1e8d69d6ab7ac9))
+
 ## [17.0.0](https://github.com/invertase/react-native-firebase/compare/v16.7.0...v17.0.0) (2023-02-02)
 
 **Note:** Version bump only for package @react-native-firebase/perf

package/android/src/main/java/io/invertase/firebase/perf/UniversalFirebasePerfModule.java

@@ -55,6 +55,9 @@ public class UniversalFirebasePerfModule extends UniversalFirebaseModule {
     constants.put(
         "isPerformanceCollectionEnabled",
         FirebasePerformance.getInstance().isPerformanceCollectionEnabled());
+        constants.put(
+          "isInstrumentationEnabled",
+          true);    
     return constants;
   }
 

package/ios/RNFBPerf/RNFBPerfModule.m

@@ -58,6 +58,8 @@ RCT_EXPORT_MODULE();
   NSMutableDictionary *constants = [NSMutableDictionary new];
   constants[@"isPerformanceCollectionEnabled"] =
       @([RCTConvert BOOL:@([FIRPerformance sharedInstance].dataCollectionEnabled)]);
+  constants[@"isInstrumentationEnabled"] =
+      @([RCTConvert BOOL:@([FIRPerformance sharedInstance].instrumentationEnabled)]);
   return constants;
 }
 
@@ -73,7 +75,6 @@ RCT_EXPORT_METHOD(setPerformanceCollectionEnabled
                   : (RCTPromiseResolveBlock)resolve rejecter
                   : (RCTPromiseRejectBlock)reject) {
   [FIRPerformance sharedInstance].dataCollectionEnabled = (BOOL)enabled;
-  [FIRPerformance sharedInstance].instrumentationEnabled = (BOOL)enabled;
   resolve([NSNull null]);
 }
 
@@ -203,4 +204,12 @@ RCT_EXPORT_METHOD(stopHttpMetric
   resolve([NSNull null]);
 }
 
+RCT_EXPORT_METHOD(instrumentationEnabled
+                  : (BOOL)enabled resolver
+                  : (RCTPromiseResolveBlock)resolve rejecter
+                  : (RCTPromiseRejectBlock)reject) {
+  [FIRPerformance sharedInstance].instrumentationEnabled = (BOOL)enabled;
+  resolve([NSNull null]);
+}
+
 @end

package/lib/index.d.ts

@@ -426,7 +426,22 @@ export namespace FirebasePerformanceTypes {
      * ```
      */
     isPerformanceCollectionEnabled: boolean;
-
+    /**
+     * Determines whether to collect 'out of the box' (i.e already setup for Firebase Performance) events.
+     * This can be set for iOS. Android will always return "true" as it has to be set at gradle level.
+     */
+    instrumentationEnabled: boolean;
+    /**
+     * Determines whether performance monitoring is enabled or disabled.
+     *
+     * #### Example
+     *
+     * ```js
+     * const isEnabled = firebase.perf().dataCollectionEnabled;
+     * console.log('Performance collection enabled: ', isEnabled);
+     * ```
+     */
+    dataCollectionEnabled: boolean;
     /**
      * Enables or disables performance monitoring.
      *
@@ -436,8 +451,9 @@ export namespace FirebasePerformanceTypes {
      * // Disable performance monitoring collection
      * await firebase.perf().setPerformanceCollectionEnabled(false);
      * ```
-     *
-     * @param enabled Should performance monitoring be enabled
+     * @deprecated prefer setting `dataCollectionEnabled = boolean`.
+     * @param enabled Should performance monitoring be enabled. For iOS only, this also toggles whether instrumentation
+     * is enabled. See: https://firebase.google.com/docs/reference/ios/firebaseperformance/api/reference/Classes/FIRPerformance#instrumentationenabled
      */
     setPerformanceCollectionEnabled(enabled: boolean): Promise<null>;
 
@@ -470,7 +486,7 @@ export namespace FirebasePerformanceTypes {
 
     /**
      * Creates a ScreenTrace instance with the given identifier.
-     * Throws if hardware acceleration is diabled or if Android is 9.0 or 9.1.
+     * Throws if hardware acceleration is disabled or if Android is 9.0 or 9.1.
      *
      * #### Example
      *
@@ -489,7 +505,7 @@ export namespace FirebasePerformanceTypes {
 
     /**
      * Creates a ScreenTrace instance with the given identifier and immediately starts it.
-     * Throws if hardware acceleration is diabled or if Android is 9.0 or 9.1.
+     * Throws if hardware acceleration is disabled or if Android is 9.0 or 9.1.
      *
      * #### Example
      *

package/lib/index.js

@@ -21,11 +21,21 @@ import {
   FirebaseModule,
   getFirebaseRoot,
 } from '@react-native-firebase/app/lib/internal';
+import { Platform } from 'react-native';
 import HttpMetric from './HttpMetric';
 import Trace from './Trace';
 import ScreenTrace from './ScreenTrace';
 import version from './version';
 
+export {
+  getPerformance,
+  initializePerformance,
+  trace,
+  httpMetric,
+  newScreenTrace,
+  startScreenTrace,
+} from './modular/index';
+
 const statics = {};
 
 const namespace = 'perf';
@@ -48,19 +58,55 @@ class FirebasePerfModule extends FirebaseModule {
   constructor(...args) {
     super(...args);
     this._isPerformanceCollectionEnabled = this.native.isPerformanceCollectionEnabled;
+    this._instrumentationEnabled = this.native.isInstrumentationEnabled;
   }
 
   get isPerformanceCollectionEnabled() {
     return this._isPerformanceCollectionEnabled;
   }
 
-  setPerformanceCollectionEnabled(enabled) {
+  get instrumentationEnabled() {
+    return this._instrumentationEnabled;
+  }
+
+  set instrumentationEnabled(enabled) {
+    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() {
+    return this._isPerformanceCollectionEnabled;
+  }
+
+  set dataCollectionEnabled(enabled) {
+    if (!isBoolean(enabled)) {
+      throw new Error("firebase.perf().dataCollectionEnabled = 'enabled' must be a boolean.");
+    }
+    this._isPerformanceCollectionEnabled = enabled;
+    this.native.setPerformanceCollectionEnabled(enabled);
+  }
+
+  async setPerformanceCollectionEnabled(enabled) {
     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);
   }

package/lib/modular/index.js

@@ -0,0 +1,89 @@
+/*
+ * 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 } from '@react-native-firebase/app/lib/common';
+import { firebase } from '..';
+
+/**
+ * Returns a Performance instance for the given app.
+ * @param app - FirebaseApp. Optional.
+ * @returns {Performance}
+ */
+export function getPerformance(app) {
+  if (app) {
+    return firebase.app(app.name).perf();
+  }
+
+  return firebase.app().perf();
+}
+
+/**
+ * Returns a Performance instance for the given app.
+ * @param app - FirebaseApp. Required.
+ * @param settings - PerformanceSettings. Set "dataCollectionEnabled" which will enable/disable Performance collection.
+ * @returns {Performance}
+ */
+export async function initializePerformance(app, settings) {
+  const perf = firebase.app(app.name).perf();
+
+  if (settings && isBoolean(settings.dataCollectionEnabled)) {
+    await perf.setPerformanceCollectionEnabled(settings.dataCollectionEnabled);
+  }
+
+  return perf;
+}
+
+/**
+ * Returns a Trace instance.
+ * @param perf - Performance instance
+ * @param identifier - A String to identify the Trace instance
+ * @returns {Trace}
+ */
+export function trace(perf, identifier) {
+  return perf.newTrace(identifier);
+}
+
+/**
+ * Returns a HttpMetric instance.
+ * @param perf - Performance instance
+ * @param identifier - A String to identify the HttpMetric instance
+ * @returns {HttpMetric}
+ */
+export function httpMetric(perf, identifier, httpMethod) {
+  return perf.newHttpMetric(identifier, httpMethod);
+}
+
+/**
+ * Creates a ScreenTrace instance with the given identifier.
+ * Throws if hardware acceleration is disabled or if Android is 9.0 or 9.1.
+ * @platform android Android !== 9.0.0 && Android !== 9.1.0
+ * @param perf - Performance instance
+ * @param identifier Name of the trace, no leading or trailing whitespace allowed, no leading underscore '_' character allowed, max length is 100.
+ */
+export function newScreenTrace(perf, identifier) {
+  return perf.newScreenTrace(identifier);
+}
+/**
+ * Creates a ScreenTrace instance with the given identifier and immediately starts it.
+ * Throws if hardware acceleration is disabled or if Android is 9.0 or 9.1.
+ * @platform android Android !== 9.0.0 && Android !== 9.1.0
+ * @param perf - Performance instance
+ * @param identifier Name of the screen
+ */
+export function startScreenTrace(perf, identifier) {
+  return perf.startScreenTrace(identifier);
+}

package/lib/version.js

@@ -1,2 +1,2 @@
 // Generated by genversion.
-module.exports = '17.0.0';
+module.exports = '17.1.0';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-native-firebase/perf",
-  "version": "17.0.0",
+  "version": "17.1.0",
   "author": "Invertase <oss@invertase.io> (http://invertase.io)",
   "description": "React Native Firebase - React Native Firebase provides native integration with Performance Monitoring to gain insight into key performance characteristics within your React Native application.",
   "main": "lib/index.js",
@@ -29,7 +29,7 @@
     "performance monitoring"
   ],
   "peerDependencies": {
-    "@react-native-firebase/app": "17.0.0"
+    "@react-native-firebase/app": "17.1.0"
   },
   "dependencies": {
     "@expo/config-plugins": "^5.0.4"
@@ -37,5 +37,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "53a436278f3c4cb23e1ddb7d2c9f14a65ce4abc1"
+  "gitHead": "635d595389bfb224fc530681627fb2180fea6e26"
 }