[NoQA] Add generic way for attributes, limit custom attributes for firebase

src/libs/Firebase/index.native.ts

@@ -2,7 +2,7 @@
 import crashlytics from '@react-native-firebase/crashlytics';
 import perf from '@react-native-firebase/perf';
 import * as Environment from '@libs/Environment/Environment';
-import type {Log, StartTrace, StopTrace, TraceMap} from './types';
+import type {FirebaseAttributes, Log, StartTrace, StopTrace, TraceMap} from './types';
 import utils from './utils';
 
 const traceMap: TraceMap = {};
@@ -17,7 +17,7 @@ const startTrace: StartTrace = (customEventName) => {
         return;
     }
 
-    const attributes = utils.getAttributes();
+    const attributes: FirebaseAttributes = utils.getAttributes(['accountId', 'personalDetailsLength', 'reportActionsLength', 'reportsLength', 'policiesLength']);
 
     perf()
         .startTrace(customEventName)

src/libs/Firebase/index.web.ts

@@ -1,7 +1,7 @@
 import {trace} from '@firebase/performance';
 import * as Environment from '@libs/Environment/Environment';
 import {firebasePerfWeb} from './firebaseWebConfig';
-import type {Log, StartTrace, StopTrace, TraceMap} from './types';
+import type {FirebaseAttributes, Log, StartTrace, StopTrace, TraceMap} from './types';
 import utils from './utils';
 
 const traceMap: TraceMap = {};
@@ -19,7 +19,7 @@ const startTrace: StartTrace = (customEventName) => {
 
     const perfTrace = trace(firebasePerfWeb, customEventName);
 
-    const attributes = utils.getAttributes();
+    const attributes: FirebaseAttributes = utils.getAttributes(['accountId', 'personalDetailsLength', 'reportActionsLength', 'reportsLength', 'policiesLength']);
 
     Object.entries(attributes).forEach(([name, value]) => {
         perfTrace.putAttribute(name, value);

src/libs/Firebase/types.ts

@@ -9,7 +9,7 @@ type TraceMap = Record<string, Trace>;
 type StartTrace = (customEventName: string) => void;
 type StopTrace = (customEventName: string) => void;
 type Log = (action: string) => void;
-type FirebaseAttributes = {
+type PerfAttributes = {
     accountId: string;
     personalDetailsLength: string;
     reportsLength: string;
@@ -21,4 +21,7 @@ type FirebaseAttributes = {
     policyRole: string;
 };
 
-export type {StartTrace, StopTrace, TraceMap, Log, FirebaseAttributes};
+// TODO confirm which attributes are required for Firebase
+type FirebaseAttributes = Pick<PerfAttributes, 'accountId' | 'personalDetailsLength' | 'reportActionsLength' | 'reportsLength' | 'policiesLength'>;
+
+export type {StartTrace, StopTrace, TraceMap, Log, PerfAttributes, FirebaseAttributes};

src/libs/Firebase/utils.ts

@@ -4,31 +4,33 @@ import {getActivePolicy, getAllPoliciesLength} from '@libs/PolicyUtils';
 import {getReportActionsLength} from '@libs/ReportActionsUtils';
 import * as ReportConnection from '@libs/ReportConnection';
 import * as SessionUtils from '@libs/SessionUtils';
-import type {FirebaseAttributes} from './types';
+import type {PerfAttributes} from './types';
 
-function getAttributes(): FirebaseAttributes {
+function getAttributes<T extends keyof PerfAttributes>(attributes?: T[]): Pick<PerfAttributes, T> {
     const session = SessionUtils.getSession();
-
-    const accountId = session?.accountID?.toString() ?? 'N/A';
-    const reportsLength = ReportConnection.getAllReportsLength().toString();
-    const reportActionsLength = getReportActionsLength().toString();
-    const personalDetailsLength = PersonalDetailsUtils.getPersonalDetailsLength().toString();
-    const transactionViolationsLength = getAllTransactionViolationsLength().toString();
-    const policiesLength = getAllPoliciesLength().toString();
-    const transactionsLength = getAllTransactions().toString();
     const policy = getActivePolicy();
 
-    return {
-        accountId,
-        reportsLength,
-        reportActionsLength,
-        personalDetailsLength,
-        transactionViolationsLength,
-        policiesLength,
-        transactionsLength,
+    const allAttributes: PerfAttributes = {
+        accountId: session?.accountID?.toString() ?? 'N/A',
+        reportsLength: ReportConnection.getAllReportsLength().toString(),
+        reportActionsLength: getReportActionsLength().toString(),
+        personalDetailsLength: PersonalDetailsUtils.getPersonalDetailsLength().toString(),
+        transactionViolationsLength: getAllTransactionViolationsLength().toString(),
+        policiesLength: getAllPoliciesLength().toString(),
+        transactionsLength: getAllTransactions().toString(),
         policyType: policy?.type ?? 'N/A',
         policyRole: policy?.role ?? 'N/A',
     };
+
+    if (attributes && attributes.length > 0) {
+        const selectedAttributes = {} as Pick<PerfAttributes, T>;
+        attributes.forEach((attribute) => {
+            selectedAttributes[attribute] = allAttributes[attribute];
+        });
+        return selectedAttributes;
+    }
+
+    return allAttributes;
 }
 
 export default {

tests/unit/FirebaseUtilsTest.ts

@@ -0,0 +1,40 @@
+import {expect} from '@jest/globals';
+import type {FirebaseAttributes, PerfAttributes} from '@libs/Firebase/types';
+import utils from '@libs/Firebase/utils';
+
+describe('getAttributes', () => {
+    const allAttributes: Array<keyof PerfAttributes> = [
+        'accountId',
+        'personalDetailsLength',
+        'reportActionsLength',
+        'reportsLength',
+        'policiesLength',
+        'transactionsLength',
+        'transactionViolationsLength',
+        'policyType',
+        'policyRole',
+    ];
+
+    const checkAttributes = (attributes: Partial<PerfAttributes>, expectedAttributes: Array<keyof Partial<PerfAttributes>>) => {
+        expectedAttributes.forEach((attr) => {
+            expect(attributes).toHaveProperty(attr);
+        });
+        expect(Object.keys(attributes).length).toEqual(expectedAttributes.length);
+    };
+
+    it('should return 5 specific attributes', () => {
+        const requestedAttributes: Array<keyof FirebaseAttributes> = ['accountId', 'personalDetailsLength', 'reportActionsLength', 'reportsLength', 'policiesLength'];
+        const attributes = utils.getAttributes(requestedAttributes);
+        checkAttributes(attributes, requestedAttributes);
+    });
+
+    it('should return all attributes when no array is passed', () => {
+        const attributes = utils.getAttributes();
+        checkAttributes(attributes, allAttributes);
+    });
+
+    it('should return all attributes when an empty array is passed', () => {
+        const attributes = utils.getAttributes([]);
+        checkAttributes(attributes, allAttributes);
+    });
+});