Skip to content

Commit

Permalink
feat(performance): add missing methods (#505)
Browse files Browse the repository at this point in the history 
Remove classes and update types.
  • Loading branch information
@ebarooni
ebarooni committed Dec 10, 2024
1 parent 4187829 commit 0bd6824
Show file tree
Hide file tree
Showing 15 changed files with 185 additions and 413 deletions.
2 changes: 1 addition & 1 deletion .changeset/chilly-seahorses-design.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
'@capacitor-firebase/performance': minor
---

feat: implement `putAttribute`, `getAttribute`, `getAttributes`, `putMetric`, `getMetric` and `record`
feat: add `putAttribute(...)`, `getAttribute(...)`, `getAttributes(...)`, `putMetric(...)`, `getMetric(...)` and `record(...)` methods
18 changes: 9 additions & 9 deletions packages/performance/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -382,9 +382,9 @@ Records a trace given its name and options.

#### GetMetricResult

| Prop | Type | Description | Since |
| ----------- | --------------------------- | ---------------------------------- | ----- |
| **`value`** | <code>number \| null</code> | The value of the metric if exists. | 6.3.0 |
| Prop | Type | Description | Since |
| ----------- | ------------------- | ---------------------------------- | ----- |
| **`value`** | <code>number</code> | The value of the metric if exists. | 6.3.0 |


#### GetMetricOptions
Expand All @@ -397,12 +397,12 @@ Records a trace given its name and options.

#### 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 hold optional maps of custom metrics and attributes. | 6.3.0 |
| 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
Expand Down
21 changes: 8 additions & 13 deletions ...main/java/io/capawesome/capacitorjs/plugins/firebase/performance/FirebasePerformance.java
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
package io.capawesome.capacitorjs.plugins.firebase.performance;

import androidx.annotation.Nullable;
import com.google.firebase.perf.metrics.Trace;
import io.capawesome.capacitorjs.plugins.firebase.performance.classes.results.GetAttributeResult;
import io.capawesome.capacitorjs.plugins.firebase.performance.classes.results.GetAttributesResult;
import io.capawesome.capacitorjs.plugins.firebase.performance.classes.results.GetMetricResult;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.Executors;
Expand Down Expand Up @@ -52,34 +48,33 @@ public static void putAttribute(Trace trace, String attribute, String value) {
trace.putAttribute(attribute, value);
}

public static GetAttributeResult getAttribute(Trace trace, String attribute) {
return new GetAttributeResult(trace.getAttribute(attribute));
public static String getAttribute(Trace trace, String attribute) {
return trace.getAttribute(attribute);
}

public static GetAttributesResult getAttributes(Trace trace) {
return new GetAttributesResult(trace.getAttributes());
public static Map<String, String> getAttributes(Trace trace) {
return trace.getAttributes();
}

public static void removeAttribute(Trace trace, String attribute) {
trace.removeAttribute(attribute);
return;
}

public static void putMetric(Trace trace, String metricName, long num) {
trace.putMetric(metricName, num);
}

public static GetMetricResult getMetric(Trace trace, String metricName) {
return new GetMetricResult(trace.getLongMetric(metricName));
public static long getMetric(Trace trace, String metricName) {
return trace.getLongMetric(metricName);
}

public void record(
Trace trace,
String traceName,
long startTime,
long duration,
@Nullable Map<String, String> attributes,
@Nullable Map<String, Long> metrics
Map<String, String> attributes,
Map<String, Long> metrics
) {
long currentTime = System.currentTimeMillis();
long startDelay = Math.max(0, (startTime - currentTime));
Expand Down
173 changes: 136 additions & 37 deletions ...ava/io/capawesome/capacitorjs/plugins/firebase/performance/FirebasePerformancePlugin.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,11 @@
import com.getcapacitor.PluginMethod;
import com.getcapacitor.annotation.CapacitorPlugin;
import com.google.firebase.perf.metrics.Trace;
import io.capawesome.capacitorjs.plugins.firebase.performance.classes.options.GetAttributeOptions;
import io.capawesome.capacitorjs.plugins.firebase.performance.classes.options.GetMetricOptions;
import io.capawesome.capacitorjs.plugins.firebase.performance.classes.options.PutAttributeOptions;
import io.capawesome.capacitorjs.plugins.firebase.performance.classes.options.PutMetricOptions;
import io.capawesome.capacitorjs.plugins.firebase.performance.classes.options.RecordOptions;
import io.capawesome.capacitorjs.plugins.firebase.performance.classes.results.GetAttributeResult;
import io.capawesome.capacitorjs.plugins.firebase.performance.classes.results.GetAttributesResult;
import io.capawesome.capacitorjs.plugins.firebase.performance.classes.results.GetMetricResult;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import org.json.JSONException;
import org.json.JSONObject;

@CapacitorPlugin(name = "FirebasePerformance")
public class FirebasePerformancePlugin extends Plugin {
Expand Down Expand Up @@ -134,13 +131,27 @@ public void isEnabled(PluginCall call) {
@PluginMethod(returnType = PluginMethod.RETURN_NONE)
public void putAttribute(PluginCall call) {
try {
PutAttributeOptions options = new PutAttributeOptions(call);
Trace trace = implementation.getTraceByName(options.getTraceName());
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, options.getAttribute(), options.getValue());
FirebasePerformance.putAttribute(trace, attribute, value);
call.resolve();
} catch (Exception exception) {
Logger.error(TAG, exception.getMessage(), exception);
Expand All @@ -151,14 +162,25 @@ public void putAttribute(PluginCall call) {
@PluginMethod(returnType = PluginMethod.RETURN_PROMISE)
public void getAttribute(PluginCall call) {
try {
GetAttributeOptions options = new GetAttributeOptions(call);
Trace trace = implementation.getTraceByName(options.getTraceName());
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;
}
GetAttributeResult result = FirebasePerformance.getAttribute(trace, options.getAttribute());
call.resolve(result.toJSObject());
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());
Expand All @@ -178,8 +200,14 @@ public void getAttributes(PluginCall call) {
call.reject(ERROR_TRACE_NOT_FOUND);
return;
}
GetAttributesResult result = FirebasePerformance.getAttributes(trace);
call.resolve(result.toJSObject());
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());
Expand All @@ -189,13 +217,22 @@ public void getAttributes(PluginCall call) {
@PluginMethod(returnType = PluginMethod.RETURN_NONE)
public void removeAttribute(PluginCall call) {
try {
GetAttributeOptions options = new GetAttributeOptions(call);
Trace trace = implementation.getTraceByName(options.getTraceName());
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, options.getAttribute());
FirebasePerformance.removeAttribute(trace, attribute);
call.resolve();
} catch (Exception exception) {
Logger.error(TAG, exception.getMessage(), exception);
Expand All @@ -206,13 +243,27 @@ public void removeAttribute(PluginCall call) {
@PluginMethod(returnType = PluginMethod.RETURN_NONE)
public void putMetric(PluginCall call) {
try {
PutMetricOptions options = new PutMetricOptions(call);
Trace trace = implementation.getTraceByName(options.getTraceName());
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, options.getMetricName(), options.getNum());
FirebasePerformance.putMetric(trace, metricName, (long) Math.floor(num));
call.resolve();
} catch (Exception exception) {
Logger.error(TAG, exception.getMessage(), exception);
Expand All @@ -223,14 +274,25 @@ public void putMetric(PluginCall call) {
@PluginMethod(returnType = PluginMethod.RETURN_PROMISE)
public void getMetric(PluginCall call) {
try {
GetMetricOptions options = new GetMetricOptions(call);
Trace trace = implementation.getTraceByName(options.getTraceName());
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;
}
GetMetricResult result = FirebasePerformance.getMetric(trace, options.getMetricName());
call.resolve(result.toJSObject());
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());
Expand All @@ -240,24 +302,61 @@ public void getMetric(PluginCall call) {
@PluginMethod(returnType = PluginMethod.RETURN_NONE)
public void record(PluginCall call) {
try {
RecordOptions options = new RecordOptions(call);
Trace trace = implementation.getTraceByName(options.getTraceName());
String traceName = call.getString("traceName");
if (traceName == null) {
call.reject(FirebasePerformancePlugin.ERROR_TRACE_NAME_MISSING);
return;
}
Long startTime = call.getLong("startTime");
if (startTime == null) {
call.reject(FirebasePerformancePlugin.ERROR_START_TIME_MISSING);
return;
}
Long duration = call.getLong("duration");
if (duration == null) {
call.reject(FirebasePerformancePlugin.ERROR_DURATION_MISSING);
return;
}
JSObject metrics = call.getObject("metrics", new JSObject());
Map<String, Long> mappedMetrics = jsObjectToMetricsMap(metrics == null ? new JSObject() : metrics);
JSObject attributes = call.getObject("attributes", new JSObject());
Map<String, String> mappedAttributes = jsObjectToAttributesMap(attributes == null ? new JSObject() : attributes);
Trace trace = implementation.getTraceByName(traceName);
if (trace == null) {
call.reject(ERROR_TRACE_NOT_FOUND);
return;
}
implementation.record(
trace,
options.getTraceName(),
options.getStartTime(),
options.getDuration(),
options.getAttributes(),
options.getMetrics()
);
implementation.record(trace, traceName, startTime, duration, mappedAttributes, mappedMetrics);
call.resolve();
} catch (Exception exception) {
Logger.error(TAG, exception.getMessage(), exception);
call.reject(exception.getMessage());
}
}

private static Map<String, String> jsObjectToAttributesMap(JSONObject object) throws JSONException {
Map<String, String> map = new HashMap<>();
Iterator<String> keys = object.keys();
while (keys.hasNext()) {
String key = keys.next();
map.put(key, object.get(key).toString());
}
return map;
}

private static Map<String, Long> jsObjectToMetricsMap(JSONObject object) throws JSONException {
Map<String, Long> map = new HashMap<>();
Iterator<String> keys = object.keys();
while (keys.hasNext()) {
String key = keys.next();
if (object.get(key) instanceof Long) {
map.put(key, (Long) object.get(key));
} else if (object.get(key) instanceof Double) {
map.put(key, (long) Math.floor((double) object.get(key)));
} else {
throw new JSONException(FirebasePerformancePlugin.ERROR_INVALID_METRIC_VALUE);
}
}
return map;
}
}
38 changes: 0 additions & 38 deletions ...awesome/capacitorjs/plugins/firebase/performance/classes/options/GetAttributeOptions.java
View file

This file was deleted.

Loading

0 comments on commit 0bd6824

Please sign in to comment.