Support for IAM in RN Messaging package #139

shtomar-adb · 2022-02-08T01:06:25Z

Added Javascript API's in Messaging package to handle In app Messages.
Implementation in iOS native side of RN Messaging package to handle In app Message.
Updated sample app

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

I have signed the Adobe Open Source CLA.
My code follows the code style of this project.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
All new and existing tests passed.

yangyansong-adbe · 2022-02-08T17:48:06Z

packages/messaging/js/Messaging.js

+    // @"onShow", @"onDismiss", @"shouldShowMessage",@"urlLoaded"
+    const eventEmitter = new NativeEventEmitter(RCTAEPMessaging);
+    eventListenerShow = eventEmitter.addListener('onShow', (event) => {
+      console.log(">>>>> onShow");      


Can we remove these console logs and use SDK debug logs instead?

yangyansong-adbe · 2022-02-08T17:49:23Z

packages/messaging/js/models/Message.js

@@ -0,0 +1,54 @@
+/*
+Copyright 2021 Adobe. All rights reserved.


yangyansong-adbe · 2022-02-08T17:49:51Z

packages/messaging/js/models/MessagingDelegate.js

@@ -0,0 +1,29 @@
+/*
+Copyright 2021 Adobe. All rights reserved.


yangyansong-adbe · 2022-02-08T18:43:49Z

@shtomar-adb can you add a private flag to messaging's package.json file? like ->

aepsdk-react-native/apps/AEPSampleApp/package.json

Line 4 in acc79a9

"private": true,

Then the (Lerna) publish script will ignore this private package. lerna/lerna#536 (comment)

…lementation of Messaging APIs

sbenedicadb

looks good with a few questions. let me know when you make the changes we talked about on our call today and i'll re-review

sbenedicadb · 2022-02-09T23:36:55Z

packages/messaging/ios/src/RCTAEPMessaging.m

+        NSLog(@">>>> shouldShowMessageWithMessage Message id: %@", messageObj.id);
+        [cachedMessages setObject:messageObj forKey:messageObj.id];
+        [self emitEventWithName:@"shouldShowMessage" body:@{@"id":messageObj.id, @"autoTrack":messageObj.autoTrack ? @"true" : @"false"}];
+    dispatch_semaphore_wait(semaphore, DISPATCH_TIME_FOREVER);


let's add a comment here in code explaining why we're using the semaphore

sbenedicadb · 2022-02-09T23:39:04Z

packages/messaging/ios/src/RCTAEPMessaging.m

+}
+
+RCT_EXPORT_BLOCKING_SYNCHRONOUS_METHOD(shouldShowMessage: (BOOL) shouldShowMessage) {
+    self->shouldShowMessage = shouldShowMessage;


any particular reason why you're using -> notation here instead of .?
e.g. - self.shouldShowMessage = shouldShowMessage;

sbenedicadb · 2022-02-09T23:41:41Z

packages/messaging/ios/src/RCTAEPMessaging.m

+- (NSArray<NSString *> *) supportedEvents {
+    return @[@"onShow", @"onDismiss", @"shouldShowMessage",@"urlLoaded"];
+}
+
+- (void) startObserving {
+    hasListeners = true;
+}
+
+- (void) stopObserving {
+    hasListeners = false;
+}
+
+- (void) emitEventWithName: (NSString *) name body: (NSDictionary<NSString*, NSString*> *) dictionary {
+    if(hasListeners){
+        [self sendEventWithName:name body:dictionary];
+    }
+}


is this section of functions to support the synchronous calls to and from javascript?

This functions are used to send events(along with event data) from native to JS event listeners.
The boolean hasListeners indicates that if an event Listener exists in the JS end. Then only send the event otherwise RN will give warning.

The events are used to notify the JS about the MessageDelegate functions called. Which further in JS are used to call corresponding Message Delegate functions registered in the JS.

sbenedicadb · 2022-02-11T18:07:43Z

packages/messaging/README.md

 ```

+**Podfile setup**  
+The In app Message APIs dependes on the AEP Messaging 1.1.0. This version is not yet published to the Cocoapods but is available in the public [github repository](https://github.com/adobe/aepsdk-messaging-ios/tree/staging). Add the following pod dependency in your applications Podfile under the application target. 


typo: dependes -> depends

AEPMessaging, v1.1.0

sbenedicadb · 2022-02-11T18:10:39Z

packages/messaging/README.md

-## Messaging SDK API usage
-Messaging SDK APIs must be called from the native Android/iOS project of React Native app.  
+## Push Message API usage
+Push Mesage related APIs in the Messaging SDK must be called from the native Android/iOS project of React Native app.  


typo: Mesage > messaging

so maybe phrase like Push messaging APIs in the SDK must be called...?

sbenedicadb · 2022-02-11T18:12:09Z

packages/messaging/README.md

+
+## In App Messages API reference
+### refreshInAppMessages
+Initiates a network call to retrieve remote In-App Message definitions.


In-App Message probably doesn't need to be capitalized here

sbenedicadb · 2022-02-11T18:31:12Z

packages/messaging/README.md

+```
+
+### setMessagingDelegate
+Sets the UI Message delegate to listen the Message lifecycle events.


Sets the MessagingDelegate in AEPCore.

… messaging Merge the changes from upstream.

sbenedicadb · 2022-02-11T20:33:56Z

packages/messaging/README.md

+```
+
+### saveMessage
+Call to the saveMessage leads to in-memory caching of the Message object. Cached Message object can be later use to show message. This function should be called from **shouldShowMessage** of MessagingDelegate.


Natively caches the provided Message object.

sbenedicadb · 2022-02-11T20:37:33Z

packages/messaging/README.md

+message.setAutoTrack(true);
+```
+
+### clearMessage


wondering if maybe we should change the name of this method to just clear?

message.clearMessage(); sounds a little redundant

message.clear(); sounds better

🤷

It does sound better.

sbenedicadb · 2022-02-11T20:38:34Z

packages/messaging/README.md

+    urlLoaded(url: string, message: Message): void;
+};
+```
+Object of type MessagingDelegate can be create as shown below:


typo: create > created

sbenedicadb · 2022-02-11T20:41:03Z

packages/messaging/README.md

+    anotherWorkflowStatus = "complete";
+    currentMessage.show();
+}
+
+function shouldShowMessage(message: Message): boolean {
+    if(someOtherWorkflowStatus == "inProgress") {                
+        // store the current message for later use
+        Messaging.saveMessage(message);
+        currentMessage = message;
+        return false
+    }
+
+    return true
+}


i think we're using different names for the same variable in the example:

anotherWorkflowStatus and someOtherWorkflowStatus

cacheung

In Readme, Android initializing example
Update
import com.adobe.marketing.mobile.edge.identity;
to
import com.adobe.marketing.mobile.edge.identity.Identity;

Added the installation instructions for react-native-aepmessaging v1.0.0-beta.2 pre release.

… messaging Merged the remote branch.

…st file.

…e functions in android sync with iOS.

…f sample app to match with main branch.

leiteszeke · 2022-03-30T21:19:48Z

Hi guys. Is there any plan on merging / including this in RN library?

…into messaging

sbenedicadb

a couple of small things that need to be updated. i'll merge those changes into the messaging branch.

sbenedicadb · 2022-04-21T18:22:30Z

apps/AEPSampleApp/ios/AEPSampleApp/AppDelegate.m

-                                       AEPMobileAssurance.class] completion:^{
-          [AEPMobileCore lifecycleStart:@{@"contextDataKey": @"contextDataVal"}];
+                                     AEPMobileOptimize.class] completion:^{
+    [AEPMobileCore configureWithAppId:@"3149c49c3910/aaaac75639c6/launch-813b9d67d95e-development"];


we'll make sure to revert this back to your-app-ID

sbenedicadb · 2022-04-21T18:40:40Z

packages/messaging/__tests__/MessagingTests.ts

@@ -0,0 +1,99 @@
+/*
+Copyright 2021 Adobe. All rights reserved.


need to change to 2022

sbenedicadb · 2022-04-21T18:55:05Z

packages/messaging/ios/src/RCTAEPMessaging.m

 #import "RCTAEPMessaging.h"
 @import AEPMessaging;
+@import AEPCore;
+@import AEPServices;


we can remove this since it's imported by the header

-a couple small updates from the pr review

yangyansong-adbe

LGTM, only a small fix is needed.

yangyansong-adbe · 2022-04-21T20:40:18Z

apps/AEPSampleApp/android/app/src/main/java/com/aepsampleapp/MainApplication.java

    MobileCore.setApplication(this);
-    MobileCore.setLogLevel(LoggingMode.DEBUG);
-      try {
-          UserProfile.registerExtension();


Need to add those extension registrations back.

add some of the extensions back into android sample app

shtomar-adb added 2 commits February 2, 2022 23:31

Added APIs for in-app messaging.

4272d8c

Added the JS equivalent of Messaging Delegate.

32041fe

shtomar-adb added the DO NOT MERGE label Feb 8, 2022

shtomar-adb requested review from PravinPK, cacheung, emdobrin, sbenedicadb and yangyansong-adbe February 8, 2022 01:06

Removed the suppresautotrack parameter from Message.dismiss.

acc79a9

yangyansong-adbe reviewed Feb 8, 2022

View reviewed changes

Updated sample app to show usage of more IAM API's. Update in the imp…

6bc2c05

…lementation of Messaging APIs

sbenedicadb approved these changes Feb 9, 2022

View reviewed changes

shtomar-adb and others added 4 commits February 10, 2022 01:17

Address code review feedback.

152cf47

Addressed code review feedback.

3e74668

Added Message parameter in urlLoaded function of MessagingDelegate.

145b590

Added IAM APIs in Messaging Readme

0b5724c

sbenedicadb reviewed Feb 11, 2022

View reviewed changes

shtomar-adb added 2 commits February 11, 2022 12:13

Added more Logs.

7d7af90

Merge branch 'messaging' of github.com:adobe/aepsdk-react-native into…

39e8415

… messaging Merge the changes from upstream.

sbenedicadb reviewed Feb 11, 2022

View reviewed changes

shtomar-adb and others added 3 commits February 11, 2022 12:56

Merged the upstream staging branch.

2c917fe

Rename function Message.clearMessage to Message.clear

5821a50

Updated the Readme to address code review feedback

1fbc49c

cacheung reviewed Feb 11, 2022

View reviewed changes

shtomar-adb and others added 9 commits February 12, 2022 13:56

Updated the installation instructions

4ed1412

Added the installation instructions for react-native-aepmessaging v1.0.0-beta.2 pre release.

Added Android native code RN package

0227248

Merge branch 'messaging' of github.com:adobe/aepsdk-react-native into…

e8fbc67

… messaging Merged the remote branch.

Updated Android install instructions

44d975f

Added Unit tests and Type script description file.

fc07d67

Changes in RN Messaging package Android side.

88e4ccb

Added Offer activity id and placement id as metadata in AndroidManife…

236aa9f

…st file.

Integrated the updated messaging.aar to keep track and handleJsMessag…

b5a4a28

…e functions in android sync with iOS.

Added the activity and placement id in plist. Changed the bundle id o…

3f955f9

…f sample app to match with main branch.

shtomar-adb requested review from cacheung, rymorale and yangyansong-adbe March 12, 2022 01:58

Merge branch 'staging' of https://github.com/adobe/aepsdk-react-native …

a1cc78c

…into messaging

dsoffiantini requested a review from sbenedicadb April 13, 2022 19:49

sbenedicadb approved these changes Apr 21, 2022

View reviewed changes

sbenedicadb added 2 commits April 21, 2022 13:06

-a couple small updates from the pr review

db3ace5

Merge pull request #174 from sbenedicadb/messaging

e76001b

-a couple small updates from the pr review

sbenedicadb removed the DO NOT MERGE label Apr 21, 2022

yangyansong-adbe approved these changes Apr 21, 2022

View reviewed changes

yangyansong-adbe reviewed Apr 21, 2022

View reviewed changes

sbenedicadb added 3 commits April 21, 2022 15:29

add some of the extensions back into android sample app

204a49d

-fix registerExtension calls

fbd9193

Merge pull request #175 from sbenedicadb/messaging

ff7eb40

add some of the extensions back into android sample app

sbenedicadb merged commit 5ad8b55 into staging Apr 22, 2022

		@@ -0,0 +1,54 @@
		/*
		Copyright 2021 Adobe. All rights reserved.

		@@ -0,0 +1,29 @@
		/*
		Copyright 2021 Adobe. All rights reserved.

		@@ -0,0 +1,99 @@
		/*
		Copyright 2021 Adobe. All rights reserved.

Support for IAM in RN Messaging package #139

Support for IAM in RN Messaging package #139

Uh oh!

Conversation

shtomar-adb commented Feb 8, 2022

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yangyansong-adbe commented Feb 8, 2022

Uh oh!

sbenedicadb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cacheung left a comment

Choose a reason for hiding this comment

Uh oh!

leiteszeke commented Mar 30, 2022

Uh oh!

sbenedicadb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yangyansong-adbe left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!