Merge pull request #40 from optimizely/mnoman/defaultDecideOptions

feat: Added optional parameter to pass defaultDecideOption in flutter SDK

Author: yasirfolio3

android/src/main/java/com/optimizely/optimizely_flutter_sdk/OptimizelyFlutterClient.java

@@ -125,13 +125,16 @@ protected void initializeOptimizely(@NonNull ArgumentsParser argumentsParser, @N
         }
         optimizelyManagerTracker.remove(sdkKey);
         notificationIdsTracker.remove(sdkKey);
+
+        List<OptimizelyDecideOption> defaultDecideOptions = argumentsParser.getDecideOptions();
         // Creating new instance
         OptimizelyManager optimizelyManager = OptimizelyManager.builder()
                 .withEventProcessor(batchProcessor)
                 .withEventHandler(eventHandler)
                 .withNotificationCenter(notificationCenter)
                 .withDatafileDownloadInterval(datafilePeriodicDownloadInterval, TimeUnit.SECONDS)
                 .withErrorHandler(new RaiseExceptionErrorHandler())
+                .withDefaultDecideOptions(defaultDecideOptions)
                 .withSDKKey(sdkKey)
                 .build(context);
 

example/lib/main.dart

@@ -24,10 +24,15 @@ class _MyAppState extends State<MyApp> {
   }
 
   Future<void> runOptimizelySDK() async {
+    Set<OptimizelyDecideOption> defaultOptions = {
+      OptimizelyDecideOption.includeReasons,
+      OptimizelyDecideOption.excludeVariables
+    };
     var flutterSDK = OptimizelyFlutterSdk("X9mZd2WDywaUL9hZXyh9A",
         datafilePeriodicDownloadInterval: 10 * 60,
         eventOptions: const EventOptions(
-            batchSize: 1, timeInterval: 60, maxQueueSize: 10000));
+            batchSize: 1, timeInterval: 60, maxQueueSize: 10000),
+        defaultDecideOptions: defaultOptions);
     var response = await flutterSDK.initializeClient();
 
     setState(() {
@@ -58,8 +63,11 @@ class _MyAppState extends State<MyApp> {
       print("decide notification received");
     });
 
+    Set<OptimizelyDecideOption> options = {
+      OptimizelyDecideOption.ignoreUserProfileService,
+    };
     // Decide call
-    var decideResponse = await userContext.decide('flag1');
+    var decideResponse = await userContext.decide('flag1', options);
     uiResponse +=
         "\nFirst decide call variationKey: ${decideResponse.decision!.variationKey}";
 

ios/Classes/SwiftOptimizelyFlutterSdkPlugin.swift

@@ -93,6 +93,12 @@ public class SwiftOptimizelyFlutterSdkPlugin: NSObject, FlutterPlugin {
         }
         let eventDispatcher = DefaultEventDispatcher(batchSize: batchSize, backingStore: .file, dataStoreName: "OPTEventQueue", timerInterval: timeInterval, maxQueueSize: maxQueueSize)
 
+        var decideOptions: [String]?
+        if let options = parameters[RequestParameterKey.decideOptions] as? [String] {
+            decideOptions = options
+        }
+        let defaultDecideOptions = Utils.getDecideOptions(options: decideOptions)
+        
         // Datafile Download Interval
         var datafilePeriodicDownloadInterval = 10 * 60 // seconds
 
@@ -113,7 +119,7 @@ public class SwiftOptimizelyFlutterSdkPlugin: NSObject, FlutterPlugin {
         optimizelyClientsTracker.removeValue(forKey: sdkKey)
 
         // Creating new instance
-        let optimizelyInstance = OptimizelyClient(sdkKey:sdkKey, eventDispatcher: eventDispatcher, datafileHandler: datafileHandler, periodicDownloadInterval: datafilePeriodicDownloadInterval)
+        let optimizelyInstance = OptimizelyClient(sdkKey:sdkKey, eventDispatcher: eventDispatcher, datafileHandler: datafileHandler, periodicDownloadInterval: datafilePeriodicDownloadInterval, defaultDecideOptions: defaultDecideOptions)
 
         optimizelyInstance.start{ [weak self] res in
             switch res {

lib/optimizely_flutter_sdk.dart

@@ -49,30 +49,36 @@ export 'package:optimizely_flutter_sdk/src/data_objects/datafile_options.dart'
 
 /// The main client class for the Optimizely Flutter SDK.
 ///
-/// To use, create an instance of OptimizelyFlutterSdk class with a valid sdkKey, datafilePeriodicDownloadInterval (optional), eventOptions (optional) and
+/// To use, create an instance of OptimizelyFlutterSdk class with a valid sdkKey, datafilePeriodicDownloadInterval (optional), eventOptions (optional) , defaultDecideOptions (optional) and
 /// call initializeClient method.
-/// If successfull, call createUserContext to setup user context.
+/// If successful, call createUserContext to setup user context.
 /// Once done, all API's should be available.
 class OptimizelyFlutterSdk {
   final String _sdkKey;
   final EventOptions _eventOptions;
   final int _datafilePeriodicDownloadInterval;
   final Map<ClientPlatform, DatafileHostOptions> _datafileHostOptions;
-
+  final Set<OptimizelyDecideOption> _defaultDecideOptions;
   OptimizelyFlutterSdk(
     this._sdkKey, {
     EventOptions eventOptions = const EventOptions(),
     int datafilePeriodicDownloadInterval =
         10 * 60, // Default time interval in seconds
     Map<ClientPlatform, DatafileHostOptions> datafileHostOptions = const {},
+    Set<OptimizelyDecideOption> defaultDecideOptions = const {},
   })  : _eventOptions = eventOptions,
         _datafilePeriodicDownloadInterval = datafilePeriodicDownloadInterval,
-        _datafileHostOptions = datafileHostOptions;
+        _datafileHostOptions = datafileHostOptions,
+        _defaultDecideOptions = defaultDecideOptions;
 
   /// Starts Optimizely SDK (Synchronous) with provided sdkKey.
   Future<BaseResponse> initializeClient() async {
-    return await OptimizelyClientWrapper.initializeClient(_sdkKey,
-        _eventOptions, _datafilePeriodicDownloadInterval, _datafileHostOptions);
+    return await OptimizelyClientWrapper.initializeClient(
+        _sdkKey,
+        _eventOptions,
+        _datafilePeriodicDownloadInterval,
+        _datafileHostOptions,
+        _defaultDecideOptions);
   }
 
   /// Use the activate method to start an experiment.

lib/src/optimizely_client_wrapper.dart

@@ -58,12 +58,15 @@ class OptimizelyClientWrapper {
       String sdkKey,
       EventOptions eventOptions,
       int datafilePeriodicDownloadInterval,
-      Map<ClientPlatform, DatafileHostOptions> datafileHostOptions) async {
+      Map<ClientPlatform, DatafileHostOptions> datafileHostOptions,
+      Set<OptimizelyDecideOption> defaultDecideOptions) async {
     _channel.setMethodCallHandler(methodCallHandler);
+    final convertedOptions = Utils.convertDecideOptions(defaultDecideOptions);
     Map<String, dynamic> requestDict = {
       Constants.sdkKey: sdkKey,
       Constants.datafilePeriodicDownloadInterval:
           datafilePeriodicDownloadInterval,
+      Constants.optimizelyDecideOption: convertedOptions,
       Constants.eventBatchSize: eventOptions.batchSize,
       Constants.eventTimeInterval: eventOptions.timeInterval,
       Constants.eventMaxQueueSize: eventOptions.maxQueueSize,

test/optimizely_flutter_sdk_test.dart

@@ -552,16 +552,23 @@ void main() {
         return true;
       }
 
-      Set<OptimizelyDecideOption> options = {
+      Set<OptimizelyDecideOption> defaultDecideOptions = {
         OptimizelyDecideOption.disableDecisionEvent,
-        OptimizelyDecideOption.enabledFlagsOnly,
+        OptimizelyDecideOption.enabledFlagsOnly
+      };
+      Set<OptimizelyDecideOption> options = {
         OptimizelyDecideOption.ignoreUserProfileService,
         OptimizelyDecideOption.includeReasons,
         OptimizelyDecideOption.excludeVariables,
       };
-
       test("decide() should succeed", () async {
-        var sdk = OptimizelyFlutterSdk(testSDKKey);
+        Set<OptimizelyDecideOption> options = {
+          OptimizelyDecideOption.ignoreUserProfileService,
+          OptimizelyDecideOption.includeReasons,
+          OptimizelyDecideOption.excludeVariables,
+        };
+        var sdk = OptimizelyFlutterSdk(testSDKKey,
+            defaultDecideOptions: defaultDecideOptions);
         var userContext = await sdk.createUserContext(userId, attributes);
         var decideKey = "decide-key";
 
@@ -573,13 +580,14 @@ void main() {
             TestUtils.compareDecisions(
                 {response.decision!.flagKey: response.decision!}),
             equals(true));
-        expect(decideOptions.length == 5, isTrue);
+        expect(decideOptions.length == 3, isTrue);
         expect(assertDecideOptions(options, decideOptions), isTrue);
         decideOptions = [];
       });
 
       test("decideForKeys should succeed", () async {
-        var sdk = OptimizelyFlutterSdk(testSDKKey);
+        var sdk = OptimizelyFlutterSdk(testSDKKey,
+            defaultDecideOptions: defaultDecideOptions);
         var userContext = await sdk.createUserContext(userId, attributes);
         var decideKeys = ["decide-key-1", "decide-key-2"];
 
@@ -588,21 +596,22 @@ void main() {
         expect(response.success, isTrue);
         expect(response.decisions.length, equals(2));
         expect(TestUtils.compareDecisions(response.decisions), isTrue);
-        expect(decideOptions.length == 5, isTrue);
+        expect(decideOptions.length == 3, isTrue);
         expect(assertDecideOptions(options, decideOptions), isTrue);
         decideOptions = [];
       });
 
       test("decideAll() should succeed", () async {
-        var sdk = OptimizelyFlutterSdk(testSDKKey);
+        var sdk = OptimizelyFlutterSdk(testSDKKey,
+            defaultDecideOptions: defaultDecideOptions);
         var userContext = await sdk.createUserContext(userId, attributes);
 
         var response = await userContext!.decideAll(options);
 
         expect(response.success, isTrue);
         expect(response.decisions.length, equals(3));
         expect(TestUtils.compareDecisions(response.decisions), isTrue);
-        expect(decideOptions.length == 5, isTrue);
+        expect(decideOptions.length == 3, isTrue);
         expect(assertDecideOptions(options, decideOptions), isTrue);
         decideOptions = [];
       });
@@ -611,8 +620,16 @@ void main() {
         final convertedOptions = Utils.convertDecideOptions(
           options,
         );
-        expect(convertedOptions.length == 5, isTrue);
+        expect(convertedOptions.length == 3, isTrue);
         expect(assertDecideOptions(options, convertedOptions), isTrue);
+        final convertedDefaultDecideOptions = Utils.convertDecideOptions(
+          defaultDecideOptions,
+        );
+        expect(convertedDefaultDecideOptions.length == 2, isTrue);
+        expect(
+            assertDecideOptions(
+                defaultDecideOptions, convertedDefaultDecideOptions),
+            isTrue);
       });
     });