Skip to content

[camera_avfoundation] Implementation swift migration - part 2 #9007

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/camera/camera_avfoundation/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 0.9.18+15

* Migrates the CameraPlugin class to Swift.

## 0.9.18+14

* Creates Swift Package Manager target for Swift implementation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@
97C146FE1CF9000F007C117D /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FD1CF9000F007C117D /* Assets.xcassets */; };
97C147011CF9000F007C117D /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 97C146FF1CF9000F007C117D /* LaunchScreen.storyboard */; };
97DB234D2D566D0700CEFE66 /* CameraPreviewPauseTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 97DB234C2D566D0700CEFE66 /* CameraPreviewPauseTests.swift */; };
E0CDBAC227CD9729002561D9 /* QueueTestUtils.m in Sources */ = {isa = PBXBuildFile; fileRef = E0CDBAC127CD9729002561D9 /* QueueTestUtils.m */; };
E11D6A8F2D81B81D0031E6C5 /* MockCaptureVideoDataOutput.swift in Sources */ = {isa = PBXBuildFile; fileRef = E11D6A8E2D81B81D0031E6C5 /* MockCaptureVideoDataOutput.swift */; };
E11D6A912D82C7740031E6C5 /* FLTCamExposureTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = E11D6A902D82C7740031E6C5 /* FLTCamExposureTests.swift */; };
E12C4FF62D68C69000515E70 /* CameraPluginDelegatingMethodTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = E12C4FF52D68C69000515E70 /* CameraPluginDelegatingMethodTests.swift */; };
Expand Down Expand Up @@ -131,8 +130,6 @@
9DDC4CE84A8B378AE4A8CD9C /* libPods-RunnerTests.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = "libPods-RunnerTests.a"; sourceTree = BUILT_PRODUCTS_DIR; };
A8F314CD1C64E9257EBC811D /* Pods-Runner.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Runner.debug.xcconfig"; path = "Target Support Files/Pods-Runner/Pods-Runner.debug.xcconfig"; sourceTree = "<group>"; };
B61D98BBC8FB276D1C4A7BB2 /* Pods-RunnerTests.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-RunnerTests.debug.xcconfig"; path = "Target Support Files/Pods-RunnerTests/Pods-RunnerTests.debug.xcconfig"; sourceTree = "<group>"; };
E0CDBAC027CD9729002561D9 /* QueueTestUtils.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = QueueTestUtils.h; sourceTree = "<group>"; };
E0CDBAC127CD9729002561D9 /* QueueTestUtils.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = QueueTestUtils.m; sourceTree = "<group>"; };
E11D6A8E2D81B81D0031E6C5 /* MockCaptureVideoDataOutput.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockCaptureVideoDataOutput.swift; sourceTree = "<group>"; };
E11D6A902D82C7740031E6C5 /* FLTCamExposureTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FLTCamExposureTests.swift; sourceTree = "<group>"; };
E12C4FF52D68C69000515E70 /* CameraPluginDelegatingMethodTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CameraPluginDelegatingMethodTests.swift; sourceTree = "<group>"; };
Expand All @@ -147,12 +144,12 @@
E142F13F2D85AD7900824824 /* MockCaptureConnection.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockCaptureConnection.swift; sourceTree = "<group>"; };
E142F1412D85AFA400824824 /* MockGlobalEventApi.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockGlobalEventApi.swift; sourceTree = "<group>"; };
E15139172D80980900FEE47B /* FLTCamSetDeviceOrientationTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FLTCamSetDeviceOrientationTests.swift; sourceTree = "<group>"; };
E15BC7E32D86D08700F66474 /* MockFlutterTextureRegistry.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockFlutterTextureRegistry.swift; sourceTree = "<group>"; };
E15BC7E52D86D17D00F66474 /* MockFlutterBinaryMessenger.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockFlutterBinaryMessenger.swift; sourceTree = "<group>"; };
E15BC7E72D86D29F00F66474 /* MockAssetWriter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockAssetWriter.swift; sourceTree = "<group>"; };
E15BC7E92D86D41F00F66474 /* MockAssetWriterInput.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockAssetWriterInput.swift; sourceTree = "<group>"; };
E15BC7EB2D86D50200F66474 /* MockAssetWriterInputPixelBufferAdaptor.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockAssetWriterInputPixelBufferAdaptor.swift; sourceTree = "<group>"; };
E15BC7ED2D86D85500F66474 /* MockCaptureDevice.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockCaptureDevice.swift; sourceTree = "<group>"; };
E15BC7E32D86D08700F66474 /* MockFlutterTextureRegistry.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockFlutterTextureRegistry.swift; sourceTree = "<group>"; };
E15BC7E52D86D17D00F66474 /* MockFlutterBinaryMessenger.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MockFlutterBinaryMessenger.swift; sourceTree = "<group>"; };
E16602942D8471C0003CFE12 /* FLTCamZoomTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FLTCamZoomTests.swift; sourceTree = "<group>"; };
E1A5F4E22D80259C0005BA64 /* FLTCamSetFlashModeTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FLTCamSetFlashModeTests.swift; sourceTree = "<group>"; };
E1ABED702D943DC700AED9CC /* MockCaptureDeviceInputFactory.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = MockCaptureDeviceInputFactory.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -190,8 +187,6 @@
children = (
7F29EB3F2D281C6D00740257 /* Mocks */,
03BB766C2665316900CE5A93 /* Info.plist */,
E0CDBAC027CD9729002561D9 /* QueueTestUtils.h */,
E0CDBAC127CD9729002561D9 /* QueueTestUtils.m */,
E142681E2D8566230046CBBC /* CameraTestUtils.swift */,
979B3DF92D5B6BA2009BDE1A /* ExceptionCatcher.h */,
979B3DFA2D5B6BC7009BDE1A /* ExceptionCatcher.m */,
Expand Down Expand Up @@ -565,7 +560,6 @@
E15139182D80980900FEE47B /* FLTCamSetDeviceOrientationTests.swift in Sources */,
972CA92B2D5A1D8C004B846F /* CameraPropertiesTests.swift in Sources */,
E15BC7E42D86D08700F66474 /* MockFlutterTextureRegistry.swift in Sources */,
E0CDBAC227CD9729002561D9 /* QueueTestUtils.m in Sources */,
978296CF2D5F744B0009BDD3 /* PhotoCaptureTests.swift in Sources */,
979B3E002D5B9E6C009BDE1A /* CameraMethodChannelTests.swift in Sources */,
E142F13C2D8596F100824824 /* MockCaptureDeviceFormat.swift in Sources */,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ final class AvailableCamerasTest: XCTestCase {
permissionManager: MockFLTCameraPermissionManager(),
deviceFactory: { _ in MockCaptureDevice() },
captureSessionFactory: { MockCaptureSession() },
captureDeviceInputFactory: MockCaptureDeviceInputFactory()
captureDeviceInputFactory: MockCaptureDeviceInputFactory(),
captureSessionQueue: DispatchQueue(label: "io.flutter.camera.captureSessionQueue")
)
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,26 @@ import XCTest
#endif

final class CameraCaptureSessionQueueRaceConditionTests: XCTestCase {
private func createCameraPlugin() -> CameraPlugin {
return CameraPlugin(
private func createCameraPlugin() -> (CameraPlugin, DispatchQueue) {
let captureSessionQueue = DispatchQueue(label: "io.flutter.camera.captureSessionQueue")

let cameraPlugin = CameraPlugin(
registry: MockFlutterTextureRegistry(),
messenger: MockFlutterBinaryMessenger(),
globalAPI: MockGlobalEventApi(),
deviceDiscoverer: MockCameraDeviceDiscoverer(),
permissionManager: MockFLTCameraPermissionManager(),
deviceFactory: { _ in MockCaptureDevice() },
captureSessionFactory: { MockCaptureSession() },
captureDeviceInputFactory: MockCaptureDeviceInputFactory()
captureDeviceInputFactory: MockCaptureDeviceInputFactory(),
captureSessionQueue: captureSessionQueue
)

return (cameraPlugin, captureSessionQueue)
}

func testFixForCaptureSessionQueueNullPointerCrashDueToRaceCondition() {
let cameraPlugin = createCameraPlugin()
let (cameraPlugin, captureSessionQueue) = createCameraPlugin()
let disposeExpectation = expectation(description: "dispose's result block must be called")
let createExpectation = expectation(description: "create's result block must be called")

Expand Down Expand Up @@ -55,6 +60,6 @@ final class CameraCaptureSessionQueueRaceConditionTests: XCTestCase {
// `captureSessionQueue` passed into `AVCaptureVideoDataOutput::setSampleBufferDelegate:queue:`
// API will cause a crash.
XCTAssertNotNil(
cameraPlugin.captureSessionQueue, "captureSessionQueue must not be nil after create method.")
captureSessionQueue, "captureSessionQueue must not be nil after create method.")
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ final class CameraMethodChannelTests: XCTestCase {
permissionManager: MockFLTCameraPermissionManager(),
deviceFactory: { _ in MockCaptureDevice() },
captureSessionFactory: { session },
captureDeviceInputFactory: MockCaptureDeviceInputFactory()
captureDeviceInputFactory: MockCaptureDeviceInputFactory(),
captureSessionQueue: DispatchQueue(label: "io.flutter.camera.captureSessionQueue")
)
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,14 @@ private final class MockUIDevice: UIDevice {

final class CameraOrientationTests: XCTestCase {
private func createCameraPlugin() -> (
CameraPlugin, MockFLTCam, MockGlobalEventApi, MockCaptureDevice, MockCameraDeviceDiscoverer
CameraPlugin, MockFLTCam, MockGlobalEventApi, MockCaptureDevice, MockCameraDeviceDiscoverer,
DispatchQueue
) {
let mockDevice = MockCaptureDevice()
let mockCamera = MockFLTCam()
let mockEventAPI = MockGlobalEventApi()
let mockDeviceDiscoverer = MockCameraDeviceDiscoverer()
let captureSessionQueue = DispatchQueue(label: "io.flutter.camera.captureSessionQueue")

let cameraPlugin = CameraPlugin(
registry: MockFlutterTextureRegistry(),
Expand All @@ -38,11 +40,14 @@ final class CameraOrientationTests: XCTestCase {
permissionManager: MockFLTCameraPermissionManager(),
deviceFactory: { _ in mockDevice },
captureSessionFactory: { MockCaptureSession() },
captureDeviceInputFactory: MockCaptureDeviceInputFactory()
captureDeviceInputFactory: MockCaptureDeviceInputFactory(),
captureSessionQueue: captureSessionQueue
)
cameraPlugin.camera = mockCamera

return (cameraPlugin, mockCamera, mockEventAPI, mockDevice, mockDeviceDiscoverer)
return (
cameraPlugin, mockCamera, mockEventAPI, mockDevice, mockDeviceDiscoverer, captureSessionQueue
)
}

private func waitForRoundTrip(with queue: DispatchQueue) {
Expand All @@ -55,9 +60,12 @@ final class CameraOrientationTests: XCTestCase {
waitForExpectations(timeout: 30, handler: nil)
}

private func sendOrientation(_ orientation: UIDeviceOrientation, to cameraPlugin: CameraPlugin) {
private func sendOrientation(
_ orientation: UIDeviceOrientation, to cameraPlugin: CameraPlugin,
captureSessionQueue: DispatchQueue
) {
cameraPlugin.orientationChanged(createMockNotification(for: orientation))
waitForRoundTrip(with: cameraPlugin.captureSessionQueue)
waitForRoundTrip(with: captureSessionQueue)
}

private func createMockNotification(for deviceOrientation: UIDeviceOrientation) -> Notification {
Expand All @@ -67,36 +75,36 @@ final class CameraOrientationTests: XCTestCase {
}

func testOrientationNotifications() {
let (cameraPlugin, _, mockEventAPI, _, _) = createCameraPlugin()
let (cameraPlugin, _, mockEventAPI, _, _, captureSessionQueue) = createCameraPlugin()

sendOrientation(.portraitUpsideDown, to: cameraPlugin)
sendOrientation(.portraitUpsideDown, to: cameraPlugin, captureSessionQueue: captureSessionQueue)
XCTAssertEqual(mockEventAPI.lastOrientation, .portraitDown)
sendOrientation(.portrait, to: cameraPlugin)
sendOrientation(.portrait, to: cameraPlugin, captureSessionQueue: captureSessionQueue)
XCTAssertEqual(mockEventAPI.lastOrientation, .portraitUp)
sendOrientation(.landscapeLeft, to: cameraPlugin)
sendOrientation(.landscapeLeft, to: cameraPlugin, captureSessionQueue: captureSessionQueue)
XCTAssertEqual(mockEventAPI.lastOrientation, .landscapeLeft)
sendOrientation(.landscapeRight, to: cameraPlugin)
sendOrientation(.landscapeRight, to: cameraPlugin, captureSessionQueue: captureSessionQueue)
XCTAssertEqual(mockEventAPI.lastOrientation, .landscapeRight)
}

func testOrientationNotificationsNotCalledForFaceUp() {
let (cameraPlugin, _, mockEventAPI, _, _) = createCameraPlugin()
sendOrientation(.faceUp, to: cameraPlugin)
let (cameraPlugin, _, mockEventAPI, _, _, captureSessionQueue) = createCameraPlugin()
sendOrientation(.faceUp, to: cameraPlugin, captureSessionQueue: captureSessionQueue)
XCTAssertFalse(mockEventAPI.deviceOrientationChangedCalled)
}

func testOrientationNotificationsNotCalledForFaceDown() {
let (cameraPlugin, _, mockEventAPI, _, _) = createCameraPlugin()
sendOrientation(.faceDown, to: cameraPlugin)
let (cameraPlugin, _, mockEventAPI, _, _, captureSessionQueue) = createCameraPlugin()
sendOrientation(.faceDown, to: cameraPlugin, captureSessionQueue: captureSessionQueue)
XCTAssertFalse(mockEventAPI.deviceOrientationChangedCalled)
}

func testOrientationUpdateMustBeOnCaptureSessionQueue() {
let queueExpectation = expectation(
description: "Orientation update must happen on the capture session queue")
let (cameraPlugin, mockCamera, _, _, _) = createCameraPlugin()
let (cameraPlugin, mockCamera, _, _, _, captureSessionQueue) = createCameraPlugin()
let captureSessionQueueSpecific = DispatchSpecificKey<Void>()
cameraPlugin.captureSessionQueue.setSpecific(
captureSessionQueue.setSpecific(
key: captureSessionQueueSpecific,
value: ())

Expand All @@ -111,7 +119,7 @@ final class CameraOrientationTests: XCTestCase {
}

func testOrientationChangedNoRetainCycle() {
let (_, mockCamera, mockEventAPI, mockDevice, mockDeviceDiscoverer) = createCameraPlugin()
let (_, mockCamera, mockEventAPI, mockDevice, mockDeviceDiscoverer, _) = createCameraPlugin()
let captureSessionQueue = DispatchQueue(label: "capture_session_queue")
weak var weakPlugin: CameraPlugin?
weak var weakDevice = mockDevice
Expand All @@ -125,10 +133,10 @@ final class CameraOrientationTests: XCTestCase {
permissionManager: MockFLTCameraPermissionManager(),
deviceFactory: { _ in weakDevice! },
captureSessionFactory: { MockCaptureSession() },
captureDeviceInputFactory: MockCaptureDeviceInputFactory()
captureDeviceInputFactory: MockCaptureDeviceInputFactory(),
captureSessionQueue: captureSessionQueue
)
weakPlugin = cameraPlugin
cameraPlugin.captureSessionQueue = captureSessionQueue
cameraPlugin.camera = mockCamera

cameraPlugin.orientationChanged(createMockNotification(for: .landscapeLeft))
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ final class CameraPluginCreateCameraTests: XCTestCase {
permissionManager: mockPermissionManager,
deviceFactory: { _ in MockCaptureDevice() },
captureSessionFactory: { mockCaptureSession },
captureDeviceInputFactory: MockCaptureDeviceInputFactory()
captureDeviceInputFactory: MockCaptureDeviceInputFactory(),
captureSessionQueue: DispatchQueue(label: "io.flutter.camera.captureSessionQueue")
)

return (cameraPlugin, mockPermissionManager, mockCaptureSession)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ final class CameraPluginDelegatingMethodTests: XCTestCase {
permissionManager: MockFLTCameraPermissionManager(),
deviceFactory: { _ in MockCaptureDevice() },
captureSessionFactory: { MockCaptureSession() },
captureDeviceInputFactory: MockCaptureDeviceInputFactory()
captureDeviceInputFactory: MockCaptureDeviceInputFactory(),
captureSessionQueue: DispatchQueue(label: "io.flutter.camera.captureSessionQueue")
)
cameraPlugin.camera = mockCamera

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,11 @@ import XCTest

final class CameraPluginInitializeCameraTests: XCTestCase {
private func createCameraPlugin() -> (
CameraPlugin, MockFLTCam, MockGlobalEventApi
CameraPlugin, MockFLTCam, MockGlobalEventApi, DispatchQueue
) {
let mockCamera = MockFLTCam()
let mockGlobalEventApi = MockGlobalEventApi()
let captureSessionQueue = DispatchQueue(label: "io.flutter.camera.captureSessionQueue")

let cameraPlugin = CameraPlugin(
registry: MockFlutterTextureRegistry(),
Expand All @@ -26,11 +27,12 @@ final class CameraPluginInitializeCameraTests: XCTestCase {
permissionManager: MockFLTCameraPermissionManager(),
deviceFactory: { _ in MockCaptureDevice() },
captureSessionFactory: { MockCaptureSession() },
captureDeviceInputFactory: MockCaptureDeviceInputFactory()
captureDeviceInputFactory: MockCaptureDeviceInputFactory(),
captureSessionQueue: captureSessionQueue
)
cameraPlugin.camera = mockCamera

return (cameraPlugin, mockCamera, mockGlobalEventApi)
return (cameraPlugin, mockCamera, mockGlobalEventApi, captureSessionQueue)
}

private func waitForRoundTrip(with queue: DispatchQueue) {
Expand All @@ -44,7 +46,7 @@ final class CameraPluginInitializeCameraTests: XCTestCase {
}

func testInitializeCamera_setsCameraOnFrameAvailableCallback() {
let (cameraPlugin, mockCamera, _) = createCameraPlugin()
let (cameraPlugin, mockCamera, _, _) = createCameraPlugin()
let expectation = expectation(description: "Initialization completed")

var onFrameAvailableSet = false
Expand All @@ -64,7 +66,7 @@ final class CameraPluginInitializeCameraTests: XCTestCase {
}

func testInitializeCamera_setsCameraDartAPI() {
let (cameraPlugin, mockCamera, _) = createCameraPlugin()
let (cameraPlugin, mockCamera, _, _) = createCameraPlugin()
let expectation = expectation(description: "Initialization completed")

var dartAPISet = false
Expand All @@ -84,20 +86,20 @@ final class CameraPluginInitializeCameraTests: XCTestCase {
}

func testInitializeCamera_sendsDeviceOrientation() {
let (cameraPlugin, _, mockGlobalEventApi) = createCameraPlugin()
let (cameraPlugin, _, mockGlobalEventApi, captureSessionQueue) = createCameraPlugin()

cameraPlugin.initializeCamera(0, withImageFormat: FCPPlatformImageFormatGroup.bgra8888) {
error in
XCTAssertNil(error)
}

waitForRoundTrip(with: cameraPlugin.captureSessionQueue)
waitForRoundTrip(with: captureSessionQueue)

XCTAssertTrue(mockGlobalEventApi.deviceOrientationChangedCalled)
}

func testInitializeCamera_startsCamera() {
let (cameraPlugin, mockCamera, _) = createCameraPlugin()
let (cameraPlugin, mockCamera, _, _) = createCameraPlugin()
let expectation = expectation(description: "Initialization completed")

var startCalled = false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,8 @@ final class CameraSettingsTests: XCTestCase {
permissionManager: MockFLTCameraPermissionManager(),
deviceFactory: { _ in mockDevice },
captureSessionFactory: { mockSession },
captureDeviceInputFactory: MockCaptureDeviceInputFactory()
captureDeviceInputFactory: MockCaptureDeviceInputFactory(),
captureSessionQueue: DispatchQueue(label: "io.flutter.camera.captureSessionQueue")
)

let expectation = self.expectation(description: "Result finished")
Expand Down
Loading