[Image Picker] - Use native Android APIs for taking images with camera and remove unneeded 3rd party dependency #453

roughike · 2018-03-31T12:05:06Z

Changes:

use the native Android APIs for taking images with the camera
remove the Gradle dependency for the 3rd party library previously used for capturing camera images
some housekeeping & refactoring

Issues fixed:

App not compiling flutter#15246 and flutter-firebase codelab - Missing repository for imagepicker package flutter#14487 would be fixed by this, but that would need the codelab (the tutorial & the starting point for that step) to be updated as well.
potentially ImagePicker plugin tip of tree no longer works with Android. flutter#16164

Sorry for the big commit; I was trying to introduce the changes to existing code, but I found it hard so I did some refactoring.

No breaking API changes this time.

CC @goderbauer @jonahwilliams as you guys reviewed the last one.

…th the camera. * removing the esafirm android-image-picker dependency * using native Android APIs for taking images with camer * some code cleanup and refactoring

…SdkVersion.

mravn-google · 2018-04-02T13:00:34Z

...ges/image_picker/android/src/main/java/io/flutter/plugins/imagepicker/ImagePickerPlugin.java

-
-    pendingResult = result;
-    methodCall = call;
+    ensureActivityIsInForeground(result);


You probably want to return, if this is not the case.

goderbauer

Please also update the version number in the pubspec.yaml and add an entry to the changelog.

goderbauer · 2018-04-02T14:11:14Z

packages/image_picker/android/src/main/AndroidManifest.xml

@@ -1,3 +1,17 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
  package="io.flutter.plugins.imagepicker">
-</manifest>
+    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>


Do people still need to add this to their own app as well es described in the README? https://github.com/flutter/plugins/tree/f2210c5403057b9ec8038b00c4b867f55c9b038a/packages/image_picker#android

Or should that be updated as well?

These permissions should get merged to the main app's Android Manifest according to the Manifest Merger documentation.

I updated the Android-specific instructions in the README.

goderbauer · 2018-04-02T14:13:32Z

packages/image_picker/android/build.gradle

@@ -37,8 +37,5 @@ android {
 }

 dependencies {
-    api 'com.github.bumptech.glide:glide:4.0.0'


(This comment is about lines 19-21, but github doesn't allow me to comment there)

Can the jitpack.io repository be removed now that we removed the external library? I think we only added it to get the external library.

goderbauer · 2018-04-02T14:14:16Z

...s/image_picker/android/src/main/java/io/flutter/plugins/imagepicker/ImagePickerDelegate.java

@@ -0,0 +1,248 @@
+package io.flutter.plugins.imagepicker;


This file needs a license header.

goderbauer · 2018-04-02T14:15:10Z

...s/image_picker/android/src/main/java/io/flutter/plugins/imagepicker/ImagePickerDelegate.java

+import java.util.List;
+import java.util.UUID;
+
+public class ImagePickerDelegate


Can you please add some do comments to the public members of this class to make the lives of future developers working on this code easier?

What are the most painful parts that would need documenting?

I find it to be pretty self-documenting (heh), but that might be because I've refactored and stared at this code a lot. :)

How about at least one overall doc comment for the entire class?

goderbauer · 2018-04-02T14:18:56Z

packages/image_picker/android/src/main/java/io/flutter/plugins/imagepicker/ImageResizer.java

+    this.exifDataCopier = exifDataCopier;
+  }
+
+  String resizeImageIfNeeded(String imagePath, Double maxWidth, Double maxHeight) {


Can you document what this method returns (e.g. the path of the rescaled image or the original path if no scalling was necessary)?

goderbauer · 2018-04-02T14:38:08Z

...s/image_picker/android/src/main/java/io/flutter/plugins/imagepicker/ImagePickerDelegate.java

+    return false;
+  }
+
+  private boolean handleChoosePictureResult(int resultCode, Intent data) {


this method always returns true. What is the return value supposed to indicate?

goderbauer · 2018-04-02T14:38:43Z

...s/image_picker/android/src/main/java/io/flutter/plugins/imagepicker/ImagePickerDelegate.java

+    return true;
+  }
+
+  private boolean handleTakePictureResult(int resultCode) {


this also always returns true.

goderbauer · 2018-04-02T14:39:33Z

...s/image_picker/android/src/main/java/io/flutter/plugins/imagepicker/ImagePickerDelegate.java

+
+      clearMethodCallAndResult();
+    } else {
+      throw new IllegalStateException("Received images from picker that were not requested");


@mravn-google When should we throw and when return an error from a plugin?

I think we should use result.error(...) explicitly only for errors that are relevant to the abstraction provided by the channel-based API. Programming errors in Java code should just lead to RuntimeExceptions, as usual. If they occur as part of onMethodCall, they would be logged on the Java side, and relayed to the Dart side as a generic "error" (code).

We need to make sure that we provide some result, lest a Dart Future will never complete.

goderbauer · 2018-04-02T14:42:43Z

...s/image_picker/android/src/main/java/io/flutter/plugins/imagepicker/ImagePickerDelegate.java

+      String path = FileUtils.getPathFromUri(registrar, data.getData());
+      handleResult(path);
+      return true;
+    } else if (resultCode != Activity.RESULT_CANCELED) {


So on Activity.RESULT_CANCELED we don't send anything back to the dart side? Will that not cause the app to hang because somebody is awaiting a result there?

goderbauer · 2018-04-02T14:44:26Z

...s/image_picker/android/src/main/java/io/flutter/plugins/imagepicker/ImagePickerDelegate.java

+      pendingResult.error("PICK_ERROR", "Error taking photo", null);
+      clearMethodCallAndResult();
+    }
+    return true;


What if Activity.RESULT_CANCELED? Don't we have to send something back to the dart side?

There is also an inconsistency compared to handleChoosePictureResult where clearMethodCallAndResult would also happen on Activity.RESULT_CANCELED.

roughike · 2018-04-02T22:17:11Z

…ty library.

… images.

…ntime permissions.

…ssion to READ.

* Android has no concept of "RESULT_ERROR" in Activity results; remove the "error picking image" methodcall result * Make the handleChoosePictureResult and handleTakePictureResult method signatures void, and return boolean on the activity result override method instead

…ive.

…no need for write permissions.

… photos.

…ncels picking the image. * Make sure that every path resolves with a result on Android side * Update the CHANGELOG to notify about the breaking change * Update `pickImage` method & sample app to handle null image paths gracefully * Add tests for the case where the image path is null

…app doesn't crash.

roughike · 2018-04-03T13:22:07Z

First feedback round incorporated, except for the "document public methods" part.

Waiting for:

input on what parts to document in ImagePickerDelegate.java
further feedback, if any.

goderbauer · 2018-04-03T15:29:40Z

packages/image_picker/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.4.1
+
+* **Breaking change**. The `pickImage` method will now return null when the user cancels picking the image or denies the needed permissions.


For a breaking change you should bump this to 0.5.0.

I am wondering: What was the behavior before when the user cancelled?

Correct me if I'm wrong, but the previous way was actually ignoring the RESULT_CANCELED alltogether and discarding the pendingResult:

User canceled picking images from gallery

User canceled taking images with camera

lol. You're right, it would just hang I guess. Thanks for fixing that.

I think this is just a bugfix, we can leave the version number as 0.4.1 and you can remove the breaking change from the changelog.

goderbauer · 2018-04-03T15:31:36Z

packages/image_picker/README.md

@@ -39,6 +32,13 @@ class _MyHomePageState extends State<MyHomePage> {

  getImage() async {
    var _fileName = await ImagePicker.pickImage(source: ImageSource.camera);
+
+    if (_fileName == null) {


I'd think for this example you'd still want to set imageFile to null if the user cancels. That way, the message "No image selected" is displayed on screen again.

goderbauer · 2018-04-03T15:32:11Z

packages/image_picker/android/build.gradle

-    api 'com.github.esafirm.android-image-picker:imagepicker:1.9.2@aar'
-    api 'com.android.support:appcompat-v7:26.1.0'
-    api 'com.android.support:recyclerview-v7:26.1.0'
+    api 'com.android.support:appcompat-v7:27.1.0'


(This comment is about lines 19-21, but github doesn't allow me to comment there)

Can the jitpack.io repository be removed now that we removed the external library? I think we only added it to get the external library.

goderbauer · 2018-04-03T15:32:55Z

...s/image_picker/android/src/main/java/io/flutter/plugins/imagepicker/ImagePickerDelegate.java

+import java.util.List;
+import java.util.UUID;
+
+public class ImagePickerDelegate


How about at least one overall doc comment for the entire class?

goderbauer · 2018-04-03T15:36:43Z

...s/image_picker/android/src/main/java/io/flutter/plugins/imagepicker/ImagePickerDelegate.java

+
+  public void chooseImageFromGallery(MethodCall methodCall, MethodChannel.Result result) {
+    if (!setPendingMethodCallAndResult(methodCall, result)) {
+      return;


I would find the code easier to understand if the finishWIthError would happen here and not inside the setPendingMethodCallAndResult. finishWithError is a strange side effect of a setter.

goderbauer · 2018-04-03T15:40:24Z

...s/image_picker/android/src/main/java/io/flutter/plugins/imagepicker/ImagePickerDelegate.java

+    Intent intent = new Intent(MediaStore.ACTION_IMAGE_CAPTURE);
+    boolean canTakePhotos = intent.resolveActivity(activity.getPackageManager()) != null;
+
+    if (canTakePhotos) {


nit: I would find this easier to understand if you turn it arround:

if(!canTakePhotos) { finishWithError(...); return; } // take photo

This also applies to code further down.

goderbauer · 2018-04-03T15:47:36Z

packages/image_picker/test/image_picker_test.dart

+      test('handles a null image path response gracefully', () {
+        channel.setMockMethodCallHandler((MethodCall methodCall) => null);
+
+        ImagePicker.pickImage(source: ImageSource.gallery);


This test case looks strange. What do you want to test? That the call doesn't throw? Or that it returns null? Either way, it should be clear from the test case.

The File constructor will throw an error if the image path passed to it is null, which will fail the test. If the test runs, all is good.

I don't know if there's any better way of testing this, but happy to hear if there is. :)

I would do something like expect(await ImagePicker.pickImage(...), isNull); to state the fact that you expect this to simply return null and nothing else.

goderbauer · 2018-04-03T15:50:24Z

Can you also please merge the latest master in to make Cirrus CI pass? Thanks.

…hout-external-libs

roughike · 2018-04-03T16:15:21Z

Alrighty! Second round it is. I'll be ready in one hour or so.

set _fileName to null even if the picked image is null in the README example
make the test case less strange
remove "breaking change" from the changelog and modify it a little
remove the jitpack.io dependency yet again
move the finishWithError calls out of the setPendingMethodCallAndResult method
turn the canTakePhotos statement around
document the ImagePickerDelegate class

… bugfix, not a breaking change.

…place.

roughike · 2018-04-03T17:16:02Z

Second round done.

Turns out I'm not that good in writing class-level documentation.

fkorotkov · 2018-04-03T17:32:31Z

There was a short Google Cloud incident with Kubernetes engine in US region where Cirrus CI runs builds for OSS projects. That's why is was failing. Now all should be good.

goderbauer · 2018-04-03T18:10:08Z

Can you address the formatting failures in https://travis-ci.org/flutter/plugins/jobs/361739005? Thanks.

goderbauer

LGTM

roughike · 2018-04-03T18:53:04Z

@goderbauer Great!

Is there a place for raising issues about the codelabs? They use a pretty outdated version of the image picker.

goderbauer · 2018-04-03T20:13:12Z

Can you file an issue about it in https://github.com/flutter/flutter? I'll find out which people to tag. If you feel ambitious, you could also send a PR to https://github.com/flutter/friendlychat-steps with suggested code changes to update the codelab.

goderbauer · 2018-04-03T20:15:06Z

This is now live: https://pub.dartlang.org/packages/image_picker

Thanks for the contribution.

…a and remove unneeded 3rd party dependency (flutter#453) Changes: * use the native Android APIs for taking images with the camera * remove the Gradle dependency for the 3rd party library previously used for capturing camera images * some housekeeping & refactoring

Iiro Krankka added 2 commits March 31, 2018 14:43

Dropping the third party library dependency used for taking images wi…

fd06267

…th the camera. * removing the esafirm android-image-picker dependency * using native Android APIs for taking images with camer * some code cleanup and refactoring

Removed unused dependencies and updated the rest to match the compile…

4678c2f

…SdkVersion.

googlebot added the cla: yes label Mar 31, 2018

mravn-google reviewed Apr 2, 2018

View reviewed changes

goderbauer suggested changes Apr 2, 2018

View reviewed changes

mravn-google assigned goderbauer Apr 2, 2018

goderbauer mentioned this pull request Apr 3, 2018

ImagePicker plugin tip of tree no longer works with Android. flutter/flutter#16164

Closed

Iiro Krankka added 17 commits April 3, 2018 11:00

Removed the unneeded JitPack dependency that was used for the 3rd par…

5b18eb3

…ty library.

Add license header for ImagePickerDelegate

4b0a4f7

Returning early if the activity is not in the foreground when picking…

1f0ef39

… images.

Add the missing targetSdkVersion to sample app so that it supports ru…

ad6a698

…ntime permissions.

Request only needed permissions & switch WRITE external storage permi…

4cff7f8

…ssion to READ.

Rename registrar to activity, since that was originally a mistake.

5de28f1

Stop picking images if there's already an existing pending result act…

c01a901

…ive.

Using the external files directory for scaled images so that there's …

5b52b03

…no need for write permissions.

Delivering error results when there's no cameras available for taking…

423b288

… photos.

Return null image path when permissions are denied so that the whole …

84c9c51

…app doesn't crash.

Updated Android installation documentation.

7ac9ca3

Documenting the resizeImageIfNeeded method.

29bfe94

Bumped up the version number and finished the changelog.

3e10d4a

Formatting.

cdd0a14

Removed the redundant FileProvider subclass.

56e6cce

goderbauer suggested changes Apr 3, 2018

View reviewed changes

Merge remote-tracking branch 'upstream/master' into camera-images-wit…

095ce1a

…hout-external-libs

Iiro Krankka added 7 commits April 3, 2018 19:21

Fixed the README example.

18d2a8c

Make the test case a little more explicit.

167ce4b

Clarified that pickImage returning null when cancelling is actually a…

0266f42

… bugfix, not a breaking change.

Removed the unneeded jitpack.io dependency.

f9c2fe5

Refactor side effects from setPendingMethodCallAndResult to a proper …

c7f7284

…place.

Turning the "canTakePhotos" if statement around for better readability.

c058c0c

Class-level documentation for the ImagePickerDelegate.

c2c6cb4

Formatting.

4023f50

goderbauer approved these changes Apr 3, 2018

View reviewed changes

goderbauer merged commit c00a2b6 into flutter:master Apr 3, 2018

roughike deleted the camera-images-without-external-libs branch April 3, 2018 20:16

		@@ -1,3 +1,8 @@
		## 0.4.1

		* Breaking change. The `pickImage` method will now return null when the user cancels picking the image or denies the needed permissions.

[Image Picker] - Use native Android APIs for taking images with camera and remove unneeded 3rd party dependency #453

[Image Picker] - Use native Android APIs for taking images with camera and remove unneeded 3rd party dependency #453

Conversation

roughike commented Mar 31, 2018 • edited Loading

Choose a reason for hiding this comment

goderbauer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

roughike Apr 3, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mravn-google Apr 2, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

roughike commented Apr 2, 2018 • edited Loading

roughike commented Apr 3, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goderbauer commented Apr 3, 2018

roughike commented Apr 3, 2018 • edited Loading

roughike commented Apr 3, 2018

fkorotkov commented Apr 3, 2018

goderbauer commented Apr 3, 2018

goderbauer left a comment

Choose a reason for hiding this comment

roughike commented Apr 3, 2018

goderbauer commented Apr 3, 2018

goderbauer commented Apr 3, 2018

roughike commented Mar 31, 2018 •

edited

Loading

roughike Apr 3, 2018 •

edited

Loading

mravn-google Apr 2, 2018 •

edited

Loading

roughike commented Apr 2, 2018 •

edited

Loading

roughike commented Apr 3, 2018 •

edited

Loading

roughike commented Apr 3, 2018 •

edited

Loading