gradle_errors.dart 25.6 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 'android_sdk.dart';
15
import 'android_studio.dart';
16
import 'gradle_utils.dart';
17
import 'multidex.dart';
18 19 20 21

typedef GradleErrorTest = bool Function(String);

/// A Gradle error handled by the tool.
22
class GradleHandledError {
23
  const GradleHandledError({
24 25
    required this.test,
    required this.handler,
26 27 28 29 30 31 32 33 34
    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({
35 36 37
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
38
    required bool multidexEnabled,
39 40
  }) handler;

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

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

55 56
/// Returns a simple test function that evaluates to `true` if at least one of
/// `errorMessages` is contained in the error message.
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
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,
76 77 78
  minSdkVersionHandler,
  transformInputIssueHandler,
  lockFileDepMissingHandler,
79
  multidexErrorHandler,
80
  incompatibleKotlinVersionHandler,
81
  minCompileSdkVersionHandler,
82
  jvm11RequiredHandler,
83
  outdatedGradleHandler,
84
  sslExceptionHandler,
85
  zipExceptionHandler,
86
  incompatibleJavaAndGradleVersionsHandler,
87
  remoteTerminatedHandshakeHandler,
88 89
];

90 91
const String _boxTitle = 'Flutter Fix';

92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
// 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. '
109
        'See https://docs.flutter.dev/deployment/android#enabling-multidex-support for more information. '
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 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
        "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,
          );
        } on StateError catch(e) {
          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 {
178
      globals.printBox(
179
        'Flutter multidex handling is disabled. If you wish to let the tool configure multidex, use the --multidex flag.',
180
        title: _boxTitle,
181 182 183 184 185 186 187
      );
    }
    return GradleBuildStatus.exit;
  },
  eventLabel: 'multidex-error',
);

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

211 212
/// Gradle crashes for several known reasons when downloading that are not
/// actionable by Flutter.
213 214 215 216 217 218 219 220 221 222
@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',
223
    "> Could not get resource 'http",
224 225
  ]),
  handler: ({
226 227 228
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
229
    required bool multidexEnabled,
230
  }) async {
231
    globals.printError(
232 233
      '${globals.logger.terminal.warningMark} '
      'Gradle threw an error while downloading artifacts from the network.'
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 275 276 277 278 279 280 281 282 283
    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';
      } on StateError catch(e) {
        globals.printError(
          e.message,
          indent: 0,
        );
      }
    }
    if (shouldDeleteUserGradle) {
284
      final String? homeDir = globals.platform.environment['HOME'];
285 286 287 288 289 290 291 292 293 294
      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');
295 296
      }
    }
297 298
    return GradleBuildStatus.retry;
  },
299
  eventLabel: 'zip-exception',
300 301 302 303 304 305 306 307 308
);

// R8 failure.
@visibleForTesting
final GradleHandledError r8FailureHandler = GradleHandledError(
  test: _lineMatcher(const <String>[
    'com.android.tools.r8',
  ]),
  handler: ({
309 310 311
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
312
    required bool multidexEnabled,
313
  }) async {
314 315 316 317 318 319
    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,
    );
320 321 322 323 324 325 326 327 328 329 330 331 332 333
    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: ({
334 335 336
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
337
    required bool multidexEnabled,
338 339
  }) async {
    const String licenseNotAcceptedMatcher =
340
      r'You have not accepted the license agreements of the following SDK components:\s*\[(.+)\]';
341 342

    final RegExp licenseFailure = RegExp(licenseNotAcceptedMatcher, multiLine: true);
343
    final Match? licenseMatch = licenseFailure.firstMatch(line);
344
    globals.printBox(
345
      '${globals.logger.terminal.warningMark} Unable to download needed Android SDK components, as the '
346
      'following licenses have not been accepted: '
347
      '${licenseMatch?.group(1)}\n\n'
348
      'To resolve this, please run the following command in a Terminal:\n'
349 350
      'flutter doctor --android-licenses',
      title: _boxTitle,
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367
    );
    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: ({
368 369 370
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
371
    required bool multidexEnabled,
372
  }) async {
373
    final RunResult tasksRunResult = await globals.processUtils.run(
374
      <String>[
375
        globals.gradleUtils!.getExecutable(project),
376 377 378 379 380 381
        'app:tasks' ,
        '--all',
        '--console=auto',
      ],
      throwOnError: true,
      workingDirectory: project.android.hostAppGradleRoot.path,
382 383
      environment: <String, String>{
        if (javaPath != null)
384
          AndroidSdk.javaHomeEnvironmentVariable: javaPath!,
385
      },
386 387 388
    );
    // Extract build types and product flavors.
    final Set<String> variants = <String>{};
389
    for (final String task in tasksRunResult.stdout.split('\n')) {
390
      final Match? match = _assembleTaskPattern.matchAsPrefix(task);
391
      if (match != null) {
392
        final String variant = match.group(1)!.toLowerCase();
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408
        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);
          }
        }
      }
    }
409 410
    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');
411
    if (productFlavors.isEmpty) {
412 413 414
      globals.printBox(
        '$errorMessage\n\n'
        'The ${buildGradle.absolute.path} file does not define '
415
        'any custom product flavors. '
416 417
        'You cannot use the --flavor option.',
        title: _boxTitle,
418 419
      );
    } else {
420 421 422 423 424 425
      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,
426 427 428 429 430 431
      );
    }
    return GradleBuildStatus.exit;
  },
  eventLabel: 'flavor-undefined',
);
432 433 434 435 436 437


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
438
final GradleHandledError minSdkVersionHandler = GradleHandledError(
439 440 441 442
  test: (String line) {
    return _minSdkVersionPattern.hasMatch(line);
  },
  handler: ({
443 444 445
    required String line,
    required FlutterProject project,
    required bool usesAndroidX,
446
    required bool multidexEnabled,
447
  }) async {
448
    final File gradleFile = project.directory
449
        .childDirectory('android')
450 451
        .childDirectory('app')
        .childFile('build.gradle');
452

453 454
    final Match? minSdkVersionMatch = _minSdkVersionPattern.firstMatch(line);
    assert(minSdkVersionMatch?.groupCount == 3);
455

456
    final String textInBold = globals.logger.terminal.bolden(
457 458 459 460 461 462
      'Fix this issue by adding the following to the file ${gradleFile.path}:\n'
      'android {\n'
      '  defaultConfig {\n'
      '    minSdkVersion ${minSdkVersionMatch?.group(2)}\n'
      '  }\n'
      '}\n'
463
    );
464
    globals.printBox(
465
      'The plugin ${minSdkVersionMatch?.group(3)} requires a higher Android SDK version.\n'
466
      '$textInBold\n'
467 468
      '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'
469
      'For more information, see: https://docs.flutter.dev/deployment/android#reviewing-the-gradle-build-configuration',
470
      title: _boxTitle,
471 472 473 474 475
    );
    return GradleBuildStatus.exit;
  },
  eventLabel: 'plugin-min-sdk',
);
476 477 478 479

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

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

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

601 602 603 604 605 606 607 608 609 610 611
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 {
612 613
    final Match? minCompileSdkVersionMatch = _minCompileSdkVersionPattern.firstMatch(line);
    assert(minCompileSdkVersionMatch?.groupCount == 1);
614 615 616 617 618 619 620 621 622

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

@visibleForTesting
633
final GradleHandledError jvm11RequiredHandler = GradleHandledError(
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
  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',
);
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674

/// 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',
);
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696

/// 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 {
    // 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 "
      'is incompatible with the Java version that Flutter is using for Gradle.\n\n'
697
      'To fix this issue, consult the migration guide at docs.flutter.dev/go/android-java-gradle-error.',
698 699 700 701 702 703
      title: _boxTitle,
    );
    return GradleBuildStatus.exit;
  },
  eventLabel: 'incompatible-java-gradle-version',
);
704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722

@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',
);