Skip to content

Commit c85072a

Browse files
committed
[camera_android_camerax] Fix leaked thread per capture in takePicture
Fixes flutter/flutter#190523 `ImageCaptureProxyApi.takePicture` creates a new single-thread executor on every call and never shuts it down. The thread it owns is only reclaimed once its `FinalizableDelegatedExecutorService` wrapper is finalized, at a time the plugin does not control. That executor only delivers an already finished result — it does no real work: - Encoding and file I/O run on CameraX's own IO executor. - `TakePictureRequest.onResult` does nothing but hand the result to the executor the plugin passed in. Dispatch the result on the main executor instead, which is what this plugin's other CameraX callbacks already use: - `CameraControlProxyApi` - `Camera2CameraControlProxyApi` - `ImageAnalysisProxyApi` - `ProcessCameraProviderProxyApi` - `PendingRecordingProxyApi` `PreviewProxyApi` uses the same per-request executor pattern for `SurfaceRequest.provideSurface`. That callback releases a `Surface`, so it is left for a separate change. The two existing `takePicture` tests now stub the main executor on their mock `Context`.
1 parent b5d6c80 commit c85072a

4 files changed

Lines changed: 45 additions & 3 deletions

File tree

‎packages/camera/camera_android_camerax/CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## 0.7.4+5
2+
3+
* Fixes a leaked thread per capture by dispatching the `takePicture` result callback on the main
4+
executor.
5+
16
## 0.7.4+4
27

38
* Fix `NullPointerException` when disposing camera during active video recording.

‎packages/camera/camera_android_camerax/android/src/main/java/io/flutter/plugins/camerax/ImageCaptureProxyApi.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
import androidx.camera.core.ImageCapture;
1010
import androidx.camera.core.ImageCaptureException;
1111
import androidx.camera.core.resolutionselector.ResolutionSelector;
12+
import androidx.core.content.ContextCompat;
1213
import java.io.File;
1314
import java.io.IOException;
14-
import java.util.concurrent.Executors;
1515
import kotlin.Result;
1616
import kotlin.Unit;
1717
import kotlin.jvm.functions.Function1;
@@ -106,7 +106,9 @@ public void takePicture(
106106
createOnImageSavedCallback(temporaryCaptureFile, systemServicesManager, callback);
107107

108108
pigeonInstance.takePicture(
109-
outputFileOptions, Executors.newSingleThreadExecutor(), onImageSavedCallback);
109+
outputFileOptions,
110+
ContextCompat.getMainExecutor(getPigeonRegistrar().getContext()),
111+
onImageSavedCallback);
110112
}
111113

112114
@Override

‎packages/camera/camera_android_camerax/android/src/test/java/io/flutter/plugins/camerax/ImageCaptureTest.java‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,23 @@
55
package io.flutter.plugins.camerax;
66

77
import static org.junit.Assert.assertEquals;
8+
import static org.junit.Assert.assertNull;
89
import static org.mockito.ArgumentMatchers.any;
910
import static org.mockito.Mockito.mock;
1011
import static org.mockito.Mockito.mockStatic;
1112
import static org.mockito.Mockito.verify;
1213
import static org.mockito.Mockito.verifyNoInteractions;
1314
import static org.mockito.Mockito.when;
15+
import static org.robolectric.Shadows.shadowOf;
1416

1517
import android.content.Context;
18+
import android.os.Looper;
1619
import android.view.Surface;
1720
import androidx.annotation.NonNull;
1821
import androidx.camera.core.ImageCapture;
1922
import androidx.camera.core.ImageCaptureException;
2023
import androidx.camera.core.resolutionselector.ResolutionSelector;
24+
import androidx.test.core.app.ApplicationProvider;
2125
import java.io.File;
2226
import java.io.IOException;
2327
import java.util.concurrent.Executor;
@@ -26,6 +30,7 @@
2630
import kotlin.jvm.functions.Function1;
2731
import org.junit.Test;
2832
import org.junit.runner.RunWith;
33+
import org.mockito.ArgumentCaptor;
2934
import org.mockito.MockedStatic;
3035
import org.robolectric.RobolectricTestRunner;
3136

@@ -85,13 +90,41 @@ public void setFlashMode_setsFlashModeOfImageCaptureInstance() {
8590
verify(instance).setFlashMode(ImageCapture.FLASH_MODE_AUTO);
8691
}
8792

93+
@Test
94+
public void takePicture_runsCallbackOnTheMainExecutor() {
95+
final ProxyApiRegistrar apiRegistrar = new TestProxyApiRegistrar();
96+
apiRegistrar.setContext(ApplicationProvider.getApplicationContext());
97+
98+
final PigeonApiImageCapture api = apiRegistrar.getPigeonApiImageCapture();
99+
final ImageCapture instance = mock(ImageCapture.class);
100+
101+
api.takePicture(
102+
instance, mock(SystemServicesManager.class), ResultCompat.asCompatCallback(reply -> null));
103+
104+
final ArgumentCaptor<Executor> executorCaptor = ArgumentCaptor.forClass(Executor.class);
105+
verify(instance)
106+
.takePicture(
107+
any(ImageCapture.OutputFileOptions.class),
108+
executorCaptor.capture(),
109+
any(ImageCapture.OnImageSavedCallback.class));
110+
111+
final Thread[] callbackThread = {null};
112+
executorCaptor.getValue().execute(() -> callbackThread[0] = Thread.currentThread());
113+
assertNull(callbackThread[0]);
114+
115+
shadowOf(Looper.getMainLooper()).idle();
116+
assertEquals(Looper.getMainLooper().getThread(), callbackThread[0]);
117+
}
118+
88119
@Test
89120
public void
90121
takePicture_sendsRequestToTakePictureWithExpectedConfigurationWhenTemporaryFileCanBeCreated() {
91122
final ProxyApiRegistrar mockApiRegistrar = mock(ProxyApiRegistrar.class);
92123
final Context mockContext = mock(Context.class);
93124
final File mockOutputDir = mock(File.class);
94125
when(mockContext.getCacheDir()).thenReturn(mockOutputDir);
126+
when(mockContext.getMainExecutor()).thenReturn(Runnable::run);
127+
when(mockContext.getMainLooper()).thenReturn(Looper.getMainLooper());
95128
when(mockApiRegistrar.getContext()).thenReturn(mockContext);
96129

97130
final String filename = "myFile.jpg";
@@ -194,6 +227,8 @@ public void takePicture_onImageSavedCallbackSendsErrorAndReportsException() {
194227
final File mockOutputDir = mock(File.class);
195228
final SystemServicesManager mockSystemServicesManager = mock(SystemServicesManager.class);
196229
when(mockContext.getCacheDir()).thenReturn(mockOutputDir);
230+
when(mockContext.getMainExecutor()).thenReturn(Runnable::run);
231+
when(mockContext.getMainLooper()).thenReturn(Looper.getMainLooper());
197232
when(mockApiRegistrar.getContext()).thenReturn(mockContext);
198233

199234
final ImageCaptureException captureException = mock(ImageCaptureException.class);

‎packages/camera/camera_android_camerax/pubspec.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ name: camera_android_camerax
22
description: Android implementation of the camera plugin using the CameraX library.
33
repository: https://github.com/flutter/packages/tree/main/packages/camera/camera_android_camerax
44
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+camera%22
5-
version: 0.7.4+4
5+
version: 0.7.4+5
66

77
environment:
88
sdk: ^3.12.0

0 commit comments

Comments
 (0)