gradle_errors.dart 26.7 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5 6
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:meta/meta.dart';

7 8
import '../base/error_handling_io.dart';
import '../base/file_system.dart';
9
import '../base/process.dart';
10
import '../base/terminal.dart';
11
import '../globals.dart' as globals;
12 13
import '../project.dart';
import '../reporting/reporting.dart';
14
import 'gradle_utils.dart';
15
import 'multidex.dart';
16 17 18 19

typedef GradleErrorTest = bool Function(String);

/// A Gradle error handled by the tool.
20
class GradleHandledError {
21
  const GradleHandledError({
22 23
    required this.test,
    required this.handler,
24 25 26 27 28 29 30 31 32
    this.eventLabel,
  });

  /// The test function.
  /// Returns [true] if the current error message should be handled.
  final GradleErrorTest test;

  /// The handler function.
  final Future<GradleBuildStatus> Function({
33 34 35
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
36
    required bool multidexEnabled,
37 38
  }) handler;

39
  /// The [BuildEvent] label is named gradle-[eventLabel].
40 41
  /// If not empty, the build event is logged along with
  /// additional metadata such as the attempt number.
42
  final String? eventLabel;
43 44 45
}

/// The status of the Gradle build.
46
enum GradleBuildStatus {
47 48 49 50 51 52
  /// The tool cannot recover from the failure and should exit.
  exit,
  /// The tool can retry the exact same build.
  retry,
}

53 54
/// Returns a simple test function that evaluates to `true` if at least one of
/// `errorMessages` is contained in the error message.
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
GradleErrorTest _lineMatcher(List<String> errorMessages) {
  return (String line) {
    return errorMessages.any((String errorMessage) => line.contains(errorMessage));
  };
}

/// The list of Gradle errors that the tool can handle.
///
/// The handlers are executed in the order in which they appear in the list.
///
/// Only the first error handler for which the [test] function returns [true]
/// is handled. As a result, sort error handlers based on how strict the [test]
/// function is to eliminate false positives.
final List<GradleHandledError> gradleErrors = <GradleHandledError>[
  licenseNotAcceptedHandler,
  networkErrorHandler,
  permissionDeniedErrorHandler,
  flavorUndefinedHandler,
  r8FailureHandler,
74 75 76
  minSdkVersionHandler,
  transformInputIssueHandler,
  lockFileDepMissingHandler,
77
  multidexErrorHandler,
78
  incompatibleKotlinVersionHandler,
79
  minCompileSdkVersionHandler,
80
  jvm11RequiredHandler,
81
  outdatedGradleHandler,
82
  sslExceptionHandler,
83
  zipExceptionHandler,
84
  incompatibleJavaAndGradleVersionsHandler,
85
  remoteTerminatedHandshakeHandler,
86
  couldNotOpenCacheDirectoryHandler,
87 88
];

89 90
const String _boxTitle = 'Flutter Fix';

91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
// Multidex error message.
@visibleForTesting
final GradleHandledError multidexErrorHandler = GradleHandledError(
  test: _lineMatcher(const <String>[
    'com.android.builder.dexing.DexArchiveMergerException: Error while merging dex archives:',
    'The number of method references in a .dex file cannot exceed 64K.',
  ]),
  handler: ({
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
    required bool multidexEnabled,
  }) async {
    globals.printStatus('${globals.logger.terminal.warningMark} App requires Multidex support', emphasis: true);
    if (multidexEnabled) {
      globals.printStatus(
        'Multidex support is required for your android app to build since the number of methods has exceeded 64k. '
108
        'See https://docs.flutter.dev/deployment/android#enabling-multidex-support for more information. '
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
        "You may pass the --no-multidex flag to skip Flutter's multidex support to use a manual solution.\n",
        indent: 4,
      );
      if (!androidManifestHasNameVariable(project.directory)) {
        globals.printStatus(
          r'Your `android/app/src/main/AndroidManifest.xml` does not contain `android:name="${applicationName}"` '
          'under the `application` element. This may be due to creating your project with an old version of Flutter. '
          'Add the `android:name="\${applicationName}"` attribute to your AndroidManifest.xml to enable Flutter\'s multidex support:\n',
          indent: 4,
        );
        globals.printStatus(r'''
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
  ...
  <application
    ...
    android:name=''',
          indent: 8,
          newline: false,
          color: TerminalColor.grey,
        );
        globals.printStatus(r'"${applicationName}"', color: TerminalColor.green, newline: true);
        globals.printStatus(r'''
    ...>
''',
          indent: 8,
          color: TerminalColor.grey,
        );

        globals.printStatus(
          'You may also roll your own multidex support by following the guide at: https://developer.android.com/studio/build/multidex\n',
          indent: 4,
        );
        return GradleBuildStatus.exit;
      }
      if (!multiDexApplicationExists(project.directory)) {
        globals.printStatus(
          'Flutter tool can add multidex support. The following file will be added by flutter:\n',
          indent: 4,
        );
        globals.printStatus(
          'android/app/src/main/java/io/flutter/app/FlutterMultiDexApplication.java\n',
          indent: 8,
        );
        String selection = 'n';
        // Default to 'no' if no interactive terminal.
        try {
          selection = await globals.terminal.promptForCharInput(
            <String>['y', 'n'],
            logger: globals.logger,
            prompt: 'Do you want to continue with adding multidex support for Android?',
            defaultChoiceIndex: 0,
          );
161
        } on StateError catch (e) {
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
          globals.printError(
            e.message,
            indent: 0,
          );
        }
        if (selection == 'y') {
          ensureMultiDexApplicationExists(project.directory);
          globals.printStatus(
            'Multidex enabled. Retrying build.\n',
            indent: 0,
          );
          return GradleBuildStatus.retry;
        }
      }
    } else {
177
      globals.printBox(
178
        'Flutter multidex handling is disabled. If you wish to let the tool configure multidex, use the --multidex flag.',
179
        title: _boxTitle,
180 181 182 183 184 185 186
      );
    }
    return GradleBuildStatus.exit;
  },
  eventLabel: 'multidex-error',
);

187 188 189 190 191 192 193
// Permission defined error message.
@visibleForTesting
final GradleHandledError permissionDeniedErrorHandler = GradleHandledError(
  test: _lineMatcher(const <String>[
    'Permission denied',
  ]),
  handler: ({
194 195 196
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
197
    required bool multidexEnabled,
198
  }) async {
199 200
    globals.printBox(
      '${globals.logger.terminal.warningMark} Gradle does not have execution permission.\n'
201 202
      'You should change the ownership of the project directory to your user, '
      'or move the project to a directory with execute permissions.',
203
      title: _boxTitle,
204 205 206 207 208 209
    );
    return GradleBuildStatus.exit;
  },
  eventLabel: 'permission-denied',
);

210 211
/// Gradle crashes for several known reasons when downloading that are not
/// actionable by Flutter.
212 213 214 215 216 217 218 219 220 221
@visibleForTesting
final GradleHandledError networkErrorHandler = GradleHandledError(
  test: _lineMatcher(const <String>[
    'java.io.FileNotFoundException: https://downloads.gradle.org',
    'java.io.IOException: Unable to tunnel through proxy',
    'java.lang.RuntimeException: Timeout of',
    'java.util.zip.ZipException: error in opening zip file',
    'javax.net.ssl.SSLHandshakeException: Remote host closed connection during handshake',
    'java.net.SocketException: Connection reset',
    'java.io.FileNotFoundException',
222
    "> Could not get resource 'http",
223 224
  ]),
  handler: ({
225 226 227
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
228
    required bool multidexEnabled,
229
  }) async {
230
    globals.printError(
231 232
      '${globals.logger.terminal.warningMark} '
      'Gradle threw an error while downloading artifacts from the network.'
233
    );
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274
    return GradleBuildStatus.retry;
  },
  eventLabel: 'network',
);

/// Handles corrupted jar or other types of zip files.
///
/// If a terminal is attached, this handler prompts the user if they would like to
/// delete the $HOME/.gradle directory prior to retrying the build.
///
/// If this handler runs on a bot (e.g. a CI bot), the $HOME/.gradle is automatically deleted.
///
/// See also:
///  * https://github.com/flutter/flutter/issues/51195
///  * https://github.com/flutter/flutter/issues/89959
///  * https://docs.gradle.org/current/userguide/directory_layout.html#dir:gradle_user_home
@visibleForTesting
final GradleHandledError zipExceptionHandler = GradleHandledError(
  test: _lineMatcher(const <String>[
    'java.util.zip.ZipException: error in opening zip file',
  ]),
  handler: ({
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
    required bool multidexEnabled,
  }) async {
    globals.printError(
      '${globals.logger.terminal.warningMark} '
      'Your .gradle directory under the home directory might be corrupted.'
    );
    bool shouldDeleteUserGradle = await globals.botDetector.isRunningOnBot;
    if (!shouldDeleteUserGradle && globals.terminal.stdinHasTerminal) {
      try {
        final String selection = await globals.terminal.promptForCharInput(
          <String>['y', 'n'],
          logger: globals.logger,
          prompt: 'Do you want to delete the .gradle directory under the home directory?',
          defaultChoiceIndex: 0,
        );
        shouldDeleteUserGradle = selection == 'y';
275
      } on StateError catch (e) {
276 277 278 279 280 281 282
        globals.printError(
          e.message,
          indent: 0,
        );
      }
    }
    if (shouldDeleteUserGradle) {
283
      final String? homeDir = globals.platform.environment['HOME'];
284 285 286 287 288 289 290 291 292 293
      if (homeDir == null) {
        globals.logger.printStatus("Could not delete .gradle directory because there isn't a HOME env variable");
        return GradleBuildStatus.retry;
      }
      final Directory userGradle = globals.fs.directory(globals.fs.path.join(homeDir, '.gradle'));
      globals.logger.printStatus('Deleting ${userGradle.path}');
      try {
        ErrorHandlingFileSystem.deleteIfExists(userGradle, recursive: true);
      } on FileSystemException catch (err) {
        globals.printTrace('Failed to delete Gradle cache: $err');
294 295
      }
    }
296 297
    return GradleBuildStatus.retry;
  },
298
  eventLabel: 'zip-exception',
299 300 301 302 303 304 305 306 307
);

// R8 failure.
@visibleForTesting
final GradleHandledError r8FailureHandler = GradleHandledError(
  test: _lineMatcher(const <String>[
    'com.android.tools.r8',
  ]),
  handler: ({
308 309 310
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
311
    required bool multidexEnabled,
312
  }) async {
313 314 315 316 317 318
    globals.printBox(
      '${globals.logger.terminal.warningMark} The shrinker may have failed to optimize the Java bytecode.\n'
      'To disable the shrinker, pass the `--no-shrink` flag to this command.\n'
      'To learn more, see: https://developer.android.com/studio/build/shrink-code',
      title: _boxTitle,
    );
319 320 321 322 323 324 325 326 327 328 329 330 331 332
    return GradleBuildStatus.exit;
  },
  eventLabel: 'r8',
);

/// Handle Gradle error thrown when Gradle needs to download additional
/// Android SDK components (e.g. Platform Tools), and the license
/// for that component has not been accepted.
@visibleForTesting
final GradleHandledError licenseNotAcceptedHandler = GradleHandledError(
  test: _lineMatcher(const <String>[
    'You have not accepted the license agreements of the following SDK components',
  ]),
  handler: ({
333 334 335
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
336
    required bool multidexEnabled,
337 338
  }) async {
    const String licenseNotAcceptedMatcher =
339
      r'You have not accepted the license agreements of the following SDK components:\s*\[(.+)\]';
340 341

    final RegExp licenseFailure = RegExp(licenseNotAcceptedMatcher, multiLine: true);
342
    final Match? licenseMatch = licenseFailure.firstMatch(line);
343
    globals.printBox(
344
      '${globals.logger.terminal.warningMark} Unable to download needed Android SDK components, as the '
345
      'following licenses have not been accepted: '
346
      '${licenseMatch?.group(1)}\n\n'
347
      'To resolve this, please run the following command in a Terminal:\n'
348 349
      'flutter doctor --android-licenses',
      title: _boxTitle,
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
    );
    return GradleBuildStatus.exit;
  },
  eventLabel: 'license-not-accepted',
);

final RegExp _undefinedTaskPattern = RegExp(r'Task .+ not found in root project.');

final RegExp _assembleTaskPattern = RegExp(r'assemble(\S+)');

/// Handler when a flavor is undefined.
@visibleForTesting
final GradleHandledError flavorUndefinedHandler = GradleHandledError(
  test: (String line) {
    return _undefinedTaskPattern.hasMatch(line);
  },
  handler: ({
367 368 369
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
370
    required bool multidexEnabled,
371
  }) async {
372
    final RunResult tasksRunResult = await globals.processUtils.run(
373
      <String>[
374
        globals.gradleUtils!.getExecutable(project),
375 376 377 378 379 380
        'app:tasks' ,
        '--all',
        '--console=auto',
      ],
      throwOnError: true,
      workingDirectory: project.android.hostAppGradleRoot.path,
381
      environment: globals.java?.environment,
382 383 384
    );
    // Extract build types and product flavors.
    final Set<String> variants = <String>{};
385
    for (final String task in tasksRunResult.stdout.split('\n')) {
386
      final Match? match = _assembleTaskPattern.matchAsPrefix(task);
387
      if (match != null) {
388
        final String variant = match.group(1)!.toLowerCase();
389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
        if (!variant.endsWith('test')) {
          variants.add(variant);
        }
      }
    }
    final Set<String> productFlavors = <String>{};
    for (final String variant1 in variants) {
      for (final String variant2 in variants) {
        if (variant2.startsWith(variant1) && variant2 != variant1) {
          final String buildType = variant2.substring(variant1.length);
          if (variants.contains(buildType)) {
            productFlavors.add(variant1);
          }
        }
      }
    }
405 406
    final String errorMessage = '${globals.logger.terminal.warningMark}  Gradle project does not define a task suitable for the requested build.';
    final File buildGradle = project.directory.childDirectory('android').childDirectory('app').childFile('build.gradle');
407
    if (productFlavors.isEmpty) {
408 409 410
      globals.printBox(
        '$errorMessage\n\n'
        'The ${buildGradle.absolute.path} file does not define '
411
        'any custom product flavors. '
412 413
        'You cannot use the --flavor option.',
        title: _boxTitle,
414 415
      );
    } else {
416 417 418 419 420 421
      globals.printBox(
        '$errorMessage\n\n'
        'The ${buildGradle.absolute.path} file defines product '
        'flavors: ${productFlavors.join(', ')}. '
        'You must specify a --flavor option to select one of them.',
        title: _boxTitle,
422 423 424 425 426 427
      );
    }
    return GradleBuildStatus.exit;
  },
  eventLabel: 'flavor-undefined',
);
428 429 430 431 432 433


final RegExp _minSdkVersionPattern = RegExp(r'uses-sdk:minSdkVersion ([0-9]+) cannot be smaller than version ([0-9]+) declared in library \[\:(.+)\]');

/// Handler when a plugin requires a higher Android API level.
@visibleForTesting
434
final GradleHandledError minSdkVersionHandler = GradleHandledError(
435 436 437 438
  test: (String line) {
    return _minSdkVersionPattern.hasMatch(line);
  },
  handler: ({
439 440 441
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
442
    required bool multidexEnabled,
443
  }) async {
444
    final File gradleFile = project.directory
445
        .childDirectory('android')
446 447
        .childDirectory('app')
        .childFile('build.gradle');
448

449 450
    final Match? minSdkVersionMatch = _minSdkVersionPattern.firstMatch(line);
    assert(minSdkVersionMatch?.groupCount == 3);
451

452
    final String textInBold = globals.logger.terminal.bolden(
453 454 455 456 457 458
      'Fix this issue by adding the following to the file ${gradleFile.path}:\n'
      'android {\n'
      '  defaultConfig {\n'
      '    minSdkVersion ${minSdkVersionMatch?.group(2)}\n'
      '  }\n'
      '}\n'
459
    );
460
    globals.printBox(
461
      'The plugin ${minSdkVersionMatch?.group(3)} requires a higher Android SDK version.\n'
462
      '$textInBold\n'
463 464
      'Following this change, your app will not be available to users running Android SDKs below ${minSdkVersionMatch?.group(2)}.\n'
      'Consider searching for a version of this plugin that supports these lower versions of the Android SDK instead.\n'
465
      'For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-gradle-build-configuration',
466
      title: _boxTitle,
467 468 469 470 471
    );
    return GradleBuildStatus.exit;
  },
  eventLabel: 'plugin-min-sdk',
);
472 473 474 475

/// Handler when https://issuetracker.google.com/issues/141126614 or
/// https://github.com/flutter/flutter/issues/58247 is triggered.
@visibleForTesting
476
final GradleHandledError transformInputIssueHandler = GradleHandledError(
477 478 479 480
  test: (String line) {
    return line.contains('https://issuetracker.google.com/issues/158753935');
  },
  handler: ({
481 482 483
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
484
    required bool multidexEnabled,
485 486 487 488 489
  }) async {
    final File gradleFile = project.directory
        .childDirectory('android')
        .childDirectory('app')
        .childFile('build.gradle');
490
    final String textInBold = globals.logger.terminal.bolden(
491 492 493 494 495 496 497
      'Fix this issue by adding the following to the file ${gradleFile.path}:\n'
      'android {\n'
      '  lintOptions {\n'
      '    checkReleaseBuilds false\n'
      '  }\n'
      '}'
    );
498
    globals.printBox(
499
      'This issue appears to be https://github.com/flutter/flutter/issues/58247.\n'
500 501
      '$textInBold',
      title: _boxTitle,
502 503 504 505 506
    );
    return GradleBuildStatus.exit;
  },
  eventLabel: 'transform-input-issue',
);
507 508 509

/// Handler when a dependency is missing in the lockfile.
@visibleForTesting
510
final GradleHandledError lockFileDepMissingHandler = GradleHandledError(
511 512 513 514
  test: (String line) {
    return line.contains('which is not part of the dependency lock state');
  },
  handler: ({
515 516 517
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
518
    required bool multidexEnabled,
519 520 521 522
  }) async {
    final File gradleFile = project.directory
        .childDirectory('android')
        .childFile('build.gradle');
523
    final String textInBold = globals.logger.terminal.bolden(
524
      'To regenerate the lockfiles run: `./gradlew :generateLockfiles` in ${gradleFile.path}\n'
525
      'To remove dependency locking, remove the `dependencyLocking` from ${gradleFile.path}'
526
    );
527
    globals.printBox(
528
      'You need to update the lockfile, or disable Gradle dependency locking.\n'
529 530
      '$textInBold',
      title: _boxTitle,
531 532 533 534 535
    );
    return GradleBuildStatus.exit;
  },
  eventLabel: 'lock-dep-issue',
);
536 537 538 539

@visibleForTesting
final GradleHandledError incompatibleKotlinVersionHandler = GradleHandledError(
  test: _lineMatcher(const <String>[
540
    'was compiled with an incompatible version of Kotlin',
541 542 543 544 545 546 547 548 549 550
  ]),
  handler: ({
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
    required bool multidexEnabled,
  }) async {
    final File gradleFile = project.directory
        .childDirectory('android')
        .childFile('build.gradle');
551 552
    globals.printBox(
      '${globals.logger.terminal.warningMark} Your project requires a newer version of the Kotlin Gradle plugin.\n'
553
      'Find the latest version on https://kotlinlang.org/docs/releases.html#release-details, then update ${gradleFile.path}:\n'
554
      "ext.kotlin_version = '<latest-version>'",
555
      title: _boxTitle,
556 557 558 559 560
    );
    return GradleBuildStatus.exit;
  },
  eventLabel: 'incompatible-kotlin-version',
);
561

562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
final RegExp _outdatedGradlePattern = RegExp(r'The current Gradle version (.+) is not compatible with the Kotlin Gradle plugin');

@visibleForTesting
final GradleHandledError outdatedGradleHandler = GradleHandledError(
  test: _outdatedGradlePattern.hasMatch,
  handler: ({
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
    required bool multidexEnabled,
  }) async {
    final File gradleFile = project.directory
        .childDirectory('android')
        .childFile('build.gradle');
    final File gradlePropertiesFile = project.directory
        .childDirectory('android')
        .childDirectory('gradle')
        .childDirectory('wrapper')
        .childFile('gradle-wrapper.properties');
    globals.printBox(
      '${globals.logger.terminal.warningMark} Your project needs to upgrade Gradle and the Android Gradle plugin.\n\n'
      'To fix this issue, replace the following content:\n'
      '${gradleFile.path}:\n'
      '    ${globals.terminal.color("- classpath 'com.android.tools.build:gradle:<current-version>'", TerminalColor.red)}\n'
      '    ${globals.terminal.color("+ classpath 'com.android.tools.build:gradle:$templateAndroidGradlePluginVersion'", TerminalColor.green)}\n'
      '${gradlePropertiesFile.path}:\n'
      '    ${globals.terminal.color('- https://services.gradle.org/distributions/gradle-<current-version>-all.zip', TerminalColor.red)}\n'
      '    ${globals.terminal.color('+ https://services.gradle.org/distributions/gradle-$templateDefaultGradleVersion-all.zip', TerminalColor.green)}',
      title: _boxTitle,
    );
    return GradleBuildStatus.exit;
  },
  eventLabel: 'outdated-gradle-version',
);

597 598 599 600 601 602 603 604 605 606 607
final RegExp _minCompileSdkVersionPattern = RegExp(r'The minCompileSdk \(([0-9]+)\) specified in a');

@visibleForTesting
final GradleHandledError minCompileSdkVersionHandler = GradleHandledError(
  test: _minCompileSdkVersionPattern.hasMatch,
  handler: ({
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
    required bool multidexEnabled,
  }) async {
608 609
    final Match? minCompileSdkVersionMatch = _minCompileSdkVersionPattern.firstMatch(line);
    assert(minCompileSdkVersionMatch?.groupCount == 1);
610 611 612 613 614 615

    final File gradleFile = project.directory
        .childDirectory('android')
        .childDirectory('app')
        .childFile('build.gradle');
    globals.printBox(
616 617
      '${globals.logger.terminal.warningMark} Your project requires a higher compileSdk version.\n'
      'Fix this issue by bumping the compileSdk version in ${gradleFile.path}:\n'
618
      'android {\n'
619
      '  compileSdk ${minCompileSdkVersionMatch?.group(1)}\n'
620 621 622 623 624 625 626
      '}',
      title: _boxTitle,
    );
    return GradleBuildStatus.exit;
  },
  eventLabel: 'min-compile-sdk-version',
);
627 628

@visibleForTesting
629
final GradleHandledError jvm11RequiredHandler = GradleHandledError(
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
  test: (String line) {
    return line.contains('Android Gradle plugin requires Java 11 to run');
  },
  handler: ({
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
    required bool multidexEnabled,
  }) async {
    globals.printBox(
      '${globals.logger.terminal.warningMark} You need Java 11 or higher to build your app with this version of Gradle.\n\n'
      'To get Java 11, update to the latest version of Android Studio on https://developer.android.com/studio/install.\n\n'
      'To check the Java version used by Flutter, run `flutter doctor -v`.',
      title: _boxTitle,
    );
    return GradleBuildStatus.exit;
  },
  eventLabel: 'java11-required',
);
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670

/// Handles SSL exceptions: https://github.com/flutter/flutter/issues/104628
@visibleForTesting
final GradleHandledError sslExceptionHandler = GradleHandledError(
  test: _lineMatcher(const <String>[
    'javax.net.ssl.SSLException: Tag mismatch!',
    'javax.crypto.AEADBadTagException: Tag mismatch!',
  ]),
  handler: ({
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
    required bool multidexEnabled,
  }) async {
    globals.printError(
      '${globals.logger.terminal.warningMark} '
      'Gradle threw an error while downloading artifacts from the network.'
    );
    return GradleBuildStatus.retry;
  },
  eventLabel: 'ssl-exception-tag-mismatch',
);
671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687

/// If an incompatible Java and Gradle versions error is caught, we expect an
/// error specifying that the Java major class file version, one of
/// https://javaalmanac.io/bytecode/versions/, is unsupported by Gradle.
final RegExp _unsupportedClassFileMajorVersionPattern = RegExp(r'Unsupported class file major version\s+\d+');

@visibleForTesting
final GradleHandledError incompatibleJavaAndGradleVersionsHandler = GradleHandledError(
  test: (String line) {
    return _unsupportedClassFileMajorVersionPattern.hasMatch(line);
  },
  handler: ({
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
    required bool multidexEnabled,
  }) async {
688 689 690 691 692
    final File gradlePropertiesFile = project.directory
        .childDirectory('android')
        .childDirectory('gradle')
        .childDirectory('wrapper')
        .childFile('gradle-wrapper.properties');
693 694 695 696
    // TODO(reidbaker): Replace URL with constant defined in
    // https://github.com/flutter/flutter/pull/123916.
    globals.printBox(
      "${globals.logger.terminal.warningMark} Your project's Gradle version "
697 698 699 700 701 702 703 704 705
          'is incompatible with the Java version that Flutter is using for Gradle.\n\n'
          'If you recently upgraded Android Studio, consult the migration guide '
          'at docs.flutter.dev/go/android-java-gradle-error.\n\n'
          'Otherwise, to fix this issue, first, check the Java version used by Flutter by '
          'running `flutter doctor --verbose`.\n\n'
          'Then, update the Gradle version specified in ${gradlePropertiesFile.path} '
          'to be compatible with that Java version. '
          'See the link below for more information on compatible Java/Gradle versions:\n'
          'https://docs.gradle.org/current/userguide/compatibility.html#java\n\n',
706 707 708 709 710 711
      title: _boxTitle,
    );
    return GradleBuildStatus.exit;
  },
  eventLabel: 'incompatible-java-gradle-version',
);
712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730

@visibleForTesting
final GradleHandledError remoteTerminatedHandshakeHandler = GradleHandledError(
  test: (String line) => line.contains('Remote host terminated the handshake'),
  handler: ({
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
    required bool multidexEnabled,
  }) async {
    globals.printError(
      '${globals.logger.terminal.warningMark} '
      'Gradle threw an error while downloading artifacts from the network.'
    );

    return GradleBuildStatus.retry;
  },
  eventLabel: 'remote-terminated-handshake',
);
731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749

@visibleForTesting
final GradleHandledError couldNotOpenCacheDirectoryHandler = GradleHandledError(
  test: (String line) => line.contains('> Could not open cache directory '),
  handler: ({
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
    required bool multidexEnabled,
  }) async {
    globals.printError(
      '${globals.logger.terminal.warningMark} '
      'Gradle threw an error while resolving dependencies.'
    );

    return GradleBuildStatus.retry;
  },
  eventLabel: 'could-not-open-cache-directory',
);