Add Simplified Initialize support by cacheung · Pull Request #129 · adobe/aepsdk_flutter

cacheung · 2025-02-14T00:30:14Z

Flutter
- Add MobileCore.initialize(initOptions: options);
  Add MobileCore.initialize(appId: "Your_APP_ID")
- Add initOptions class
Implement the wrapper for Android and iOS
Update the Sample App to use this API

TODO:

Add tests

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.

Add Initialize API support for TS and Android

update main.dart

Update logging to trace

Add MobileCore.initialize(appId: "Your_APP_ID") API

...p/src/main/java/com/adobe/marketing/mobile/flutter/flutter_aepsdk_example/MyApplication.java

praveek · 2025-02-14T21:01:20Z

plugins/flutter_aepcore/lib/src/aepmobile_init_options.dart

+class InitOptions {
+  String? appId;
+  String? filePath;
+  bool lifecycleAutomaticTracking;


Make this optional and avoid setting a default value. This allows the wrapper to defer to the default value provided by the underlying platform.

praveek · 2025-02-14T21:01:50Z

plugins/flutter_aepcore/lib/src/aepmobile_init_options.dart

@@ -0,0 +1,29 @@
+class InitOptions {
+  String? appId;


Can you add some comments for each property here?

plugins/flutter_aepcore/lib/src/aepmobile_init_options.dart

praveek · 2025-02-14T21:06:34Z

plugins/flutter_aepcore/lib/src/aepmobile_init_options.dart

+    this.lifecycleAutomaticTracking = true, // Default value set to true
+    this.lifecycleAdditionalContextData = null, // Default value set to null
+    this.appGroupIOS = null, // Default value set to null
+  }) : assert(appId != null || filePath != null,


If neither value is set, the SDK will default to the bundled configuration.
You should assert that both values are not set at the same time.

praveek · 2025-02-14T21:19:33Z

plugins/flutter_aepcore/lib/flutter_aepcore.dart

+ /// @param initOptions The [InitOptions] to configure the SDK.
+ /// @param appId The AEP SDK App ID.
+ /// @throws [ArgumentError] if neither `initOptions` nor `appId` is provided, or if both
+  static Future<void> initialize({InitOptions? initOptions, String? appId}) {


Split it into two APIs:
initialize()
initializeWithAppId()
For initializeWithAppId(), create an InitOptions object using the provided appId, and then call the initialize() API.

praveek · 2025-02-14T21:20:14Z

...d/src/main/java/com/adobe/marketing/mobile/flutter/flutter_aepcore/FlutterAEPCorePlugin.java

            result.success(MobileCore.extensionVersion());
+        } else if ("initialize".equals(call.method)) {
+           handleInitialize(result, call.arguments);
+        } else if ("initializeWithAppId".equals(call.method)) {


You can remove this binding.

praveek · 2025-02-14T21:20:30Z

...d/src/main/java/com/adobe/marketing/mobile/flutter/flutter_aepcore/FlutterAEPCorePlugin.java


+   private void handleInitialize(Result result, Object arguments) {
+       if (!(arguments instanceof Map)) {
+           result.error("INVALID_ARGUMENT", "Initialize failed because arguments is not a Map", null);


Define INVALID_ARGUMENT and other strings as constants.

praveek · 2025-02-14T21:21:54Z

...d/src/main/java/com/adobe/marketing/mobile/flutter/flutter_aepcore/FlutterAEPCorePlugin.java

+           return;
+       }
+
+       if (application == null) {


You do this check in Line 113. Can you remove this?

praveek · 2025-02-14T21:24:20Z

...d/src/main/java/com/adobe/marketing/mobile/flutter/flutter_aepcore/FlutterAEPCorePlugin.java

+           return;
+       }
+
+       Map initOptionsMap = (Map) arguments;


Perform a safe cast.

if (arguments instanceof Map) { Map initOptionsMap = (Map) arguments; }

I also recommend moving this logic to FlutterAEPCoreDataBridge.initOptionsFromMap()

Incorporate review comments

praveek · 2025-02-18T21:08:18Z

plugins/flutter_aepcore/lib/src/aepmobile_init_options.dart

+  /// The file path for the local configuration file
+  String? filePath;
+  /// Flag indicating whether automatic lifecycle tracking is enabled
+  bool? lifecycleAutomaticTracking;


Can you rename this to lifecycleAutomaticTrackingEnabled to make it consistent with Android and iOS?

praveek · 2025-02-18T21:17:22Z

example/lib/main.dart

+    appGroupIOS: "group.com.example",
+  );
+
+  await MobileCore.initialize(initOptions: initOptions);


This is incorrect, as it will delay the app load until the SDK initializes. Could you move this to a more relevant place?

I think you need to move this to the initState() function of the HomePage class. See my example in the spec.
https://wiki.corp.adobe.com/pages/viewpage.action?spaceKey=adms&title=004+%3A+SDK+Initialization+Simplification#id-004:SDKInitializationSimplification-Wrappers

Add iOS implementation for Simplified initialization

praveek · 2025-02-19T00:25:59Z

...c/main/java/com/adobe/marketing/mobile/flutter/flutter_aepcore/FlutterAEPCoreDataBridge.java

+        } else if (filePath != null) {
+            options = InitOptions.configureWithFileInPath(filePath);
+        } else {
+            return null; // Either appId or filePath must be provided


Don't return here. Instead use options = InitOptions() and remove the comment.
If both appID and filePath are absent, we use bundled config.

praveek · 2025-02-19T00:27:26Z

...c/main/java/com/adobe/marketing/mobile/flutter/flutter_aepcore/FlutterAEPCoreDataBridge.java

        return AEP_PRIVACY_STATUS_UNKNOWN;
    }

+    static InitOptions initOptionsFromMap(final Object option) {


nit: Can you fix the variable names.
option -> arguments
optionsAsMap -> argumentsAsMap
initOptionMap -> initOptionsMap

praveek · 2025-02-19T00:28:28Z

...c/main/java/com/adobe/marketing/mobile/flutter/flutter_aepcore/FlutterAEPCoreDataBridge.java

+        } else {
+            return null; // Either appId or filePath must be provided
+        }
+        options.setLifecycleAutomaticTrackingEnabled(lifecycleAutomaticTrackingEnabled != null ? lifecycleAutomaticTrackingEnabled : true);


if (lifecycleAutomaticTrackingEnabled != null) { options.setLifecycleAutomaticTrackingEnabled(lifecycleAutomaticTrackingEnabled) }

praveek · 2025-02-19T00:30:53Z

...c/main/java/com/adobe/marketing/mobile/flutter/flutter_aepcore/FlutterAEPCoreDataBridge.java

+        String appId = getNullableString(initOptionMap, APPID_KEY);
+        String filePath = getNullableString(initOptionMap, FILE_PATH_KEY);
+        Boolean lifecycleAutomaticTrackingEnabled = getNullableBoolean(initOptionMap, LIFECYCLE_AUTOMATION_TRACKING_KEY);
+        Map<String, String> lifecycleAdditionalContextData = getNullableMap(initOptionMap, LIFECYCLE_ADDITIONAL_CONTEXTDATA_KEY);


This cast is incorrect. Can you add getNullableStringMap() which verifies the keys and values are all String?

praveek · 2025-02-19T00:35:28Z

...d/src/main/java/com/adobe/marketing/mobile/flutter/flutter_aepcore/FlutterAEPCorePlugin.java

    public void onAttachedToEngine(@NonNull final FlutterPluginBinding binding) {
        channel = new MethodChannel(binding.getBinaryMessenger(), "flutter_aepcore");
        channel.setMethodCallHandler(new FlutterAEPCorePlugin());
+        application = (Application) binding.getApplicationContext();


Context appContext = binding.getApplicationContext()
if (appContext instanceof Application) {
application = (Application) appContext;
}

praveek · 2025-02-19T00:38:06Z

plugins/flutter_aepcore/ios/Classes/FlutterAEPCorePlugin.m

        result([AEPMobileCore extensionVersion]);
+    } else if ([@"initialize" isEqualToString:call.method]) {
+        [self handleInitialize:call result:result];
+        result(nil);


result(nil) should be called from inside the callback passed to initialize API.

praveek · 2025-02-19T00:38:56Z

plugins/flutter_aepcore/ios/Classes/FlutterAEPCorePlugin.m

+    AEPInitOptions *initOptions = [FlutterAEPCoreDataBridge initOptionsFromMap:arguments];
+    if (!initOptions) {
+        result([FlutterError errorWithCode:@"INVALID_ARGUMENT"
+                                   message:@"Initialize failed because initOptions is not a dictionary"


Initialize failed because InitOptions is not valid.

praveek · 2025-02-19T00:40:40Z

plugins/flutter_aepcore/lib/src/aepmobile_init_options.dart

+  InitOptions({
+    this.appId,
+    this.filePath,
+    this.lifecycleAutomaticTrackingEnabled = true,


this.lifecycleAutomaticTrackingEnabled = null

praveek · 2025-02-19T00:42:25Z

plugins/flutter_aepcore/lib/src/aepmobile_init_options.dart

+    this.lifecycleAutomaticTrackingEnabled = true,
+    this.lifecycleAdditionalContextData = null, 
+    this.appGroup = null,
+  }) : assert(!(appId != null && filePath != null),


Can you change your assertion to appId == null || filePath == null?

praveek · 2025-02-19T00:43:39Z

plugins/flutter_aepcore/lib/src/aepmobile_init_options.dart

+  /// Additional context data to be included in lifecycle start event.
+  Map<String, String>? lifecycleAdditionalContextData;
+  /// App group used to share user defaults and files among containing app and extension apps on iOS
+  String? appGroup;


appGroupIOS

praveek · 2025-02-19T00:45:16Z

plugins/flutter_aepcore/lib/src/aepmobile_init_options.dart

+    retMap['filePath'] = filePath;
+    retMap['lifecycleAutomaticTrackingEnabled'] = lifecycleAutomaticTrackingEnabled;
+    retMap['lifecycleAdditionalContextData'] = lifecycleAdditionalContextData;
+    retMap['appGroup'] = appGroup;


appGroupIOS

Incorporate review comments

update format

Update for the missing import for context

Update for the null and isKindOfClass check for appId on iOS

kevinlind · 2025-02-19T01:57:50Z

example/ios/Runner/AppDelegate.m

Is this file still needed? Can you remove it?

I am not able to remove AppDelegate files with error for the example app. I think we can keep it here. I will test with a brand new app to make sure the initialize API works there.

kevinlind · 2025-02-19T01:58:10Z

example/ios/Runner/AppDelegate.h

Are you able to remove the AppDelegate altogether?

Same as above.

kevinlind · 2025-02-19T02:01:52Z

example/lib/main.dart

+    appGroupIOS: "group.com.example",
+  );
+
+  await MobileCore.initialize(initOptions: initOptions);


I think you need to move this to the initState() function of the HomePage class. See my example in the spec.
https://wiki.corp.adobe.com/pages/viewpage.action?spaceKey=adms&title=004+%3A+SDK+Initialization+Simplification#id-004:SDKInitializationSimplification-Wrappers

kevinlind · 2025-02-19T19:15:53Z

...c/main/java/com/adobe/marketing/mobile/flutter/flutter_aepcore/FlutterAEPCoreDataBridge.java


+    private final static String APPID_KEY = "appId";
+    private final static String FILE_PATH_KEY = "filePath";
+    private final static String LIFECYCLE_AUTOMATION_TRACKING_KEY = "lifecycleAutomaticTrackingEnabled";


"AUTOMATIC"

Fixing typo

Remove filePath parameter in initialize API

praveek · 2025-02-20T06:50:05Z

...c/main/java/com/adobe/marketing/mobile/flutter/flutter_aepcore/FlutterAEPCoreDataBridge.java

+    }
+
+    Map rawMap = (Map) data.get(key);
+    Map<String, String> stringMap = new HashMap<>();


Don't create a new map. Instead, after validation, your return value on line 186 should be (Map<String, String>) rawMap.

praveek · 2025-02-20T07:46:13Z

...d/src/main/java/com/adobe/marketing/mobile/flutter/flutter_aepcore/FlutterAEPCorePlugin.java

+        Context appContext = binding.getApplicationContext();
+        if (appContext instanceof Application) {
+            application = (Application) appContext;
+        }


Can you also add a call to MobileCore.setWrapperType(WrapperType.Flutter) here?
Additionally, include the same API call within the registerWithRegistrar method of your iOS wrapper.

…per Type Flutter for Android and iOS. Update SDK initialize in initState() in the example app, add AEP Wrapper Type Flutter for Android and iOS. Fix return map in Core DataBridge Java file.

kevinlind · 2025-02-20T18:03:58Z

plugins/flutter_aepcore/ios/Classes/FlutterAEPCoreDataBridge.m

+    NSString *appGroup = initOptionsMap[@"appGroup"];
+
+    AEPInitOptions *initOptions;
+    if (appId != nil && ![appId isKindOfClass:[NSNull class]]) {


Instead of testing if appId is not NSNull class, can you check if it is NSString class?
if (appId != nil && [appId isKindOfClass:[NSString class]])

kevinlind · 2025-02-20T18:06:20Z

plugins/flutter_aepcore/ios/Classes/FlutterAEPCoreDataBridge.m

+    if (lifecycleAdditionalContextData != nil && [lifecycleAdditionalContextData isKindOfClass:[NSDictionary class]]) {
+        initOptions.lifecycleAdditionalContextData = lifecycleAdditionalContextData;
+    } else {
+        NSLog(@"lifecycleAdditionalContextData is nil or not a dictionary");


I'd recommend removing this log entry as it's probably more common to not set additional context data. Plus, the Android implementation doesn't log here either.

kevinlind · 2025-02-20T18:06:41Z

plugins/flutter_aepcore/ios/Classes/FlutterAEPCoreDataBridge.m

+    if (appGroup != nil && [appGroup isKindOfClass:[NSString class]]) {
+        initOptions.appGroup = appGroup;
+    } else {
+        NSLog(@"appGroup is nil or not a string");


I'd recommend removing this log entry as it's probably more common to not set an app group.

Update AEPCoreDataBridge

cacheung added 3 commits February 13, 2025 14:57

Add Initialize API support for TS and Android

dae505b

Add Initialize API support for TS and Android

update main.dart

47e468e

update main.dart

Update logging to trace

d7f5075

Update logging to trace

cacheung requested a review from praveek February 14, 2025 00:30

Add MobileCore.initialize(appId: "Your_APP_ID") API

382cc7f

Add MobileCore.initialize(appId: "Your_APP_ID") API

praveek reviewed Feb 14, 2025

View reviewed changes

...p/src/main/java/com/adobe/marketing/mobile/flutter/flutter_aepsdk_example/MyApplication.java Outdated Show resolved Hide resolved

praveek reviewed Feb 14, 2025

View reviewed changes

plugins/flutter_aepcore/lib/src/aepmobile_init_options.dart Outdated Show resolved Hide resolved

praveek reviewed Feb 14, 2025

View reviewed changes

Incorporate review comments

3e19f0c

Incorporate review comments

praveek reviewed Feb 18, 2025

View reviewed changes

Add iOS implementation for Simplified initialization

597529c

Add iOS implementation for Simplified initialization

cacheung requested a review from kevinlind February 19, 2025 00:21

praveek reviewed Feb 19, 2025

View reviewed changes

cacheung changed the title ~~Add Simplified Initialize support for Android~~ Add Simplified Initialize support Feb 19, 2025

praveek reviewed Feb 19, 2025

View reviewed changes

cacheung added 4 commits February 18, 2025 18:57

Incorporate review comments

8896135

Incorporate review comments

update format

a367265

update format

Update for the missing import for context

15d458b

Update for the missing import for context

Update for the null and isKindOfClass check for appId on iOS

5d69f25

Update for the null and isKindOfClass check for appId on iOS

kevinlind reviewed Feb 19, 2025

View reviewed changes

cacheung added 2 commits February 19, 2025 15:24

Fixing typo

1ff70a0

Fixing typo

Remove filePath parameter in initialize API

bed7cd6

Remove filePath parameter in initialize API

praveek reviewed Feb 20, 2025

View reviewed changes

Update SDK initialize in initState() in the example app, add AEP Wrap…

d84ad00

…per Type Flutter for Android and iOS. Update SDK initialize in initState() in the example app, add AEP Wrapper Type Flutter for Android and iOS. Fix return map in Core DataBridge Java file.

kevinlind reviewed Feb 20, 2025

View reviewed changes

praveek approved these changes Feb 20, 2025

View reviewed changes

Update AEPCoreDataBridge

74d3038

Update AEPCoreDataBridge

kevinlind approved these changes Feb 20, 2025

View reviewed changes

cacheung merged commit 6ecc70d into adobe:dev-v5.0.0 Feb 21, 2025
2 checks passed

cacheung deleted the simplifed branch February 21, 2025 01:01

Conversation

cacheung commented Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue

Motivation and Context

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

Checklist:

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

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!

praveek Feb 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

praveek Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

praveek Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

praveek Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

praveek Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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

cacheung commented Feb 14, 2025 •

edited

Loading

praveek Feb 14, 2025 •

edited

Loading

praveek Feb 19, 2025 •

edited

Loading

praveek Feb 19, 2025 •

edited

Loading

praveek Feb 19, 2025 •

edited

Loading

praveek Feb 19, 2025 •

edited

Loading

praveek Feb 20, 2025 •

edited

Loading