[MOB-9128] Migrate to Pigeon (#279)

* Init Structure

* Migrate Instabug Module

* Migrate InstabugLog Module

* Migrate BugReporting Module

* Migrate BugReporting Callbacks

* Migrate Surveys Module

* Migrate Surveys Callbacks

* Migrate FeatureRequests Module

* Migrate CrashReporting Module

* Migrate APM Module

* Migrate Replies Module

* Migrate Replies Callbacks

* Migrate `Network Log` Module

* Fix iOS Imports

* Clean Native Entry Files

* Rename Files & Classes

* Create ArgsRegistry for iOS

* Create Util Directory

* Improve iOS Setup

* Improve Android Setup

* Ignore generated files from analyzer

* Add Setters for Host APIs

* Add Instabug Unit Tests

* Change Android Initialization Logic

* Remove Android Unit Tests

* Add One Android Unit Test

* Run Pigeon on CI

* Bump example app iOS version

* Remove iOS Unit Tests

* Add One iOS Unit Test

* Add InstabugLog Unit Tests

* Add APM Unit Tests

* Add BugReporting Unit Tests

* Add CrashReporting Unit Tests

* Add FeatureRequests Unit Tests

* Add Replies Unit Tests

* Add Surveys Unit Tests

* Add Trace Unit Tests

* Add NetworkData Unit Tests

* Add NetworkLogger Unit Tests

* Delete `instabug_flutter_test.dart`

* Change iOS Initialization Logic

* Fix Format Issues

* Clean pigeon script

* Fix CI Jobs

* Format Generated Pigeon Files

* Remove TODO comments

* Replace Lambdas with Anonymous Classes

* Downgrade Pigeon Version to 3.0.4

* Pin Mockito to 5.2.0

* Add .pubignore

* Fix `gh_ibg_release` CI Job

* Update Changelog

* Fix `setValueForStringWithKey` on Android

* Fix `setOnDismissCallback` on iOS

* Remove Unnecessary try/catch Block

* Add `EnumConverter` Extension Method

* Format OBJ-C Files w/`clang-format`

* Format Java Files w/Android Studio

* Edit CI Working Directories

* Run Pigeon Script For All API Files

Author: TheBuggedYRN

.circleci/config.yml

@@ -15,6 +15,7 @@ jobs:
       - run: bundle exec danger
       - run: flutter doctor
       - run: flutter packages get
+      - run: sh ./scripts/pigeon.sh
       - run: flutter pub run build_runner build --delete-conflicting-outputs
       - run: flutter test --coverage
       - run: bash <(curl -s https://codecov.io/bash)
@@ -29,66 +30,66 @@ jobs:
       - run: bundle exec danger
       - run: flutter doctor
       - run: flutter packages get
+      - run: sh ./scripts/pigeon.sh
       - run: flutter pub run build_runner build --delete-conflicting-outputs
       - run: flutter test --coverage
 
   test_android:
-    working_directory: ~/project/example/android
     executor:
       name: android/android-machine
       resource-class: xlarge
       tag: 2022.04.1
     steps:
-      - checkout:
-          path: ~/project
+      - checkout
       - flutter/install_sdk_and_pub:
-          flutter_version: 2.2.3
-          app-dir: ..
+          flutter_version: 3.3.0
+      - run:
+          name: Generate Pigeons
+          command: sh ./scripts/pigeon.sh
       - android/start-emulator-and-run-tests:
           system-image: system-images;android-30;google_apis;x86
           additional-avd-args: -d "Nexus 5"
-          post-emulator-launch-assemble-command: flutter build apk
+          post-emulator-launch-assemble-command: cd example && flutter build apk
+          run-tests-working-directory: example/android
           test-command: ./gradlew app:connectedAndroidTest
       - android/run-tests:
+          working-directory: example/android
           test-command: ./gradlew test
 
   ios_tests:
     macos:
-      xcode: "13.4.1"
-    working_directory: ~/project/example
-    environment:
-      FL_OUTPUT_DIR: output
+      xcode: 13.4.1
     steps:
-      - checkout:
-          path: ~/project
+      - checkout
+      - flutter/install_sdk_and_pub:
+          flutter_version: 3.3.0
+      - run:
+          name: Generate Pigeons
+          command: sh ./scripts/pigeon.sh
       - run:
           name: Install CocoaPods
           command: sudo gem install cocoapods
-      - run:
-          name: download flutter SDK
-          command: if ! test -f "~/flutter_sdk.zip"; then curl -o ~/flutter_sdk.zip https://storage.googleapis.com/flutter_infra_release/releases/stable/macos/flutter_macos_2.2.3-stable.zip; fi
-      - run:
-          name: unzip flutter SDK
-          command: unzip ~/flutter_sdk.zip -d ~
-      - run:
-          name: export flutter path
-          command: echo 'export PATH="$PATH:~/flutter/bin"'  >> $BASH_ENV
-      - run: flutter doctor
-      - run: flutter pub get
       - run:
           name: Install Pods
-          command: cd ios && pod install --repo-update
+          working_directory: example/ios
+          command: pod install --repo-update
       - run:
           name: Build and run tests
-          command: cd ios && xcodebuild  -allowProvisioningUpdates   -workspace Runner.xcworkspace   -scheme Runner   -sdk iphonesimulator   -destination 'platform=iOS Simulator,name=iPhone 13 Pro Max,OS=15.5'   test | xcpretty
+          working_directory: example/ios
+          command: |
+            xcodebuild -allowProvisioningUpdates \
+                       -workspace Runner.xcworkspace \
+                       -scheme Runner \
+                       -sdk iphonesimulator \
+                       -destination 'name=iPhone 12 Pro Max' \
+                       test | xcpretty
 
   format_flutter:
     docker:
       - image: cirrusci/flutter
     steps:
       - checkout
       - run: flutter pub get
-      - run: flutter pub run build_runner build --delete-conflicting-outputs
       - run:
           name: Check Format
           command: flutter format . --set-exit-if-changed
@@ -99,6 +100,7 @@ jobs:
     steps:
       - checkout
       - run: flutter pub get
+      - run: sh ./scripts/pigeon.sh
       - run: flutter pub run build_runner build --delete-conflicting-outputs
       - run:
           name: Perform Static Analysis
@@ -110,6 +112,7 @@ jobs:
     steps:
       - checkout
       - run: flutter pub get
+      - run: sh ./scripts/pigeon.sh
       - run:
           name: Check Package Score
           command: flutter pub run pana --no-warning --exit-code-threshold 0

.gitignore

@@ -1,5 +1,8 @@
 # Generated files
 *.mocks.dart
+*.g.dart
+android/**/generated/
+ios/**/Generated/
 
 # Miscellaneous
 *.class

.pubignore

@@ -0,0 +1,80 @@
+# Generated files
+*.mocks.dart
+
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+
+# IntelliJ related
+*.iml
+*.ipr
+*.iws
+.idea/
+
+# The .vscode folder contains launch configuration and tasks you configure in
+# VS Code which you may wish to be included in version control, so this line
+# is commented out by default.
+#.vscode/
+
+# Flutter/Dart/Pub related
+**/doc/api/
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+pubspec.lock
+build/
+coverage/
+
+# Android related
+**/android/**/gradle-wrapper.jar
+**/android/.gradle
+**/android/captures/
+android/gradlew
+android/gradlew.bat
+**/android/local.properties
+**/android/**/GeneratedPluginRegistrant.java
+
+# iOS/XCode related
+**/ios/**/*.mode1v3
+**/ios/**/*.mode2v3
+**/ios/**/*.moved-aside
+**/ios/**/*.pbxuser
+**/ios/**/*.perspectivev3
+**/ios/**/*sync/
+**/ios/**/.sconsign.dblite
+**/ios/**/.tags*
+**/ios/**/.vagrant/
+**/ios/**/DerivedData/
+**/ios/**/Icon?
+**/ios/**/Pods/
+**/ios/**/.symlinks/
+**/ios/**/profile
+**/ios/**/xcuserdata
+**/ios/.generated/
+**/ios/Flutter/App.framework
+**/ios/Flutter/Flutter.framework
+**/ios/Flutter/Flutter.podspec
+**/ios/Flutter/Generated.xcconfig
+**/ios/Flutter/app.flx
+**/ios/Flutter/app.zip
+**/ios/Flutter/flutter_assets/
+**/ios/Flutter/flutter_export_environment.sh
+**/ios/ServiceDefinitions.json
+**/ios/Runner/GeneratedPluginRegistrant.*
+
+# Exceptions to above rules.
+!**/ios/**/default.mode1v3
+!**/ios/**/default.mode2v3
+!**/ios/**/default.pbxuser
+!**/ios/**/default.perspectivev3
+!/packages/flutter_tools/test/data/dart_dependencies_test/**/.packages

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+
+* Uses pigeon for internal communication between Flutter and the host platform.
+
 ## 11.3.0 (2022-09-30)
 
 * Bumps Instabug Android SDK to v11.5.1

analysis_options.yaml

@@ -3,6 +3,7 @@ include: package:lint/analysis_options_package.yaml
 analyzer:
   exclude:
     - "example/**"
+    - "**/*.g.dart"
 
 linter:
   rules:

android/build.gradle

@@ -42,7 +42,8 @@ android {
 
 dependencies {
     implementation 'com.instabug.library:instabug:11.5.1'
-    testImplementation 'junit:junit:4.12'
+    testImplementation 'junit:junit:4.13.2'
+    testImplementation "org.mockito:mockito-inline:3.12.1"
 }
 
 // add upload_symbols task