fix: fix 'Sending a message before the FlutterEngine has been run.' e…

…rror fix: fix 'Sending a message before the FlutterEngine has been run.' error
AgoraIO-Extensions · Aug 15, 2022 · d0d6fad · d0d6fad
1 parent f76a056
commit d0d6fad
Show file tree

Hide file tree

Showing 59 changed files with 2,046 additions and 49 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -132,18 +132,20 @@ jobs:
       - run: flutter pub get
       - run: bash ci/run_android_test.sh
 
-  unittest_ios:
-    name: Run iOS Unit Test
+  run_test_shard:
+    name: Run test shard
     needs: flutter_codestyle_check
     runs-on: macos-11
     timeout-minutes: 60
+    env:
+      TEST_APP_ID: ${{ secrets.MY_APP_ID }}
     steps:
       - uses: actions/checkout@v1
       - uses: subosito/flutter-action@v1
         with:
-          flutter-version: '2.10.5'
+          flutter-version: '3.0.1'
       - run: flutter pub get
-      - run: bash ci/run_ios_test.sh
+      - run: bash ci/run_test_shard.sh
 
   build_android_windows:
     name: Build Android on Windows

diff --git a/.pubignore b/.pubignore
@@ -1,4 +1,5 @@
 integration_test_app/
 tools/
 ios/libs
-macos/libs
+macos/libs
+test_shard/
diff --git a/ci/run_test_shard.sh b/ci/run_test_shard.sh
@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+set -e
+set -x
+
+pushd test_shard/destroy_irisengine_smoke_test
+flutter packages get
+flutter build ios --no-codesign --simulator --debug
+popd
+
+pushd test_shard/destroy_irisengine_smoke_test/ios
+
+bundle install
+bundle exec fastlane tests --verbose
+
+popd
+
diff --git a/ios/Classes/AgoraRtcEnginePlugin.mm b/ios/Classes/AgoraRtcEnginePlugin.mm
@@ -66,7 +66,12 @@ - (instancetype)init {
   return self;
 }
 
+- (void)detachFromEngineForRegistrar:(NSObject<FlutterPluginRegistrar> *)registrar {
+    [self destroyIrisRtcEngine];
+}
+
 - (void)destroyIrisRtcEngine {
+    [self.flutterIrisEventHandler resetEventHandler:self.irisRtcEngine];
     self.irisRtcEngine->SetEventHandler(nil);
     self.irisRtcEngine->channel()->SetEventHandler(nil);
     delete self.irisRtcEngine;

diff --git a/ios/Classes/FlutterIrisEventHandler.mm b/ios/Classes/FlutterIrisEventHandler.mm
@@ -1,30 +1,45 @@
 #import <Foundation/Foundation.h>
 #import "FlutterIrisEventHandler.h"
 #import <AgoraRtcWrapper/iris_rtc_engine.h>
+#include <mutex>
 
 class EventHandler : public agora::iris::IrisEventHandler {
+
 public:
-    EventHandler(FlutterEventSink eventSink, bool shouldHandleSubProcess = false, bool sub_process = false) : eventSink_(eventSink), sub_process_(sub_process), shouldHandleSubProcess_(shouldHandleSubProcess) {
+    EventHandler(FlutterEventSink eventSink, bool shouldHandleSubProcess = false, bool sub_process = false) : eventSink_(eventSink), sub_process_(sub_process),  shouldHandleSubProcess_(shouldHandleSubProcess), isCleanUp_(false) {
   }
 
   void OnEvent(const char *event, const char *data) override {
-    @autoreleasepool {
-        if (eventSink_) {
-            bool subProcess = shouldHandleSubProcess_ && sub_process_;
-            NSMutableDictionary *dic = [NSMutableDictionary dictionaryWithObjectsAndKeys:
-                [NSString stringWithUTF8String:event], @"methodName", 
-                [NSString stringWithUTF8String:data], @"data", 
-                                        @(subProcess), @"subProcess",
-                nil];
-
-            eventSink_(dic);
-        }
+    std::lock_guard<std::mutex> guard(isCleanUpMutex_);
+
+    if (isCleanUp_) return;
+
+    @try {
+      if (eventSink_) {
+          bool subProcess = shouldHandleSubProcess_ && sub_process_;
+          NSMutableDictionary *dic = [NSMutableDictionary dictionaryWithObjectsAndKeys:
+              [NSString stringWithUTF8String:event], @"methodName",
+              [NSString stringWithUTF8String:data], @"data",
+                                      @(subProcess), @"subProcess",
+              nil];
+
+          if (isCleanUp_) return;
+          eventSink_(dic);
+      }
+    } @catch (NSException *e) {
+        NSLog(@"Error: %@ %@", e, [e userInfo]);
+    } @finally {
     }
+
   }
 
   void OnEvent(const char *event, const char *data, const void *buffer,
                unsigned int length) override {
-    @autoreleasepool {
+    std::lock_guard<std::mutex> guard(isCleanUpMutex_);
+
+    if (isCleanUp_) return;
+
+    @try {
       FlutterStandardTypedData *bufferApple = [FlutterStandardTypedData
           typedDataWithBytes:[[NSData alloc] initWithBytes:buffer
                                                     length:length]];
@@ -37,15 +52,26 @@ void OnEvent(const char *event, const char *data, const void *buffer,
                                         @(subProcess), @"subProcess",
                                         nil];
 
+            if (isCleanUp_) return;
             eventSink_(dic);
         }
+    } @catch (NSException *e) {
+      NSLog(@"Error: %@ %@", e, [e userInfo]);
+    } @finally {
     }
   }
+
+    void setIsCleanUp(bool isCleanUp) {
+        std::lock_guard<std::mutex> guard(isCleanUpMutex_);
+        isCleanUp_ = isCleanUp;
+    }
 
 private:
     FlutterEventSink eventSink_;
     bool sub_process_;
     bool shouldHandleSubProcess_;
+    bool isCleanUp_ = false;
+    std::mutex isCleanUpMutex_;
 };
 
 @interface FlutterIrisEventHandler ()
@@ -115,6 +141,13 @@ - (void)setUpEventHandler:(void *)engine eventHandler:(void *)eventHandler {
 }
 
 - (void)resetEventHandler:(void *)engine {
+    if (self.eventHandler) {
+        self.eventHandler->setIsCleanUp(true);
+    }
+    if (self.eventHandlerSub) {
+        self.eventHandlerSub->setIsCleanUp(true);
+    }
+
     agora::iris::rtc::IrisRtcEngine *e = (agora::iris::rtc::IrisRtcEngine *)engine;
     e->SetEventHandler(nil);
     self.eventSink = nil;

diff --git a/macos/Classes/AgoraRtcEnginePlugin.mm b/macos/Classes/AgoraRtcEnginePlugin.mm
@@ -64,6 +64,8 @@ - (instancetype)init {
 }
 
 - (void)dealloc {
+  [self.eventHandler resetEventHandler:self.engine_main];
+
   if (self.engine_main) {
     self.engine_main->SetEventHandler(nil);
     self.engine_main->channel()->SetEventHandler(nil);

diff --git a/macos/Classes/FlutterIrisEventHandler.mm b/macos/Classes/FlutterIrisEventHandler.mm
@@ -1,6 +1,7 @@
 #import "FlutterIrisEventHandler.h"
 #import <AgoraRtcWrapper/iris_rtc_engine.h>
 #import <Foundation/Foundation.h>
+#include <mutex>
 
 class EventHandler : public agora::iris::IrisEventHandler {
 public:
@@ -10,49 +11,72 @@
         shouldHandleSubProcess_(shouldHandleSubProcess) {}
 
   void OnEvent(const char *event, const char *data) override {
-    @autoreleasepool {
-      if (eventSink_) {
-        NSMutableDictionary *dic = [NSMutableDictionary
-            dictionaryWithObjectsAndKeys:[NSString stringWithUTF8String:event],
-                                         @"methodName",
-                                         [NSString stringWithUTF8String:data],
-                                         @"data", nil];
-
-        if (shouldHandleSubProcess_) {
-          [dic setObject:@(sub_process_) forKey:@"subProcess"];
-        }
-
-        eventSink_(dic);
+      std::lock_guard<std::mutex> guard(isCleanUpMutex_);
+
+      if (isCleanUp_) return;
+
+      @try {
+          if (eventSink_) {
+            NSMutableDictionary *dic = [NSMutableDictionary
+                dictionaryWithObjectsAndKeys:[NSString stringWithUTF8String:event],
+                                             @"methodName",
+                                             [NSString stringWithUTF8String:data],
+                                             @"data", nil];
+
+            if (shouldHandleSubProcess_) {
+              [dic setObject:@(sub_process_) forKey:@"subProcess"];
+            }
+
+            if (isCleanUp_) return;
+            eventSink_(dic);
+          }
+      } @catch (NSException *e) {
+          NSLog(@"Error: %@ %@", e, [e userInfo]);
+      } @finally {
       }
-    }
   }
 
   void OnEvent(const char *event, const char *data, const void *buffer,
                unsigned int length) override {
-    @autoreleasepool {
-      FlutterStandardTypedData *bufferApple = [FlutterStandardTypedData
-          typedDataWithBytes:[[NSData alloc] initWithBytes:buffer
-                                                    length:length]];
-      if (eventSink_) {
-        NSMutableDictionary *dic = [NSMutableDictionary
-            dictionaryWithObjectsAndKeys:[NSString stringWithUTF8String:event],
-                                         @"methodName",
-                                         [NSString stringWithUTF8String:data],
-                                         @"data", bufferApple, @"buffer", nil];
-
-        if (shouldHandleSubProcess_) {
-          [dic setObject:@(sub_process_) forKey:@"subProcess"];
-        }
-
-        eventSink_(dic);
+      std::lock_guard<std::mutex> guard(isCleanUpMutex_);
+
+      if (isCleanUp_) return;
+
+      @try {
+          FlutterStandardTypedData *bufferApple = [FlutterStandardTypedData
+              typedDataWithBytes:[[NSData alloc] initWithBytes:buffer
+                                                        length:length]];
+          if (eventSink_) {
+            NSMutableDictionary *dic = [NSMutableDictionary
+                dictionaryWithObjectsAndKeys:[NSString stringWithUTF8String:event],
+                                             @"methodName",
+                                             [NSString stringWithUTF8String:data],
+                                             @"data", bufferApple, @"buffer", nil];
+
+            if (shouldHandleSubProcess_) {
+              [dic setObject:@(sub_process_) forKey:@"subProcess"];
+            }
+
+            if (isCleanUp_) return;
+            eventSink_(dic);
+          }
+      } @catch (NSException *e) {
+          NSLog(@"Error: %@ %@", e, [e userInfo]);
+      } @finally {
       }
-    }
   }
+
+    void setIsCleanUp(bool isCleanUp) {
+        std::lock_guard<std::mutex> guard(isCleanUpMutex_);
+        isCleanUp_ = isCleanUp;
+    }
 
 private:
   FlutterEventSink eventSink_;
   bool sub_process_;
   bool shouldHandleSubProcess_;
+    bool isCleanUp_ = false;
+    std::mutex isCleanUpMutex_;
 };
 
 @interface FlutterIrisEventHandler ()
@@ -125,6 +149,12 @@ - (void)setUpEventHandler:(void *)engine eventHandler:(void *)eventHandler {
 }
 
 - (void)resetEventHandler:(void *)engine {
+    if (self.eventHandler) {
+        self.eventHandler->setIsCleanUp(true);
+    }
+    if (self.eventHandlerSub) {
+        self.eventHandlerSub->setIsCleanUp(true);
+    }
   agora::iris::rtc::IrisRtcEngine *e =
       (agora::iris::rtc::IrisRtcEngine *)engine;
   e->SetEventHandler(nil);

diff --git a/test_shard/destroy_irisengine_smoke_test/.gitignore b/test_shard/destroy_irisengine_smoke_test/.gitignore
@@ -0,0 +1,47 @@
+# Miscellaneous
+*.class
+*.log
+*.pyc
+*.swp
+.DS_Store
+.atom/
+.buildlog/
+.history
+.svn/
+migrate_working_dir/
+
+# 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/
+**/ios/Flutter/.last_build_id
+.dart_tool/
+.flutter-plugins
+.flutter-plugins-dependencies
+.packages
+.pub-cache/
+.pub/
+/build/
+
+# Web related
+lib/generated_plugin_registrant.dart
+
+# Symbolication related
+app.*.symbols
+
+# Obfuscation related
+app.*.map.json
+
+# Android Studio will place build artifacts here
+/android/app/debug
+/android/app/profile
+/android/app/release
diff --git a/test_shard/destroy_irisengine_smoke_test/.metadata b/test_shard/destroy_irisengine_smoke_test/.metadata
@@ -0,0 +1,30 @@
+# This file tracks properties of this Flutter project.
+# Used by Flutter tool to assess capabilities and perform upgrades etc.
+#
+# This file should be version controlled.
+
+version:
+  revision: fb57da5f945d02ef4f98dfd9409a72b7cce74268
+  channel: stable
+
+project_type: app
+
+# Tracks metadata for the flutter migrate command
+migration:
+  platforms:
+    - platform: root
+      create_revision: fb57da5f945d02ef4f98dfd9409a72b7cce74268
+      base_revision: fb57da5f945d02ef4f98dfd9409a72b7cce74268
+    - platform: ios
+      create_revision: fb57da5f945d02ef4f98dfd9409a72b7cce74268
+      base_revision: fb57da5f945d02ef4f98dfd9409a72b7cce74268
+
+  # User provided section
+
+  # List of Local paths (relative to this file) that should be
+  # ignored by the migrate tool.
+  #
+  # Files that are not part of the templates will be ignored by default.
+  unmanaged_files:
+    - 'lib/main.dart'
+    - 'ios/Runner.xcodeproj/project.pbxproj'
diff --git a/test_shard/destroy_irisengine_smoke_test/README.md b/test_shard/destroy_irisengine_smoke_test/README.md
@@ -0,0 +1,16 @@
+# destroy_irisengine_smoke_test
+
+A new Flutter project.
+
+## Getting Started
+
+This project is a starting point for a Flutter application.
+
+A few resources to get you started if this is your first Flutter project:
+
+- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
+- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+
+For help getting started with Flutter development, view the
+[online documentation](https://docs.flutter.dev/), which offers tutorials,
+samples, guidance on mobile development, and a full API reference.