[camera] android-rework part 1: Base classes to support Android Camera features #3795

mvanbeusekom · 2021-04-08T11:49:41Z

Introduces some base classes in the Android Camera implementation which will allow us to separate specific feature logic from the Camera class into specific feature classes. This has the following benefits (basically all benefits of the Separation of Concerns principle):

It allows for focussed feature classes making it easier to maintain the implementation of the feature;
It will reduce the amount of code currently in the Camera class, making it easier to maintain the Camera class;
It will be easier to write unit-tests to cover the feature logic.

This is the first PR in a series of pull-requests which will gradually introduce changes from PR #3651, making it easier to review the code (as discussed with @stuartmorgan).

If you had to change anything in the flutter/tests repo, include a link to the migration guide as per the breaking change policy.

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

google-cla · 2021-04-08T11:49:45Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

google-cla · 2021-04-08T11:52:24Z

All (the pull request submitter and all commit authors) CLAs are signed, but one or more commits were authored or co-authored by someone other than the pull request submitter.

We need to confirm that all authors are ok with their commits being contributed to this project. Please have them confirm that by leaving a comment that contains only @googlebot I consent. in this pull request.

Note to project maintainer: There may be cases where the author cannot leave a comment, or the comment is not properly detected as consent. In those cases, you can manually confirm consent of the commit author(s), and set the cla label to yes (if enabled on your project).

ℹ️ Googlers: Go here for more info.

acoutts · 2021-04-08T12:15:56Z

@googlebot I consent.

stuartmorgan-g · 2021-04-09T19:10:25Z

FYI I'm OOO at the moment but will start working through these reviews as time allows.

bparrishMines

LGTM

stuartmorgan-g

Just small nits, otherwise looks good.

stuartmorgan-g · 2021-04-19T19:19:03Z

packages/camera/camera/android/src/main/java/io/flutter/plugins/camera/CameraProperties.java

+
+/** An interface allowing access to the different characteristics of the device's camera. */
+public interface CameraProperties {
+  String getCameraName();


It's not obvious what most of these methods mean. Please add Javadoc comments to each public method (as required by style); it seems like the best option would probably be to document them by indicating what CameraCharacteristics entry each one maps to.

stuartmorgan-g · 2021-04-19T19:20:24Z

packages/camera/camera/android/src/main/java/io/flutter/plugins/camera/CameraProperties.java

+    return cameraCharacteristics.get(CameraCharacteristics.CONTROL_MAX_REGIONS_AF);
+  }
+
+  @RequiresApi(api = VERSION_CODES.P)


Maybe this is a Java noob question, but shouldn't this be on the interface, not the implementation? It's not clear to me what it means for an interface with no API requirement to be implemented by something that does have one.

stuartmorgan-g · 2021-04-19T19:22:21Z

...es/camera/camera/android/src/main/java/io/flutter/plugins/camera/features/CameraFeature.java

+  public abstract String getDebugName();
+
+  /**
+   * Get the current value of this feature's setting.


What is the expected behavior of get/set if checkIsSupported returns false? That would be good to document.

stuartmorgan-g · 2021-04-19T19:23:31Z

...es/camera/camera/android/src/main/java/io/flutter/plugins/camera/features/CameraFeature.java

+  public abstract void setValue(T value);
+
+  /**
+   * Returns whether or not this feature is supported.


Nit: please use consistent mood in declaration comments (e.g., the above is Sets, not Set, but this is Returns, not Return.)

It looks like the preferred style for Javadoc is declarative, so this is correct and the other methods here should be Gets, Sets, Updates.

Co-authored-by: Andrew Coutts <[email protected]>

stuartmorgan-g

LGTM

…id Camera features (flutter/plugins#3795)

* master: (397 commits) [in_app_purchase] Implementation of platform interface (flutter#3781) [google_sign_in] Add todo WRT correctly setting X-Goog-AuthUser header (flutter#3819) [tools] fix version check command not working for new packages (flutter#3818) [camera] android-rework part 1: Base classes to support Android Camera features (flutter#3795) fix MD (flutter#3815) Path provider windows crash fix (flutter#3814) [local_auth] docs update (flutter#3103) Update PULL_REQUEST_TEMPLATE.md (flutter#3801) [quick_actions] handle cold start on iOS correctly (flutter#3811) Replace path_provider_linux widget tests with simple unit tests (flutter#3812) [sensors] format dart code based on the new dart formatter (flutter#3809) [google_sign_in] Fix "pick account" on iOS (flutter#3805) [image_picker_platform_interface] Added pickMultiImage (flutter#3782) [in_app_purchase] Added currency code and numerical price to product detail model. (flutter#3794) [local_auth] Fix iOS crash when no localizedReason (flutter#3780) Fix and update version checks (flutter#3792) [in_app_purchase] Configured example app to use StoreKit Testing on iOS 14 (flutter#3772) [local_auth] Unnecessary reassignment in example removed (flutter#2983) [flutter_webview] Fix `allowsInlineMediaPlayback` ignored on iOS (flutter#3791) Switch script/tools over to the new analysis options (flutter#3777) ...

* master: (79 commits) Fix grammatical error in contributing guide (flutter#3217) [google_sign_in_web] fix README typos. [tool] combine run and runAndExitOnError (flutter#3827) [camera] android-rework part 2: Android auto focus feature (flutter#3796) [in_app_purchase_platform_interface] Added additional fields to ProductDetails (flutter#3826) Move all null safety packages' min dart sdk to 2.12.0 (flutter#3822) [path_provider_*] code cleanup: sort directives (flutter#3823) [in_app_purchase] Implementation of platform interface (flutter#3781) [google_sign_in] Add todo WRT correctly setting X-Goog-AuthUser header (flutter#3819) [tools] fix version check command not working for new packages (flutter#3818) [camera] android-rework part 1: Base classes to support Android Camera features (flutter#3795) fix MD (flutter#3815) Path provider windows crash fix (flutter#3814) [local_auth] docs update (flutter#3103) Update PULL_REQUEST_TEMPLATE.md (flutter#3801) [quick_actions] handle cold start on iOS correctly (flutter#3811) Replace path_provider_linux widget tests with simple unit tests (flutter#3812) [sensors] format dart code based on the new dart formatter (flutter#3809) [google_sign_in] Fix "pick account" on iOS (flutter#3805) [image_picker_platform_interface] Added pickMultiImage (flutter#3782) ...

* upstream/master: (383 commits) Add implement and registerWith method to plugins (flutter#3833) Update third_party license checking (flutter#3844) [tool] add `all` and `dry-run` flags to publish-plugin command (flutter#3776) Re-add bin/ to flutter_plugin_tools (flutter#3839) switch from using 'tuneup' to analyze to 'dart analyze' (flutter#3837) [in_app_purchase] Federated iOS implementation (flutter#3832) Prep the tools for publishing (flutter#3836) [in_app_purchase] Make PurchaseDetails.status mandatory (flutter#3831) Fix grammatical error in contributing guide (flutter#3217) [google_sign_in_web] fix README typos. [tool] combine run and runAndExitOnError (flutter#3827) [camera] android-rework part 2: Android auto focus feature (flutter#3796) [in_app_purchase_platform_interface] Added additional fields to ProductDetails (flutter#3826) Move all null safety packages' min dart sdk to 2.12.0 (flutter#3822) [path_provider_*] code cleanup: sort directives (flutter#3823) [in_app_purchase] Implementation of platform interface (flutter#3781) [google_sign_in] Add todo WRT correctly setting X-Goog-AuthUser header (flutter#3819) [tools] fix version check command not working for new packages (flutter#3818) [camera] android-rework part 1: Base classes to support Android Camera features (flutter#3795) fix MD (flutter#3815) ...

…a features (flutter#3795) * Base classes to support Android camera features Co-authored-by: Andrew Coutts <[email protected]> * Fixed formatting * Applied feedback from PR Co-authored-by: Andrew Coutts <[email protected]>

mvanbeusekom requested review from stuartmorgan-g and bparrishMines April 8, 2021 11:49

google-cla bot added the cla: no label Apr 8, 2021

github-actions bot added p: camera platform-android labels Apr 8, 2021

google-cla bot added cla: yes and removed cla: no labels Apr 8, 2021

bparrishMines approved these changes Apr 19, 2021

View reviewed changes

stuartmorgan-g suggested changes Apr 19, 2021

View reviewed changes

mvanbeusekom and others added 3 commits April 20, 2021 09:35

Base classes to support Android camera features

2b7aa9b

Co-authored-by: Andrew Coutts <[email protected]>

Fixed formatting

f780742

Applied feedback from PR

76bc5bd

mvanbeusekom force-pushed the camera-android/prepare_feature_support branch from a02cc68 to 76bc5bd Compare April 20, 2021 11:22

stuartmorgan-g approved these changes Apr 20, 2021

View reviewed changes

mvanbeusekom merged commit 9ac4fb8 into flutter:master Apr 21, 2021

mvanbeusekom deleted the camera-android/prepare_feature_support branch April 21, 2021 11:18

github-actions bot added the needs-publishing label Apr 21, 2021

engine-flutter-autoroll mentioned this pull request Apr 21, 2021

Roll Plugins from 6398441f5873 to 9ac4fb87f088 (4 revisions) flutter/flutter#80859

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Apr 21, 2021

9ac4fb8 [camera] android-rework part 1: Base classes to support Andro…

fab29e0

…id Camera features (flutter/plugins#3795)

stuartmorgan-g removed the needs-publishing label Apr 22, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[camera] android-rework part 1: Base classes to support Android Camera features #3795

[camera] android-rework part 1: Base classes to support Android Camera features #3795

Uh oh!

mvanbeusekom commented Apr 8, 2021 •

edited

Loading

Uh oh!

google-cla bot commented Apr 8, 2021

Uh oh!

google-cla bot commented Apr 8, 2021

Uh oh!

acoutts commented Apr 8, 2021

Uh oh!

stuartmorgan-g commented Apr 9, 2021

Uh oh!

bparrishMines left a comment

Uh oh!

stuartmorgan-g left a comment

Uh oh!

stuartmorgan-g Apr 19, 2021

Uh oh!

stuartmorgan-g Apr 19, 2021

Uh oh!

stuartmorgan-g Apr 19, 2021

Uh oh!

stuartmorgan-g Apr 19, 2021

Uh oh!

stuartmorgan-g left a comment

Uh oh!

Uh oh!

[camera] android-rework part 1: Base classes to support Android Camera features #3795

[camera] android-rework part 1: Base classes to support Android Camera features #3795

Uh oh!

Conversation

mvanbeusekom commented Apr 8, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

google-cla bot commented Apr 8, 2021

Uh oh!

google-cla bot commented Apr 8, 2021

Uh oh!

acoutts commented Apr 8, 2021

Uh oh!

stuartmorgan-g commented Apr 9, 2021

Uh oh!

bparrishMines left a comment

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Apr 19, 2021

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Apr 19, 2021

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Apr 19, 2021

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Apr 19, 2021

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mvanbeusekom commented Apr 8, 2021 •

edited

Loading