Visitar URL original
[Android] Add Java/AGP/Gradle incompatibility warning to `flutter create` by camsim99 · Pull Request #131444 · flutter/flutter · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
70 commits
Select commit Hold shift + click to select a range
389288f
Add verify methods and initial warnings
camsim99 Jul 27, 2023
8069931
Get code to compile
camsim99 Jul 28, 2023
0a91a4d
Pair w/Reid
camsim99 Jul 31, 2023
45b324e
Add wip from last week
camsim99 Aug 8, 2023
f864c26
gradle_utils edit
camsim99 Aug 8, 2023
95e6f70
Fix file paths
camsim99 Aug 8, 2023
e4cc801
Add compatible version ranges
camsim99 Aug 9, 2023
956124b
Merge remote-tracking branch 'upstream/master' into create_java_warning
camsim99 Aug 9, 2023
3b030b7
Update Java/Gradle tests
camsim99 Aug 9, 2023
4147210
Add tests for retrieving compatible Gradle/AGP versions
camsim99 Aug 9, 2023
f4c0753
Add create_tests and lint fixes
camsim99 Aug 14, 2023
4b62456
Merge remote-tracking branch 'upstream/master' into create_java_warning
camsim99 Aug 14, 2023
42f7ba5
Override Java in tool_tests_commands
camsim99 Aug 14, 2023
3420779
Merge remote-tracking branch 'upstream/master' into create_java_warning
camsim99 Aug 14, 2023
51706a1
Fix more Java versions
camsim99 Aug 14, 2023
1c1f07c
More fixes
camsim99 Aug 14, 2023
62f9ec4
Put fakes in create_usage_test.dart
camsim99 Aug 15, 2023
ce9158b
Change to fakejava
camsim99 Aug 15, 2023
5b97f1f
Merge branch 'master' into create_java_warning
camsim99 Aug 15, 2023
093d8e2
Self review
camsim99 Aug 15, 2023
6930330
Merge branch 'create_java_warning' of github.com:camsim99/flutter int…
camsim99 Aug 15, 2023
0c8b4e8
Fix header message and add patch versions to test
camsim99 Aug 16, 2023
606c86a
nits
camsim99 Aug 16, 2023
bba16b5
Add check for files and fix message formatting
camsim99 Aug 16, 2023
4598087
Merge remote-tracking branch 'upstream/master' into create_java_warning
camsim99 Aug 16, 2023
ea0ad42
nits
camsim99 Aug 16, 2023
bc1eeb4
correct messagse
camsim99 Aug 16, 2023
f4fd1de
Merge branch 'master' into create_java_warning
camsim99 Aug 16, 2023
a5998d1
Update packages/flutter_tools/lib/src/android/gradle_utils.dart
camsim99 Aug 22, 2023
e320678
Update packages/flutter_tools/lib/src/android/gradle_utils.dart
camsim99 Aug 22, 2023
bdeba7a
Update packages/flutter_tools/lib/src/commands/create.dart
camsim99 Aug 22, 2023
9bb0f6e
Update packages/flutter_tools/test/general.shard/android/gradle_utils…
camsim99 Aug 22, 2023
02f29d7
Update packages/flutter_tools/test/general.shard/android/gradle_utils…
camsim99 Aug 22, 2023
d8e3549
Update packages/flutter_tools/test/general.shard/android/gradle_utils…
camsim99 Aug 22, 2023
4a8c468
Update packages/flutter_tools/test/general.shard/android/gradle_utils…
camsim99 Aug 22, 2023
3580e66
Address review pt1
camsim99 Aug 22, 2023
74ce356
Merge remote-tracking branch 'upstream/master' into create_java_warning
camsim99 Aug 22, 2023
b9e4518
Fix gradle utils tests
camsim99 Aug 22, 2023
246942c
Fix analyze, add documentation
camsim99 Aug 23, 2023
f64886c
Merge remote-tracking branch 'upstream/master' into create_java_warning
camsim99 Aug 23, 2023
7a26d40
Add refs to readme
camsim99 Aug 23, 2023
ee6e4d1
Merge remote-tracking branch 'upstream/master' into create_java_warning
camsim99 Aug 23, 2023
39a2343
Correct readme
camsim99 Aug 23, 2023
a595dda
Change name
camsim99 Aug 24, 2023
6dff67d
Add checks for module
camsim99 Aug 28, 2023
b97a3a8
Merge remote-tracking branch 'upstream/master' into create_java_warning
camsim99 Aug 28, 2023
fd75c2f
Fix inclusiveMax issue
camsim99 Aug 28, 2023
0ad6404
Merge branch 'master' into create_java_warning
camsim99 Aug 28, 2023
defb95b
Merge branch 'master' into create_java_warning
camsim99 Aug 29, 2023
21eb4b9
Update packages/flutter_tools/lib/src/android/gradle_utils.dart
camsim99 Aug 30, 2023
6a34dca
Update packages/flutter_tools/lib/src/android/README.md
camsim99 Aug 30, 2023
6c7e807
Update packages/flutter_tools/lib/src/android/gradle_utils.dart
camsim99 Aug 30, 2023
f6e1d10
Update packages/flutter_tools/lib/src/android/README.md
camsim99 Aug 30, 2023
e6ee3de
Update packages/flutter_tools/lib/src/android/README.md
camsim99 Aug 30, 2023
3ef6e63
Address gray nits
camsim99 Aug 30, 2023
bced8f1
Update packages/flutter_tools/lib/src/android/README.md
camsim99 Aug 30, 2023
2aa9d28
More nits
camsim99 Aug 30, 2023
703114b
Merge branch 'create_java_warning' of github.com:camsim99/flutter int…
camsim99 Aug 30, 2023
fb44759
Finish addressing gray's PR
camsim99 Aug 31, 2023
ebfae2f
Merge remote-tracking branch 'upstream/master' into create_java_warning
camsim99 Sep 14, 2023
ecdf8ec
Start addressing review
camsim99 Sep 14, 2023
f5404cd
Add todo before lannding
camsim99 Sep 14, 2023
5b2327a
Delete note that
camsim99 Sep 14, 2023
4408fd1
Fix test failures
camsim99 Sep 18, 2023
4465827
Merge remote-tracking branch 'upstream/main' into create_java_warning
camsim99 Sep 18, 2023
73a41e8
Update todos
camsim99 Sep 18, 2023
00b5fdc
Fix test logger calls
camsim99 Sep 18, 2023
b8361e1
Don't show java/gradle warning for plugin, pluginffi
camsim99 Sep 18, 2023
8f78253
Remove note that usages
camsim99 Sep 18, 2023
8908981
Nits and final test fixes
camsim99 Sep 19, 2023
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
Prev Previous commit
Next Next commit
Add tests for retrieving compatible Gradle/AGP versions
  • Loading branch information
camsim99 committed Aug 9, 2023
commit 4147210aafe56cc2fcd3010a5aa1d111331f1e51
102 changes: 65 additions & 37 deletions packages/flutter_tools/lib/src/android/gradle_utils.dart
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ const String ndkVersion = '23.1.7779620';

// Update these when new major versions of Java are supported by android.
// Supported means Java <-> Gradle support.
Comment thread
camsim99 marked this conversation as resolved.
Resolved
const String oneMajorVersionHigherJavaVersion = '21';
const String oneMajorVersionHigherJavaVersion = '20';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
const String oneMajorVersionHigherJavaVersion = '20';
const String oneMajorVersionHigherJavaVersion = '21';

per https://docs.gradle.org/current/userguide/compatibility.html#java

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can you file a follow up bug for this? I have a machine with java 20 that I use for flutter projects.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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


// Update this when new versions of Gradle come out including minor versions
//
// Supported here means supported by the tooling for
// flutter analyze --suggestions and does not imply broader flutter support.
const String _maxKnownAndSupportedGradleVersion = '8.2.1';
const String maxKnownAndSupportedGradleVersion = '8.2.1';

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

maybe this should be bumped to 8.3, per https://docs.gradle.org/current/userguide/compatibility.html#java ? I'll trust your judgment though

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think this should be the max gradle version we test in ci. I do not think we have a test using 8.3 but maybe we should.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

That makes sense. We don't test it currently , so I put it back to 8.0.2. Planning on upgrading this version soon, so I'll do that in a follow-up PR.


// Update this when new versions of AGP come out.
//
Expand Down Expand Up @@ -373,11 +373,11 @@ bool validateGradleAndAgp(Logger logger,
// Check highest supported version before checking unknown versions.
if (isWithinVersionRange(agpV, min: '8.0', max: maxKnownAgpVersion)) {
return isWithinVersionRange(gradleV,
min: '8.0', max: _maxKnownAndSupportedGradleVersion);
min: '8.0', max: maxKnownAndSupportedGradleVersion);
}
// Check if versions are newer than the max known versions.
if (isWithinVersionRange(agpV,
min: _maxKnownAndSupportedGradleVersion, max: '100.100')) {
min: maxKnownAndSupportedGradleVersion, max: '100.100')) {
// Assume versions we do not know about are valid but log.
final bool validGradle =
isWithinVersionRange(gradleV, min: '8.0', max: '100.00');
Expand All @@ -390,74 +390,74 @@ bool validateGradleAndAgp(Logger logger,
// Max agp here is a made up version to contain all 7.4 changes.
if (isWithinVersionRange(agpV, min: '7.4', max: '7.5')) {
return isWithinVersionRange(gradleV,
min: '7.5', max: _maxKnownAndSupportedGradleVersion);
min: '7.5', max: maxKnownAndSupportedGradleVersion);
}
if (isWithinVersionRange(agpV,
min: '7.3', max: '7.4', inclusiveMax: false)) {
return isWithinVersionRange(gradleV,
min: '7.4', max: _maxKnownAndSupportedGradleVersion);
min: '7.4', max: maxKnownAndSupportedGradleVersion);
}
if (isWithinVersionRange(agpV,
min: '7.2', max: '7.3', inclusiveMax: false)) {
return isWithinVersionRange(gradleV,
min: '7.3.3', max: _maxKnownAndSupportedGradleVersion);
min: '7.3.3', max: maxKnownAndSupportedGradleVersion);
}
if (isWithinVersionRange(agpV,
min: '7.1', max: '7.2', inclusiveMax: false)) {
return isWithinVersionRange(gradleV,
min: '7.2', max: _maxKnownAndSupportedGradleVersion);
min: '7.2', max: maxKnownAndSupportedGradleVersion);
}
if (isWithinVersionRange(agpV,
min: '7.0', max: '7.1', inclusiveMax: false)) {
return isWithinVersionRange(gradleV,
min: '7.0', max: _maxKnownAndSupportedGradleVersion);
min: '7.0', max: maxKnownAndSupportedGradleVersion);
}
if (isWithinVersionRange(agpV,
min: '4.2.0', max: '7.0', inclusiveMax: false)) {
return isWithinVersionRange(gradleV,
min: '6.7.1', max: _maxKnownAndSupportedGradleVersion);
min: '6.7.1', max: maxKnownAndSupportedGradleVersion);
}
if (isWithinVersionRange(agpV,
min: '4.1.0', max: '4.2.0', inclusiveMax: false)) {
return isWithinVersionRange(gradleV,
min: '6.5', max: _maxKnownAndSupportedGradleVersion);
min: '6.5', max: maxKnownAndSupportedGradleVersion);
}
if (isWithinVersionRange(agpV,
min: '4.0.0', max: '4.1.0', inclusiveMax: false)) {
return isWithinVersionRange(gradleV,
min: '6.1.1', max: _maxKnownAndSupportedGradleVersion);
min: '6.1.1', max: maxKnownAndSupportedGradleVersion);
}
if (isWithinVersionRange(
agpV,
min: '3.6.0',
max: '3.6.4',
)) {
return isWithinVersionRange(gradleV,
min: '5.6.4', max: _maxKnownAndSupportedGradleVersion);
min: '5.6.4', max: maxKnownAndSupportedGradleVersion);
}
if (isWithinVersionRange(
agpV,
min: '3.5.0',
max: '3.5.4',
)) {
return isWithinVersionRange(gradleV,
min: '5.4.1', max: _maxKnownAndSupportedGradleVersion);
min: '5.4.1', max: maxKnownAndSupportedGradleVersion);
}
if (isWithinVersionRange(
agpV,
min: '3.4.0',
max: '3.4.3',
)) {
return isWithinVersionRange(gradleV,
min: '5.1.1', max: _maxKnownAndSupportedGradleVersion);
min: '5.1.1', max: maxKnownAndSupportedGradleVersion);
}
if (isWithinVersionRange(
agpV,
min: '3.3.0',
max: '3.3.3',
)) {
return isWithinVersionRange(gradleV,
min: '4.10.1', max: _maxKnownAndSupportedGradleVersion);
min: '4.10.1', max: maxKnownAndSupportedGradleVersion);
}

logger.printTrace('Unknown Gradle-Agp compatibility, $gradleV, $agpV');
Expand Down Expand Up @@ -504,7 +504,7 @@ bool validateJavaGradle(Logger logger,
// Assume versions Java versions newer than [maxSupportedJavaVersion]
// required a higher gradle version.
final bool validGradle = isWithinVersionRange(gradleV,
min: _maxKnownAndSupportedGradleVersion, max: '100.00');
min: maxKnownAndSupportedGradleVersion, max: '100.00');
logger.printWarning(
'Newer than known valid Java version ($javaV), gradle ($gradleV).'
'\n Treating as valid configuration.');
Expand All @@ -522,6 +522,8 @@ bool validateJavaGradle(Logger logger,
return false;
}

// Returns compatibility info for valid range of Gradle versions for given Java
// version.
JavaGradleCompat? getValidGradleVersionRangeForJavaVersion(Logger logger,
{required String? javaV}) {
if (javaV == null) {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

non blocking question: FWIW the string we will call this (and getMinimumAgpVersionForJavaVersion) with is never null - would it be better here to remove null handling and make the method take a String instead?

Expand Down Expand Up @@ -582,6 +584,8 @@ bool validateJavaAgp(Logger logger,
return false;
}

// Returns compatibility information for minimum AGP version for given
// Java version.
JavaAgpCompat? getMinimumAgpVersionForJavaVersion(Logger logger,
{required String? javaV}) {
if (javaV == null) {
Expand Down Expand Up @@ -620,7 +624,7 @@ String getGradleVersionFor(String androidPluginVersion) {
GradleForAgp(agpMin: '7.5.0', agpMax: '100.100', minRequiredGradle: '8.0'),
// Assume if AGP is newer than this code know about return the highest gradle
// version we know about.
GradleForAgp(agpMin: maxKnownAgpVersion, agpMax: maxKnownAgpVersion, minRequiredGradle: _maxKnownAndSupportedGradleVersion),
GradleForAgp(agpMin: maxKnownAgpVersion, agpMax: maxKnownAgpVersion, minRequiredGradle: maxKnownAndSupportedGradleVersion),


];
Expand All @@ -630,7 +634,7 @@ String getGradleVersionFor(String androidPluginVersion) {
}
}
if (isWithinVersionRange(androidPluginVersion, min: maxKnownAgpVersion, max: '100.100')) {
return _maxKnownAndSupportedGradleVersion;
return maxKnownAndSupportedGradleVersion;
}
throwToolExit('Unsupported Android Plugin version: $androidPluginVersion.');
}
Expand Down Expand Up @@ -721,8 +725,9 @@ void exitWithNoSdkMessage() {
}

// Data class to hold normal/defined Java <-> Gradle compatability criteria.
@immutable
class JavaGradleCompat {
JavaGradleCompat({
const JavaGradleCompat({
required this.javaMin,
required this.javaMax,
required this.gradleMin,
Expand All @@ -732,11 +737,23 @@ class JavaGradleCompat {
final String javaMax;
final String gradleMin;
final String gradleMax;

@override
bool operator ==(Object other) =>
other is JavaGradleCompat &&
other.javaMin == javaMin &&
other.javaMax == javaMax &&
other.gradleMin == gradleMin &&
other.gradleMax == gradleMax;

@override
int get hashCode => Object.hash(javaMin, javaMax, gradleMin, gradleMax);
}

// Data class to hold defined Java <-> AGP compatibility criteria.
@immutable
class JavaAgpCompat {
JavaAgpCompat({
const JavaAgpCompat({
required this.javaMin,
required this.javaDefault,
required this.agpMin,
Expand All @@ -746,6 +763,17 @@ class JavaAgpCompat {
final String javaDefault;
final String agpMin;
final String agpMax;

@override
bool operator ==(Object other) =>
other is JavaAgpCompat &&
other.javaMin == javaMin &&
other.javaDefault == javaDefault &&
other.agpMin == agpMin &&
other.agpMax == agpMax;

@override
int get hashCode => Object.hash(javaMin, javaDefault, agpMin, agpMax);
}

class GradleForAgp {
Expand All @@ -769,93 +797,93 @@ String getGradlewFileName(Platform platform) {
}

// List of compatible Java/Gradle versions.
Comment thread
camsim99 marked this conversation as resolved.
Resolved
List<JavaGradleCompat> _javaGradleCompatList = <JavaGradleCompat>[
List<JavaGradleCompat> _javaGradleCompatList = const <JavaGradleCompat>[

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is mostly copied from an existing method, so this doesn't have to be blocking for this PR, but I don't think we actually need to do something this complicated for either the original use or the new one here.

If we just have a map where each entry is (java version) -> (first gradle version to support it), we can replace the existing loop (i.e. the previous use case in validateJavaGradle) with something like

return gradleV > describedMap.get(javaV)

We can replace the loop in getValidGradleVersionRangeForJavaVersion with

return VersionRange(describedMap.get(javaV), maxKnownAndSupportedGradleVersion) //or something similar to VersionRange

The use case in getJavaVersionFor isn't quite as clean to replace, but you can still do something like

for (MapEntry entry in describedMap) {
  if (gradleV > entry.value) {
    maxJavaVersion = max(entry.key, maxJavaVersion)
  }
}

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This makes sense to me and would improve readability IMO. I am hesitant to make this change in this PR just because it is balloon-ing a little, but I can definitely follow up on this PR making this change.

JavaGradleCompat(
javaMin: '19',
javaMax: '20',
gradleMin: '7.6',
gradleMax: _maxKnownAndSupportedGradleVersion,
gradleMax: maxKnownAndSupportedGradleVersion,
),
JavaGradleCompat(
javaMin: '18',
javaMax: '19',
gradleMin: '7.5',
gradleMax: _maxKnownAndSupportedGradleVersion,
gradleMax: maxKnownAndSupportedGradleVersion,
),
JavaGradleCompat(
javaMin: '17',
javaMax: '18',
gradleMin: '7.3',
gradleMax: _maxKnownAndSupportedGradleVersion,
gradleMax: maxKnownAndSupportedGradleVersion,
),
JavaGradleCompat(
javaMin: '16',
javaMax: '17',
gradleMin: '7.0',
gradleMax: _maxKnownAndSupportedGradleVersion,
gradleMax: maxKnownAndSupportedGradleVersion,
),
JavaGradleCompat(
javaMin: '15',
javaMax: '16',
gradleMin: '6.7',
gradleMax: _maxKnownAndSupportedGradleVersion,
gradleMax: maxKnownAndSupportedGradleVersion,
),
JavaGradleCompat(
javaMin: '14',
javaMax: '15',
gradleMin: '6.3',
gradleMax: _maxKnownAndSupportedGradleVersion,
gradleMax: maxKnownAndSupportedGradleVersion,
),
JavaGradleCompat(
javaMin: '13',
javaMax: '14',
gradleMin: '6.0',
gradleMax: _maxKnownAndSupportedGradleVersion,
gradleMax: maxKnownAndSupportedGradleVersion,
),
JavaGradleCompat(
javaMin: '12',
javaMax: '13',
gradleMin: '5.4',
gradleMax: _maxKnownAndSupportedGradleVersion,
gradleMax: maxKnownAndSupportedGradleVersion,
),
JavaGradleCompat(
javaMin: '11',
javaMax: '12',
gradleMin: '5.0',
gradleMax: _maxKnownAndSupportedGradleVersion,
gradleMax: maxKnownAndSupportedGradleVersion,
),
// 1.11 is a made up java version to cover everything in 1.10.*
JavaGradleCompat(
javaMin: '1.10',
javaMax: '1.11',
gradleMin: '4.7',
gradleMax: _maxKnownAndSupportedGradleVersion,
gradleMax: maxKnownAndSupportedGradleVersion,
),
JavaGradleCompat(
javaMin: '1.9',
javaMax: '1.10',
gradleMin: '4.3',
gradleMax: _maxKnownAndSupportedGradleVersion,
gradleMax: maxKnownAndSupportedGradleVersion,
),
JavaGradleCompat(
javaMin: '1.8',
javaMax: '1.9',
gradleMin: '2.0',
gradleMax: _maxKnownAndSupportedGradleVersion,
gradleMax: maxKnownAndSupportedGradleVersion,
),
];

// List of compatible Java/AGP versions
List<JavaAgpCompat> _javaAgpCompatList = <JavaAgpCompat>[
List<JavaAgpCompat> _javaAgpCompatList = const <JavaAgpCompat>[
JavaAgpCompat(
javaMin: '17',
javaDefault: '17',
agpMin: '8.0',
agpMax: maxKnownAgpVersion,
),
JavaAgpCompat(
javaMin: '11',
javaDefault: '11',
javaMin: '1.11',
javaDefault: '1.11',
agpMin: '7.0',
agpMax: '7.4',
),
Expand Down
Loading