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

[path_provider] Android: Support multiple external storage options #2049

Merged
cyanglaz merged 43 commits into from
Oct 21, 2019
Merged

[path_provider] Android: Support multiple external storage options #2049

cyanglaz merged 43 commits into from
Oct 21, 2019

Conversation

@ened
Copy link
Contributor

@ened ened commented Sep 9, 2019 •
edited
Loading

Description

Some Android phones support multiple external storage options to store files, e.g. SD cards.
This PR adds functionality to path_provider so that developers can inquire about those folders.

The Android API defines a set of standard folder name constants in android.os.Environment which are now bridged to Dart using this PR.

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • My PR includes unit or integration tests for all changed/updated/fixed behaviors (See Contributor Guide).
  • All existing and new tests are passing.
  • I updated/added relevant documentation (doc comments with ///).
  • The analyzer (flutter analyze) does not report any problems on my PR.
  • I read and followed the Flutter Style Guide.
  • The title of the PR starts with the name of the plugin surrounded by square brackets, e.g. [shared_preferences]
  • I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy.
  • I updated CHANGELOG.md to add a description of the change.
  • I signed the CLA.
  • I am willing to follow-up on review comments in a timely manner.

An existing test does not pass currently, this was introduced in #1953. Will include the fix in this PR.

Breaking Change

Does your PR require plugin users to manually update their apps to accommodate your change?

  • No, this is not a breaking change.

This is a followup PR of #966

/cc @collinjackson

ened and others added 20 commits January 31, 2019 22:23
@ened
Add support for Android devices with multiple external storage options.
f9bca2b
Merge branch 'master' into path-provider-android
6414953
Update path_provider AGB & iOS project file
e5fe50b
extend unit tests for new methods
8c5b266
[path_provider] Activate getApplicationSupportDirectory integration test
8803465
Merge branch 'path_provider/integration_test' into path-provider-android
ecc8aca
add integration tests
280f229
[path_provider] Activate getApplicationSupportDirectory integration test
2a3e4d4
Merge branch 'path_provider/integration_test' into path-provider-android
d6f66f2
Add missing unit tests
72a943b
Merge branch 'path_provider/integration_test' into path-provider-android
b4459b3
Formatting
7323e37
Merge branch 'path_provider/integration_test' into path-provider-android
1cfb256
Merge branch 'master' of https://github.com/flutter/plugins into path…
2736545 
…-provider-android
Merge branch 'master' into path-provider-android
e05e869
Merge branch 'master' of https://github.com/flutter/plugins into path…
e577e50 
…-provider-android
Merge branch 'master' of https://github.com/flutter/plugins into path…
f2941d9 
…-provider-android
[path_provider] Updates tests and copy Android environment names.
cf475e1
Bump version
354c9fa
Revert unrelated PR changes.
b60142f
@ened ened requested a review from collinjackson as a code owner September 9, 2019 15:27
ened
ened commented Sep 10, 2019
View reviewed changes
cyanglaz
cyanglaz suggested changes Oct 3, 2019
View reviewed changes
Copy link
Contributor

@cyanglaz cyanglaz left a comment

Choose a reason for hiding this comment

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

Thank you for the PR. I left some comments.

@ened
Copy link
Contributor Author

ened commented Oct 3, 2019

@cyanglaz Thank you for reviewing and will update the PR tomorrow.

@ened
Copy link
Contributor Author

ened commented Oct 4, 2019

@amirh @cyanglaz there may a problem that's not catch with either approach (enum, String etc):
When you look at the documentation here: https://developer.android.com/reference/android/os/Environment.html#fields_1 , then you find that the DIRECTORY_* variables are marked as Fields and do not show their actual constant value.

I would therefore assume that the values are not stable and thus, we should not rely on arbitrary string values.

Perhaps that's what you meant with public-facing enum & string internally, but I think there needs to be double-mapping. So on dart side enum to a transfer type (like integer) and on native side from integer to the actual constant. WDYT?

cyanglaz
cyanglaz reviewed Oct 4, 2019
View reviewed changes
Copy link
Contributor

@cyanglaz cyanglaz left a comment

Choose a reason for hiding this comment

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

@ened I think what you said makes sense. Do you mind work on that? After you done with it, we might need to add a test to test the mapping.

@ened
Copy link
Contributor Author

ened commented Oct 11, 2019

@cyanglaz back to you, when you get a chance

@ened ened force-pushed the path-provider-android branch from c8d7572 to f9bca2b Compare October 15, 2019 21:05
@ened ened requested a review from cyanglaz October 16, 2019 08:11
cyanglaz
cyanglaz reviewed Oct 17, 2019
View reviewed changes
@ened ened requested a review from cyanglaz October 21, 2019 08:16
@ened
Copy link
Contributor Author

ened commented Oct 21, 2019

@cyanglaz sorry to re-request - Github shows more changes required but I can not find them anywhere.

cyanglaz
cyanglaz approved these changes Oct 21, 2019
View reviewed changes
Copy link
Contributor

@cyanglaz cyanglaz left a comment

Choose a reason for hiding this comment

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

LGTM!

@cyanglaz cyanglaz merged commit 017a57e into flutter:master Oct 21, 2019
mormih pushed a commit to mormih/plugins that referenced this pull request Nov 17, 2019
@ened @mormih
[path_provider] Android: Support multiple external storage options (f…
3f87577 
…lutter#2049)
sungmin-park pushed a commit to sungmin-park/flutter-plugins that referenced this pull request Dec 17, 2019
@ened
[path_provider] Android: Support multiple external storage options (f…
118870b 
…lutter#2049)
julianscheel pushed a commit to jusst-engineering/plugins that referenced this pull request Mar 11, 2020
@creativecreatorormaybenot
Replace deprecated getFlutterEngine calls on Android (flutter#2050)
ac5ddec 
* Resolve flutter#2049
@stuartmorgan-g stuartmorgan-g mentioned this pull request Mar 25, 2021
Closed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@collinjackson collinjackson Awaiting requested review from collinjackson

1 more reviewer

@cyanglaz cyanglaz cyanglaz approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

cla: yes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ened @cyanglaz @googlebot