Applied Gradle Plugins Declaratively for `path_provider` #7822

jesswrd · 2024-10-08T17:44:24Z

Updated applying gradle plugins from usage of imperative apply to usage of declarative blocks {} apply. Intending on updating all android example apps under packages. Did one more as a proof of concept before doing more.

More information on Flutter Gradle Plugin Apply here

Partially addresses #152656

Pre-launch Checklist

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

flutter-dashboard · 2024-10-08T17:44:27Z

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

stuartmorgan · 2024-10-08T20:23:17Z

Looks like this change triggers a new check on the existing targetSdkVersion value?

jesswrd · 2024-10-08T21:45:01Z

Looks like this change triggers a new check on the existing targetSdkVersion value?

Yeah, I think the current targetSdkVersion is outdated. I'm just going to update it to 35 (most recent one)

# Conflicts: # packages/path_provider/path_provider/example/android/app/gradle/wrapper/gradle-wrapper.properties # packages/path_provider/path_provider/example/android/build.gradle

This reverts commit f52aee5.

This reverts commit d904532.

reidbaker · 2024-10-24T14:39:02Z

packages/path_provider/path_provider/CHANGELOG.md

@@ -1,5 +1,6 @@
 ## NEXT

+* Updates example app Android compileSdkVersion to 35.


This changelog should also mention moving the example to include flutter as a declarative dependency.

Why are we updating the CHANGELOG at all for this PR? Example-build-only changes are exempt; we generally only mention them if they are about something that is directly relevant to clients of the package (e.g., if a new version of Android requires a new permission to use the code in the package, we might mention adding that permission to the example).

Because we are changing the example app which is users facing and should be updated.

It's user-facing, but (other than the one file from the example directory shown on pub.dev) it's not directly pub-package-client-facing; if someone flutter pub upgrades and gets a new version of path_provider, nothing in this PR is in the code they will import, and that's generally what we consider as the CHANGELOG audience.

We expect people running the example to check out the repo (in theory they could build and run it directly from their pub cache, but they really shouldn't), and the git history is the record of changes for someone interacting with the repo itself.

The things in the CHANGELOG change here are part of what our written policy explicitly exempts, and we also have not historically put this kind of thing in the CHANGELOG, so it seems odd to include it this time.

Ok, I misunderstood the policy. @jesswrd sorry for leading you astray but it will make your follow up prs much easier.

stuartmorgan · 2024-10-28T17:15:00Z

script/tool/lib/src/gradle_check_command.dart

+  /// configuration without the artifact hub env variable.
+  /// GP stands for the gradle plugin method of flutter tooling inclusion.
+  @visibleForTesting
+  static String exampleSettingsWithoutArtifactHubStringGP = '''


Why is this defined here? It only seems to be used in tests.

Moved it to the test file. done.

stuartmorgan · 2024-10-28T17:16:13Z

script/tool/lib/src/gradle_check_command.dart

-    return documentationPresent &&
-        artifactRegistryDefined &&
-        artifactRegistryPluginApplied;
+    return validArtifactConfiguration;


If the only thing is missing is the documentation, before it would print an example of what needed to be included that included the documentation, whereas now it would fail without any actionable message.

I just tried out only removing only the documentation, and it does include an error message. I have a check for documentationPresent when validArtifactConfiguration is deinfed, and check for !validArtifactConfiguration when an error should be printed. Could you further explain why it would fail?

reidbaker · 2024-10-28T19:06:32Z

script/tool/lib/src/gradle_check_command.dart

+    if (!validArtifactConfiguration && !artifactRegistryPluginAppliedGP) {
+      printError('Failed Artifact Hub validation. Include the following in '
+          'example root settings.gradle:\n$exampleSettingsArtifactHubStringGP');
+    }


Instead of these lines which I think are a response to this thread.

add documentationPresent to the check for GP method of applying artifact registry.

stuartmorgan

LGTM with a couple of small changes.

stuartmorgan · 2024-10-30T15:15:26Z

script/tool/lib/src/gradle_check_command.dart

+        printError('Include the following in '
+            'example root settings.gradle:\n$exampleRootSettingsArtifactHubString');
+      }
+      else if (!declarativeArtifactRegistryApplied){


I think this file needs dart format run on it. (CI currently doesn't check formatting for script/tool, which is a bug.)

stuartmorgan · 2024-10-30T15:17:48Z

script/tool/test/gradle_check_command_test.dart

+      final RepositoryPackage example = package.getExamples().first;
+      writeFakeExampleBuildGradleGP(example,
+          pluginName: packageName,
+          // ignore: avoid_redundant_argument_values


If we always want to have the tests be explicit about all of their arguments, then let's make the test helper arguments be required instead of having to annotate all of the calls.

I dont see the version of the code where includeBuildArtifactHub and includeSettingsDocumentationArtifactHub are required without defaults and the // ignore: avoid_redundant_argument_values are removed. Did you need to push a change?

I added required and removed the annotations for writeFakeExampleBuildGradleGP but not for writeFakeExampleBuildGradles. Keeping args optional for writeFakeExampleBuildGradles as it is used in unrelated tests.

I think that writeFakeExampleBuildGradles will need to be modified in the version of your pr that removes the "or" condition from the older way and the way you are replacing but for now can be left alone.

…lutter/packages#7822)

flutter/packages@7cc1caa...796afa3 2024-11-01 [email protected] [google_maps_flutter] Update Android for non-nullable generics (flutter/packages#7990) 2024-11-01 [email protected] [various] Minor cleanup in recently imported packages (flutter/packages#7995) 2024-11-01 [email protected] [go_router] Update example app to Kotlin 1.9.0 (flutter/packages#7997) 2024-10-31 [email protected] Manual roll Flutter from fe71cad to 0fe6153 (18 revisions) (flutter/packages#7989) 2024-10-31 [email protected] [vector_garphics] fix execution on the web with WebAssembly (flutter/packages#7991) 2024-10-31 49699333+dependabot[bot]@users.noreply.github.com [url_launcher]: Bump androidx.annotation:annotation from 1.9.0 to 1.9.1 in /packages/url_launcher/url_launcher_android/android (flutter/packages#7986) 2024-10-31 [email protected] [flutter_svg] Initial import (flutter/packages#7944) 2024-10-31 [email protected] [vector_graphics] Initial import (flutter/packages#7941) 2024-10-30 [email protected] [ci] Ensure repo tool is autoformatted (flutter/packages#7963) 2024-10-30 [email protected] Updates path_parsing README.md with a note about Dan (flutter/packages#7949) 2024-10-30 [email protected] [tool] Support third_party for --current-package (flutter/packages#7967) 2024-10-30 [email protected] [tool] Fix third_party dependency overrides (flutter/packages#7966) 2024-10-30 [email protected] Applied Gradle Plugins Declaratively for `path_provider` (flutter/packages#7822) 2024-10-30 [email protected] [palette_generator] Remove unmanaged code snippet (flutter/packages#7962) 2024-10-30 [email protected] Roll Flutter from 42132e8 to fe71cad (12 revisions) (flutter/packages#7961) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…#7968) Updated applying gradle plugins from usage of imperative apply to usage of declarative blocks {} apply for 7 plugins. Intending on updating all android example apps under packages. Previously migrated applying `path_provider` plugin example app from imperatively to declaratively in this PR [here](#7822). Tests for changes in the linked PR above. More information on Flutter Gradle Pluggin Apply [here](https://docs.flutter.dev/release/breaking-changes/flutter-gradle-plugin-apply) Partially addresses [#152656](flutter/flutter#152656) ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] page, which explains my responsibilities. - [x] I read and followed the [relevant style guides] and ran the auto-formatter. (Unlike the flutter/flutter repo, the flutter/packages repo does use `dart format`.) - [x] I signed the [CLA]. - [x] The title of the PR starts with the name of the package surrounded by square brackets, e.g. `[shared_preferences]` - [x] I [linked to at least one issue that this PR fixes] in the description above. - [x] I updated `pubspec.yaml` with an appropriate new version according to the [pub versioning philosophy], or this PR is [exempt from version changes]. - [x] I updated `CHANGELOG.md` to add a description of the change, [following repository CHANGELOG style], or this PR is [exempt from CHANGELOG changes]. - [x] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord].  [Contributor Guide]: https://github.com/flutter/packages/blob/main/CONTRIBUTING.md [Tree Hygiene]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md [relevant style guides]: https://github.com/flutter/packages/blob/main/CONTRIBUTING.md#style [CLA]: https://cla.developers.google.com/ [Discord]: https://github.com/flutter/flutter/blob/master/docs/contributing/Chat.md [linked to at least one issue that this PR fixes]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md#overview [pub versioning philosophy]: https://dart.dev/tools/pub/versioning [exempt from version changes]: https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#version [following repository CHANGELOG style]: https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changelog-style [exempt from CHANGELOG changes]: https://github.com/flutter/flutter/blob/master/docs/ecosystem/contributing/README.md#changelog [test-exempt]: https://github.com/flutter/flutter/blob/master/docs/contributing/Tree-hygiene.md#tests

jesswrd requested a review from stuartmorgan as a code owner October 8, 2024 17:44

github-actions bot added p: path_provider platform-android labels Oct 8, 2024

stuartmorgan requested a review from camsim99 October 8, 2024 20:21

jesswrd added 7 commits October 18, 2024 13:05

applied plugins declaratively and updated AGP and Gradle version

1723e03

# Conflicts: # packages/path_provider/path_provider/example/android/app/gradle/wrapper/gradle-wrapper.properties # packages/path_provider/path_provider/example/android/build.gradle

upgraded targetsdk, agp, and gradle version

dfa206d

updated regex and example settings string

1325af9

Revert "upgraded targetsdk, agp, and gradle version"

4d843ae

This reverts commit f52aee5.

Revert "updated regex and example settings string"

9e57354

This reverts commit d904532.

updated targetsdk, gradle, and agp version

ab38f6d

updated regex and example settings

5ac281b

jesswrd force-pushed the apply_path_prov branch from ca8f0ee to 5ac281b Compare October 18, 2024 20:29

jesswrd added 3 commits October 21, 2024 13:57

added regex for declarative way

00c0579

updated changelog and added comments

30c2c33

added regex and tests

c87ae30

jesswrd self-assigned this Oct 23, 2024

jesswrd changed the title ~~[WIP] Applied Gradle Plugins Declaratively for path_provider~~ Applied Gradle Plugins Declaratively for path_provider Oct 23, 2024

jesswrd requested a review from reidbaker October 23, 2024 22:23

reidbaker approved these changes Oct 24, 2024

View reviewed changes

added declarative statement to the changelog

8df5a41

jesswrd added override: no versioning needed Override the check requiring version bumps for most changes override: no changelog needed Override the check requiring CHANGELOG updates for most changes labels Oct 24, 2024

remove changelog

8fc4466

stuartmorgan requested changes Oct 28, 2024

View reviewed changes

moved string w/o artifact hub

a73ad60

reidbaker requested changes Oct 28, 2024

View reviewed changes

updated error logic to be more readable and added docArtifact test

80f0902

separated documentation hub error check for imperative method check

5629ea3

stuartmorgan approved these changes Oct 30, 2024

View reviewed changes

jesswrd and others added 3 commits October 30, 2024 10:04

ran dart format

d51a036

made args required and removed related annotations

55f9c9d

Merge branch 'main' into apply_path_prov

bf607c5

reidbaker approved these changes Oct 30, 2024

View reviewed changes

jesswrd merged commit 4feddff into flutter:main Oct 30, 2024
76 checks passed

jesswrd deleted the apply_path_prov branch October 30, 2024 19:40

jesswrd mentioned this pull request Oct 30, 2024

Applied Gradle Plugins Declaratively for Multiple Plugin Example Apps #7968

Merged

11 tasks

engine-flutter-autoroll mentioned this pull request Oct 31, 2024

Roll Packages from 7cc1caa0cc36 to ed7ee79e4c90 (7 revisions) flutter/flutter#157924

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 31, 2024

4feddffcf Applied Gradle Plugins Declaratively for path_provider (f…

aac990b

…lutter/packages#7822)

engine-flutter-autoroll mentioned this pull request Oct 31, 2024

Roll Packages from 7cc1caa0cc36 to dcf47df88e4c (9 revisions) flutter/flutter#157932

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 31, 2024

4feddffcf Applied Gradle Plugins Declaratively for path_provider (f…

7482cd6

…lutter/packages#7822)

engine-flutter-autoroll mentioned this pull request Nov 1, 2024

Roll Packages from 7cc1caa0cc36 to ee43c7eb37eb (12 revisions) flutter/flutter#157997

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Nov 1, 2024

4feddffcf Applied Gradle Plugins Declaratively for path_provider (f…

5717810

…lutter/packages#7822)

engine-flutter-autoroll mentioned this pull request Nov 1, 2024

Roll Packages from 7cc1caa0cc36 to 796afa35071d (15 revisions) flutter/flutter#158003

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Nov 1, 2024

4feddffcf Applied Gradle Plugins Declaratively for path_provider (f…

803f256

…lutter/packages#7822)

jesswrd mentioned this pull request Nov 4, 2024

[WIP] Applied Gradle Plugins Declaratively for Multiple Plugin Example Apps (Part 2) #8019

Open

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Applied Gradle Plugins Declaratively for `path_provider` #7822

Applied Gradle Plugins Declaratively for `path_provider` #7822

jesswrd commented Oct 8, 2024 •

edited

Loading

flutter-dashboard bot commented Oct 8, 2024

stuartmorgan commented Oct 8, 2024

jesswrd commented Oct 8, 2024

reidbaker Oct 24, 2024

stuartmorgan Oct 24, 2024

reidbaker Oct 24, 2024

stuartmorgan Oct 24, 2024

reidbaker Oct 24, 2024

stuartmorgan Oct 28, 2024

jesswrd Oct 28, 2024 •

edited

Loading

stuartmorgan Oct 28, 2024

jesswrd Oct 28, 2024 •

edited

Loading

reidbaker Oct 28, 2024

jesswrd Oct 30, 2024

stuartmorgan left a comment

stuartmorgan Oct 30, 2024

jesswrd Oct 30, 2024

stuartmorgan Oct 30, 2024

jesswrd Oct 30, 2024

reidbaker Oct 30, 2024

jesswrd Oct 30, 2024 •

edited

Loading

reidbaker Oct 30, 2024

		@@ -1,5 +1,6 @@
		## NEXT

		* Updates example app Android compileSdkVersion to 35.

Applied Gradle Plugins Declaratively for path_provider #7822

Applied Gradle Plugins Declaratively for path_provider #7822

Conversation

jesswrd commented Oct 8, 2024 • edited Loading

Pre-launch Checklist

flutter-dashboard bot commented Oct 8, 2024

stuartmorgan commented Oct 8, 2024

jesswrd commented Oct 8, 2024

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

jesswrd Oct 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jesswrd Oct 28, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stuartmorgan 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

jesswrd Oct 30, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Applied Gradle Plugins Declaratively for `path_provider` #7822

Applied Gradle Plugins Declaratively for `path_provider` #7822

jesswrd commented Oct 8, 2024 •

edited

Loading

jesswrd Oct 28, 2024 •

edited

Loading

jesswrd Oct 28, 2024 •

edited

Loading

jesswrd Oct 30, 2024 •

edited

Loading