Merge pull request #180 from guykogus/nnbd

Dart 2 & null safety

Author: Ali Abdelfattah

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`

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

@@ -39,10 +39,12 @@ - (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
           const char *type = [signature methodReturnType];
 
           if (strcmp(type, "v") != 0) {
-              void *returnVal;
+            void *returnVal;
             [inv getReturnValue:&returnVal];
             NSObject *resultSet = (__bridge NSObject *)returnVal;
             result(resultSet);
+          } else {
+            result(nil);
           }
       }
     if (!isImplemented) {

ios/Classes/InstabugFlutterPlugin.m

@@ -1,5 +1,8 @@
+// ignore_for_file: avoid_classes_with_only_static_members
+
 import 'dart:async';
 import 'dart:io' show Platform;
+
 import 'package:flutter/services.dart';
 import 'package:instabug_flutter/Instabug.dart';
 
@@ -21,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':
@@ -64,17 +65,17 @@ class BugReporting {
             break;
         }
         try {
-          _onDismissCallback(dismissType, reportType);
+          _onDismissCallback?.call(dismissType, reportType);
         } catch (exception) {
-          _onDismissCallback();
+          _onDismissCallback?.call();
         }
         return;
     }
   }
 
   ///Enables and disables manual invocation and prompt options for bug and feedback.
   /// [boolean] isEnabled
-  static void setEnabled(bool isEnabled) async {
+  static Future<void> setEnabled(bool isEnabled) async {
     final List<dynamic> params = <dynamic>[isEnabled];
     await _channel.invokeMethod<Object>('setBugReportingEnabled:', params);
   }
@@ -83,7 +84,7 @@ class BugReporting {
   /// This block is executed on the UI thread. Could be used for performing any
   /// UI changes before the SDK's UI is shown.
   /// [function]  A callback that gets executed before invoking the SDK
-  static void setOnInvokeCallback(Function function) async {
+  static Future<void> setOnInvokeCallback(Function function) async {
     _channel.setMethodCallHandler(_handleMethod);
     _onInvokeCallback = function;
     await _channel.invokeMethod<Object>('setOnInvokeCallback');
@@ -93,7 +94,7 @@ class BugReporting {
   /// This block is executed on the UI thread. Could be used for performing any
   /// UI changes before the SDK's UI is shown.
   /// [function]  A callback that gets executed before invoking the SDK
-  static void setOnDismissCallback(Function function) async {
+  static Future<void> setOnDismissCallback(Function function) async {
     _channel.setMethodCallHandler(_handleMethod);
     _onDismissCallback = function;
     await _channel.invokeMethod<Object>('setOnDismissCallback');
@@ -102,15 +103,12 @@ class BugReporting {
   /// Sets the events that invoke the feedback form.
   /// Default is set by `Instabug.startWithToken`.
   /// [invocationEvents] invocationEvent List of events that invokes the
-  static 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];
+  static Future<void> setInvocationEvents(
+      List<InvocationEvent>? invocationEvents) async {
+    final invocationEventsStrings =
+        invocationEvents?.map((e) => e.toString()).toList(growable: false) ??
+            [];
+    final params = <dynamic>[invocationEventsStrings];
     await _channel.invokeMethod<Object>('setInvocationEvents:', params);
   }
 
@@ -121,8 +119,8 @@ class BugReporting {
   /// attachments. In iOS 10+,NSPhotoLibraryUsageDescription should be set in
   /// info.plist to enable gallery image attachments.
   /// [screenRecording] A boolean to enable or disable screen recording attachments.
-  static void setEnabledAttachmentTypes(bool screenshot, bool extraScreenshot,
-      bool galleryImage, bool screenRecording) async {
+  static Future<void> setEnabledAttachmentTypes(bool screenshot,
+      bool extraScreenshot, bool galleryImage, bool screenRecording) async {
     final List<dynamic> params = <dynamic>[
       screenshot,
       extraScreenshot,
@@ -136,21 +134,17 @@ class BugReporting {
 
   ///Sets what type of reports, bug or feedback, should be invoked.
   /// [reportTypes] - List of reportTypes
-  static 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);
   }
 
   /// Sets whether the extended bug report mode should be disabled, enabled with
   /// required fields or enabled with optional fields.
   /// [extendedBugReportMode] ExtendedBugReportMode enum
-  static void setExtendedBugReportMode(
+  static Future<void> setExtendedBugReportMode(
       ExtendedBugReportMode extendedBugReportMode) async {
     final List<dynamic> params = <dynamic>[extendedBugReportMode.toString()];
     await _channel.invokeMethod<Object>('setExtendedBugReportMode:', params);
@@ -159,29 +153,23 @@ class BugReporting {
   /// Sets the invocation options.
   /// Default is set by `Instabug.startWithToken`.
   /// [invocationOptions] List of invocation options
-  static 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];
+  static Future<void> setInvocationOptions(
+      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 void show(
-      ReportType reportType, List<InvocationOption> invocationOptions) async {
-    final List<String> invocationOptionsStrings = <String>[];
-    if (invocationOptions != null) {
-      invocationOptions.forEach((e) {
-        invocationOptionsStrings.add(e.toString());
-      });
-    }
+  static Future<void> show(
+      ReportType reportType, List<InvocationOption>? invocationOptions) async {
+    final invocationOptionsStrings =
+        invocationOptions?.map((e) => e.toString()).toList(growable: false) ??
+            [];
     final List<dynamic> params = <dynamic>[
       reportType.toString(),
       invocationOptionsStrings
@@ -193,7 +181,7 @@ class BugReporting {
   /// Sets the threshold value of the shake gesture for iPhone/iPod Touch
   /// Default for iPhone is 2.5.
   /// [iPhoneShakingThreshold] iPhoneShakingThreshold double
-  static void setShakingThresholdForiPhone(
+  static Future<void> setShakingThresholdForiPhone(
       double iPhoneShakingThreshold) async {
     if (Platform.isIOS) {
       final List<dynamic> params = <dynamic>[iPhoneShakingThreshold];
@@ -205,7 +193,8 @@ class BugReporting {
   /// Sets the threshold value of the shake gesture for iPad
   /// Default for iPhone is 0.6.
   /// [iPadShakingThreshold] iPhoneShakingThreshold double
-  static void setShakingThresholdForiPad(double iPadShakingThreshold) async {
+  static Future<void> setShakingThresholdForiPad(
+      double iPadShakingThreshold) async {
     if (Platform.isIOS) {
       final List<dynamic> params = <dynamic>[iPadShakingThreshold];
       await _channel.invokeMethod<Object>(
@@ -218,7 +207,8 @@ class BugReporting {
   /// you could increase the shaking difficulty level by
   /// increasing the `350` value and vice versa
   /// [androidThreshold] iPhoneShakingThreshold int
-  static void setShakingThresholdForAndroid(int androidThreshold) async {
+  static Future<void> setShakingThresholdForAndroid(
+      int androidThreshold) async {
     if (Platform.isAndroid) {
       final List<dynamic> params = <dynamic>[androidThreshold];
       await _channel.invokeMethod<Object>(

lib/BugReporting.dart

@@ -1,26 +1,28 @@
+// 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 void show() async {
-    await _channel.invokeMethod<Object>('showChats');
-  }
+  static Future<void> show() async =>
+      await _channel.invokeMethod<Object>('showChats');
 
   @deprecated
+
   ///Use {@link BugReporting.setReportTypes} instead.
   /// Enables and disables everything related to creating new chats.
   /// [boolean] isEnabled
-  static void setEnabled(bool isEnabled) async {
+  static Future<void> setEnabled(bool isEnabled) async {
     final List<dynamic> params = <dynamic>[isEnabled];
     await _channel.invokeMethod<Object>('setChatsEnabled:', params);
   }

lib/Chats.dart

@@ -1,29 +1,30 @@
+// ignore_for_file: avoid_classes_with_only_static_members
+
 import 'dart:async';
 import 'dart:convert';
-import 'dart:io' show Platform, exit;
-import 'package:flutter/services.dart';
+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: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
-  static void setEnabled(bool isEnabled) async {
+  static Future<void> setEnabled(bool isEnabled) async {
     enabled = isEnabled;
     final List<dynamic> params = <dynamic>[isEnabled];
     await _channel.invokeMethod<Object>('setCrashReportingEnabled:', params);
   }
 
-  static void reportCrash(dynamic exception, StackTrace stack) async {
+  static Future<void> reportCrash(dynamic exception, StackTrace stack) async {
     if (kReleaseMode && enabled) {
       _reportUnhandledCrash(exception, stack);
     } else {
@@ -35,19 +36,21 @@ class CrashReporting {
   /// Reports a handled crash to you dashboard
   /// [dynamic] exception
   /// [StackTrace] stack
-  static void reportHandledCrash(dynamic exception, [StackTrace stack]) async {
+  static Future<void> reportHandledCrash(dynamic exception,
+      [StackTrace? stack]) async {
     if (stack != null) {
       _sendCrash(exception, stack, true);
     } else {
       _sendCrash(exception, StackTrace.current, true);
     }
   }
 
-  static void _reportUnhandledCrash(dynamic exception, StackTrace stack) async {
+  static Future<void> _reportUnhandledCrash(
+      dynamic exception, StackTrace stack) async {
     _sendCrash(exception, stack, false);
   }
 
-  static void _sendCrash(
+  static Future<void> _sendCrash(
       dynamic exception, StackTrace stack, bool handled) async {
     final Trace trace = Trace.from(stack);
     final List<ExceptionData> frames = <ExceptionData>[];
@@ -56,7 +59,7 @@ class CrashReporting {
           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].column == null ? 0 : trace.frames[i].column!));
     }
     final CrashData crashData = CrashData(
         exception.toString(), Platform.operatingSystem.toString(), frames);