Replace PlatformManager with IBGBuildInfo (#229)

* itReplace `PlatformManager` with `InstaBuildInfo`

* Rename to `IBGBuildInfo`

Author: TheBuggedYRN

lib/APM.dart

@@ -1,11 +1,11 @@
 // ignore_for_file: avoid_classes_with_only_static_members
 
 import 'dart:async';
-import 'dart:io';
 
 import 'package:flutter/services.dart';
 import 'package:instabug_flutter/models/network_data.dart';
 import 'package:instabug_flutter/models/trace.dart';
+import 'package:instabug_flutter/utils/ibg_build_info.dart';
 import 'package:instabug_flutter/utils/ibg_date_time.dart';
 
 enum LogLevel {
@@ -110,7 +110,7 @@ class APM {
   }
 
   static Future<bool?> networkLogAndroid(NetworkData data) async {
-    if (Platform.isAndroid) {
+    if (IBGBuildInfo.instance.isAndroid) {
       final params = <dynamic>[data.toMap()];
       return await _channel.invokeMethod<bool>(
           'apmNetworkLogByReflection:', params);

lib/BugReporting.dart

@@ -4,7 +4,7 @@ import 'dart:async';
 
 import 'package:flutter/services.dart';
 import 'package:instabug_flutter/Instabug.dart';
-import 'package:instabug_flutter/utils/platform_manager.dart';
+import 'package:instabug_flutter/utils/ibg_build_info.dart';
 
 enum InvocationOption {
   commentFieldRequired,
@@ -183,7 +183,7 @@ class BugReporting {
   /// [iPhoneShakingThreshold] iPhoneShakingThreshold double
   static Future<void> setShakingThresholdForiPhone(
       double iPhoneShakingThreshold) async {
-    if (PlatformManager.instance.isIOS()) {
+    if (IBGBuildInfo.instance.isIOS) {
       final List<dynamic> params = <dynamic>[iPhoneShakingThreshold];
       await _channel.invokeMethod<Object>(
           'setShakingThresholdForiPhone:', params);
@@ -195,7 +195,7 @@ class BugReporting {
   /// [iPadShakingThreshold] iPhoneShakingThreshold double
   static Future<void> setShakingThresholdForiPad(
       double iPadShakingThreshold) async {
-    if (PlatformManager.instance.isIOS()) {
+    if (IBGBuildInfo.instance.isIOS) {
       final List<dynamic> params = <dynamic>[iPadShakingThreshold];
       await _channel.invokeMethod<Object>(
           'setShakingThresholdForiPad:', params);
@@ -209,7 +209,7 @@ class BugReporting {
   /// [androidThreshold] iPhoneShakingThreshold int
   static Future<void> setShakingThresholdForAndroid(
       int androidThreshold) async {
-    if (PlatformManager.instance.isAndroid()) {
+    if (IBGBuildInfo.instance.isAndroid) {
       final List<dynamic> params = <dynamic>[androidThreshold];
       await _channel.invokeMethod<Object>(
           'setShakingThresholdForAndroid:', params);

lib/CrashReporting.dart

@@ -2,12 +2,12 @@
 
 import 'dart:async';
 import 'dart:convert';
-import 'dart:io' show Platform;
 
 import 'package:flutter/foundation.dart';
 import 'package:flutter/services.dart';
 import 'package:instabug_flutter/models/crash_data.dart';
 import 'package:instabug_flutter/models/exception_data.dart';
+import 'package:instabug_flutter/utils/ibg_build_info.dart';
 import 'package:stack_trace/stack_trace.dart';
 
 class CrashReporting {
@@ -25,7 +25,7 @@ class CrashReporting {
   }
 
   static Future<void> reportCrash(dynamic exception, StackTrace stack) async {
-    if (kReleaseMode && enabled) {
+    if (IBGBuildInfo.instance.isReleaseMode && enabled) {
       await _reportUnhandledCrash(exception, stack);
     } else {
       FlutterError.dumpErrorToConsole(
@@ -58,7 +58,10 @@ class CrashReporting {
           trace.frames[i].column ?? 0));
     }
     final CrashData crashData = CrashData(
-        exception.toString(), Platform.operatingSystem.toString(), frames);
+      exception.toString(),
+      IBGBuildInfo.instance.operatingSystem,
+      frames,
+    );
     final List<dynamic> params = <dynamic>[jsonEncode(crashData), handled];
     await _channel.invokeMethod<Object>(
         'sendJSCrashByReflection:handled:', params);

lib/Instabug.dart

@@ -1,12 +1,11 @@
 // ignore_for_file: avoid_classes_with_only_static_members
 
 import 'dart:async';
-import 'dart:io' show Platform;
 import 'dart:typed_data';
 import 'dart:ui';
 
 import 'package:flutter/services.dart';
-import 'package:instabug_flutter/utils/platform_manager.dart';
+import 'package:instabug_flutter/utils/ibg_build_info.dart';
 
 enum InvocationEvent {
   shake,
@@ -250,7 +249,7 @@ class Instabug {
   /// Enable/disable SDK logs
   /// [debugEnabled] desired state of debug mode.
   static Future<void> setDebugEnabled(bool debugEnabled) async {
-    if (PlatformManager.instance.isAndroid()) {
+    if (IBGBuildInfo.instance.isAndroid) {
       final List<dynamic> params = <dynamic>[debugEnabled];
       await _channel.invokeMethod<Object>('setDebugEnabled:', params);
     }
@@ -276,7 +275,7 @@ class Instabug {
   ///[fileName] of the file
   static Future<void> addFileAttachmentWithURL(
       String filePath, String fileName) async {
-    if (Platform.isIOS) {
+    if (IBGBuildInfo.instance.isIOS) {
       final List<dynamic> params = <dynamic>[filePath];
       await _channel.invokeMethod<Object>('addFileAttachmentWithURL:', params);
     } else {
@@ -290,7 +289,7 @@ class Instabug {
   ///[fileName] of the file
   static Future<void> addFileAttachmentWithData(
       Uint8List data, String fileName) async {
-    if (Platform.isIOS) {
+    if (IBGBuildInfo.instance.isIOS) {
       final List<dynamic> params = <dynamic>[data];
       await _channel.invokeMethod<Object>('addFileAttachmentWithData:', params);
     } else {
@@ -330,15 +329,15 @@ class Instabug {
   ///Android Only
   ///Enables all Instabug functionality
   static Future<void> enableAndroid() async {
-    if (Platform.isAndroid) {
+    if (IBGBuildInfo.instance.isAndroid) {
       await _channel.invokeMethod<Object>('enable:');
     }
   }
 
   ///Android Only
   ///Disables all Instabug functionality
   static Future<void> disableAndroid() async {
-    if (Platform.isAndroid) {
+    if (IBGBuildInfo.instance.isAndroid) {
       await _channel.invokeMethod<Object>('disable:');
     }
   }

lib/Replies.dart

@@ -3,7 +3,7 @@
 import 'dart:async';
 
 import 'package:flutter/services.dart';
-import 'package:instabug_flutter/utils/platform_manager.dart';
+import 'package:instabug_flutter/utils/ibg_build_info.dart';
 
 class Replies {
   static Function? _hasChatsCallback;
@@ -78,7 +78,7 @@ class Replies {
   /// [isEnabled] A boolean to set whether notifications sound should be played.
   /// @android ONLY
   static Future<void> setInAppNotificationSound(bool isEnabled) async {
-    if (PlatformManager.instance.isAndroid()) {
+    if (IBGBuildInfo.instance.isAndroid) {
       final List<dynamic> params = <dynamic>[isEnabled];
       await _channel.invokeMethod<Object>(
           'setEnableInAppNotificationSound:', params);

lib/Surveys.dart

@@ -3,7 +3,7 @@
 import 'dart:async';
 
 import 'package:flutter/services.dart';
-import 'package:instabug_flutter/utils/platform_manager.dart';
+import 'package:instabug_flutter/utils/ibg_build_info.dart';
 
 class Surveys {
   static Function? _onShowCallback;
@@ -131,7 +131,7 @@ class Surveys {
   /// NPS Surveys or AppRating Surveys to AppStore to let users rate your app on AppStore itself.
   /// [appStoreURL] A String url for the published iOS app on AppStore
   static Future<void> setAppStoreURL(String appStoreURL) async {
-    if (PlatformManager.instance.isIOS()) {
+    if (IBGBuildInfo.instance.isIOS) {
       final List<dynamic> params = <dynamic>[appStoreURL];
       await _channel.invokeMethod<Object>('setAppStoreURL:', params);
     }

lib/utils/ibg_build_info.dart

@@ -0,0 +1,28 @@
+import 'dart:io';
+
+import 'package:flutter/foundation.dart';
+
+/// Mockable class that contains info about the
+/// [Platform], the OS and build modes.
+class IBGBuildInfo {
+  IBGBuildInfo._();
+
+  static IBGBuildInfo _instance = IBGBuildInfo._();
+  static IBGBuildInfo get instance => _instance;
+
+  /// Shorthand for [instance]
+  static IBGBuildInfo get I => instance;
+
+  @visibleForTesting
+  static void setInstance(IBGBuildInfo instance) {
+    _instance = instance;
+  }
+
+  bool get isAndroid => Platform.isAndroid;
+  bool get isIOS => Platform.isIOS;
+
+  String get operatingSystem => Platform.operatingSystem;
+
+  bool get isReleaseMode => kReleaseMode;
+  bool get isDebugMode => kDebugMode;
+}

lib/utils/platform_manager.dart

@@ -1,7 +1,5 @@
 import 'dart:convert';
-import 'dart:io';
 import 'dart:typed_data';
-import 'dart:ui';
 
 import 'package:flutter/cupertino.dart';
 import 'package:flutter/services.dart';
@@ -19,16 +17,16 @@ import 'package:instabug_flutter/models/crash_data.dart';
 import 'package:instabug_flutter/models/exception_data.dart';
 import 'package:instabug_flutter/models/network_data.dart';
 import 'package:instabug_flutter/models/trace.dart' as execution_trace;
+import 'package:instabug_flutter/utils/ibg_build_info.dart';
 import 'package:instabug_flutter/utils/ibg_date_time.dart';
-import 'package:instabug_flutter/utils/platform_manager.dart';
 import 'package:mockito/annotations.dart';
 import 'package:mockito/mockito.dart';
 import 'package:stack_trace/stack_trace.dart';
 
 import 'instabug_flutter_test.mocks.dart';
 
 @GenerateMocks([
-  PlatformManager,
+  IBGBuildInfo,
   IBGDateTime,
 ])
 void main() {
@@ -46,7 +44,7 @@ void main() {
   const Map<String, String> userAttributePair = <String, String>{
     'gender': 'female'
   };
-  late MockPlatformManager mockPlatform;
+  late MockIBGBuildInfo mockBuildInfo;
 
   const String url = 'https://jsonplaceholder.typicode.com';
   const String method = 'POST';
@@ -98,8 +96,8 @@ void main() {
   });
 
   setUp(() {
-    mockPlatform = MockPlatformManager();
-    PlatformManager.setPlatformInstance(mockPlatform);
+    mockBuildInfo = MockIBGBuildInfo();
+    IBGBuildInfo.setInstance(mockBuildInfo);
   });
 
   tearDown(() async {
@@ -419,7 +417,7 @@ void main() {
   });
 
   test('setDebugEnabled: Test', () async {
-    when(mockPlatform.isAndroid()).thenAnswer((_) => true);
+    when(mockBuildInfo.isAndroid).thenReturn(true);
 
     const bool debugEnabled = true;
     final List<dynamic> args = <dynamic>[debugEnabled];
@@ -460,7 +458,10 @@ void main() {
     const filePath = 'filePath';
     const fileName = 'fileName';
     final List<dynamic> args = <dynamic>[filePath, fileName];
+
+    when(mockBuildInfo.isIOS).thenReturn(false);
     await Instabug.addFileAttachmentWithURL(filePath, fileName);
+
     expect(log, <Matcher>[
       isMethodCall(
         'addFileAttachmentWithURL:',
@@ -473,7 +474,10 @@ void main() {
     final bdata = Uint8List(10);
     const fileName = 'fileName';
     final List<dynamic> args = <dynamic>[bdata, fileName];
+
+    when(mockBuildInfo.isIOS).thenReturn(false);
     await Instabug.addFileAttachmentWithData(bdata, fileName);
+    
     expect(log, <Matcher>[
       isMethodCall(
         'addFileAttachmentWithData:',
@@ -542,7 +546,7 @@ void main() {
     const iPhoneShakingThreshold = 1.6;
     final List<dynamic> args = <dynamic>[iPhoneShakingThreshold];
 
-    when(mockPlatform.isIOS()).thenAnswer((_) => true);
+    when(mockBuildInfo.isIOS).thenReturn(true);
 
     await BugReporting.setShakingThresholdForiPhone(iPhoneShakingThreshold);
     expect(log, <Matcher>[
@@ -557,7 +561,7 @@ void main() {
     const iPadShakingThreshold = 1.6;
     final List<dynamic> args = <dynamic>[iPadShakingThreshold];
 
-    when(mockPlatform.isIOS()).thenAnswer((_) => true);
+    when(mockBuildInfo.isIOS).thenReturn(true);
 
     await BugReporting.setShakingThresholdForiPad(iPadShakingThreshold);
     expect(log, <Matcher>[
@@ -572,7 +576,7 @@ void main() {
     const androidThreshold = 1000;
     final List<dynamic> args = <dynamic>[androidThreshold];
 
-    when(mockPlatform.isAndroid()).thenAnswer((_) => true);
+    when(mockBuildInfo.isAndroid).thenReturn(true);
 
     await BugReporting.setShakingThresholdForAndroid(androidThreshold);
     expect(log, <Matcher>[
@@ -814,7 +818,7 @@ void main() {
     const appStoreURL = 'appStoreURL';
     final List<dynamic> args = <dynamic>[appStoreURL];
 
-    when(mockPlatform.isIOS()).thenAnswer((_) => true);
+    when(mockBuildInfo.isIOS).thenReturn(true);
 
     await Surveys.setAppStoreURL(appStoreURL);
     expect(log, <Matcher>[
@@ -863,7 +867,7 @@ void main() {
     const isEnabled = false;
     final List<dynamic> args = <dynamic>[isEnabled];
 
-    when(mockPlatform.isAndroid()).thenAnswer((_) => true);
+    when(mockBuildInfo.isAndroid).thenReturn(true);
 
     await Replies.setInAppNotificationSound(isEnabled);
     expect(log, <Matcher>[
@@ -914,7 +918,10 @@ void main() {
         NetworkData(method: 'method', url: 'url', startTime: DateTime.now());
     final List<dynamic> args = <dynamic>[data.toMap()];
     final networkLogger = NetworkLogger();
+
+    when(mockBuildInfo.isAndroid).thenReturn(false);
     await networkLogger.networkLog(data);
+
     expect(log, <Matcher>[
       isMethodCall(
         'networkLog:',
@@ -950,8 +957,12 @@ void main() {
             trace.frames[i].line,
             trace.frames[i].column == null ? 0 : trace.frames[i].column!));
       }
+      when(mockBuildInfo.operatingSystem).thenReturn('test');
       final crashData = CrashData(
-          exception.toString(), Platform.operatingSystem.toString(), frames);
+        exception.toString(),
+        IBGBuildInfo.instance.operatingSystem,
+        frames,
+      );
       final List<dynamic> args = <dynamic>[jsonEncode(crashData), handled];
       await CrashReporting.reportHandledCrash(exception, stack);
       expect(log, <Matcher>[