feat: support app variant (#585)

* feat: app variant

* feat: app variant

* feat: app variant

* feat: app variant

Author: ahmedAlaaInstabug

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ### Added
 
+- Add support for App variant. ([#585](https://github.com/Instabug/Instabug-Flutter/pull/585))
+
 - Add support for xCode 16. ([#574](https://github.com/Instabug/Instabug-Flutter/pull/574))
 
 - Add support for BugReporting user consents. ([#573](https://github.com/Instabug/Instabug-Flutter/pull/573))

android/src/main/java/com/instabug/flutter/modules/InstabugApi.java

@@ -6,9 +6,11 @@
 import android.graphics.BitmapFactory;
 import android.net.Uri;
 import android.util.Log;
+
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.annotation.VisibleForTesting;
+
 import com.instabug.flutter.generated.InstabugPigeon;
 import com.instabug.flutter.util.ArgsRegistry;
 import com.instabug.flutter.util.Reflection;
@@ -30,9 +32,11 @@
 import com.instabug.library.invocation.InstabugInvocationEvent;
 import com.instabug.library.model.NetworkLog;
 import com.instabug.library.ui.onboarding.WelcomeMessage;
+
 import io.flutter.FlutterInjector;
 import io.flutter.embedding.engine.loader.FlutterLoader;
 import io.flutter.plugin.common.BinaryMessenger;
+
 import org.jetbrains.annotations.NotNull;
 import org.json.JSONObject;
 
@@ -102,10 +106,12 @@ public Boolean isEnabled() {
 
     @NotNull
     @Override
-    public Boolean isBuilt() { return Instabug.isBuilt(); }
+    public Boolean isBuilt() {
+        return Instabug.isBuilt();
+    }
 
     @Override
-    public void init(@NonNull String token, @NonNull List<String> invocationEvents, @NonNull String debugLogsLevel) {
+    public void init(@NonNull String token, @NonNull List<String> invocationEvents, @NonNull String debugLogsLevel, @Nullable String appVariant) {
         setCurrentPlatform();
 
         InstabugInvocationEvent[] invocationEventsArray = new InstabugInvocationEvent[invocationEvents.size()];
@@ -116,11 +122,14 @@ public void init(@NonNull String token, @NonNull List<String> invocationEvents,
 
         final Application application = (Application) context;
         final int parsedLogLevel = ArgsRegistry.sdkLogLevels.get(debugLogsLevel);
-
-        new Instabug.Builder(application, token)
+        Instabug.Builder builder = new Instabug.Builder(application, token)
                 .setInvocationEvents(invocationEventsArray)
-                .setSdkDebugLogsLevel(parsedLogLevel)
-                .build();
+                .setSdkDebugLogsLevel(parsedLogLevel);
+        if (appVariant != null) {
+            builder.setAppVariant(appVariant);
+        }
+
+        builder.build();
 
         Instabug.setScreenshotProvider(screenshotProvider);
     }
@@ -146,6 +155,17 @@ public void setUserData(@NonNull String data) {
         Instabug.setUserData(data);
     }
 
+    @Override
+    public void setAppVariant(@NonNull String appVariant) {
+        try {
+            Instabug.setAppVariant(appVariant);
+
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+
+    }
+
     @Override
     public void logUserEvent(@NonNull String name) {
         Instabug.logUserEvent(name);
@@ -500,13 +520,13 @@ public void willRedirectToStore() {
         Instabug.willRedirectToStore();
     }
 
-    
+
     @Override
     public void setNetworkLogBodyEnabled(@NonNull Boolean isEnabled) {
-                try {
-                    Instabug.setNetworkLogBodyEnabled(isEnabled);
-                } catch (Exception e) {
-                    e.printStackTrace();
-                }
+        try {
+            Instabug.setNetworkLogBodyEnabled(isEnabled);
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
     }
 }

android/src/test/java/com/instabug/flutter/InstabugApiTest.java

@@ -132,6 +132,8 @@ public void testSetCurrentPlatform() {
     @Test
     public void testSdkInit() {
         String token = "app-token";
+        String appVariant = "app-variant";
+
         List<String> invocationEvents = Collections.singletonList("InvocationEvent.floatingButton");
         String logLevel = "LogLevel.error";
 
@@ -143,7 +145,7 @@ public void testSdkInit() {
             when(mock.setSdkDebugLogsLevel(anyInt())).thenReturn(mock);
         });
 
-        api.init(token, invocationEvents, logLevel);
+        api.init(token, invocationEvents, logLevel,appVariant);
 
         Instabug.Builder builder = mInstabugBuilder.constructed().get(0);
 
@@ -155,6 +157,8 @@ public void testSdkInit() {
         );
         verify(builder).setInvocationEvents(InstabugInvocationEvent.FLOATING_BUTTON);
         verify(builder).setSdkDebugLogsLevel(LogLevel.ERROR);
+        verify(builder).setAppVariant(appVariant);
+
         verify(builder).build();
 
         // Sets screenshot provider
@@ -652,6 +656,14 @@ public void testSetNetworkLogBodyEnabled() {
         mInstabug.verify(() -> Instabug.setNetworkLogBodyEnabled(true));
     }
 
+    @Test
+    public void testSetAppVariant() {
+        String appVariant = "app-variant";
+        api.setAppVariant(appVariant);
+
+        mInstabug.verify(() -> Instabug.setAppVariant(appVariant));
+    }
+
     @Test
     public void testSetNetworkLogBodyDisabled() {
         api.setNetworkLogBodyEnabled(false);

example/ios/InstabugTests/InstabugApiTests.m

@@ -38,15 +38,22 @@ - (void)testSetEnabled {
 
 - (void)testInit {
     NSString *token = @"app-token";
+    NSString *appVariant = @"app-variant";
+
     NSArray<NSString *> *invocationEvents = @[@"InvocationEvent.floatingButton", @"InvocationEvent.screenshot"];
     NSString *logLevel = @"LogLevel.error";
     FlutterError *error;
 
-    [self.api initToken:token invocationEvents:invocationEvents debugLogsLevel:logLevel error:&error];
+    [self.api initToken:token invocationEvents:invocationEvents debugLogsLevel:logLevel appVariant:appVariant error:&error];
 
     OCMVerify([self.mInstabug setCurrentPlatform:IBGPlatformFlutter]);
+
     OCMVerify([self.mInstabug setSdkDebugLogsLevel:IBGSDKDebugLogsLevelError]);
+
     OCMVerify([self.mInstabug startWithToken:token invocationEvents:(IBGInvocationEventFloatingButton | IBGInvocationEventScreenshot)]);
+    
+    XCTAssertEqual(Instabug.appVariant, appVariant);
+
 }
 
 - (void)testShow {

example/ios/Podfile

@@ -30,7 +30,6 @@ target 'Runner' do
 
   use_frameworks!
   use_modular_headers!
-
   flutter_install_all_ios_pods File.dirname(File.realpath(__FILE__))
 end
 

example/lib/main.dart

@@ -48,10 +48,10 @@ void main() {
       WidgetsFlutterBinding.ensureInitialized();
 
       Instabug.init(
-        token: 'ed6f659591566da19b67857e1b9d40ab',
-        invocationEvents: [InvocationEvent.floatingButton],
-        debugLogsLevel: LogLevel.verbose,
-      );
+          token: 'ed6f659591566da19b67857e1b9d40ab',
+          invocationEvents: [InvocationEvent.floatingButton],
+          debugLogsLevel: LogLevel.verbose,
+          appVariant: 'variant 1');
 
       FlutterError.onError = (FlutterErrorDetails details) {
         Zone.current.handleUncaughtError(details.exception, details.stack!);

ios/Classes/Modules/InstabugApi.m

@@ -29,7 +29,13 @@ - (nullable NSNumber *)isEnabledWithError:(FlutterError * _Nullable __autoreleas
     return @(Instabug.enabled);
 }
 
-- (void)initToken:(NSString *)token invocationEvents:(NSArray<NSString *> *)invocationEvents debugLogsLevel:(NSString *)debugLogsLevel error:(FlutterError *_Nullable *_Nonnull)error {
+- (void)initToken:(nonnull NSString *)token invocationEvents:(nonnull NSArray<NSString *> *)invocationEvents debugLogsLevel:(nonnull NSString *)debugLogsLevel appVariant:(nullable NSString *)appVariant error:(FlutterError * _Nullable __autoreleasing * _Nonnull)error {
+    
+    if(appVariant != nil){
+        Instabug.appVariant = appVariant;
+    }
+
+    
     SEL setPrivateApiSEL = NSSelectorFromString(@"setCurrentPlatform:");
     if ([[Instabug class] respondsToSelector:setPrivateApiSEL]) {
         NSInteger *platformID = IBGPlatformFlutter;
@@ -45,7 +51,8 @@ - (void)initToken:(NSString *)token invocationEvents:(NSArray<NSString *> *)invo
     [IBGNetworkLogger disableAutomaticCapturingOfNetworkLogs];
 
     IBGInvocationEvent resolvedEvents = 0;
-
+    
+   
     for (NSString *event in invocationEvents) {
         resolvedEvents |= (ArgsRegistry.invocationEvents[event]).integerValue;
     }
@@ -396,4 +403,12 @@ - (void)setNetworkLogBodyEnabledIsEnabled:(NSNumber *)isEnabled
     IBGNetworkLogger.logBodyEnabled = [isEnabled boolValue];
 }
 
+
+- (void)setAppVariantAppVariant:(nonnull NSString *)appVariant error:(FlutterError * _Nullable __autoreleasing * _Nonnull)error { 
+
+    Instabug.appVariant = appVariant;
+
+}
+
+
 @end

lib/src/modules/instabug.dart

@@ -11,6 +11,7 @@ import 'dart:typed_data';
 import 'dart:ui';
 
 import 'package:flutter/material.dart';
+
 // to maintain supported versions prior to Flutter 3.3
 // ignore: unused_import
 import 'package:flutter/services.dart';
@@ -179,17 +180,20 @@ class Instabug {
   /// The [token] that identifies the app, you can find it on your dashboard.
   /// The [invocationEvents] are the events that invoke the SDK's UI.
   /// The [debugLogsLevel] used to debug Instabug's SDK.
+  /// The [appVariant] used to set current App variant name.
   static Future<void> init({
     required String token,
     required List<InvocationEvent> invocationEvents,
     LogLevel debugLogsLevel = LogLevel.error,
+    String? appVariant,
   }) async {
     $setup();
     InstabugLogger.I.logLevel = debugLogsLevel;
     await _host.init(
       token,
       invocationEvents.mapToString(),
       debugLogsLevel.toString(),
+      appVariant,
     );
     return FeatureFlagsManager().registerW3CFlagsListener();
   }
@@ -482,4 +486,11 @@ class Instabug {
   static Future<void> willRedirectToStore() async {
     return _host.willRedirectToStore();
   }
+
+  /// This property sets the `appVariant` string to be included in all network requests.
+  ///  It should be set before calling [init] method.
+  /// [appVariant] used to set current App variant name
+  static Future<void> setAppVariant(String appVariant) async {
+    return _host.setAppVariant(appVariant);
+  }
 }

pigeons/instabug.api.dart

@@ -12,39 +12,65 @@ abstract class FeatureFlagsFlutterApi {
 @HostApi()
 abstract class InstabugHostApi {
   void setEnabled(bool isEnabled);
+
   bool isEnabled();
+
   bool isBuilt();
-  void init(String token, List<String> invocationEvents, String debugLogsLevel);
+
+  void init(
+    String token,
+    List<String> invocationEvents,
+    String debugLogsLevel,
+    String? appVariant,
+  );
 
   void show();
+
   void showWelcomeMessageWithMode(String mode);
 
   void identifyUser(String email, String? name, String? userId);
+
   void setUserData(String data);
+
+  void setAppVariant(String appVariant);
+
   void logUserEvent(String name);
+
   void logOut();
 
   void setLocale(String locale);
+
   void setColorTheme(String theme);
+
   void setWelcomeMessageMode(String mode);
+
   void setPrimaryColor(int color);
+
   void setSessionProfilerEnabled(bool enabled);
+
   void setValueForStringWithKey(String value, String key);
 
   void appendTags(List<String> tags);
+
   void resetTags();
 
   @async
   List<String>? getTags();
 
   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);
 
   @async
@@ -58,13 +84,17 @@ abstract class InstabugHostApi {
     String? crashMode,
     String? sessionReplayMode,
   );
+
   void reportScreenChange(String screenName);
 
   void setCustomBrandingImage(String light, String dark);
+
   void setFont(String font);
 
   void addFileAttachmentWithURL(String filePath, String fileName);
+
   void addFileAttachmentWithData(Uint8List data, String fileName);
+
   void clearFileAttachments();
 
   void networkLog(Map<String, Object> data);

test/instabug_test.dart

@@ -84,7 +84,7 @@ void main() {
     );
 
     verify(
-      mHost.init(token, events.mapToString(), LogLevel.error.toString()),
+      mHost.init(token, events.mapToString(), LogLevel.error.toString(), null),
     ).called(1);
   });