[MOB-11886] Add Instabug.init API (#333)

Author: TheBuggedYRN

CHANGELOG.md

@@ -1,5 +1,6 @@
 ## Unreleased
 
+* Deprecates `Instabug.start` in favour of the new `Instabug.init` API.
 * Adds `hungarian` and `finnish` locales support
 * Adds missing mapping for `norwegian` and `slovak` locales on iOS
 

README.md

@@ -38,16 +38,21 @@ flutter packages get
 
 ### Initializing Instabug
 
-To start using Instabug, import it into your Flutter app. 
+Initialize the SDK in your `main` function. This starts the SDK with the default behavior and sets it to be shown when the device is shaken.
 
 ```dart
 import 'package:instabug_flutter/instabug_flutter.dart';
-```
 
-Initialize the SDK in `initState()`. This line enables the SDK with the default behavior and sets it to be shown when the device is shaken.
+void main() {
+  WidgetsFlutterBinding.ensureInitialized();
 
-```dart
-Instabug.start('APP_TOKEN', [InvocationEvent.shake]);
+  Instabug.init(
+    token: 'APP_TOKEN',
+    invocationEvents: [InvocationEvent.shake],
+  );
+
+  runApp(MyApp());
+}
 ```
 
 > :warning:  If you're updating the SDK from versions prior to v11, please check our [migration guide](https://docs.instabug.com/docs/flutter-migration-guide).
@@ -58,19 +63,20 @@ Instabug automatically captures every crash of your app and sends relevant detai
 
 ⚠️ **Crashes will only be reported in release mode and not in debug mode.**
 
+```dart
+void main() {
+  WidgetsFlutterBinding.ensureInitialized();
 
-Replace `void main() => runApp(MyApp());` with the following snippet:
+  Instabug.init(
+    token: 'APP_TOKEN',
+    invocationEvents: [InvocationEvent.floatingButton],
+  );
 
-```dart
-void main() async {
   FlutterError.onError = (FlutterErrorDetails details) {
-    Zone.current.handleUncaughtError(details.exception, details.stack);
+    Zone.current.handleUncaughtError(details.exception, details.stack!);
   };
-  runZonedGuarded<Future<void>>(() async {
-    runApp(MyApp());
-  }, (Object error, StackTrace stackTrace) {
-    CrashReporting.reportCrash(error, stackTrace);
-  });
+
+  runZonedGuarded(() => runApp(MyApp()), CrashReporting.reportCrash);
 }
 ```
 

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

@@ -84,7 +84,7 @@ public void setEnabled(@NonNull Boolean isEnabled) {
         }
     }
 
-    public void start(@NonNull String token, @NonNull List<String> invocationEvents) {
+    public void init(@NonNull String token, @NonNull List<String> invocationEvents) {
         setCurrentPlatform();
 
         InstabugInvocationEvent[] invocationEventsArray = new InstabugInvocationEvent[invocationEvents.size()];

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

@@ -111,7 +111,7 @@ public void testStart() {
             when(mock.setInvocationEvents(any())).thenReturn(mock);
         });
 
-        api.start(token, invocationEvents);
+        api.init(token, invocationEvents);
 
         Instabug.Builder builder = mInstabugBuilder.constructed().get(0);
 

example/ios/InstabugSampleTests/InstabugApiTests.m

@@ -39,7 +39,7 @@ - (void)testStart {
     NSArray<NSString *> *invocationEvents = @[@"InvocationEvent.floatingButton", @"InvocationEvent.screenshot"];
     FlutterError *error;
 
-    [self.api startToken:token invocationEvents:invocationEvents error:&error];
+    [self.api initToken:token invocationEvents:invocationEvents error:&error];
 
     OCMVerify([self.mInstabug setCurrentPlatform:IBGPlatformFlutter]);
 

example/lib/main.dart

@@ -4,15 +4,20 @@ import 'package:flutter/material.dart';
 import 'package:instabug_flutter/instabug_flutter.dart';
 
 void main() {
+  WidgetsFlutterBinding.ensureInitialized();
+
+  Instabug.init(
+    token: 'ed6f659591566da19b67857e1b9d40ab',
+    invocationEvents: [InvocationEvent.floatingButton],
+  );
+
+  Instabug.setWelcomeMessageMode(WelcomeMessageMode.disabled);
+
   FlutterError.onError = (FlutterErrorDetails details) {
     Zone.current.handleUncaughtError(details.exception, details.stack!);
   };
 
   runZonedGuarded(() => runApp(MyApp()), CrashReporting.reportCrash);
-
-  Instabug.start(
-      'ed6f659591566da19b67857e1b9d40ab', [InvocationEvent.floatingButton]);
-  Instabug.setWelcomeMessageMode(WelcomeMessageMode.disabled);
 }
 
 class MyApp extends StatelessWidget {

ios/Classes/Modules/InstabugApi.m

@@ -18,7 +18,7 @@ - (void)setEnabledIsEnabled:(NSNumber *)isEnabled error:(FlutterError *_Nullable
     Instabug.enabled = [isEnabled boolValue];
 }
 
-- (void)startToken:(NSString *)token invocationEvents:(NSArray<NSString *> *)invocationEvents error:(FlutterError *_Nullable *_Nonnull)error {
+- (void)initToken:(NSString *)token invocationEvents:(NSArray<NSString *> *)invocationEvents error:(FlutterError *_Nullable *_Nonnull)error {
     SEL setPrivateApiSEL = NSSelectorFromString(@"setCurrentPlatform:");
     if ([[Instabug class] respondsToSelector:setPrivateApiSEL]) {
         NSInteger *platformID = IBGPlatformFlutter;

lib/src/modules/bug_reporting.dart

@@ -53,7 +53,7 @@ class BugReporting implements BugReportingFlutterApi {
 
   /// @nodoc
   @internal
-  static void init() {
+  static void $setup() {
     BugReportingFlutterApi.setup(_instance);
   }
 
@@ -121,7 +121,7 @@ class BugReporting implements BugReportingFlutterApi {
   }
 
   /// Sets the events that invoke the feedback form.
-  /// Default is set by `Instabug.startWithToken`.
+  /// Default is set by [Instabug.init].
   /// [invocationEvents] invocationEvent List of events that invokes the
   static Future<void> setInvocationEvents(
     List<InvocationEvent>? invocationEvents,
@@ -166,7 +166,7 @@ class BugReporting implements BugReportingFlutterApi {
   }
 
   /// Sets the invocation options.
-  /// Default is set by `Instabug.startWithToken`.
+  /// Default is set by [Instabug.init].
   /// [invocationOptions] List of invocation options
   static Future<void> setInvocationOptions(
     List<InvocationOption>? invocationOptions,

lib/src/modules/instabug.dart

@@ -136,10 +136,10 @@ class Instabug {
 
   /// @nodoc
   @internal
-  static void init() {
-    BugReporting.init();
-    Replies.init();
-    Surveys.init();
+  static void $setup() {
+    BugReporting.$setup();
+    Replies.$setup();
+    Surveys.$setup();
   }
 
   /// Enables or disables Instabug functionality.
@@ -155,12 +155,25 @@ class Instabug {
   /// it on your dashboard.
   /// The [invocationEvents] are the events that invoke
   /// the SDK's UI.
+  static Future<void> init({
+    required String token,
+    required List<InvocationEvent> invocationEvents,
+  }) async {
+    $setup();
+    return _host.init(token, invocationEvents.mapToString());
+  }
+
+  @Deprecated(
+    "Use [Instabug.init] instead.",
+  )
   static Future<void> start(
     String token,
     List<InvocationEvent> invocationEvents,
   ) async {
-    init();
-    return _host.start(token, invocationEvents.mapToString());
+    return init(
+      token: token,
+      invocationEvents: invocationEvents,
+    );
   }
 
   /// Shows the welcome message in a specific mode.

lib/src/modules/replies.dart

@@ -33,7 +33,7 @@ class Replies implements RepliesFlutterApi {
 
   /// @nodoc
   @internal
-  static void init() {
+  static void $setup() {
     RepliesFlutterApi.setup(_instance);
   }