Skip to content
This repository was archived by the owner on Feb 22, 2023. It is now read-only.

[image_picker] add requestFullMetadata for iOS (optional permissions) #4638

Closed
wants to merge 50 commits into from
Closed

[image_picker] add requestFullMetadata for iOS (optional permissions) #4638

Show file tree
Hide file tree
Changes from 47 commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
5d3a9aa
Added new image picking method with flag for controlling metadata
PiotrMitkowski Jan 3, 2022
4195dca
Updated tests with cases for the new method
PiotrMitkowski Jan 3, 2022
7d255de
Updated changelog in platform interface and app-facing package to mat…
PiotrMitkowski Jan 3, 2022
3fd7383
Updated app-facing package to call new method from platform interface
PiotrMitkowski Jan 3, 2022
686bc22
Merge branch 'master' of github.com:flutter/plugins into ios-optional…
PiotrMitkowski Jan 12, 2022
1f73191
Fixed version in changelog file
PiotrMitkowski Jan 12, 2022
24d0679
Merge branch 'main' into ios-optional-permissions
PiotrMitkowski Jan 18, 2022
1ba0c73
Merge branch 'main' into ios-optional-permissions
PiotrMitkowski Jan 18, 2022
1084763
PR remarks
PiotrMitkowski Jan 24, 2022
a89ad0a
Renamed flag to better specify its purpose
PiotrMitkowski Jan 24, 2022
8ff7492
Renamed flag in remaining occurences
PiotrMitkowski Jan 24, 2022
193bbe9
Merge branch 'main' into ios-optional-permissions
PiotrMitkowski Jan 24, 2022
95eef20
Fixed formatting and originalAsset assignment
PiotrMitkowski Jan 24, 2022
e10b24e
Merge remote-tracking branch 'origin/ios-optional-permissions' into i…
PiotrMitkowski Jan 24, 2022
f2c2e68
Resolved merge conflicts
PiotrMitkowski Feb 1, 2022
f5f94b2
PR remarks
PiotrMitkowski Feb 14, 2022
97efdca
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Feb 14, 2022
bd3dfeb
Fixed issues after merge
PiotrMitkowski Feb 14, 2022
b99ba07
Added a test for picking image without full metadata
PiotrMitkowski Feb 14, 2022
3d6c45c
Fixed code formatting
PiotrMitkowski Feb 14, 2022
b3e9166
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Apr 7, 2022
bf3f55c
PR remarks
PiotrMitkowski Apr 7, 2022
742b259
Fixed linter warnings
PiotrMitkowski Apr 7, 2022
d41b390
Added dependency overrides for missing modules
PiotrMitkowski Apr 7, 2022
ead2f62
Fixed formatting
PiotrMitkowski Apr 7, 2022
7b6ace9
Added options class for handling image picking settings
PiotrMitkowski Apr 8, 2022
0f43653
Added missing license comment
PiotrMitkowski Apr 8, 2022
c6dcc49
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Apr 13, 2022
9ba71b9
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Apr 14, 2022
c1fc9da
PR remarks
PiotrMitkowski Apr 15, 2022
7f958a6
pbxproj version revert
PiotrMitkowski Apr 15, 2022
c825d09
PR remarks
PiotrMitkowski Apr 27, 2022
a2ca361
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Apr 27, 2022
0120c47
Resolved merge conflicts
PiotrMitkowski Apr 27, 2022
0827c80
Generated Pigeon files for new API and metadata flag
PiotrMitkowski Apr 27, 2022
994e45f
Switched to use options object in private picking method
PiotrMitkowski Apr 28, 2022
9b39e31
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski Apr 28, 2022
933254e
Fixed failing unit tests
PiotrMitkowski Apr 28, 2022
66f14b2
Added missing tests for a new method and request full metadata parameter
PiotrMitkowski Apr 28, 2022
47098ec
Fixed failing native tests
PiotrMitkowski Apr 28, 2022
0a811d8
PR remarks
PiotrMitkowski Apr 29, 2022
0789a7b
Fixed linting
PiotrMitkowski Apr 29, 2022
c5966d4
Removed dependency overrides
PiotrMitkowski May 12, 2022
6f32405
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski May 12, 2022
217237b
PR remarks
PiotrMitkowski May 12, 2022
7a4d250
Fixed linter warnings and failing tests
PiotrMitkowski May 12, 2022
4ee04cb
Removed remaining dependency override
PiotrMitkowski May 12, 2022
b3fb220
Enforcing proper platform interface version having required API changes
PiotrMitkowski May 13, 2022
4d884de
Merge branch 'main' of github.com:flutter/plugins into ios-optional-p…
PiotrMitkowski May 13, 2022
c2240fa
Fixed failing test in app-facing plugin
PiotrMitkowski May 13, 2022
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/image_picker/image_picker/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 0.8.6

* Adds `requestFullMetadata` option to `pickImage`, so images on iOS can be picked without `Photo Library Usage` permission.

## 0.8.5+2

* Minor fixes for new analysis options.
Expand Down
18 changes: 13 additions & 5 deletions packages/image_picker/image_picker/lib/image_picker.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,10 @@ class ImagePicker {
/// the front or rear camera should be opened, this function is not guaranteed
/// to work on an Android device.
///
/// Use `requestFullMetadata` (defaults to `true`) to control how much additional information the plugin tries to get.
/// If `requestFullMetadata` is set to `true`, the plugin tries to get the full image metadata which may require
/// extra permission requests on some platforms, such as `Photo Library Usage` permission on iOS .
///
/// In Android, the MainActivity can be destroyed for various reasons. If that happens, the result will be lost
/// in this call. You can then call [retrieveLostData] when your app relaunches to retrieve the lost data.
///
Expand All @@ -206,13 +210,17 @@ class ImagePicker {
double? maxHeight,
int? imageQuality,
CameraDevice preferredCameraDevice = CameraDevice.rear,
bool requestFullMetadata = true,
}) {
return platform.getImage(
return platform.getImageFromSource(
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to require the version of the platform interface that has this method in pubspec.yaml.

source: source,
maxWidth: maxWidth,
maxHeight: maxHeight,
imageQuality: imageQuality,
preferredCameraDevice: preferredCameraDevice,
options: ImagePickerOptions(
maxWidth: maxWidth,
maxHeight: maxHeight,
imageQuality: imageQuality,
preferredCameraDevice: preferredCameraDevice,
requestFullMetadata: requestFullMetadata,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would also be better to pull the iOS changes into a separate PR and land it first so that you can require that version, otherwise someone who only updates this package will not actually get a working implementation of the new parameter.

),
);
}

Expand Down
2 changes: 1 addition & 1 deletion packages/image_picker/image_picker/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: Flutter plugin for selecting images from the Android and iOS image
library, and taking new pictures with the camera.
repository: https://github.com/flutter/plugins/tree/main/packages/image_picker/image_picker
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+image_picker%22
version: 0.8.5+2
version: 0.8.6

environment:
sdk: ">=2.14.0 <3.0.0"
Expand Down
29 changes: 20 additions & 9 deletions packages/image_picker/image_picker/test/image_picker_deprecated_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,16 @@ void main() {
'maxWidth': null,
'maxHeight': null,
'imageQuality': null,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll need to reconcile the test changes against #5706 once that lands (which is needed to resolve the current tree breakage, so will be before this PR can land).

}),
isMethodCall('pickImage', arguments: <String, dynamic>{
'source': 1,
'maxWidth': null,
'maxHeight': null,
'imageQuality': null,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
],
);
Expand Down Expand Up @@ -103,49 +105,56 @@ void main() {
'maxWidth': null,
'maxHeight': null,
'imageQuality': null,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
isMethodCall('pickImage', arguments: <String, dynamic>{
'source': 0,
'maxWidth': 10.0,
'maxHeight': null,
'imageQuality': null,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
isMethodCall('pickImage', arguments: <String, dynamic>{
'source': 0,
'maxWidth': null,
'maxHeight': 10.0,
'imageQuality': null,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
isMethodCall('pickImage', arguments: <String, dynamic>{
'source': 0,
'maxWidth': 10.0,
'maxHeight': 20.0,
'imageQuality': null,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
isMethodCall('pickImage', arguments: <String, dynamic>{
'source': 0,
'maxWidth': 10.0,
'maxHeight': null,
'imageQuality': 70,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
isMethodCall('pickImage', arguments: <String, dynamic>{
'source': 0,
'maxWidth': null,
'maxHeight': 10.0,
'imageQuality': 70,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
isMethodCall('pickImage', arguments: <String, dynamic>{
'source': 0,
'maxWidth': 10.0,
'maxHeight': 20.0,
'imageQuality': 70,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
],
);
Expand Down Expand Up @@ -182,6 +191,7 @@ void main() {
'maxHeight': null,
'imageQuality': null,
'cameraDevice': 0,
'requestFullMetadata': true,
}),
],
);
Expand All @@ -201,6 +211,7 @@ void main() {
'maxHeight': null,
'imageQuality': null,
'cameraDevice': 1,
'requestFullMetadata': true,
}),
],
);
Expand Down
48 changes: 39 additions & 9 deletions packages/image_picker/image_picker/test/image_picker_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,16 @@ void main() {
'maxWidth': null,
'maxHeight': null,
'imageQuality': null,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
isMethodCall('pickImage', arguments: <String, dynamic>{
'source': 1,
'maxWidth': null,
'maxHeight': null,
'imageQuality': null,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
],
);
Expand Down Expand Up @@ -98,49 +100,56 @@ void main() {
'maxWidth': null,
'maxHeight': null,
'imageQuality': null,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
isMethodCall('pickImage', arguments: <String, dynamic>{
'source': 0,
'maxWidth': 10.0,
'maxHeight': null,
'imageQuality': null,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
isMethodCall('pickImage', arguments: <String, dynamic>{
'source': 0,
'maxWidth': null,
'maxHeight': 10.0,
'imageQuality': null,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
isMethodCall('pickImage', arguments: <String, dynamic>{
'source': 0,
'maxWidth': 10.0,
'maxHeight': 20.0,
'imageQuality': null,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
isMethodCall('pickImage', arguments: <String, dynamic>{
'source': 0,
'maxWidth': 10.0,
'maxHeight': null,
'imageQuality': 70,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
isMethodCall('pickImage', arguments: <String, dynamic>{
'source': 0,
'maxWidth': null,
'maxHeight': 10.0,
'imageQuality': 70,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
isMethodCall('pickImage', arguments: <String, dynamic>{
'source': 0,
'maxWidth': 10.0,
'maxHeight': 20.0,
'imageQuality': 70,
'cameraDevice': 0
'cameraDevice': 0,
'requestFullMetadata': true,
}),
],
);
Expand Down Expand Up @@ -177,6 +186,7 @@ void main() {
'maxHeight': null,
'imageQuality': null,
'cameraDevice': 0,
'requestFullMetadata': true,
}),
],
);
Expand All @@ -196,6 +206,26 @@ void main() {
'maxHeight': null,
'imageQuality': null,
'cameraDevice': 1,
'requestFullMetadata': true,
}),
],
);
});

test('passes the full metadata argument correctly', () async {
await picker.pickImage(
source: ImageSource.camera, requestFullMetadata: false);

expect(
log,
<Matcher>[
isMethodCall('pickImage', arguments: <String, dynamic>{
'source': 0,
'maxWidth': null,
'maxHeight': null,
'imageQuality': null,
'cameraDevice': 0,
'requestFullMetadata': false,
}),
],
);
Expand Down
4 changes: 4 additions & 0 deletions packages/image_picker/image_picker_ios/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 0.8.6

* Adds `requestFullMetadata` option to `pickImage`, so images on iOS can be picked without `Photo Library Usage` permission.

## 0.8.5+2

* Minor fixes for new analysis options.
Expand Down
24 changes: 24 additions & 0 deletions packages/image_picker/image_picker_ios/example/ios/RunnerTests/ImagePickerPluginTests.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ - (void)testPluginPickImageDeviceBack {
camera:FLTSourceCameraRear]
maxSize:[[FLTMaxSize alloc] init]
quality:nil
fullMetadata:@(YES)
completion:^(NSString *_Nullable result, FlutterError *_Nullable error){
}];

Expand Down Expand Up @@ -86,6 +87,7 @@ - (void)testPluginPickImageDeviceFront {
camera:FLTSourceCameraFront]
maxSize:[[FLTMaxSize alloc] init]
quality:nil
fullMetadata:@(YES)
completion:^(NSString *_Nullable result, FlutterError *_Nullable error){
}];

Expand Down Expand Up @@ -177,6 +179,27 @@ - (void)testPickMultiImageShouldUseUIImagePickerControllerOnPreiOS14 {
[mockUIImagePicker setSourceType:UIImagePickerControllerSourceTypePhotoLibrary]);
}

- (void)testPickImageWithoutFullMetadataPreiOS14 {
if (@available(iOS 14, *)) {
return;
}
id mockUIImagePicker = OCMClassMock([UIImagePickerController class]);
FLTImagePickerPlugin *plugin = [FLTImagePickerPlugin new];
[plugin setImagePickerControllerOverrides:@[ mockUIImagePicker ]];
FlutterMethodCall *call = [FlutterMethodCall methodCallWithMethodName:@"pickImage"
arguments:@{
@"source" : @(1),
@"requestFullMetadata" : @(NO),
}];

[plugin handleMethodCall:call
result:^(id _Nullable r){
}];

OCMVerify(times(1),
[mockUIImagePicker setSourceType:UIImagePickerControllerSourceTypePhotoLibrary]);
}

#pragma mark - Test camera devices, no op on simulators

- (void)testPluginPickImageDeviceCancelClickMultipleTimes {
Expand All @@ -191,6 +214,7 @@ - (void)testPluginPickImageDeviceCancelClickMultipleTimes {
camera:FLTSourceCameraRear]
maxSize:[[FLTMaxSize alloc] init]
quality:nil
fullMetadata:@(YES)
completion:^(NSString *_Nullable result, FlutterError *_Nullable error){
}];

Expand Down
Loading