Merge pull request #589 from BranchMetrics/SDK-1024/customer-event-alias

[SDK-1024] customer event alias

Author: jdee

android/src/main/java/io/branch/rnbranch/RNBranchModule.java

@@ -637,6 +637,7 @@ public static BranchEvent createBranchEvent(String eventName, ReadableMap params
         if (params.hasKey("affiliation")) event.setAffiliation(params.getString("affiliation"));
         if (params.hasKey("description")) event.setDescription(params.getString("description"));
         if (params.hasKey("searchQuery")) event.setSearchQuery(params.getString("searchQuery"));
+        if (params.hasKey("alias")) event.setCustomerEventAlias(params.getString("alias"));
 
         if (params.hasKey("customData")) {
             ReadableMap customData = params.getMap("customData");

examples/testbed_simple/ios/Podfile.lock

@@ -1,8 +1,6 @@
 PODS:
   - boost-for-react-native (1.63.0)
-  - Branch (0.32.0):
-    - Branch/Core (= 0.32.0)
-  - Branch/Core (0.32.0)
+  - Branch (0.34.0)
   - DoubleConversion (1.1.6)
   - Folly (2018.10.22.00):
     - boost-for-react-native
@@ -60,8 +58,8 @@ PODS:
     - React-cxxreact (= 0.60.3)
     - React-jsi (= 0.60.3)
   - React-jsinspector (0.60.3)
-  - react-native-branch (5.0.0-beta.1):
-    - Branch (= 0.32.0)
+  - react-native-branch (5.0.0-beta.2):
+    - Branch (= 0.34.0)
     - React
   - React-RCTActionSheet (0.60.3):
     - React-Core (= 0.60.3)
@@ -169,7 +167,7 @@ EXTERNAL SOURCES:
 
 SPEC CHECKSUMS:
   boost-for-react-native: 39c7adb57c4e60d6c5479dd8623128eb5b3f0f2c
-  Branch: 770a23c04d3f5410cf9231db099a444dd3060784
+  Branch: 446aeb832102f56f04edf5fa7cb0a752dc392ca7
   DoubleConversion: 5805e889d232975c086db112ece9ed034df7a0b2
   Folly: 30e7936e1c45c08d884aa59369ed951a8e68cf51
   glog: 1f3da668190260b06b429bb211bfbee5cd790c28
@@ -181,7 +179,7 @@ SPEC CHECKSUMS:
   React-jsi: c2b6e57836bcae2677a036384111dc2c58e94369
   React-jsiexecutor: d9023c5c199114d2b6f38ec861a4d923c73d0735
   React-jsinspector: 817b64f3c8a807f09d78620f4f505868d89b26f3
-  react-native-branch: ed90b087f2ff6a2f81643ead0b321531877f2e69
+  react-native-branch: c3f12fbc43ea98a9e8732cec78dfa83d525b7caf
   React-RCTActionSheet: 9c42321fd5652515d706dd722c5a10b1970d7ec8
   React-RCTAnimation: fabb087dde8964c9a835a7fabd0e7e5701787913
   React-RCTBlob: 93f34281d9c9c9e216b25824309eed9fe22a5d41

examples/testbed_simple/src/BranchMethods.js

@@ -173,7 +173,8 @@ class BranchMethods extends Component {
           customData: {
             "Custom_Event_Property_Key1": "Custom_Event_Property_val1",
             "Custom_Event_Property_Key2": "Custom_Event_Property_val2"
-          }
+          },
+          alias: 'ItemViewed'
         }
       )
       branchEvent.logEvent()

ios/BranchEvent+RNBranch.m

@@ -27,7 +27,8 @@ @implementation BranchEvent(RNBranch)
           @"affiliation": [RNBranchProperty propertyWithSetterSelector:@selector(setAffiliation:) type:NSString.class],
           @"description": [RNBranchProperty propertyWithSetterSelector:@selector(setEventDescription:) type:NSString.class],
           @"searchQuery": [RNBranchProperty propertyWithSetterSelector:@selector(setSearchQuery:) type:NSString.class],
-          @"customData": [RNBranchProperty propertyWithSetterSelector:@selector(setCustomData:) type:NSDictionary.class]
+          @"customData": [RNBranchProperty propertyWithSetterSelector:@selector(setCustomData:) type:NSDictionary.class],
+          @"alias": [RNBranchProperty propertyWithSetterSelector:@selector(setAlias:) type:NSString.class]
           };
     });
 

native-tests/ios/NativeTestsTests/BranchEventExtensionTests.m

@@ -21,7 +21,7 @@ @implementation BranchEventExtensionTests
 - (void)testFieldMapping
 {
     NSDictionary<NSString *, RNBranchProperty *> *supportedProperties = BranchEvent.supportedProperties;
-    XCTAssertEqual(10, supportedProperties.count);
+    XCTAssertEqual(11, supportedProperties.count);
 
     XCTAssert([supportedProperties[@"transactionID"] isEqual:[RNBranchProperty propertyWithSetterSelector:@selector(setTransactionID:) type:NSString.class]]);
     XCTAssert([supportedProperties[@"currency"] isEqual:[RNBranchProperty propertyWithSetterSelector:@selector(setCurrency:) type:NSString.class]]);
@@ -33,6 +33,7 @@ - (void)testFieldMapping
     XCTAssert([supportedProperties[@"description"] isEqual:[RNBranchProperty propertyWithSetterSelector:@selector(setEventDescription:) type:NSString.class]]);
     XCTAssert([supportedProperties[@"searchQuery"] isEqual:[RNBranchProperty propertyWithSetterSelector:@selector(setSearchQuery:) type:NSString.class]]);
     XCTAssert([supportedProperties[@"customData"] isEqual:[RNBranchProperty propertyWithSetterSelector:@selector(setCustomData:) type:NSDictionary.class]]);
+    XCTAssert([supportedProperties[@"alias"] isEqual:[RNBranchProperty propertyWithSetterSelector:@selector(setAlias:) type:NSString.class]]);
 }
 
 - (void)testInitialization
@@ -48,7 +49,8 @@ - (void)testInitialization
                                                              @"affiliation": @"affiliation",
                                                              @"description": @"description",
                                                              @"searchQuery": @"searchQuery",
-                                                             @"customData": @{ @"key": @"value" }
+                                                             @"customData": @{ @"key": @"value" },
+                                                             @"alias": @"My Alias"
                                                             }];
 
     XCTAssertEqualObjects(@"transactionID", event.transactionID);
@@ -61,6 +63,7 @@ - (void)testInitialization
     XCTAssertEqualObjects(@"description", event.eventDescription);
     XCTAssertEqualObjects(@"searchQuery", event.searchQuery);
     XCTAssertEqualObjects(@{ @"key": @"value" }, event.customData);
+    XCTAssertEqualObjects(@"My Alias", event.alias);
 }
 
 @end

src/BranchEvent.js

@@ -80,6 +80,12 @@ export default class BranchEvent {
    */
   customData = null
 
+  /**
+   * Optional alias for this event
+   * @type {?string}
+   */
+  alias = null
+
   /**
    * Constructs a new BranchEvent from arguments
    *
@@ -118,6 +124,7 @@ export default class BranchEvent {
     if (params.description) this.description = params.description
     if (params.searchQuery) this.searchQuery = params.searchQuery
     if (params.customData) this.customData = params.customData
+    if (params.alias) this.alias = params.alias
   }
 
   /**
@@ -184,6 +191,7 @@ export default class BranchEvent {
         // TODO: throw?
       }
     }
+    if (this.alias) params.alias = this.alias
 
     return params
   }

test/BranchEvent.test.js

@@ -190,6 +190,15 @@ test('customData is correct', () => {
   expect(event.customData.key).toBe('value')
 })
 
+test('alias is null by default', () => {
+  expect(new BranchEvent(BranchEvent.ViewItem).alias).toBe(null)
+})
+
+test('alias is correct', () => {
+  const event = new BranchEvent(BranchEvent.ViewItem, null, { alias: 'My Alias' })
+  expect(event.alias).toBe('My Alias')
+})
+
 // --- _identFromMessage
 
 test('_identFromMessage parses a UUID from text', () => {