Validate Analytics keys and params #1339

Author: EddyVerbruggen

demo-ng/package.json

@@ -25,7 +25,7 @@
     "nativescript-angular": "^6.1.0",
     "nativescript-camera": "~4.1.1",
     "nativescript-imagepicker": "~6.0.5",
-    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-9.0.3.tgz",
+    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-9.0.4.tgz",
     "nativescript-theme-core": "~1.0.4",
     "reflect-metadata": "~0.1.10",
     "rxjs": "~6.0.0 || >=6.1.0",

demo-push/package.json

@@ -9,7 +9,7 @@
     }
   },
   "dependencies": {
-    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-9.0.3.tgz",
+    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-9.0.4.tgz",
     "nativescript-theme-core": "^1.0.4",
     "nativescript-unit-test-runner": "^0.3.4",
     "tns-core-modules": "~4.2.0"

demo-vue/package.json

@@ -14,7 +14,7 @@
     }
   },
   "dependencies": {
-    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-9.0.3.tgz",
+    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-9.0.4.tgz",
     "nativescript-theme-core": "^1.0.4",
     "nativescript-vue": "^2.0.0",
     "tns-core-modules": "^5.0.2"

demo/app/main-view-model.ts

@@ -466,10 +466,11 @@ export class HelloWorldModel extends Observable {
     firebase.analytics.logEvent({
       // see https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Event.html
       key: "add_to_cart",
-      parameters: [{ // optional
-        key: "item_id",
-        value: "p7655"
-      },
+      parameters: [
+        { // optional
+          key: "item_id",
+          value: "p7655"
+        },
         {
           key: "item_name",
           value: "abcd"
@@ -1088,8 +1089,8 @@ export class HelloWorldModel extends Observable {
       type: firebase.LoginType.GOOGLE,
       googleOptions: {
         scopes: [
-            "https://www.googleapis.com/auth/contacts.readonly",
-            "https://www.googleapis.com/auth/user.birthday.read"
+          "https://www.googleapis.com/auth/contacts.readonly",
+          "https://www.googleapis.com/auth/user.birthday.read"
         ]
       }
     }).then(

demo/package.json

@@ -10,7 +10,7 @@
   },
   "dependencies": {
     "firebase-functions": "^2.0.5",
-    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-9.0.3.tgz",
+    "nativescript-plugin-firebase": "file:../publish/package/nativescript-plugin-firebase-9.0.4.tgz",
     "nativescript-theme-core": "^1.0.4",
     "nativescript-unit-test-runner": "0.7.0",
     "tns-core-modules": "6.0.1"

src/analytics/analytics-common.ts

@@ -0,0 +1,99 @@
+import { LogEventParameter } from "./analytics";
+
+export function validateAnalyticsKey(key: string): string | undefined {
+  if (key === undefined) {
+    return "Argument 'key' is missing";
+  }
+
+  if (key.length > 40) {
+    return "Argument 'key' must be 40 characters or fewer";
+  }
+
+  if (!key.match(/^[a-zA-Z][a-zA-Z_]+$/)) {
+    return "Argument 'key' can only contain alphanumeric characters and underscores and must start with an alphanumeric character";
+  }
+
+  if (key.startsWith("firebase_")) {
+    return "Argument 'key' must not start with 'firebase_'";
+  }
+
+  if (key.startsWith("google_")) {
+    return "Argument 'key' must not start with 'google_'";
+  }
+
+  if (key.startsWith("ga_")) {
+    return "Argument 'key' must not start with 'ga_'";
+  }
+
+  if ([
+    "ad_activeview",
+    "ad_click",
+    "ad_exposure",
+    "ad_impression",
+    "ad_query",
+    "adunit_exposure",
+    "app_clear_data",
+    "app_uninstall",
+    "app_update",
+    "error",
+    "first_open",
+    "first_visit",
+    "in_app_purchase",
+    "notification_dismiss",
+    "notification_foreground",
+    "notification_open",
+    "notification_receive",
+    "os_update",
+    "screen_view",
+    "session_start",
+    "user_engagement"
+  ].indexOf(key) > -1) {
+    return "Avoid using a reserved event name as the 'key' argument. Full list at: https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Event";
+  }
+
+  return undefined;
+}
+
+export function validateAnalyticsParam(param: LogEventParameter): string | undefined {
+  return validateAnalyticsParamKey(param.key) || validateAnalyticsParamValue(param.value);
+}
+
+function validateAnalyticsParamKey(key: string): string | undefined {
+  if (key === undefined) {
+    return "Param 'key' is missing";
+  }
+
+  if (key.length > 40) {
+    return "Param 'key' must be 40 characters or fewer";
+  }
+
+  if (!key.match(/^[a-zA-Z][a-zA-Z_]+$/)) {
+    return "Param 'key' can only contain alphanumeric characters and underscores and must start with an alphanumeric character";
+  }
+
+  return undefined;
+}
+
+function validateAnalyticsParamValue(value: string): string | undefined {
+  if (value === undefined) {
+    return "Param 'value' is missing";
+  }
+
+  if (value.length > 100) {
+    return "Param 'value' must be 100 characters or fewer";
+  }
+
+  if (value.startsWith("firebase_")) {
+    return "Param 'value' must not start with 'firebase_'";
+  }
+
+  if (value.startsWith("google_")) {
+    return "Param 'value' must not start with 'google_'";
+  }
+
+  if (value.startsWith("ga_")) {
+    return "Param 'value' must not start with 'ga_'";
+  }
+
+  return undefined;
+}

src/analytics/analytics.android.ts

@@ -1,26 +1,28 @@
 import * as appModule from "tns-core-modules/application";
-import {
-  LogEventOptions,
-  SetScreenNameOptions,
-  SetUserPropertyOptions,
-  LogComplexEventOptions,
-  LogComplexEventParameter
-} from "./analytics";
+import { LogComplexEventOptions, LogComplexEventParameter, LogEventOptions, SetScreenNameOptions, SetUserPropertyOptions } from "./analytics";
+import { validateAnalyticsKey, validateAnalyticsParam } from "./analytics-common";
 
 declare const com: any;
 
 export function logEvent(options: LogEventOptions): Promise<void> {
   return new Promise<void>((resolve, reject) => {
     try {
-      if (options.key === undefined) {
-        reject("Argument 'key' is missing");
+      const validationError = validateAnalyticsKey(options.key);
+      if (validationError !== undefined) {
+        reject(validationError);
         return;
       }
 
       const bundle = new android.os.Bundle();
       if (options.parameters !== undefined) {
         for (const p in options.parameters) {
           const param = options.parameters[p];
+          const validationParamError = validateAnalyticsParam(param);
+          if (validationParamError !== undefined) {
+            reject(validationParamError);
+            return;
+          }
+
           if (param.value !== undefined) {
             bundle.putString(param.key, param.value);
           }

src/analytics/analytics.ios.ts

@@ -1,22 +1,25 @@
-import {
-  LogEventOptions,
-  SetScreenNameOptions,
-  SetUserPropertyOptions,
-  LogComplexEventOptions
-} from "./analytics";
+import { LogComplexEventOptions, LogEventOptions, SetScreenNameOptions, SetUserPropertyOptions } from "./analytics";
+import { validateAnalyticsKey, validateAnalyticsParam } from "./analytics-common";
 
 export function logEvent(options: LogEventOptions): Promise<void> {
   return new Promise<void>((resolve, reject) => {
     try {
-      if (options.key === undefined) {
-        reject("Argument 'key' is missing");
+      const validationError = validateAnalyticsKey(options.key);
+      if (validationError !== undefined) {
+        reject(validationError);
         return;
       }
 
       const dic: any = NSMutableDictionary.new();
       if (options.parameters !== undefined) {
         for (let p in options.parameters) {
           const param = options.parameters[p];
+          const validationParamError = validateAnalyticsParam(param);
+          if (validationParamError !== undefined) {
+            reject(validationParamError);
+            return;
+          }
+
           if (param.value !== undefined) {
             dic.setObjectForKey(param.value, param.key);
           }