Add Gradle lockfiles and tool to generate them #83067

blasten · 2021-05-21T02:11:18Z

Related issue: #82745

Checks in the .lockfiles and adds a tool to generate them across the Flutter repo.

To regenerate these files, run find . -type d -name 'android' | dart dev/tools/bin/generate_gradle_lockfiles.dart
from the root of the Flutter repo.

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making or feature I am adding, or Hixie said the PR is test-exempt.
All existing and new tests are passing.

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

blasten · 2021-05-21T02:17:00Z

dev/benchmarks/complex_layout/android/build.gradle

@@ -2,14 +2,24 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.

+// This file is auto generated.
+// To update all the build.gradle files in the Flutter repo,
+// See dev/tools/bin/generate_gradle_lockfiles.dart.


The root build.gradle file will be auto-generated after this PR, and every plugin with Gradle dependency will also have its own lockfile. See https://github.com/flutter/flutter/tree/46d887f30003b5843911cf665af942c9c37fb23b/dev/benchmarks/complex_layout/android

dnfield

Style nits. I think making the script work on Windows would be beneficial.

Please revert the unrelated files (*.xcconfig, *.h, *.cc).

Consider landing this in two steps: one where we just update all the gradle deps, and one where we actually add the lock files (or vice versa). Right now doing both may make it harder to bisect if anything goes wrong in devicelab.

dnfield · 2021-05-21T04:15:05Z

dev/benchmarks/complex_layout/ios/Flutter/Release.xcconfig

@@ -1 +1,2 @@
+#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig"


Seems unrelated to this PR.

@jmagman would it be ok to add this file to .gitignore?

These files were created after flutter pub get, which is required prior to creating the lockfiles.

Maybe we should just go through and update all of these then in a separate pr. Or alternatively gitignore them and remove them

These xcconfigs should be checked into the project, not gitignored. I'm not sure why it's not already for dev/benchmarks/complex_layout. I can look into that in another PR.

dev/benchmarks/complex_layout/ios/Flutter/Debug.xcconfig

dev/manual_tests/windows/flutter/generated_plugin_registrant.cc

dev/manual_tests/windows/flutter/generated_plugin_registrant.h

dnfield · 2021-05-21T04:53:21Z

dev/tools/bin/generate_gradle_lockfiles.dart

+
+void main(List<String> arguments) {
+  print(
+      "Usage: find . -type d -name 'android' | dart dev/tools/bin/generate_gradle_lockfiles.dart\n\n");


nit: no newline.

also nit: this makes it harder for developers on windows to run this script. Consider changing this to a file path argument where we just read the file.

what would be the issue? I have added a section about how to enter the files manually to write to the stdin pipe.

FWIW, the blaze command (internally) works this way for running multiple targets at once. I don't know what part wouldn't work on Windows since powershell also has support for the pipe operator.

Ahh ok, so I guess on Windows you could just use something like gci -Recurse -Directory -Name "android" | dart .... That should be fine then.

dev/tools/bin/generate_gradle_lockfiles.dart

dnfield

LGTM

blasten · 2021-05-21T17:53:04Z

@godofredoc I'd like to see if this change also makes Gradle builds fasters. Is there a SQL I could run to see the before/after of this change?

jmagman · 2021-05-21T18:20:18Z

dev/benchmarks/complex_layout/ios/Flutter/Debug.xcconfig

@@ -1 +0,0 @@
-#include "Generated.xcconfig"


Don't delete this file.

jmagman · 2021-05-21T18:20:26Z

dev/benchmarks/complex_layout/ios/Flutter/Release.xcconfig

@@ -1 +0,0 @@
-#include "Generated.xcconfig"


Or this one.

jmagman

LGTM

When will generate_gradle_lockfiles need to be run?

blasten · 2021-05-21T18:40:59Z

@jmagman it would need to be run if a Gradle dependencies is added or modified from these apps. That includes modifying Flutter plugins. I've added a custom Gradle error to https://github.com/flutter/flutter/pull/83067/files#diff-c0a1cddc5ca2d811173e4bd32e800ed637b1203c37a22907703b2eaa00899dbb to guide folks on how to resolve this issue on their own.

blasten · 2021-05-21T18:42:23Z

Here:

flutter/packages/flutter_tools/lib/src/android/gradle_errors.dart

Lines 436 to 459 in a7cd63e

    
           final GradleHandledError lockFileDepMissing = GradleHandledError( 
        
             test: (String line) { 
        
               return line.contains('which is not part of the dependency lock state'); 
        
             }, 
        
             handler: ({ 
        
               String line, 
        
               FlutterProject project, 
        
               bool usesAndroidX, 
        
               bool shouldBuildPluginAsAar, 
        
             }) async { 
        
               final File gradleFile = project.directory 
        
                   .childDirectory('android') 
        
                   .childFile('build.gradle'); 
        
               globals.printStatus( 
        
                 '\nYou need to update the lockfile, or disable Gradle dependency locking.\n'+ 
        
                 globals.logger.terminal.bolden( 
        
                   'To regenerate the lockfiles run: `./gradlew :generateLockfiles` in ${gradleFile.path}\n' 
        
                   'To remove dependency locking, remove the `dependencyLocking` from ${gradleFile.path}\n' 
        
                 ) 
        
               ); 
        
               return GradleBuildStatus.exit; 
        
             }, 
        
             eventLabel: 'lock-dep-issue',

…restore testing deprecated (plugins.each) state

…each) (#140037) Restore testing deprecated settings.gradle (plugins.each). Updated presumably by accident in #83067 Split from #137115 See also #137115 (comment)

…each) (flutter#140037) Restore testing deprecated settings.gradle (plugins.each). Updated presumably by accident in flutter#83067 Split from flutter#137115 See also flutter#137115 (comment)

Emmanuel Garcia added 3 commits May 20, 2021 16:39

Add task to generate lockfiles

3d47ad9

Merge branch 'master' into gradle_managment

39297c9

Generate lockfiles and tool

46d887f

google-cla bot added the cla: yes label May 21, 2021

blasten commented May 21, 2021

View reviewed changes

Fixes

cbef250

blasten requested review from dnfield and godofredoc May 21, 2021 02:31

Use const instead

59f5065

blasten force-pushed the gradle_managment branch from 0ab882d to 59f5065 Compare May 21, 2021 02:42

dnfield reviewed May 21, 2021

View reviewed changes

Emmanuel Garcia added 2 commits May 21, 2021 10:29

Feedback

003ef32

Skip add-to-app modules

ba4c3ce

dnfield approved these changes May 21, 2021

View reviewed changes

Emmanuel Garcia added 2 commits May 21, 2021 10:41

period

ad6ff74

Line

61e071d

blasten added the waiting for tree to go green label May 21, 2021

jmagman requested changes May 21, 2021

View reviewed changes

Emmanuel Garcia added 2 commits May 21, 2021 11:31

Restore files

e72f402

restore ios files

a7cd63e

jmagman approved these changes May 21, 2021

View reviewed changes

fluttergithubbot merged commit fa5883b into flutter:master May 21, 2021

blasten deleted the gradle_managment branch May 21, 2021 20:27

Nayuta403 mentioned this pull request Aug 30, 2022

Android Gradle Sync is time-consuming #110559

Closed

gmackall mentioned this pull request Mar 6, 2023

Updating to androidx.annotation:annotation:1.5.0 is causing CI failures. #122039

Closed

Gustl22 mentioned this pull request Oct 26, 2023

Reland: "Fix how Gradle resolves Android plugin" #137115

Merged

8 tasks

Gustl22 added a commit to Gustl22/flutter that referenced this pull request Dec 13, 2023

Revert automated changes made to settings.gradle in flutter#83067 to …

68d45f2

…restore testing deprecated (plugins.each) state

Gustl22 mentioned this pull request Dec 13, 2023

Revert automated changes made to deprecated settings.gradle (plugins.each) #140037

Merged

8 tasks

bartekpacia mentioned this pull request Jul 29, 2024

generate_gradle_lockfiles.dart doesn't support .kts Gradle scripts #141540

Open

		@@ -1 +1,2 @@
		#include? "Pods/Target Support Files/Pods-Runner/Pods-Runner.release.xcconfig"

Add Gradle lockfiles and tool to generate them #83067

Add Gradle lockfiles and tool to generate them #83067

Uh oh!

Conversation

blasten commented May 21, 2021

Pre-launch Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dnfield left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dnfield left a comment

Choose a reason for hiding this comment

Uh oh!

blasten commented May 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jmagman left a comment

Choose a reason for hiding this comment

Uh oh!

blasten commented May 21, 2021

Uh oh!

blasten commented May 21, 2021

Uh oh!

Uh oh!

blasten commented May 21, 2021 •

edited

Loading