Merge pull request #496 from Instabug/dev

Author: mzelzoghbi

CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## [13.3.0](https://github.com/Instabug/Instabug-Flutter/compare/v13.2.0...v13.3.0) (August 5, 2024)
+
+### 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)).
+
+### Changed
+
+- Bump Instabug Android SDK to v13.3.0 ([#492](https://github.com/Instabug/Instabug-Flutter/pull/492)). [See release notes](https://github.com/Instabug/Instabug-Android/releases/tag/v13.3.0).
+- Bump Instabug iOS SDK to v13.3.0 ([#493](https://github.com/Instabug/Instabug-Flutter/pull/493)). [See release notes](https://github.com/Instabug/Instabug-iOS/releases/tag/13.3.0).
+
+### 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)).
+
+### Fixed
+
+- Fix APM network logging on Android ([#491](https://github.com/Instabug/Instabug-Flutter/pull/491)).
+
 ## [13.2.0](https://github.com/Instabug/Instabug-Flutter/compare/v13.1.1...v13.2.0)
 
 ### Added
@@ -159,18 +178,18 @@
 
   Below is a list of all the affected APIs:
 
-    - `APM.startExecutionTrace`
-    - `BugReporting.setOnInvokeCallback`
-    - `BugReporting.setOnDismissCallback`
-    - `Instabug.getTags`
-    - `Instabug.getUserAttributeForKey`
-    - `Instabug.getUserAttributes`
-    - `Replies.getUnreadRepliesCount`
-    - `Replies.hasChats`
-    - `Replies.setOnNewReplyReceivedCallback`
-    - `Surveys.hasRespondToSurvey`
-    - `Surveys.setOnShowCallback`
-    - `Surveys.setOnDismissCallback`
+  - `APM.startExecutionTrace`
+  - `BugReporting.setOnInvokeCallback`
+  - `BugReporting.setOnDismissCallback`
+  - `Instabug.getTags`
+  - `Instabug.getUserAttributeForKey`
+  - `Instabug.getUserAttributes`
+  - `Replies.getUnreadRepliesCount`
+  - `Replies.hasChats`
+  - `Replies.setOnNewReplyReceivedCallback`
+  - `Surveys.hasRespondToSurvey`
+  - `Surveys.setOnShowCallback`
+  - `Surveys.setOnDismissCallback`
 
 ## [11.12.0](https://github.com/Instabug/Instabug-Flutter/compare/v11.10.1...v11.12.0) (May 30, 2023)
 
@@ -247,10 +266,10 @@
 - Deprecates Instabug.enableAndroid and Instabug.disableAndroid APIs in favour of the new API
   Instabug.setEnabled, which works on both platforms
 - Deprecates callbacks in favor of return values in the following APIs:
-    1. Replies.getUnreadRepliesCount
-    2. Replies.hasChats
-    3. Surveys.hasRespondedToSurvey
-    4. Surveys.getAvailableSurveys
+  1. Replies.getUnreadRepliesCount
+  2. Replies.hasChats
+  3. Surveys.hasRespondedToSurvey
+  4. Surveys.getAvailableSurveys
 
 ## 11.3.0 (2022-09-30)
 

android/build.gradle

@@ -1,5 +1,5 @@
 group 'com.instabug.flutter'
-version '13.2.0'
+version '13.3.0'
 
 buildscript {
     repositories {
@@ -41,7 +41,7 @@ android {
 }
 
 dependencies {
-    api 'com.instabug.library:instabug:13.2.0'
+    api 'com.instabug.library:instabug:13.3.0'
 
     testImplementation 'junit:junit:4.13.2'
     testImplementation "org.mockito:mockito-inline:3.12.1"

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

@@ -14,6 +14,7 @@
 import com.instabug.flutter.generated.ApmPigeon;
 import com.instabug.flutter.util.Reflection;
 import com.instabug.flutter.util.ThreadManager;
+import com.instabug.apm.networkinterception.cp.APMCPNetworkLog;
 
 import io.flutter.plugin.common.BinaryMessenger;
 
@@ -210,9 +211,9 @@ public void networkLogAndroid(@NonNull Map<String, Object> data) {
                 serverErrorMessage = (String) data.get("serverErrorMessage");
             }
 
-            Method method = Reflection.getMethod(Class.forName("com.instabug.apm.networking.APMNetworkLogger"), "log", long.class, long.class, String.class, String.class, long.class, String.class, String.class, String.class, String.class, String.class, long.class, int.class, String.class, String.class, String.class, String.class);
+            Method method = Reflection.getMethod(Class.forName("com.instabug.apm.networking.APMNetworkLogger"), "log", long.class, long.class, String.class, String.class, long.class, String.class, String.class, String.class, String.class, String.class, long.class, int.class, String.class, String.class, String.class, String.class, APMCPNetworkLog.W3CExternalTraceAttributes.class);
             if (method != null) {
-                method.invoke(apmNetworkLogger, requestStartTime, requestDuration, requestHeaders, requestBody, requestBodySize, requestMethod, requestUrl, requestContentType, responseHeaders, responseBody, responseBodySize, statusCode, responseContentType, errorMessage, gqlQueryName, serverErrorMessage);
+                method.invoke(apmNetworkLogger, requestStartTime, requestDuration, requestHeaders, requestBody, requestBodySize, requestMethod, requestUrl, requestContentType, responseHeaders, responseBody, responseBodySize, statusCode, responseContentType, errorMessage, gqlQueryName, serverErrorMessage, null);
             } else {
                 Log.e(TAG, "APMNetworkLogger.log was not found by reflection");
             }

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);

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

@@ -262,7 +262,8 @@ public void testNetworkLogAndroid() {
                 responseContentType,
                 errorDomain,
                 null,
-                serverErrorMessage
+                serverErrorMessage,
+                null
         ));
 
         mAPMNetworkLogger.close();

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

@@ -35,6 +35,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;
@@ -48,6 +49,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;
@@ -345,6 +347,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";

android/src/test/java/com/instabug/flutter/util/GlobalMocks.java

@@ -8,6 +8,7 @@
 import android.net.Uri;
 import android.util.Log;
 
+import com.instabug.apm.networkinterception.cp.APMCPNetworkLog;
 import com.instabug.crash.models.IBGNonFatalException;
 
 import org.json.JSONObject;
@@ -69,10 +70,10 @@ public static void setUp() throws NoSuchMethodException {
                 .when(() -> Reflection.getMethod(Class.forName("com.instabug.library.Instabug"), "setCurrentPlatform", int.class))
                 .thenReturn(mSetCurrentPlatform);
 
-        Method mAPMNetworkLog = MockReflected.class.getDeclaredMethod("apmNetworkLog", long.class, long.class, String.class, String.class, long.class, String.class, String.class, String.class, String.class, String.class, long.class, int.class, String.class, String.class, String.class, String.class);
+        Method mAPMNetworkLog = MockReflected.class.getDeclaredMethod("apmNetworkLog", long.class, long.class, String.class, String.class, long.class, String.class, String.class, String.class, String.class, String.class, long.class, int.class, String.class, String.class, String.class, String.class, APMCPNetworkLog.W3CExternalTraceAttributes.class);
         mAPMNetworkLog.setAccessible(true);
         reflection
-                .when(() -> Reflection.getMethod(Class.forName("com.instabug.apm.networking.APMNetworkLogger"), "log", long.class, long.class, String.class, String.class, long.class, String.class, String.class, String.class, String.class, String.class, long.class, int.class, String.class, String.class, String.class, String.class))
+                .when(() -> Reflection.getMethod(Class.forName("com.instabug.apm.networking.APMNetworkLogger"), "log", long.class, long.class, String.class, String.class, long.class, String.class, String.class, String.class, String.class, String.class, long.class, int.class, String.class, String.class, String.class, String.class, APMCPNetworkLog.W3CExternalTraceAttributes.class))
                 .thenReturn(mAPMNetworkLog);
 
         Method mCrashReportException = MockReflected.class.getDeclaredMethod("crashReportException", JSONObject.class, boolean.class);

android/src/test/java/com/instabug/flutter/util/MockReflected.java

@@ -3,6 +3,7 @@
 import android.graphics.Bitmap;
 import androidx.annotation.Nullable;
 
+import com.instabug.apm.networkinterception.cp.APMCPNetworkLog;
 import com.instabug.crash.models.IBGNonFatalException;
 
 import org.json.JSONObject;
@@ -33,7 +34,7 @@ public static void setCurrentPlatform(int platform) {}
     /**
      * APMNetworkLogger.log
      */
-    public static void apmNetworkLog(long requestStartTime, long requestDuration, String requestHeaders, String requestBody, long requestBodySize, String requestMethod, String requestUrl, String responseHeaders, String responseBody, String responseBodySize, long statusCode, int responseContentType, String errorMessage, String var18, @Nullable String gqlQueryName, @Nullable String serverErrorMessage) {}
+    public static void apmNetworkLog(long requestStartTime, long requestDuration, String requestHeaders, String requestBody, long requestBodySize, String requestMethod, String requestUrl, String responseHeaders, String responseBody, String responseBodySize, long statusCode, int responseContentType, String errorMessage, String var18, @Nullable String gqlQueryName, @Nullable String serverErrorMessage, @Nullable APMCPNetworkLog.W3CExternalTraceAttributes w3CExternalTraceAttributes) {}
 
     /**
      * CrashReporting.reportException

example/ios/InstabugTests/InstabugApiTests.m

@@ -224,6 +224,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";

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'