@capacitor-firebase/performance 6.2.0 → 6.3.1

package/README.md

@@ -58,6 +58,66 @@ const isEnabled = async () => {
   const result = await FirebasePerformance.isEnabled();
   return result.enabled;
 };
+
+const putAttribute = async () => {
+  await FirebasePerformance.putAttribute({
+    traceName: 'test_trace',
+    attribute: 'user_id',
+    value: '123',
+  });
+};
+
+const getAttribute = async () => {
+  const result = await FirebasePerformance.getAttribute({
+    traceName: 'test_trace',
+    attribute: 'user_id',
+  });
+  return result.attributes;
+};
+
+const getAttributes = async () => {
+  const result = await FirebasePerformance.getAttributes({ traceName: 'test_trace' });
+  return result.attributes;
+};
+
+const removeAttribute = async () => {
+  await FirebasePerformance.removeAttribute({
+    traceName: 'test_trace',
+    attribute: 'user_id',
+  });
+};
+
+const putMetric = async () => {
+  await FirebasePerformance.putMetric({
+    traceName: 'test_trace',
+    metricName: 'item_cache_hit',
+    num: 1,
+  });
+};
+
+const getMetric = async () => {
+  const result = await FirebasePerformance.getMetric({
+    traceName: 'test_trace',
+    metricName: 'item_cache_hit',
+  });
+  return result.value;
+};
+
+const record = async () => {
+  await FirebasePerformance.record({
+    traceName: 'test_trace',
+    startTime: Date.now(),
+    duration: 1000,
+    options: {
+      metrics: {
+        item_cache_hit: 1,
+      },
+      attributes: {
+        user_id: '123',
+      },
+    },
+  });
+};
 ```
 
 ## API
@@ -69,7 +129,15 @@ const isEnabled = async () => {
 * [`incrementMetric(...)`](#incrementmetric)
 * [`setEnabled(...)`](#setenabled)
 * [`isEnabled()`](#isenabled)
+* [`putAttribute(...)`](#putattribute)
+* [`getAttribute(...)`](#getattribute)
+* [`getAttributes(...)`](#getattributes)
+* [`removeAttribute(...)`](#removeattribute)
+* [`putMetric(...)`](#putmetric)
+* [`getMetric(...)`](#getmetric)
+* [`record(...)`](#record)
 * [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
 
 </docgen-index>
 
@@ -160,6 +228,133 @@ Determines whether performance monitoring is enabled or disabled.
 --------------------
 
 
+### putAttribute(...)
+
+```typescript
+putAttribute(options: PutAttributeOptions) => Promise<void>
+```
+
+Sets a custom attribute of a trace to a given value.
+
+| Param         | Type                                                                |
+| ------------- | ------------------------------------------------------------------- |
+| **`options`** | <code><a href="#putattributeoptions">PutAttributeOptions</a></code> |
+
+**Since:** 6.3.0
+
+--------------------
+
+
+### getAttribute(...)
+
+```typescript
+getAttribute(options: GetAttributeOptions) => Promise<GetAttributeResult>
+```
+
+Returns the value of a custom attribute of a trace.
+
+| Param         | Type                                                                |
+| ------------- | ------------------------------------------------------------------- |
+| **`options`** | <code><a href="#getattributeoptions">GetAttributeOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#getattributeresult">GetAttributeResult</a>&gt;</code>
+
+**Since:** 6.3.0
+
+--------------------
+
+
+### getAttributes(...)
+
+```typescript
+getAttributes(options: GetAttributesOptions) => Promise<GetAttributesResult>
+```
+
+Gets the all the custom attributes of a trace with their values.
+
+| Param         | Type                                                                  |
+| ------------- | --------------------------------------------------------------------- |
+| **`options`** | <code><a href="#getattributesoptions">GetAttributesOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#getattributesresult">GetAttributesResult</a>&gt;</code>
+
+**Since:** 6.3.0
+
+--------------------
+
+
+### removeAttribute(...)
+
+```typescript
+removeAttribute(options: RemoveAttributeOptions) => Promise<void>
+```
+
+Removes a custom attribute from a trace given its name.
+
+| Param         | Type                                                                |
+| ------------- | ------------------------------------------------------------------- |
+| **`options`** | <code><a href="#getattributeoptions">GetAttributeOptions</a></code> |
+
+**Since:** 6.3.0
+
+--------------------
+
+
+### putMetric(...)
+
+```typescript
+putMetric(options: PutMetricOptions) => Promise<void>
+```
+
+Sets the value of a custom metric.
+
+| Param         | Type                                                          |
+| ------------- | ------------------------------------------------------------- |
+| **`options`** | <code><a href="#putmetricoptions">PutMetricOptions</a></code> |
+
+**Since:** 6.3.0
+
+--------------------
+
+
+### getMetric(...)
+
+```typescript
+getMetric(options: GetMetricOptions) => Promise<GetMetricResult>
+```
+
+Get the value of a custom metric by name.
+
+| Param         | Type                                                          |
+| ------------- | ------------------------------------------------------------- |
+| **`options`** | <code><a href="#getmetricoptions">GetMetricOptions</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#getmetricresult">GetMetricResult</a>&gt;</code>
+
+**Since:** 6.3.0
+
+--------------------
+
+
+### record(...)
+
+```typescript
+record(options: RecordOptions) => Promise<void>
+```
+
+Records a trace given its name and options.
+
+Only available on web.
+
+| Param         | Type                                                    |
+| ------------- | ------------------------------------------------------- |
+| **`options`** | <code><a href="#recordoptions">RecordOptions</a></code> |
+
+**Since:** 6.3.0
+
+--------------------
+
+
 ### Interfaces
 
 
@@ -199,6 +394,86 @@ Determines whether performance monitoring is enabled or disabled.
 | ------------- | -------------------- | --------------------------------------------------------------- | ----- |
 | **`enabled`** | <code>boolean</code> | `true` if performance monitoring is enabled, otherwise `false`. | 0.1.0 |
 
+
+#### PutAttributeOptions
+
+| Prop            | Type                | Description                             | Since |
+| --------------- | ------------------- | --------------------------------------- | ----- |
+| **`traceName`** | <code>string</code> | Name of the trace to set its attribute. | 6.3.0 |
+| **`attribute`** | <code>string</code> | Name of the attribute to set its value. | 6.3.0 |
+| **`value`**     | <code>string</code> | The value to set to the attribute.      | 6.3.0 |
+
+
+#### GetAttributeResult
+
+| Prop        | Type                        | Description                        | Since |
+| ----------- | --------------------------- | ---------------------------------- | ----- |
+| **`value`** | <code>string \| null</code> | The value of the custom attribute. | 6.3.0 |
+
+
+#### GetAttributeOptions
+
+| Prop            | Type                | Description                                  | Since |
+| --------------- | ------------------- | -------------------------------------------- | ----- |
+| **`traceName`** | <code>string</code> | Name of the trace to set its attribute.      | 6.3.0 |
+| **`attribute`** | <code>string</code> | Name of the attribute to retrieve its value. | 6.3.0 |
+
+
+#### GetAttributesResult
+
+| Prop             | Type                                    | Description                                                  | Since |
+| ---------------- | --------------------------------------- | ------------------------------------------------------------ | ----- |
+| **`attributes`** | <code>{ [key: string]: string; }</code> | A map of all custom attributes of a trace with their values. | 6.3.0 |
+
+
+#### GetAttributesOptions
+
+| Prop            | Type                | Description                              | Since |
+| --------------- | ------------------- | ---------------------------------------- | ----- |
+| **`traceName`** | <code>string</code> | Name of the trace to get its attributes. | 6.3.0 |
+
+
+#### PutMetricOptions
+
+| Prop             | Type                | Description                                                                              | Since |
+| ---------------- | ------------------- | ---------------------------------------------------------------------------------------- | ----- |
+| **`traceName`**  | <code>string</code> | Name of the trace to set its metric.                                                     | 6.3.0 |
+| **`metricName`** | <code>string</code> | The metric name.                                                                         | 6.3.0 |
+| **`num`**        | <code>number</code> | The value to set for the metric. The given value is floored down to the nearest integer. | 6.3.0 |
+
+
+#### GetMetricResult
+
+| Prop        | Type                | Description                        | Since |
+| ----------- | ------------------- | ---------------------------------- | ----- |
+| **`value`** | <code>number</code> | The value of the metric if exists. | 6.3.0 |
+
+
+#### GetMetricOptions
+
+| Prop             | Type                | Description                          | Since |
+| ---------------- | ------------------- | ------------------------------------ | ----- |
+| **`traceName`**  | <code>string</code> | Name of the trace to get its metric. | 6.3.0 |
+| **`metricName`** | <code>string</code> | The metric name.                     | 6.3.0 |
+
+
+#### RecordOptions
+
+| Prop            | Type                                                                                            | Description                                                                   | Since |
+| --------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----- |
+| **`traceName`** | <code>string</code>                                                                             | Name of the trace to record.                                                  | 6.3.0 |
+| **`startTime`** | <code>number</code>                                                                             | Start time of the trace since epoch in milliseconds.                          | 6.3.0 |
+| **`duration`**  | <code>number</code>                                                                             | The duration of the trace in milliseconds.                                    | 6.3.0 |
+| **`options`**   | <code>{ metrics?: { [key: string]: number; }; attributes?: { [key: string]: string; }; }</code> | An optional object that holds optional maps of custom metrics and attributes. | 6.3.0 |
+
+
+### Type Aliases
+
+
+#### RemoveAttributeOptions
+
+<code><a href="#getattributeoptions">GetAttributeOptions</a></code>
+
 </docgen-api>
 
 ## Changelog

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

@@ -2,6 +2,7 @@ package io.capawesome.capacitorjs.plugins.firebase.performance;
 
 import com.google.firebase.perf.metrics.Trace;
 import java.util.HashMap;
+import java.util.Map;
 
 public class FirebasePerformance {
 
@@ -39,6 +40,30 @@ public class FirebasePerformance {
         return this.getFirebasePerformanceInstance().isPerformanceCollectionEnabled();
     }
 
+    public static void putAttribute(Trace trace, String attribute, String value) {
+        trace.putAttribute(attribute, value);
+    }
+
+    public static String getAttribute(Trace trace, String attribute) {
+        return trace.getAttribute(attribute);
+    }
+
+    public static Map<String, String> getAttributes(Trace trace) {
+        return trace.getAttributes();
+    }
+
+    public static void removeAttribute(Trace trace, String attribute) {
+        trace.removeAttribute(attribute);
+    }
+
+    public static void putMetric(Trace trace, String metricName, long num) {
+        trace.putMetric(metricName, num);
+    }
+
+    public static long getMetric(Trace trace, String metricName) {
+        return trace.getLongMetric(metricName);
+    }
+
     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

@@ -7,6 +7,7 @@ import com.getcapacitor.PluginCall;
 import com.getcapacitor.PluginMethod;
 import com.getcapacitor.annotation.CapacitorPlugin;
 import com.google.firebase.perf.metrics.Trace;
+import java.util.Map;
 
 @CapacitorPlugin(name = "FirebasePerformance")
 public class FirebasePerformancePlugin extends Plugin {
@@ -17,6 +18,12 @@ public class FirebasePerformancePlugin extends Plugin {
     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.";
+    public static final String ERROR_ATTRIBUTE_MISSING = "attribute must be provided.";
+    public static final String ERROR_VALUE_MISSING = "value must be provided.";
+    public static final String ERROR_NUM_MISSING = "num must be provided.";
+    public static final String ERROR_START_TIME_MISSING = "startTime must be provided.";
+    public static final String ERROR_DURATION_MISSING = "duration must be provided.";
+    public static final String ERROR_INVALID_METRIC_VALUE = "provided metric value is not a number.";
     private FirebasePerformance implementation = new FirebasePerformance();
 
     @PluginMethod
@@ -116,4 +123,180 @@ public class FirebasePerformancePlugin extends Plugin {
             call.reject(exception.getMessage());
         }
     }
+
+    @PluginMethod
+    public void putAttribute(PluginCall call) {
+        try {
+            String traceName = call.getString("traceName");
+            if (traceName == null) {
+                call.reject(FirebasePerformancePlugin.ERROR_TRACE_NAME_MISSING);
+                return;
+            }
+            String attribute = call.getString("attribute");
+            if (attribute == null) {
+                call.reject(FirebasePerformancePlugin.ERROR_ATTRIBUTE_MISSING);
+                return;
+            }
+            String value = call.getString("value");
+            if (value == null) {
+                call.reject(FirebasePerformancePlugin.ERROR_VALUE_MISSING);
+                return;
+            }
+            Trace trace = implementation.getTraceByName(traceName);
+            if (trace == null) {
+                call.reject(ERROR_TRACE_NOT_FOUND);
+                return;
+            }
+            FirebasePerformance.putAttribute(trace, attribute, value);
+            call.resolve();
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void getAttribute(PluginCall call) {
+        try {
+            String traceName = call.getString("traceName");
+            if (traceName == null) {
+                call.reject(FirebasePerformancePlugin.ERROR_TRACE_NAME_MISSING);
+                return;
+            }
+            String attribute = call.getString("attribute");
+            if (attribute == null) {
+                call.reject(FirebasePerformancePlugin.ERROR_ATTRIBUTE_MISSING);
+                return;
+            }
+            Trace trace = implementation.getTraceByName(traceName);
+            if (trace == null) {
+                call.reject(ERROR_TRACE_NOT_FOUND);
+                return;
+            }
+            String value = FirebasePerformance.getAttribute(trace, attribute);
+            JSObject result = new JSObject();
+            result.put("value", value);
+            call.resolve(result);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void getAttributes(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;
+            }
+            Map<String, String> attributesMap = FirebasePerformance.getAttributes(trace);
+            JSObject result = new JSObject();
+            JSObject resultMap = new JSObject();
+            for (String attribute : attributesMap.keySet()) {
+                resultMap.put(attribute, attributesMap.get(attribute));
+            }
+            result.put("result", resultMap);
+            call.resolve(result);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void removeAttribute(PluginCall call) {
+        try {
+            String traceName = call.getString("traceName");
+            if (traceName == null) {
+                call.reject(FirebasePerformancePlugin.ERROR_TRACE_NAME_MISSING);
+                return;
+            }
+            String attribute = call.getString("attribute");
+            if (attribute == null) {
+                call.reject(FirebasePerformancePlugin.ERROR_ATTRIBUTE_MISSING);
+                return;
+            }
+            Trace trace = implementation.getTraceByName(traceName);
+            if (trace == null) {
+                call.reject(ERROR_TRACE_NOT_FOUND);
+                return;
+            }
+            FirebasePerformance.removeAttribute(trace, attribute);
+            call.resolve();
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void putMetric(PluginCall call) {
+        try {
+            String traceName = call.getString("traceName");
+            if (traceName == null) {
+                call.reject(FirebasePerformancePlugin.ERROR_TRACE_NAME_MISSING);
+                return;
+            }
+            String metricName = call.getString("metricName");
+            if (metricName == null) {
+                call.reject(FirebasePerformancePlugin.ERROR_METRIC_NAME_MISSING);
+                return;
+            }
+            Double num = call.getDouble("num");
+            if (num == null) {
+                call.reject(FirebasePerformancePlugin.ERROR_NUM_MISSING);
+                return;
+            }
+            Trace trace = implementation.getTraceByName(traceName);
+            if (trace == null) {
+                call.reject(ERROR_TRACE_NOT_FOUND);
+                return;
+            }
+            FirebasePerformance.putMetric(trace, metricName, (long) Math.floor(num));
+            call.resolve();
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void getMetric(PluginCall call) {
+        try {
+            String traceName = call.getString("traceName");
+            if (traceName == null) {
+                call.reject(FirebasePerformancePlugin.ERROR_TRACE_NAME_MISSING);
+                return;
+            }
+            String metricName = call.getString("metricName");
+            if (metricName == null) {
+                call.reject(FirebasePerformancePlugin.ERROR_METRIC_NAME_MISSING);
+                return;
+            }
+            Trace trace = implementation.getTraceByName(traceName);
+            if (trace == null) {
+                call.reject(ERROR_TRACE_NOT_FOUND);
+                return;
+            }
+            long value = FirebasePerformance.getMetric(trace, metricName);
+            JSObject result = new JSObject();
+            result.put("value", value);
+            call.resolve(result);
+        } catch (Exception exception) {
+            Logger.error(TAG, exception.getMessage(), exception);
+            call.reject(exception.getMessage());
+        }
+    }
+
+    @PluginMethod
+    public void record(PluginCall call) {
+        call.unimplemented("Not implemented on Android.");
+    }
 }