Upgrade to Flutter 2 & null safety

Author: guykogus

CHANGELOG.md

@@ -1,3 +1,7 @@
+## master
+
+* Change all `void ... async` methods to `Future<void> ... async` so that callers can use `await`.
+
 ## v9.1.9 (2021-05-11)
 
 * Adds support for overriding the replies notification string values through `repliesNotificationTeamName`, `repliesNotificationReplyButton`, `repliesNotificationDismissButton`
@@ -6,7 +10,6 @@
 ## v9.1.8 (2021-02-17)
 
 * Fixes an issue with iOS invocation events causing the welcome message not to show.
-* Change all `void ... async` methods to `Future<void> ... async` so that callers can use `await`.
 
 ## v9.1.7 (2020-10-01)
 

analysis_options.yaml

@@ -48,10 +48,9 @@ linter:
     - always_put_control_body_on_new_line
     # - always_put_required_named_parameters_first # we prefer having parameters in the same order as fields https://github.com/flutter/flutter/issues/10219
     - always_require_non_null_named_parameters
-    - always_specify_types
+    # - always_specify_types
     - annotate_overrides
     # - avoid_annotating_with_dynamic # conflicts with always_specify_types
-    - avoid_as
     # - avoid_bool_literals_in_conditional_expressions # not yet tested
     # - avoid_catches_without_on_clauses # we do this commonly
     # - avoid_catching_errors # we do this commonly

example/lib/main.dart

@@ -1,4 +1,4 @@
-name: InstabugSample
+name: instabug_sample
 description: A new Flutter project.
 
 # The following line prevents the package from being accidentally published to
@@ -26,11 +26,6 @@ dependencies:
   instabug_flutter:
     path: ../
 
-
-  # The following adds the Cupertino Icons font to your application.
-  # Use with the CupertinoIcons class for iOS style icons.
-  cupertino_icons: ^1.0.0
-
 dev_dependencies:
   flutter_test:
     sdk: flutter

example/pubspec.yaml

@@ -7,8 +7,7 @@
 
 import 'package:flutter/material.dart';
 import 'package:flutter_test/flutter_test.dart';
-
-import 'package:InstabugSample/main.dart';
+import 'package:instabug_sample/main.dart';
 
 void main() {
   testWidgets('Counter increments smoke test', (WidgetTester tester) async {

example/test/widget_test.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: avoid_classes_with_only_static_members
+
 import 'dart:async';
 import 'dart:io' show Platform;
 
@@ -22,24 +24,22 @@ enum ExtendedBugReportMode {
 }
 
 class BugReporting {
-  static Function _onInvokeCallback;
-  static Function _onDismissCallback;
+  static Function? _onInvokeCallback;
+  static Function? _onDismissCallback;
   static const MethodChannel _channel = MethodChannel('instabug_flutter');
 
-  static Future<String> get platformVersion async {
-    final String version = await _channel.invokeMethod('getPlatformVersion');
-    return version;
-  }
+  static Future<String> get platformVersion async =>
+      (await _channel.invokeMethod<String>('getPlatformVersion'))!;
 
   static Future<dynamic> _handleMethod(MethodCall call) async {
     switch (call.method) {
       case 'onInvokeCallback':
-        _onInvokeCallback();
+        _onInvokeCallback?.call();
         return;
       case 'onDismissCallback':
         final Map<dynamic, dynamic> map = call.arguments;
-        DismissType dismissType;
-        ReportType reportType;
+        DismissType? dismissType;
+        ReportType? reportType;
         final String dismissTypeString = map['dismissType'].toUpperCase();
         switch (dismissTypeString) {
           case 'CANCEL':
@@ -65,9 +65,9 @@ class BugReporting {
             break;
         }
         try {
-          _onDismissCallback(dismissType, reportType);
+          _onDismissCallback?.call(dismissType, reportType);
         } catch (exception) {
-          _onDismissCallback();
+          _onDismissCallback?.call();
         }
         return;
     }
@@ -104,14 +104,11 @@ class BugReporting {
   /// Default is set by `Instabug.startWithToken`.
   /// [invocationEvents] invocationEvent List of events that invokes the
   static Future<void> setInvocationEvents(
-      List<InvocationEvent> invocationEvents) async {
-    final List<String> invocationEventsStrings = <String>[];
-    if (invocationEvents != null) {
-      invocationEvents.forEach((e) {
-        invocationEventsStrings.add(e.toString());
-      });
-    }
-    final List<dynamic> params = <dynamic>[invocationEventsStrings];
+      List<InvocationEvent>? invocationEvents) async {
+    final invocationEventsStrings =
+        invocationEvents?.map((e) => e.toString()).toList(growable: false) ??
+            [];
+    final params = <dynamic>[invocationEventsStrings];
     await _channel.invokeMethod<Object>('setInvocationEvents:', params);
   }
 
@@ -137,14 +134,10 @@ class BugReporting {
 
   ///Sets what type of reports, bug or feedback, should be invoked.
   /// [reportTypes] - List of reportTypes
-  static Future<void> setReportTypes(List<ReportType> reportTypes) async {
-    final List<String> reportTypesStrings = <String>[];
-    if (reportTypes != null) {
-      reportTypes.forEach((e) {
-        reportTypesStrings.add(e.toString());
-      });
-    }
-    final List<dynamic> params = <dynamic>[reportTypesStrings];
+  static Future<void> setReportTypes(List<ReportType>? reportTypes) async {
+    final reportTypesStrings =
+        reportTypes?.map((e) => e.toString()).toList(growable: false) ?? [];
+    final params = <dynamic>[reportTypesStrings];
     await _channel.invokeMethod<Object>('setReportTypes:', params);
   }
 
@@ -161,28 +154,22 @@ class BugReporting {
   /// Default is set by `Instabug.startWithToken`.
   /// [invocationOptions] List of invocation options
   static Future<void> setInvocationOptions(
-      List<InvocationOption> invocationOptions) async {
-    final List<String> invocationOptionsStrings = <String>[];
-    if (invocationOptions != null) {
-      invocationOptions.forEach((e) {
-        invocationOptionsStrings.add(e.toString());
-      });
-    }
-    final List<dynamic> params = <dynamic>[invocationOptionsStrings];
+      List<InvocationOption>? invocationOptions) async {
+    final invocationOptionsStrings =
+        invocationOptions?.map((e) => e.toString()).toList(growable: false) ??
+            [];
+    final params = <dynamic>[invocationOptionsStrings];
     await _channel.invokeMethod<Object>('setInvocationOptions:', params);
   }
 
   /// Invoke bug reporting with report type and options.
   /// [reportType] type
   /// [invocationOptions]  List of invocation options
   static Future<void> show(
-      ReportType reportType, List<InvocationOption> invocationOptions) async {
-    final List<String> invocationOptionsStrings = <String>[];
-    if (invocationOptions != null) {
-      invocationOptions.forEach((e) {
-        invocationOptionsStrings.add(e.toString());
-      });
-    }
+      ReportType reportType, List<InvocationOption>? invocationOptions) async {
+    final invocationOptionsStrings =
+        invocationOptions?.map((e) => e.toString()).toList(growable: false) ??
+            [];
     final List<dynamic> params = <dynamic>[
       reportType.toString(),
       invocationOptionsStrings

lib/BugReporting.dart

@@ -1,22 +1,21 @@
+// ignore_for_file: avoid_classes_with_only_static_members
+
 import 'dart:async';
 
 import 'package:flutter/services.dart';
 
 class Chats {
   static const MethodChannel _channel = MethodChannel('instabug_flutter');
 
-  static Future<String> get platformVersion async {
-    final String version = await _channel.invokeMethod('getPlatformVersion');
-    return version;
-  }
+  static Future<String> get platformVersion async =>
+      (await _channel.invokeMethod<String>('getPlatformVersion'))!;
 
   @deprecated
 
   ///Use {@link BugReporting.show} instead.
   ///Manual invocation for chats view.
-  static Future<void> show() async {
-    await _channel.invokeMethod<Object>('showChats');
-  }
+  static Future<void> show() async =>
+      await _channel.invokeMethod<Object>('showChats');
 
   @deprecated
 

lib/Chats.dart

@@ -1,6 +1,8 @@
+// ignore_for_file: avoid_classes_with_only_static_members
+
 import 'dart:async';
 import 'dart:convert';
-import 'dart:io' show Platform, exit;
+import 'dart:io' show Platform;
 
 import 'package:flutter/foundation.dart';
 import 'package:flutter/services.dart';
@@ -11,10 +13,8 @@ import 'package:stack_trace/stack_trace.dart';
 class CrashReporting {
   static const MethodChannel _channel = MethodChannel('instabug_flutter');
   static bool enabled = true;
-  static Future<String> get platformVersion async {
-    final String version = await _channel.invokeMethod('getPlatformVersion');
-    return version;
-  }
+  static Future<String> get platformVersion async =>
+      (await _channel.invokeMethod<String>('getPlatformVersion'))!;
 
   ///Enables and disables Enables and disables automatic crash reporting.
   /// [boolean] isEnabled
@@ -37,7 +37,7 @@ class CrashReporting {
   /// [dynamic] exception
   /// [StackTrace] stack
   static Future<void> reportHandledCrash(dynamic exception,
-      [StackTrace stack]) async {
+      [StackTrace? stack]) async {
     if (stack != null) {
       _sendCrash(exception, stack, true);
     } else {
@@ -57,9 +57,9 @@ class CrashReporting {
     for (int i = 0; i < trace.frames.length; i++) {
       frames.add(ExceptionData(
           trace.frames[i].uri.toString(),
-          trace.frames[i].member,
-          trace.frames[i].line,
-          trace.frames[i].column == null ? 0 : trace.frames[i].column));
+          trace.frames[i].member!,
+          trace.frames[i].line!,
+          trace.frames[i].column == null ? 0 : trace.frames[i].column!));
     }
     final CrashData crashData = CrashData(
         exception.toString(), Platform.operatingSystem.toString(), frames);

lib/CrashReporting.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: avoid_classes_with_only_static_members
+
 import 'dart:async';
 
 import 'package:flutter/services.dart';
@@ -7,10 +9,8 @@ enum ActionType { requestNewFeature, addCommentToFeature }
 class FeatureRequests {
   static const MethodChannel _channel = MethodChannel('instabug_flutter');
 
-  static Future<String> get platformVersion async {
-    final String version = await _channel.invokeMethod('getPlatformVersion');
-    return version;
-  }
+  static Future<String> get platformVersion async =>
+      (await _channel.invokeMethod<String>('getPlatformVersion'))!;
 
   ///Shows the UI for feature requests list
   static Future<void> show() async {
@@ -23,17 +23,10 @@ class FeatureRequests {
   /// field is required or not.
   /// [actionTypes] An enum that indicates which action types will have the isEmailFieldRequired
   static Future<void> setEmailFieldRequired(
-      bool isEmailFieldRequired, List<ActionType> actionTypes) async {
-    final List<String> actionTypesStrings = <String>[];
-    if (actionTypes != null) {
-      actionTypes.forEach((e) {
-        actionTypesStrings.add(e.toString());
-      });
-    }
-    final List<dynamic> params = <dynamic>[
-      isEmailFieldRequired,
-      actionTypesStrings
-    ];
+      bool isEmailFieldRequired, List<ActionType>? actionTypes) async {
+    final actionTypesStrings =
+        actionTypes?.map((e) => e.toString()).toList(growable: false) ?? [];
+    final params = <dynamic>[isEmailFieldRequired, actionTypesStrings];
     await _channel.invokeMethod<Object>(
         'setEmailFieldRequiredForFeatureRequests:forAction:', params);
   }

lib/FeatureRequests.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: avoid_classes_with_only_static_members
+
 import 'dart:async';
 import 'dart:io' show Platform;
 import 'dart:typed_data';
@@ -88,10 +90,8 @@ enum ReproStepsMode { enabled, disabled, enabledWithNoScreenshots }
 class Instabug {
   static const MethodChannel _channel = MethodChannel('instabug_flutter');
 
-  static Future<String> get platformVersion async {
-    final String version = await _channel.invokeMethod('getPlatformVersion');
-    return version;
-  }
+  static Future<String> get platformVersion async =>
+      (await _channel.invokeMethod<String>('getPlatformVersion'))!;
 
   /// Starts the SDK.
   /// This is the main SDK method that does all the magic. This is the only
@@ -102,10 +102,8 @@ class Instabug {
   /// the SDK's UI.
   static Future<void> start(
       String token, List<InvocationEvent> invocationEvents) async {
-    final List<String> invocationEventsStrings = <String>[];
-    invocationEvents.forEach((e) {
-      invocationEventsStrings.add(e.toString());
-    });
+    final List<String> invocationEventsStrings =
+        invocationEvents.map((e) => e.toString()).toList(growable: false);
     final List<dynamic> params = <dynamic>[token, invocationEventsStrings];
     await _channel.invokeMethod<Object>(
         'startWithToken:invocationEvents:', params);
@@ -123,7 +121,7 @@ class Instabug {
   /// and set the user's [name] to be included with all reports.
   /// It also reset the chats on device to that email and removes user attributes,
   /// user data and completed surveys.
-  static Future<void> identifyUser(String email, [String name]) async {
+  static Future<void> identifyUser(String email, [String? name]) async {
     final List<dynamic> params = <dynamic>[email, name];
     await _channel.invokeMethod<Object>('identifyUserWithEmail:name:', params);
   }
@@ -162,9 +160,9 @@ class Instabug {
   }
 
   /// Gets all tags of reported feedback, bug or crash. Returns the list of tags.
-  static Future<List<String>> getTags() async {
-    final List<dynamic> tags = await _channel.invokeMethod<Object>('getTags');
-    return tags != null ? tags.cast<String>() : null;
+  static Future<List<String>?> getTags() async {
+    final tags = await _channel.invokeMethod<List<dynamic>>('getTags');
+    return tags?.cast<String>();
   }
 
   /// Add custom user attribute [value] with a [key] that is going to be sent with each feedback, bug or crash.
@@ -181,16 +179,16 @@ class Instabug {
   }
 
   /// Returns the user attribute associated with a given [key].
-  static Future<String> getUserAttributeForKey(String key) async {
+  static Future<String?> getUserAttributeForKey(String key) async {
     final List<dynamic> params = <dynamic>[key];
-    return await _channel.invokeMethod<Object>(
+    return await _channel.invokeMethod<String>(
         'getUserAttributeForKey:', params);
   }
 
   /// A new Map containing all the currently set user attributes, or an empty Map if no user attributes have been set.
   static Future<Map<String, String>> getUserAttributes() async {
-    final Object userAttributes =
-        await _channel.invokeMethod<Object>('getUserAttributes');
+    final userAttributes =
+        await _channel.invokeMethod<Map<dynamic, dynamic>>('getUserAttributes');
     return userAttributes != null
         ? Map<String, String>.from(userAttributes)
         : <String, String>{};

lib/Instabug.dart

@@ -1,14 +1,14 @@
+// ignore_for_file: avoid_classes_with_only_static_members
+
 import 'dart:async';
 
 import 'package:flutter/services.dart';
 
 class InstabugLog {
   static const MethodChannel _channel = MethodChannel('instabug_flutter');
 
-  static Future<String> get platformVersion async {
-    final String version = await _channel.invokeMethod('getPlatformVersion');
-    return version;
-  }
+  static Future<String> get platformVersion async =>
+      (await _channel.invokeMethod<String>('getPlatformVersion'))!;
 
   /// Appends a log [message] to Instabug internal log
   /// These logs are then sent along the next uploaded report.