feat: support variants in feature flags (#471)

ahmedAlaaInstabug · a7medev · AndrewAminInstabug · ahmedAlaaInstabug · commit 997a266f4661 · 2024-11-04T17:17:36.000+02:00
* feat: support Variants in Features & Experiments APIs * fix: deprecated comment * fix: removeFeatureFlagsFeatureFlag catch * fix: removeFeatureFlagsFeatureFlag catch * fix: removeFeatureFlagsFeatureFlag catch * fix: removeFeatureFlagsFeatureFlag catch * fix: removeFeatureFlagsFeatureFlag catch * fix: removeFeatureFlagsFeatureFlag catch * fix removeFeaturFlag test case * test: decommission native e2e tests in favor of captain (#484) * chore(android): bump sdk to 13.2.0 (#482) * chore(ios): bump sdk to v13.2.0 (#483) * feat: add screen loading manual & automatic approaches (#477) * release: v13.2.0 (#485) * fix: format files * fix: format files * fix: format files * fix: pr comments * fix: PR comments * fix: PR comments * fix: PR comments * fix: PR comments * fix: PR comments * chore: correct pr number in changelog * chore: correct pr number in changelog * chore: correct changelog section level * refactor: remove unnecessary `List.of` * chore: mention variants support in changelog --------- Co-authored-by: Ahmed Mahmoud <68241710+a7medev@users.noreply.github.com> Co-authored-by: Andrew Amin <160974398+AndrewAminInstabug@users.noreply.github.com> Co-authored-by: Ahmed Mahmoud <a7med.mahmoud2004@gmail.com>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,15 @@
 # Changelog
 
+## [Unreleased](https://github.com/Instabug/Instabug-Flutter/compare/v13.2.0...dev)
+
+### Added
+
+- Add support for variants in Feature Flags through the APIs `Instabug.addFeatureFlags`, `Instabug.removeFeatureFlags` and `Instabug.clearAllFeatureFlags` ([#471](https://github.com/Instabug/Instabug-Flutter/pull/471)).
+
+### Deprecated
+
+- Deprecate Experiments APIs `Instabug.addExperiments`, `Instabug.removeExperiments` and `Instabug.clearAllExperiments` in favor of the new Feature Flags APIs ([#471](https://github.com/Instabug/Instabug-Flutter/pull/471)).
+
 ## [13.2.0](https://github.com/Instabug/Instabug-Flutter/compare/v13.1.1...v13.2.0)
 
 ### Added
diff --git a/android/src/main/java/com/instabug/flutter/modules/InstabugApi.java b/android/src/main/java/com/instabug/flutter/modules/InstabugApi.java
@@ -13,7 +13,14 @@
 import com.instabug.flutter.util.ArgsRegistry;
 import com.instabug.flutter.util.Reflection;
 import com.instabug.flutter.util.ThreadManager;
-import com.instabug.library.*;
+import com.instabug.library.Feature;
+import com.instabug.library.Instabug;
+import com.instabug.library.InstabugColorTheme;
+import com.instabug.library.InstabugCustomTextPlaceHolder;
+import com.instabug.library.IssueType;
+import com.instabug.library.Platform;
+import com.instabug.library.ReproConfigurations;
+import com.instabug.library.featuresflags.model.IBGFeatureFlag;
 import com.instabug.library.internal.module.InstabugLocale;
 import com.instabug.library.invocation.InstabugInvocationEvent;
 import com.instabug.library.model.NetworkLog;
@@ -28,6 +35,7 @@
 import java.io.IOException;
 import java.io.InputStream;
 import java.lang.reflect.Method;
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Locale;
@@ -225,6 +233,37 @@ public void clearAllExperiments() {
         Instabug.clearAllExperiments();
     }
 
+    @Override
+    public void addFeatureFlags(@NonNull Map<String, String> featureFlags) {
+        try {
+            List<IBGFeatureFlag> features = new ArrayList<>();
+            for (Map.Entry<String, String> entry : featureFlags.entrySet()) {
+                features.add(new IBGFeatureFlag(entry.getKey(), entry.getValue().isEmpty() ? null : entry.getValue()));
+            }
+            Instabug.addFeatureFlags(features);
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
+    @Override
+    public void removeFeatureFlags(@NonNull List<String> featureFlags) {
+        try {
+            Instabug.removeFeatureFlag(featureFlags);
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
+    @Override
+    public void removeAllFeatureFlags() {
+        try {
+            Instabug.removeAllFeatureFlags();
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
     @Override
     public void setUserAttribute(@NonNull String value, @NonNull String key) {
         Instabug.setUserAttribute(key, value);
diff --git a/android/src/test/java/com/instabug/flutter/InstabugApiTest.java b/android/src/test/java/com/instabug/flutter/InstabugApiTest.java
@@ -39,6 +39,7 @@
 import com.instabug.library.Platform;
 import com.instabug.library.ReproConfigurations;
 import com.instabug.library.ReproMode;
+import com.instabug.library.featuresflags.model.IBGFeatureFlag;
 import com.instabug.library.invocation.InstabugInvocationEvent;
 import com.instabug.library.model.NetworkLog;
 import com.instabug.library.ui.onboarding.WelcomeMessage;
@@ -54,6 +55,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
@@ -356,6 +358,32 @@ public void testClearAllExperiments() {
         mInstabug.verify(Instabug::clearAllExperiments);
     }
 
+    @Test
+    public void testAddFeatureFlags() {
+       Map<String,String > featureFlags = new HashMap<>();
+        featureFlags.put("key1","variant1");
+        api.addFeatureFlags(featureFlags);
+        List<IBGFeatureFlag> flags=new ArrayList<IBGFeatureFlag>();
+        flags.add(new IBGFeatureFlag("key1","variant1"));
+        mInstabug.verify(() -> Instabug.addFeatureFlags(flags));
+    }
+
+    @Test
+    public void testRemoveFeatureFlags() {
+        List<String> featureFlags = Arrays.asList("premium", "star");
+
+        api.removeFeatureFlags(featureFlags);
+
+        mInstabug.verify(() -> Instabug.removeFeatureFlag(featureFlags));
+    }
+
+    @Test
+    public void testClearAllFeatureFlags() {
+        api.removeAllFeatureFlags();
+
+        mInstabug.verify(Instabug::removeAllFeatureFlags);
+    }
+
     @Test
     public void testSetUserAttribute() {
         String key = "is_premium";
diff --git a/example/ios/InstabugTests/InstabugApiTests.m b/example/ios/InstabugTests/InstabugApiTests.m
@@ -226,6 +226,46 @@ - (void)testClearAllExperiments {
     OCMVerify([self.mInstabug clearAllExperiments]);
 }
 
+- (void)testAddFeatureFlags {
+  NSDictionary *featureFlagsMap = @{ @"key13" : @"value1", @"key2" : @"value2"};
+    FlutterError *error;
+
+  [self.api addFeatureFlagsFeatureFlagsMap:featureFlagsMap error:&error];
+  OCMVerify([self.mInstabug addFeatureFlags: [OCMArg checkWithBlock:^(id value) {
+    NSArray<IBGFeatureFlag *> *featureFlags = value;
+    NSString* firstFeatureFlagName = [featureFlags objectAtIndex:0 ].name;
+    NSString* firstFeatureFlagKey = [[featureFlagsMap allKeys] objectAtIndex:0] ;
+    if([ firstFeatureFlagKey isEqualToString: firstFeatureFlagName]){
+      return YES;
+    }
+    return  NO;
+  }]]);
+}
+
+- (void)testRemoveFeatureFlags {
+  NSArray *featureFlags = @[@"exp1"];
+    FlutterError *error;
+    
+  [self.api removeFeatureFlagsFeatureFlags:featureFlags error:&error];
+    OCMVerify([self.mInstabug removeFeatureFlags: [OCMArg checkWithBlock:^(id value) {
+      NSArray<IBGFeatureFlag *> *featureFlagsObJ = value;
+      NSString* firstFeatureFlagName = [featureFlagsObJ objectAtIndex:0 ].name;
+      NSString* firstFeatureFlagKey = [featureFlags firstObject] ;
+      if([ firstFeatureFlagKey isEqualToString: firstFeatureFlagName]){
+        return YES;
+      }
+      return  NO;
+    }]]);}
+
+- (void)testRemoveAllFeatureFlags {
+    FlutterError *error;
+
+  [self.api removeAllFeatureFlagsWithError:&error];
+  OCMVerify([self.mInstabug removeAllFeatureFlags]);
+}
+
+
+
 - (void)testSetUserAttribute {
     NSString *key = @"is_premium";
     NSString *value = @"true";
diff --git a/example/ios/Podfile b/example/ios/Podfile
@@ -1,5 +1,5 @@
 # Uncomment this line to define a global platform for your project
-platform :ios, '13.0'
+platform :ios, '13.4'
 
 # CocoaPods analytics sends network stats synchronously affecting flutter build latency.
 ENV['COCOAPODS_DISABLE_STATS'] = 'true'
diff --git a/example/lib/src/screens/my_home_page.dart b/example/lib/src/screens/my_home_page.dart
@@ -19,6 +19,15 @@ class _MyHomePageState extends State<MyHomePage> {
 
   final primaryColorController = TextEditingController();
   final screenNameController = TextEditingController();
+  final featureFlagsController = TextEditingController();
+
+  @override
+  void dispose() {
+    featureFlagsController.dispose();
+    screenNameController.dispose();
+    primaryColorController.dispose();
+    super.dispose();
+  }
 
   void restartInstabug() {
     Instabug.setEnabled(false);
@@ -325,7 +334,36 @@ class _MyHomePageState extends State<MyHomePage> {
             ),
           ],
         ),
+        SectionTitle('FeatureFlags'),
+        InstabugTextField(
+          controller: featureFlagsController,
+          label: 'Feature Flag name',
+        ),
+        InstabugButton(
+          onPressed: () => setFeatureFlag(),
+          text: 'SetFeatureFlag',
+        ),
+        InstabugButton(
+          onPressed: () => removeFeatureFlag(),
+          text: 'RemoveFeatureFlag',
+        ),
+        InstabugButton(
+          onPressed: () => removeAllFeatureFlags(),
+          text: 'RemoveAllFeatureFlags',
+        ),
       ],
     );
   }
+
+  setFeatureFlag() {
+    Instabug.addFeatureFlags([FeatureFlag(name: featureFlagsController.text)]);
+  }
+
+  removeFeatureFlag() {
+    Instabug.removeFeatureFlags([featureFlagsController.text]);
+  }
+
+  removeAllFeatureFlags() {
+    Instabug.clearAllFeatureFlags();
+  }
 }
diff --git a/ios/Classes/Modules/InstabugApi.m b/ios/Classes/Modules/InstabugApi.m
@@ -318,5 +318,40 @@ - (void)willRedirectToStoreWithError:(FlutterError * _Nullable __autoreleasing *
     [Instabug willRedirectToAppStore];
 }
 
+- (void)addFeatureFlagsFeatureFlagsMap:(nonnull NSDictionary<NSString *,NSString *> *)featureFlagsMap error:(FlutterError * _Nullable __autoreleasing * _Nonnull)error {
+    NSMutableArray<IBGFeatureFlag *> *featureFlags = [NSMutableArray array];
+    for(id key in featureFlagsMap){
+        NSString* variant =((NSString * )[featureFlagsMap objectForKey:key]);
+        if ([variant length]==0) {
+            [featureFlags addObject:[[IBGFeatureFlag alloc] initWithName:key]];
+        }
+        else{
+            [featureFlags addObject:[[IBGFeatureFlag alloc] initWithName:key variant:variant]];
+
+        }
+    }
+    [Instabug addFeatureFlags:featureFlags];
+}
+
+
+- (void)removeAllFeatureFlagsWithError:(FlutterError * _Nullable __autoreleasing * _Nonnull)error {
+    [Instabug removeAllFeatureFlags];
+
+}
+
+
+- (void)removeFeatureFlagsFeatureFlags:(nonnull NSArray<NSString *> *)featureFlags error:(FlutterError * _Nullable __autoreleasing * _Nonnull)error {
+
+    NSMutableArray<IBGFeatureFlag *> *features = [NSMutableArray array];
+       for(id item in featureFlags){
+               [features addObject:[[IBGFeatureFlag alloc] initWithName:item]];
+           }
+    @try {
+        [Instabug removeFeatureFlags:features];
+    } @catch (NSException *exception) {
+        NSLog(@"%@", exception);
+
+    }
+}
 
 @end
diff --git a/lib/instabug_flutter.dart b/lib/instabug_flutter.dart
@@ -1,6 +1,7 @@
 // Models
 export 'src/models/crash_data.dart';
 export 'src/models/exception_data.dart';
+export 'src/models/feature_flag.dart';
 export 'src/models/network_data.dart';
 export 'src/models/trace.dart';
 export 'src/models/w3c_header.dart';
diff --git a/lib/src/models/feature_flag.dart b/lib/src/models/feature_flag.dart
@@ -0,0 +1,9 @@
+class FeatureFlag {
+  /// the name of feature flag
+  String name;
+
+  /// The variant of the feature flag.
+  String? variant;
+
+  FeatureFlag({required this.name, this.variant});
+}
diff --git a/lib/src/modules/instabug.dart b/lib/src/modules/instabug.dart
@@ -1,9 +1,11 @@
 // ignore_for_file: avoid_classes_with_only_static_members
 
 import 'dart:async';
+
 // to maintain supported versions prior to Flutter 3.3
 // ignore: unnecessary_import
 import 'dart:typed_data';
+
 // to maintain supported versions prior to Flutter 3.3
 // ignore: unnecessary_import
 import 'dart:ui';
@@ -247,20 +249,50 @@ class Instabug {
   }
 
   /// Adds experiments to the next report.
+  @Deprecated(
+    'Please migrate to the new feature flags APIs: Instabug.addFeatureFlags.',
+  )
   static Future<void> addExperiments(List<String> experiments) async {
     return _host.addExperiments(experiments);
   }
 
   /// Removes certain experiments from the next report.
+  @Deprecated(
+    'Please migrate to the new feature flags APIs: Instabug.removeFeatureFlags.',
+  )
   static Future<void> removeExperiments(List<String> experiments) async {
     return _host.removeExperiments(experiments);
   }
 
   /// Clears all experiments from the next report.
+
+  @Deprecated(
+    'Please migrate to the new feature flags APIs: Instabug.clearAllFeatureFlags.',
+  )
   static Future<void> clearAllExperiments() async {
     return _host.clearAllExperiments();
   }
 
+  /// Adds feature flags to the next report.
+  static Future<void> addFeatureFlags(List<FeatureFlag> featureFlags) async {
+    final map = <String, String>{};
+    for (final value in featureFlags) {
+      map[value.name] = value.variant ?? '';
+    }
+
+    return _host.addFeatureFlags(map);
+  }
+
+  /// Removes certain feature flags from the next report.
+  static Future<void> removeFeatureFlags(List<String> featureFlags) async {
+    return _host.removeFeatureFlags(featureFlags);
+  }
+
+  /// Clears all feature flags from the next report.
+  static Future<void> clearAllFeatureFlags() async {
+    return _host.removeAllFeatureFlags();
+  }
+
   /// Add custom user attribute [value] with a [key] that is going to be sent with each feedback, bug or crash.
   static Future<void> setUserAttribute(String value, String key) async {
     return _host.setUserAttribute(value, key);
diff --git a/pigeons/instabug.api.dart b/pigeons/instabug.api.dart
@@ -40,6 +40,9 @@ abstract class InstabugHostApi {
   void addExperiments(List<String> experiments);
   void removeExperiments(List<String> experiments);
   void clearAllExperiments();
+  void addFeatureFlags(Map<String, String> featureFlagsMap);
+  void removeFeatureFlags(List<String> featureFlags);
+  void removeAllFeatureFlags();
 
   void setUserAttribute(String value, String key);
   void removeUserAttribute(String key);
diff --git a/test/instabug_test.dart b/test/instabug_test.dart
