Add URL event/user attribute

Author: Minishlink

android/src/main/java/tech/bam/RNBatchPush/RNBatchModule.java

@@ -10,8 +10,6 @@
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 
-import android.util.Log;
-
 import com.batch.android.Batch;
 import com.batch.android.BatchActivityLifecycleHelper;
 import com.batch.android.BatchEventDispatcher;
@@ -37,6 +35,7 @@
 import com.facebook.react.bridge.WritableNativeMap;
 import com.facebook.react.modules.core.DeviceEventManagerModule;
 
+import java.net.URI;
 import java.util.Date;
 import java.util.EnumSet;
 import java.util.HashMap;
@@ -518,6 +517,10 @@ public void userData_save(ReadableArray actions) {
  long timestamp = (long) action.getDouble("value");
  Date date = new Date(timestamp);
  editor.setAttribute(key, date);
+ } else if (type.equals("setURLAttribute")) {
+ String key = action.getString("key");
+ String url = action.getString("value");
+ editor.setAttribute(key, URI.create(url));
  } else if (type.equals("removeAttribute")) {
  String key = action.getString("key");
  editor.removeAttribute(key);

android/src/main/java/tech/bam/RNBatchPush/RNUtils.java

@@ -1,6 +1,7 @@
 package tech.bam.RNBatchPush;
 
 import androidx.annotation.Nullable;
+
 import android.util.Log;
 
 import com.batch.android.BatchEventData;
@@ -13,32 +14,31 @@
 import com.facebook.react.bridge.WritableNativeMap;
 
 import org.json.JSONArray;
-import org.json.JSONException;
-import org.json.JSONObject;
 
-import java.lang.reflect.Array;
-import java.util.Iterator;
+import java.net.URI;
 import java.util.Map;
 
 public class RNUtils {
  public static WritableMap convertMapToWritableMap(Map<String, Object> input) {
  WritableMap output = new WritableNativeMap();
 
-  for(Map.Entry<String, Object> entry: input.entrySet()){
+ for (Map.Entry<String, Object> entry : input.entrySet()) {
  String key = entry.getKey();
  Object value = entry.getValue();
  if (value instanceof Map) {
  output.putMap(key, convertMapToWritableMap((Map<String, Object>) value));
  } else if (value instanceof JSONArray) {
- output.putArray(key, convertArrayToWritableArray((Object[])value));
- } else if (value instanceof  Boolean) {
+ output.putArray(key, convertArrayToWritableArray((Object[]) value));
+ } else if (value instanceof Boolean) {
  output.putBoolean(key, (Boolean) value);
- } else if (value instanceof  Integer) {
+ } else if (value instanceof Integer) {
  output.putInt(key, (Integer) value);
- } else if (value instanceof  Double) {
+ } else if (value instanceof Double) {
  output.putDouble(key, (Double) value);
- } else if (value instanceof String)  {
+ } else if (value instanceof String) {
  output.putString(key, (String) value);
+ } else if (value instanceof URI) {
+ output.putString(key, value.toString());
  } else {
  output.putString(key, value.toString());
  }
@@ -53,16 +53,18 @@ public static WritableArray convertArrayToWritableArray(Object[] input) {
  Object value = input[i];
  if (value instanceof Map) {
  output.pushMap(convertMapToWritableMap((Map<String, Object>) value));
- } else if (value instanceof  JSONArray) {
+ } else if (value instanceof JSONArray) {
  output.pushArray(convertArrayToWritableArray((Object[]) value));
- } else if (value instanceof  Boolean) {
+ } else if (value instanceof Boolean) {
  output.pushBoolean((Boolean) value);
- } else if (value instanceof  Integer) {
+ } else if (value instanceof Integer) {
  output.pushInt((Integer) value);
- } else if (value instanceof  Double) {
+ } else if (value instanceof Double) {
  output.pushDouble((Double) value);
- } else if (value instanceof String)  {
+ } else if (value instanceof String) {
  output.pushString((String) value);
+ } else if (value instanceof URI) {
+ output.pushString(value.toString());
  } else {
  output.pushString(value.toString());
  }
@@ -89,7 +91,6 @@ public static BatchEventData convertSerializedEventDataToEventData(@Nullable Rea
  while (iterator.hasNextKey()) {
  String key = iterator.nextKey();
  ReadableMap valueMap = attributes.getMap(key);
-
  String type = valueMap.getString("type");
  if ("string".equals(type)) {
  batchEventData.put(key, valueMap.getString("value"));
@@ -99,6 +100,8 @@ public static BatchEventData convertSerializedEventDataToEventData(@Nullable Rea
  batchEventData.put(key, valueMap.getDouble("value"));
  } else if ("float".equals(type)) {
  batchEventData.put(key, valueMap.getDouble("value"));
+ } else if ("url".equals(type)) {
+ batchEventData.put(key, URI.create(valueMap.getString("value")));
  } else {
  Log.e("RNBatchPush", "Invalid parameter : Unknown event_data.attributes type (" + type + ")");
  }

ios/RNBatch.m

@@ -232,6 +232,11 @@ - (NSDictionary*) dictionaryWithEventDispatcherPayload:(id<BatchEventDispatcherP
  [editor setAttribute:date forKey:action[@"key"]];
  }
 
+ else if([type isEqualToString:@"setURLAttribute"]) {
+ NSURL *url = [NSURL URLWithString:[self safeNilValue:action[@"value"]]];
+ [editor setAttribute:url forKey:action[@"key"]];
+ }
+
  else if([type isEqualToString:@"removeAttribute"]) {
  [editor removeAttributeForKey:action[@"key"]];
  }
@@ -352,6 +357,13 @@ - (NSDictionary*) dictionaryWithEventDispatcherPayload:(id<BatchEventDispatcherP
  return;
  }
  [batchEventData putDouble:[(NSNumber*)value doubleValue] forKey:key];
+ } else if ([@"url" isEqualToString:type]) {
+ if (![value isKindOfClass:[NSString class]])
+ {
+ NSLog(@"RNBatch: Error while tracking event data: event data.attributes: expected string value, got something else");
+ return;
+ }
+ [batchEventData putURL:[NSURL URLWithString:(NSString*) value] forKey:key];
  } else {
  NSLog(@"RNBatch: Error while tracking event data: Unknown event data.attributes type");
  return;

src/BatchEventData.test.ts

@@ -2,6 +2,10 @@ import { BatchEventData, Consts } from './BatchEventData';
 import * as Logger from './helpers/Logger';
 
 describe('BatchEventData', () => {
+ afterEach(() => {
+ jest.clearAllMocks();
+ });
+
  it(`handles less than or equal ${Consts.EventDataMaxTags} tags`, () => {
  const batchEventData = new BatchEventData();
  const spy = jest.spyOn(Logger, 'Log');
@@ -12,9 +16,7 @@ describe('BatchEventData', () => {
 
  expect(spy).not.toHaveBeenCalled();
  });
- it(`handles less than or equal ${
- Consts.EventDataMaxValues
- } attributes`, () => {
+ it(`handles less than or equal ${Consts.EventDataMaxValues} attributes`, () => {
  const batchEventData = new BatchEventData();
  const spy = jest.spyOn(Logger, 'Log');
 
@@ -36,9 +38,7 @@ describe('BatchEventData', () => {
 
  expect(spy).toHaveBeenCalled();
  });
- it(`skips other attributes after the first ${
- Consts.EventDataMaxValues
- }`, () => {
+ it(`skips other attributes after the first ${Consts.EventDataMaxValues}`, () => {
  const batchEventData = new BatchEventData();
  const spy = jest.spyOn(Logger, 'Log');
 
@@ -48,6 +48,27 @@ describe('BatchEventData', () => {
 
  batchEventData.put('too_much', 'value');
 
+ expect(spy).toHaveBeenCalled();
+ });
+ it(`handles an url attribute`, () => {
+ const batchEventData = new BatchEventData();
+ const spy = jest.spyOn(Logger, 'Log');
+
+ batchEventData.putURL('test_url', 'https://batch.com');
+
+ expect(spy).not.toHaveBeenCalled();
+ });
+ it(`skips a too long url attribute`, () => {
+ const batchEventData = new BatchEventData();
+ const spy = jest.spyOn(Logger, 'Log');
+
+ batchEventData.putURL(
+ 'test_url',
+ `https://batch.com?${Array(2048)
+ .fill(1)
+ .join()}`
+ );
+
  expect(spy).toHaveBeenCalled();
  });
 });

src/BatchEventData.ts

@@ -6,13 +6,15 @@ export const Consts = {
  EventDataMaxTags: 10,
  EventDataMaxValues: 15,
  EventDataStringMaxLength: 64,
+ EventDataURLMaxLength: 2048,
 };
 
 export enum TypedEventAttributeType {
  String = 'string',
  Boolean = 'boolean',
  Integer = 'integer',
  Float = 'float',
+ URL = 'url',
 }
 
 export interface ITypedEventAttribute {
@@ -69,10 +71,10 @@ export class BatchEventData {
  return this;
  }
 
- public put(key: string, value: string | number | boolean): BatchEventData {
+ private checkBeforePuttingAttribute(key: string, value: any): void {
  if (!isString(key)) {
  Log(false, 'BatchEventData - Key must be a string');
- return this;
+ throw new Error();
  }
 
  if (!Consts.AttributeKeyRegexp.test(key || '')) {
@@ -82,16 +84,14 @@ export class BatchEventData {
  key +
  "'"
  );
- return this;
+ throw new Error();
  }
 
  if (typeof value === 'undefined' || value === null) {
  Log(false, 'BatchEventData - Value cannot be undefined or null');
- return this;
+ throw new Error();
  }
 
- key = key.toLowerCase();
-
  if (
  Object.keys(this._attributes).length >= Consts.EventDataMaxValues &&
  !this._attributes.hasOwnProperty(key)
@@ -104,6 +104,48 @@ export class BatchEventData {
  key +
  "'"
  );
+ throw new Error();
+ }
+ }
+
+ private prepareAttributeKey(key: string) {
+ return key.toLowerCase();
+ }
+
+ public putURL(key: string, url: string): BatchEventData {
+ key = this.prepareAttributeKey(key);
+ try {
+ this.checkBeforePuttingAttribute(key, url);
+ } catch {
+ return this;
+ }
+
+ if (url.length > Consts.EventDataURLMaxLength) {
+ Log(
+ false,
+ "BatchEventData - Event data can't be longer than " +
+ Consts.EventDataURLMaxLength +
+ " characters. Ignoring event data value '" +
+ url +
+ "'."
+ );
+ return this;
+ }
+
+ this._attributes[key] = {
+ type: TypedEventAttributeType.URL,
+ value: url,
+ };
+
+ return this;
+ }
+
+ public put(key: string, value: string | number | boolean): BatchEventData {
+ key = this.prepareAttributeKey(key);
+
+ try {
+ this.checkBeforePuttingAttribute(key, value);
+ } catch {
  return this;
  }
 

src/BatchUserEditor.ts

@@ -22,6 +22,12 @@ interface IUserSettingsSetDateAttributeAction {
  value: number;
 }
 
+interface IUserSettingsSetURLAttributeAction {
+ type: 'setURLAttribute';
+ key: string;
+ value: string;
+}
+
 interface IUserSettingsSetLanguageAction {
  type: 'setLanguage';
  value?: string;
@@ -63,6 +69,7 @@ type IUserSettingsAction =
  | IUserSettingsRemoveAttributeAction
  | IUserSettingsClearAttributesAction
  | IUserSettingsSetDateAttributeAction
+ | IUserSettingsSetURLAttributeAction
  | IUserSettingsSetIdentifierAction
  | IUserSettingsSetLanguageAction
  | IUserSettingsSetRegionAction
@@ -104,6 +111,14 @@ export class BatchUserEditor {
  });
  }
 
+ public setURLAttribute(key: string, value: string) {
+ return this.addAction({
+ type: 'setURLAttribute',
+ key,
+ value,
+ });
+ }
+
  public removeAttribute(key: string) {
  return this.addAction({
  type: 'removeAttribute',