[camera] Run iOS methods on UI thread by default (#4140)

Author: renefloor

packages/camera/camera/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.9.4+3
+
+* Fix registerTexture and result being called on background thread on iOS.
+
 ## 0.9.4+2
 
 * Updated package description;

packages/camera/camera/example/ios/Runner.xcodeproj/project.pbxproj

@@ -19,7 +19,7 @@ @interface FLTCam : NSObject <FlutterTexture,
 
 - (void)applyFocusMode;
 - (void)applyFocusMode:(FocusMode)focusMode onDevice:(AVCaptureDevice *)captureDevice;
-- (void)setFocusPointWithResult:(FlutterResult)result x:(double)x y:(double)y;
+- (void)setFocusPointWithResult:(FLTThreadSafeFlutterResult *)result x:(double)x y:(double)y;
 @end
 
 @interface CameraFocusTests : XCTestCase
@@ -128,11 +128,11 @@ - (void)testSetFocusPointWithResult_SetsFocusPointOfInterest {
   [_camera setValue:_mockDevice forKey:@"captureDevice"];
 
   // Run test
-  [_camera
-      setFocusPointWithResult:^void(id _Nullable result) {
-      }
-                            x:1
-                            y:1];
+  [_camera setFocusPointWithResult:[[FLTThreadSafeFlutterResult alloc]
+                                       initWithResult:^(id _Nullable result){
+                                       }]
+                                 x:1
+                                 y:1];
 
   // Verify the focus point of interest has been set
   OCMVerify([_mockDevice setFocusPointOfInterest:CGPointMake(1, 1)]);

packages/camera/camera/example/ios/RunnerTests/CameraFocusTests.m

@@ -0,0 +1,48 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+@import camera;
+@import camera.Test;
+@import XCTest;
+@import AVFoundation;
+#import <OCMock/OCMock.h>
+#import "MockFLTThreadSafeFlutterResult.h"
+
+@interface CameraMethodChannelTests : XCTestCase
+@end
+
+@implementation CameraMethodChannelTests
+
+- (void)testCreate_ShouldCallResultOnMainThread {
+  CameraPlugin *camera = [[CameraPlugin alloc] initWithRegistry:nil messenger:nil];
+
+  XCTestExpectation *expectation =
+      [[XCTestExpectation alloc] initWithDescription:@"Result finished"];
+
+  // Set up mocks for initWithCameraName method
+  id avCaptureDeviceInputMock = OCMClassMock([AVCaptureDeviceInput class]);
+  OCMStub([avCaptureDeviceInputMock deviceInputWithDevice:[OCMArg any] error:[OCMArg anyObjectRef]])
+      .andReturn([AVCaptureInput alloc]);
+
+  id avCaptureSessionMock = OCMClassMock([AVCaptureSession class]);
+  OCMStub([avCaptureSessionMock alloc]).andReturn(avCaptureSessionMock);
+  OCMStub([avCaptureSessionMock canSetSessionPreset:[OCMArg any]]).andReturn(YES);
+
+  MockFLTThreadSafeFlutterResult *resultObject =
+      [[MockFLTThreadSafeFlutterResult alloc] initWithExpectation:expectation];
+
+  // Set up method call
+  FlutterMethodCall *call = [FlutterMethodCall
+      methodCallWithMethodName:@"create"
+                     arguments:@{@"resolutionPreset" : @"medium", @"enableAudio" : @(1)}];
+
+  [camera handleMethodCallAsync:call result:resultObject];
+
+  // Verify the result
+  NSDictionary *dictionaryResult = (NSDictionary *)resultObject.receivedResult;
+  XCTAssertNotNil(dictionaryResult);
+  XCTAssert([[dictionaryResult allKeys] containsObject:@"cameraId"]);
+}
+
+@end

packages/camera/camera/example/ios/RunnerTests/CameraMethodChannelTests.m

@@ -10,46 +10,52 @@
 #import <OCMock/OCMock.h>
 
 @interface CameraOrientationTests : XCTestCase
-@property(strong, nonatomic) id mockMessenger;
-@property(strong, nonatomic) CameraPlugin *cameraPlugin;
 @end
 
 @implementation CameraOrientationTests
 
-- (void)setUp {
-  [super setUp];
-
-  self.mockMessenger = OCMProtocolMock(@protocol(FlutterBinaryMessenger));
-  self.cameraPlugin = [[CameraPlugin alloc] initWithRegistry:nil messenger:self.mockMessenger];
-}
-
 - (void)testOrientationNotifications {
-  id mockMessenger = self.mockMessenger;
+  id mockMessenger = OCMProtocolMock(@protocol(FlutterBinaryMessenger));
+  CameraPlugin *cameraPlugin = [[CameraPlugin alloc] initWithRegistry:nil messenger:mockMessenger];
+
   [mockMessenger setExpectationOrderMatters:YES];
 
-  [self rotate:UIDeviceOrientationPortraitUpsideDown expectedChannelOrientation:@"portraitDown"];
-  [self rotate:UIDeviceOrientationPortrait expectedChannelOrientation:@"portraitUp"];
-  [self rotate:UIDeviceOrientationLandscapeRight expectedChannelOrientation:@"landscapeLeft"];
-  [self rotate:UIDeviceOrientationLandscapeLeft expectedChannelOrientation:@"landscapeRight"];
+  [self rotate:UIDeviceOrientationPortraitUpsideDown
+      expectedChannelOrientation:@"portraitDown"
+                    cameraPlugin:cameraPlugin
+                       messenger:mockMessenger];
+  [self rotate:UIDeviceOrientationPortrait
+      expectedChannelOrientation:@"portraitUp"
+                    cameraPlugin:cameraPlugin
+                       messenger:mockMessenger];
+  [self rotate:UIDeviceOrientationLandscapeRight
+      expectedChannelOrientation:@"landscapeLeft"
+                    cameraPlugin:cameraPlugin
+                       messenger:mockMessenger];
+  [self rotate:UIDeviceOrientationLandscapeLeft
+      expectedChannelOrientation:@"landscapeRight"
+                    cameraPlugin:cameraPlugin
+                       messenger:mockMessenger];
 
   OCMReject([mockMessenger sendOnChannel:[OCMArg any] message:[OCMArg any]]);
 
   // No notification when flat.
-  [self.cameraPlugin
+  [cameraPlugin
       orientationChanged:[self createMockNotificationForOrientation:UIDeviceOrientationFaceUp]];
   // No notification when facedown.
-  [self.cameraPlugin
+  [cameraPlugin
       orientationChanged:[self createMockNotificationForOrientation:UIDeviceOrientationFaceDown]];
 
   OCMVerifyAll(mockMessenger);
 }
 
 - (void)rotate:(UIDeviceOrientation)deviceOrientation
-    expectedChannelOrientation:(NSString *)channelOrientation {
-  id mockMessenger = self.mockMessenger;
+    expectedChannelOrientation:(NSString *)channelOrientation
+                  cameraPlugin:(CameraPlugin *)cameraPlugin
+                     messenger:(NSObject<FlutterBinaryMessenger> *)messenger {
   XCTestExpectation *orientationExpectation = [self expectationWithDescription:channelOrientation];
 
-  OCMExpect([mockMessenger
+  OCMExpect([messenger
       sendOnChannel:[OCMArg any]
             message:[OCMArg checkWithBlock:^BOOL(NSData *data) {
               NSObject<FlutterMethodCodec> *codec = [FlutterStandardMethodCodec sharedInstance];
@@ -60,8 +66,7 @@ - (void)rotate:(UIDeviceOrientation)deviceOrientation
                   [methodCall.arguments isEqualToDictionary:@{@"orientation" : channelOrientation}];
             }]]);
 
-  [self.cameraPlugin
-      orientationChanged:[self createMockNotificationForOrientation:deviceOrientation]];
+  [cameraPlugin orientationChanged:[self createMockNotificationForOrientation:deviceOrientation]];
   [self waitForExpectationsWithTimeout:30.0 handler:nil];
 }
 

packages/camera/camera/example/ios/RunnerTests/CameraOrientationTests.m

@@ -6,45 +6,37 @@
 @import XCTest;
 @import AVFoundation;
 #import <OCMock/OCMock.h>
+#import "MockFLTThreadSafeFlutterResult.h"
 
 @interface FLTCam : NSObject <FlutterTexture,
                               AVCaptureVideoDataOutputSampleBufferDelegate,
                               AVCaptureAudioDataOutputSampleBufferDelegate>
 @property(assign, nonatomic) BOOL isPreviewPaused;
-- (void)pausePreviewWithResult:(FlutterResult)result;
-- (void)resumePreviewWithResult:(FlutterResult)result;
+
+- (void)pausePreviewWithResult:(FLTThreadSafeFlutterResult *)result;
+
+- (void)resumePreviewWithResult:(FLTThreadSafeFlutterResult *)result;
 @end
 
 @interface CameraPreviewPauseTests : XCTestCase
-@property(readonly, nonatomic) FLTCam* camera;
 @end
 
 @implementation CameraPreviewPauseTests
 
-- (void)setUp {
-  _camera = [[FLTCam alloc] init];
-}
-
 - (void)testPausePreviewWithResult_shouldPausePreview {
-  XCTestExpectation* resultExpectation =
-      [self expectationWithDescription:@"Succeeding result with nil value"];
-  [_camera pausePreviewWithResult:^void(id _Nullable result) {
-    XCTAssertNil(result);
-    [resultExpectation fulfill];
-  }];
-  [self waitForExpectationsWithTimeout:2.0 handler:nil];
-  XCTAssertTrue(_camera.isPreviewPaused);
+  FLTCam *camera = [[FLTCam alloc] init];
+  MockFLTThreadSafeFlutterResult *resultObject = [[MockFLTThreadSafeFlutterResult alloc] init];
+
+  [camera pausePreviewWithResult:resultObject];
+  XCTAssertTrue(camera.isPreviewPaused);
 }
 
 - (void)testResumePreviewWithResult_shouldResumePreview {
-  XCTestExpectation* resultExpectation =
-      [self expectationWithDescription:@"Succeeding result with nil value"];
-  [_camera resumePreviewWithResult:^void(id _Nullable result) {
-    XCTAssertNil(result);
-    [resultExpectation fulfill];
-  }];
-  [self waitForExpectationsWithTimeout:2.0 handler:nil];
-  XCTAssertFalse(_camera.isPreviewPaused);
+  FLTCam *camera = [[FLTCam alloc] init];
+  MockFLTThreadSafeFlutterResult *resultObject = [[MockFLTThreadSafeFlutterResult alloc] init];
+
+  [camera resumePreviewWithResult:resultObject];
+  XCTAssertFalse(camera.isPreviewPaused);
 }
 
 @end

packages/camera/camera/example/ios/RunnerTests/CameraPreviewPauseTests.m

@@ -0,0 +1,25 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef MockFLTThreadSafeFlutterResult_h
+#define MockFLTThreadSafeFlutterResult_h
+
+/**
+ * Extends FLTThreadSafeFlutterResult to give tests the ability to wait on the result and
+ * read the received result.
+ */
+@interface MockFLTThreadSafeFlutterResult : FLTThreadSafeFlutterResult
+@property(readonly, nonatomic, nonnull) XCTestExpectation *expectation;
+@property(nonatomic, nullable) id receivedResult;
+
+/**
+ * Initializes the MockFLTThreadSafeFlutterResult with an expectation.
+ *
+ * The expectation is fullfilled when a result is called allowing tests to await the result in an
+ * asynchronous manner.
+ */
+- (nonnull instancetype)initWithExpectation:(nonnull XCTestExpectation *)expectation;
+@end
+
+#endif /* MockFLTThreadSafeFlutterResult_h */

packages/camera/camera/example/ios/RunnerTests/MockFLTThreadSafeFlutterResult.h

@@ -0,0 +1,27 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+@import camera;
+@import XCTest;
+
+#import "MockFLTThreadSafeFlutterResult.h"
+
+@implementation MockFLTThreadSafeFlutterResult
+
+- (instancetype)initWithExpectation:(XCTestExpectation *)expectation {
+  self = [super init];
+  _expectation = expectation;
+  return self;
+}
+
+- (void)sendSuccessWithData:(id)data {
+  self.receivedResult = data;
+  [self.expectation fulfill];
+}
+
+- (void)sendSuccess {
+  self.receivedResult = nil;
+  [self.expectation fulfill];
+}
+@end