Adds feature to disable event and/or metric tracking (#36)

.changeset/slimy-nails-study.md

@@ -0,0 +1,5 @@
+---
+'client-analytics': minor
+---
+
+New feature to disable metric/event api calls

CHANGELOG.md

@@ -1,5 +1,11 @@
 # client-analytics
 
+## 0.0.9
+
+### Patch Changes
+
+- [Feature] Added new parameters to provide the option of disabling event/metric calls
+
 ## 0.0.8
 
 ### Patch Changes

package.json

@@ -1,6 +1,6 @@
 {
   "name": "client-analytics",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "type": "module",
   "main": "./dist/client-analytics.umd.cjs",
   "module": "./dist/client-analytics.js",

src/storage/config.test.ts

@@ -12,6 +12,8 @@ describe('Config', () => {
       isDebug: false,
       eventPath: '/events',
       metricPath: '/metrics',
+      disableEventApi: false,
+      disableMetricApi: false,
       onError: expect.any(Function),
       disabled: false,
       apiEndpoint: 'https://cca-lite.coinbase.com',
@@ -25,6 +27,8 @@ describe('Config', () => {
       isDebug: true,
       eventPath: '/custom-events',
       metricPath: '/custom-metrics',
+      disableEventApi: true,
+      disableMetricApi: true,
       onError: expect.any(Function),
       apiEndpoint: 'https://client.analytics',
       disabled: false,
@@ -36,6 +40,8 @@ describe('Config', () => {
       isDebug: true,
       eventPath: '/custom-events',
       metricPath: '/custom-metrics',
+      disableEventApi: true,
+      disableMetricApi: true,
       onError: expect.any(Function),
       apiEndpoint: 'https://client.analytics',
       disabled: false,
@@ -76,6 +82,8 @@ describe('Config', () => {
       isDebug: false,
       eventPath: '/events',
       metricPath: '/metrics',
+      disableEventApi: false,
+      disableMetricApi: false,
       onError: expect.any(Function),
       disabled: false,
       apiEndpoint: 'https://cca-lite.coinbase.com',

src/storage/config.ts

@@ -10,7 +10,8 @@ export const DEFAULT_CONFIG = {
   eventPath: '/events',
   metricPath: '/metrics',
   apiEndpoint: 'https://cca-lite.coinbase.com', // works for production only
-
+  disableEventApi: false,
+  disableMetricApi: false,
   disabled: false,
   isAlwaysAuthed: false,
   version: null,

src/trackEvent.test.ts

@@ -43,6 +43,17 @@ describe('trackEvent', () => {
     });
   });
 
+  test('should return null when disableEventApi is true', async () => {
+    const config = getConfig();
+    Object.assign(config, { disableEventApi: true });
+    const event = await trackEvent({
+      action: 'test',
+      component: 'testComponent',
+      name: 'testName',
+    });
+    expect(event).toBe(null);
+  });
+
   test('should return null when identity.isOptOut is true', async () => {
     const identity = getIdentity();
     Object.assign(identity, { isOptOut: true });

src/trackEvent.ts

@@ -14,6 +14,10 @@ export const trackEvent = (
 ): Promise<Event | null> => {
   const { config, identity } = getStorage();
 
+  if (config.disableEventApi) {
+    return Promise.resolve(null);
+  }
+
   // TODO: combine validation in a set of validators
   if (identity.isOptOut) {
     return Promise.resolve(null);

src/trackMetric.test.ts

@@ -45,6 +45,17 @@ describe('trackMetric', () => {
     expect(metric).toBe(null);
   });
 
+  test('should return null when metric api is disabled', async () => {
+    const config = getConfig();
+    Object.assign(config, { disableMetricApi: true });
+    const metric = await trackMetric({
+      metricName: 'test',
+      metricType: MetricType.count,
+      value: 1,
+    });
+    expect(metric).toBe(null);
+  });
+
   test('should return null when platform is not web', async () => {
     const config = setConfig({
       platform: 'unknown',

src/trackMetric.ts

@@ -9,6 +9,11 @@ import { getConfig, getMetricScheduler } from './storage/storage';
  */
 export const trackMetric = (metric: Metric): Promise<Metric | null> => {
   const config = getConfig();
+
+  if (config.disableMetricApi) {
+    return Promise.resolve(null);
+  }
+
   if (config.disabled) {
     return Promise.resolve(null);
   }

src/types/config.ts

@@ -24,7 +24,9 @@ export type RequiredConfig = {
  */
 export type CustomConfig = {
   eventPath: string;
+  disableEventApi?: boolean;
   metricPath: string;
+  disableMetricApi?: boolean;
   disabled?: boolean;
   onError: (err: Error, metadata?: Record<string, unknown>) => void;
   isDebug?: boolean;