@capacitor-firebase/performance 0.5.0 → 0.5.1-dev.01021f0.1659726888

package/README.md

@@ -1,80 +1,78 @@
-# @capacitor-firebase/performance
-
-⚡️ Capacitor plugin for Firebase Performance Monitoring.
-
-## Installation
-
-```bash
-npm install @capacitor-firebase/performance firebase
-npx cap sync
-```
-
-Add Firebase to your project if you haven't already ([Android](https://firebase.google.com/docs/android/setup) / [iOS](https://firebase.google.com/docs/ios/setup) / [Web](https://firebase.google.com/docs/web/setup)).
-
-### Android
-
-**Attention**: Please make sure that you are using **Java 11**.
-
-See [Add the Performance Monitoring plugin to your app](https://firebase.google.com/docs/perf-mon/get-started-android#add-perfmon-plugin) and follow the instructions to set up your app correctly.
-
-#### Variables
-
-This plugin will use the following project variables (defined in your app’s `variables.gradle` file):
-
-- `$firebasePerfVersion` version of `com.google.firebase:firebase-perf` (default: `20.0.6`)
-
-## Configuration
-
-No configuration required for this plugin.
-
-## Demo
-
-A working example can be found here: [robingenz/capacitor-firebase-plugin-demo](https://github.com/robingenz/capacitor-firebase-plugin-demo)
-
-## Usage
-
-```typescript
-import { FirebasePerformance } from '@capacitor-firebase/performance';
-
-const startTrace = async () => {
-  await FirebasePerformance.startTrace({ traceName: 'test_trace' });
-};
-
-const stopTrace = async () => {
-  await FirebasePerformance.stopTrace({ traceName: 'test_trace' });
-};
-
-const incrementMetric = async () => {
-  await FirebasePerformance.incrementMetric({
-    traceName: 'test_trace',
-    metricName: 'item_cache_hit',
-    incrementBy: 1,
-  });
-};
-
-const setPerformanceCollectionEnabled = async () => {
-  await FirebasePerformance.setPerformanceCollectionEnabled({ enabled: true });
-};
-
-const isPerformanceCollectionEnabled = async () => {
-  const result = await FirebasePerformance.isPerformanceCollectionEnabled();
-  return result.enabled;
-};
-```
-
-## API
-
+# @capacitor-firebase/performance
+
+⚡️ Capacitor plugin for Firebase Performance Monitoring.
+
+## Installation
+
+```bash
+npm install @capacitor-firebase/performance firebase
+npx cap sync
+```
+
+Add Firebase to your project if you haven't already ([Android](https://firebase.google.com/docs/android/setup) / [iOS](https://firebase.google.com/docs/ios/setup) / [Web](https://firebase.google.com/docs/web/setup)).
+
+### Android
+
+See [Add the Performance Monitoring plugin to your app](https://firebase.google.com/docs/perf-mon/get-started-android#add-perfmon-plugin) and follow the instructions to set up your app correctly.
+
+#### Variables
+
+This plugin will use the following project variables (defined in your app’s `variables.gradle` file):
+
+- `$firebasePerfVersion` version of `com.google.firebase:firebase-perf` (default: `20.0.6`)
+
+## Configuration
+
+No configuration required for this plugin.
+
+## Demo
+
+A working example can be found here: [robingenz/capacitor-firebase-plugin-demo](https://github.com/robingenz/capacitor-firebase-plugin-demo)
+
+## Usage
+
+```typescript
+import { FirebasePerformance } from '@capacitor-firebase/performance';
+
+const startTrace = async () => {
+  await FirebasePerformance.startTrace({ traceName: 'test_trace' });
+};
+
+const stopTrace = async () => {
+  await FirebasePerformance.stopTrace({ traceName: 'test_trace' });
+};
+
+const incrementMetric = async () => {
+  await FirebasePerformance.incrementMetric({
+    traceName: 'test_trace',
+    metricName: 'item_cache_hit',
+    incrementBy: 1,
+  });
+};
+
+const setPerformanceCollectionEnabled = async () => {
+  await FirebasePerformance.setPerformanceCollectionEnabled({ enabled: true });
+};
+
+const isPerformanceCollectionEnabled = async () => {
+  const result = await FirebasePerformance.isPerformanceCollectionEnabled();
+  return result.enabled;
+};
+```
+
+## API
+
 <docgen-index>
 
 * [`startTrace(...)`](#starttrace)
 * [`stopTrace(...)`](#stoptrace)
 * [`incrementMetric(...)`](#incrementmetric)
-* [`setPerformanceCollectionEnabled(...)`](#setperformancecollectionenabled)
-* [`isPerformanceCollectionEnabled()`](#isperformancecollectionenabled)
+* [`setEnabled(...)`](#setenabled)
+* [`isEnabled()`](#isenabled)
 * [Interfaces](#interfaces)
 
-</docgen-index>
-
+</docgen-index>
+
 <docgen-api>
 <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
 
@@ -129,33 +127,33 @@ Atomically increments the metric with the given name for the selected trace by t
 --------------------
 
 
-### setPerformanceCollectionEnabled(...)
+### setEnabled(...)
 
 ```typescript
-setPerformanceCollectionEnabled(options: SetPerformanceCollectionEnabledOptions) => Promise<void>
+setEnabled(options: SetEnabledOptions) => Promise<void>
 ```
 
-Enables or disables performance monitoring.
+Enables or disables performance monitoring.
 Will be applied with the next start of the app.
 
-| Param         | Type                                                                                                      |
-| ------------- | --------------------------------------------------------------------------------------------------------- |
-| **`options`** | <code><a href="#setperformancecollectionenabledoptions">SetPerformanceCollectionEnabledOptions</a></code> |
+| Param         | Type                                                            |
+| ------------- | --------------------------------------------------------------- |
+| **`options`** | <code><a href="#setenabledoptions">SetEnabledOptions</a></code> |
 
 **Since:** 0.1.0
 
 --------------------
 
 
-### isPerformanceCollectionEnabled()
+### isEnabled()
 
 ```typescript
-isPerformanceCollectionEnabled() => Promise<IsPerformanceCollectionEnabledResult>
+isEnabled() => Promise<IsEnabledResult>
 ```
 
 Determines whether performance monitoring is enabled or disabled.
 
-**Returns:** <code>Promise&lt;<a href="#isperformancecollectionenabledresult">IsPerformanceCollectionEnabledResult</a>&gt;</code>
+**Returns:** <code>Promise&lt;<a href="#isenabledresult">IsEnabledResult</a>&gt;</code>
 
 **Since:** 0.1.0
 
@@ -188,25 +186,25 @@ Determines whether performance monitoring is enabled or disabled.
 | **`incrementBy`** | <code>number</code> | Amount by which the metric has to be incremented. | <code>1</code> | 0.1.0 |
 
 
-#### SetPerformanceCollectionEnabledOptions
+#### SetEnabledOptions
 
 | Prop          | Type                 | Description                               | Since |
 | ------------- | -------------------- | ----------------------------------------- | ----- |
 | **`enabled`** | <code>boolean</code> | Should performance monitoring be enabled. | 0.1.0 |
 
 
-#### IsPerformanceCollectionEnabledResult
+#### IsEnabledResult
 
 | Prop          | Type                 | Description                                                     | Since |
 | ------------- | -------------------- | --------------------------------------------------------------- | ----- |
 | **`enabled`** | <code>boolean</code> | `true` if performance monitoring is enabled, otherwise `false`. | 0.1.0 |
 
-</docgen-api>
-
-## Changelog
-
-See [CHANGELOG.md](/packages/performance/CHANGELOG.md).
-
-## License
-
-See [LICENSE](/packages/performance/LICENSE).
+</docgen-api>
+
+## Changelog
+
+See [CHANGELOG.md](/packages/performance/CHANGELOG.md).
+
+## License
+
+See [LICENSE](/packages/performance/LICENSE).

package/android/build.gradle

@@ -1,60 +1,59 @@
-ext {
-    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.1'
-    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.2.0'
-    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.2'
-    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.3.0'
-    firebasePerfVersion = project.hasProperty('firebasePerfVersion') ? rootProject.ext.firebasePerfVersion : '20.0.6'
-}
-
-buildscript {
-    repositories {
-        google()
-        mavenCentral()
-    }
-    dependencies {
-        classpath 'com.android.tools.build:gradle:4.2.1'
-    }
-}
-
-apply plugin: 'com.android.library'
-
-android {
-    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 30
-    defaultConfig {
-        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 21
-        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 30
-        versionCode 1
-        versionName "1.0"
-        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
-    }
-    buildTypes {
-        release {
-            minifyEnabled false
-            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
-        }
-    }
-    lintOptions {
-        abortOnError false
-    }
-    compileOptions {
-        sourceCompatibility JavaVersion.VERSION_1_8
-        targetCompatibility JavaVersion.VERSION_1_8
-    }
-}
-
-repositories {
-    google()
-    mavenCentral()
-    jcenter()
-}
-
-
-dependencies {
-    implementation fileTree(dir: 'libs', include: ['*.jar'])
-    implementation project(':capacitor-android')
-    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
-    implementation "com.google.firebase:firebase-perf:$firebasePerfVersion"
-    testImplementation "junit:junit:$junitVersion"
-    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
-    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
-}
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.4.2'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.3'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.4.0'
+    firebasePerfVersion = project.hasProperty('firebasePerfVersion') ? rootProject.ext.firebasePerfVersion : '20.0.6'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:7.2.1'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 32
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 32
+        versionCode 1
+        versionName "1.0"
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+    }
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
+        }
+    }
+    lintOptions {
+        abortOnError false
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_11
+        targetCompatibility JavaVersion.VERSION_11
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation "com.google.firebase:firebase-perf:$firebasePerfVersion"
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -1,3 +1,3 @@
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="dev.robingenz.capacitorjs.plugins.firebase.performance">
-</manifest>
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="io.capawesome.capacitorjs.plugins.firebase.performance">
+</manifest>

package/android/src/main/java/{dev/robingenz → io/capawesome}/capacitorjs/plugins/firebase/performance/FirebasePerformance.java

@@ -1,45 +1,45 @@
-package dev.robingenz.capacitorjs.plugins.firebase.performance;
-
-import com.google.firebase.perf.metrics.Trace;
-import java.util.HashMap;
-
-public class FirebasePerformance {
-
-    private HashMap<String, Trace> traces = new HashMap<String, Trace>();
-
-    public void startTrace(String traceName) {
-        Trace trace = this.getFirebasePerformanceInstance().newTrace(traceName);
-        trace.start();
-        this.traces.put(traceName, trace);
-    }
-
-    public void stopTrace(String traceName) {
-        Trace trace = this.traces.get(traceName);
-        trace.stop();
-        this.traces.remove(traceName);
-    }
-
-    public void incrementMetric(String traceName, String metricName, Integer incrementBy) {
-        Trace trace = this.traces.get(traceName);
-        trace.incrementMetric(metricName, incrementBy);
-    }
-
-    public Trace getTraceByName(String traceName) {
-        if (this.traces.containsKey(traceName)) {
-            return this.traces.get(traceName);
-        }
-        return null;
-    }
-
-    public void setPerformanceCollectionEnabled(Boolean enabled) {
-        this.getFirebasePerformanceInstance().setPerformanceCollectionEnabled(enabled);
-    }
-
-    public Boolean isPerformanceCollectionEnabled() {
-        return this.getFirebasePerformanceInstance().isPerformanceCollectionEnabled();
-    }
-
-    private com.google.firebase.perf.FirebasePerformance getFirebasePerformanceInstance() {
-        return com.google.firebase.perf.FirebasePerformance.getInstance();
-    }
-}
+package io.capawesome.capacitorjs.plugins.firebase.performance;
+
+import com.google.firebase.perf.metrics.Trace;
+import java.util.HashMap;
+
+public class FirebasePerformance {
+
+    private HashMap<String, Trace> traces = new HashMap<String, Trace>();
+
+    public void startTrace(String traceName) {
+        Trace trace = this.getFirebasePerformanceInstance().newTrace(traceName);
+        trace.start();
+        this.traces.put(traceName, trace);
+    }
+
+    public void stopTrace(String traceName) {
+        Trace trace = this.traces.get(traceName);
+        trace.stop();
+        this.traces.remove(traceName);
+    }
+
+    public void incrementMetric(String traceName, String metricName, Integer incrementBy) {
+        Trace trace = this.traces.get(traceName);
+        trace.incrementMetric(metricName, incrementBy);
+    }
+
+    public Trace getTraceByName(String traceName) {
+        if (this.traces.containsKey(traceName)) {
+            return this.traces.get(traceName);
+        }
+        return null;
+    }
+
+    public void setEnabled(Boolean enabled) {
+        this.getFirebasePerformanceInstance().setPerformanceCollectionEnabled(enabled);
+    }
+
+    public Boolean isEnabled() {
+        return this.getFirebasePerformanceInstance().isPerformanceCollectionEnabled();
+    }
+
+    private com.google.firebase.perf.FirebasePerformance getFirebasePerformanceInstance() {
+        return com.google.firebase.perf.FirebasePerformance.getInstance();
+    }
+}

package/android/src/main/java/io/capawesome/capacitorjs/plugins/firebase/performance/FirebasePerformancePlugin.java

@@ -0,0 +1,112 @@
+package io.capawesome.capacitorjs.plugins.firebase.performance;
+
+import com.getcapacitor.JSObject;
+import com.getcapacitor.Plugin;
+import com.getcapacitor.PluginCall;
+import com.getcapacitor.PluginMethod;
+import com.getcapacitor.annotation.CapacitorPlugin;
+import com.google.firebase.perf.metrics.Trace;
+
+@CapacitorPlugin(name = "FirebasePerformance")
+public class FirebasePerformancePlugin extends Plugin {
+
+    public static final String ERROR_TRACE_NAME_MISSING = "traceName must be provided.";
+    public static final String ERROR_METRIC_NAME_MISSING = "metricName must be provided.";
+    public static final String ERROR_TRACE_NAME_ALREADY_ASSIGNED = "traceName already assigned.";
+    public static final String ERROR_ENABLED_MISSING = "enabled must be provided.";
+    public static final String ERROR_TRACE_NOT_FOUND = "No trace was found with the provided traceName.";
+    private FirebasePerformance implementation = new FirebasePerformance();
+
+    @PluginMethod
+    public void startTrace(PluginCall call) {
+        try {
+            String traceName = call.getString("traceName");
+            if (traceName == null) {
+                call.reject(ERROR_TRACE_NAME_MISSING);
+                return;
+            }
+            Trace trace = implementation.getTraceByName(traceName);
+            if (trace != null) {
+                call.reject(ERROR_TRACE_NAME_ALREADY_ASSIGNED);
+                return;
+            }
+            implementation.startTrace(traceName);
+            call.resolve();
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
+    }
+
+    @PluginMethod
+    public void stopTrace(PluginCall call) {
+        try {
+            String traceName = call.getString("traceName");
+            if (traceName == null) {
+                call.reject(ERROR_TRACE_NAME_MISSING);
+                return;
+            }
+            Trace trace = implementation.getTraceByName(traceName);
+            if (trace == null) {
+                call.reject(ERROR_TRACE_NOT_FOUND);
+                return;
+            }
+            implementation.stopTrace(traceName);
+            call.resolve();
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
+    }
+
+    @PluginMethod
+    public void incrementMetric(PluginCall call) {
+        try {
+            String traceName = call.getString("traceName");
+            String metricName = call.getString("metricName");
+            Integer incrementBy = call.getInt("incrementBy", 1);
+            if (traceName == null) {
+                call.reject(ERROR_TRACE_NAME_MISSING);
+                return;
+            }
+            if (metricName == null) {
+                call.reject(ERROR_METRIC_NAME_MISSING);
+                return;
+            }
+            Trace trace = implementation.getTraceByName(traceName);
+            if (trace == null) {
+                call.reject(ERROR_TRACE_NOT_FOUND);
+                return;
+            }
+            implementation.incrementMetric(traceName, metricName, incrementBy);
+            call.resolve();
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
+    }
+
+    @PluginMethod
+    public void setEnabled(PluginCall call) {
+        try {
+            Boolean enabled = call.getBoolean("enabled");
+            if (enabled == null) {
+                call.reject(ERROR_ENABLED_MISSING);
+                return;
+            }
+            implementation.setEnabled(enabled);
+            call.resolve();
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
+    }
+
+    @PluginMethod
+    public void isEnabled(PluginCall call) {
+        try {
+            Boolean enabled = implementation.isEnabled();
+            JSObject result = new JSObject();
+            result.put("enabled", enabled);
+            call.resolve(result);
+        } catch (Exception ex) {
+            call.reject(ex.getLocalizedMessage());
+        }
+    }
+}

package/dist/docs.json

@@ -75,13 +75,13 @@
         "slug": "incrementmetric"
       },
       {
-        "name": "setPerformanceCollectionEnabled",
-        "signature": "(options: SetPerformanceCollectionEnabledOptions) => Promise<void>",
+        "name": "setEnabled",
+        "signature": "(options: SetEnabledOptions) => Promise<void>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "SetPerformanceCollectionEnabledOptions"
+            "type": "SetEnabledOptions"
           }
         ],
         "returns": "Promise<void>",
@@ -91,17 +91,17 @@
             "text": "0.1.0"
           }
         ],
-        "docs": "Enables or disables performance monitoring.\nWill be applied with the next start of the app.",
+        "docs": "Enables or disables performance monitoring.\r\nWill be applied with the next start of the app.",
         "complexTypes": [
-          "SetPerformanceCollectionEnabledOptions"
+          "SetEnabledOptions"
         ],
-        "slug": "setperformancecollectionenabled"
+        "slug": "setenabled"
       },
       {
-        "name": "isPerformanceCollectionEnabled",
-        "signature": "() => Promise<IsPerformanceCollectionEnabledResult>",
+        "name": "isEnabled",
+        "signature": "() => Promise<IsEnabledResult>",
         "parameters": [],
-        "returns": "Promise<IsPerformanceCollectionEnabledResult>",
+        "returns": "Promise<IsEnabledResult>",
         "tags": [
           {
             "name": "since",
@@ -110,9 +110,9 @@
         ],
         "docs": "Determines whether performance monitoring is enabled or disabled.",
         "complexTypes": [
-          "IsPerformanceCollectionEnabledResult"
+          "IsEnabledResult"
         ],
-        "slug": "isperformancecollectionenabled"
+        "slug": "isenabled"
       }
     ],
     "properties": []
@@ -138,7 +138,7 @@
               "name": "since"
             }
           ],
-          "docs": "Custom trace name.\n\nNames for custom code traces must meet the following requirements:\nno leading or trailing whitespace, no leading underscore (_) character,\nand max length is 100 characters.",
+          "docs": "Custom trace name.\r\n\r\nNames for custom code traces must meet the following requirements:\r\nno leading or trailing whitespace, no leading underscore (_) character,\r\nand max length is 100 characters.",
           "complexTypes": [],
           "type": "string"
         }
@@ -225,8 +225,8 @@
       ]
     },
     {
-      "name": "SetPerformanceCollectionEnabledOptions",
-      "slug": "setperformancecollectionenabledoptions",
+      "name": "SetEnabledOptions",
+      "slug": "setenabledoptions",
       "docs": "",
       "tags": [
         {
@@ -251,8 +251,8 @@
       ]
     },
     {
-      "name": "IsPerformanceCollectionEnabledResult",
-      "slug": "isperformancecollectionenabledresult",
+      "name": "IsEnabledResult",
+      "slug": "isenabledresult",
       "docs": "",
       "tags": [],
       "methods": [],