flutter.gradle 48.9 KB
Newer Older
1 2 3 4
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
import static groovy.io.FileType.FILES
6 7

import com.android.builder.model.AndroidProject
8
import com.android.build.OutputFile
9
import groovy.json.JsonSlurper
10 11
import java.nio.file.Path
import java.nio.file.Paths
12 13
import java.util.regex.Matcher
import java.util.regex.Pattern
14
import org.apache.tools.ant.taskdefs.condition.Os
15 16 17 18 19
import org.gradle.api.DefaultTask
import org.gradle.api.GradleException
import org.gradle.api.Project
import org.gradle.api.Plugin
import org.gradle.api.Task
20
import org.gradle.api.file.CopySpec
21 22
import org.gradle.api.file.FileCollection
import org.gradle.api.tasks.Copy
23
import org.gradle.api.tasks.InputFiles
24 25
import org.gradle.api.tasks.OutputDirectory
import org.gradle.api.tasks.TaskAction
26
import org.gradle.api.tasks.bundling.Jar
27
import org.gradle.internal.os.OperatingSystem
28
import org.gradle.util.VersionNumber
29

30 31 32
/** For apps only. Provides the flutter extension used in app/build.gradle. */
class FlutterExtension {
    /** Sets the compileSdkVersion used by default in Flutter app projects. */
33
    static int compileSdkVersion = 31
34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50

    /** Sets the minSdkVersion used by default in Flutter app projects. */
    static int minSdkVersion = 16

    /** Sets the targetSdkVersion used by default in Flutter app projects. */
    static int targetSdkVersion = 31

    /**
     * Specifies the relative directory to the Flutter project directory.
     * In an app project, this is ../.. since the app's build.gradle is under android/app.
     */
    String source

    /** Allows to override the target file. Otherwise, the target is lib/main.dart. */
    String target
}

51
buildscript {
52
    repositories {
53
        google()
54
        mavenCentral()
55 56
    }
    dependencies {
57
        classpath 'com.android.tools.build:gradle:4.1.0'
58
    }
59 60
}

61 62 63 64 65
/**
 * Some apps don't set default compile options.
 * Apps can change these values in android/app/build.gradle.
 * This just ensures that default values are set.
 */
Dan Field's avatar
Dan Field committed
66 67
android {
    compileOptions {
68 69
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
Dan Field's avatar
Dan Field committed
70 71 72
    }
}

73 74
apply plugin: FlutterPlugin

75
class FlutterPlugin implements Plugin<Project> {
76
    private static final String DEFAULT_MAVEN_HOST = "https://storage.googleapis.com";
77

78
    /** The platforms that can be passed to the `--Ptarget-platform` flag. */
79 80 81 82 83
    private static final String PLATFORM_ARM32  = "android-arm";
    private static final String PLATFORM_ARM64  = "android-arm64";
    private static final String PLATFORM_X86    = "android-x86";
    private static final String PLATFORM_X86_64 = "android-x64";

84
    /** The ABI architectures supported by Flutter. */
85 86 87 88 89
    private static final String ARCH_ARM32      = "armeabi-v7a";
    private static final String ARCH_ARM64      = "arm64-v8a";
    private static final String ARCH_X86        = "x86";
    private static final String ARCH_X86_64     = "x86_64";

90
    /** Maps platforms to ABI architectures. */
91 92 93 94 95 96 97
    private static final Map PLATFORM_ARCH_MAP = [
        (PLATFORM_ARM32)    : ARCH_ARM32,
        (PLATFORM_ARM64)    : ARCH_ARM64,
        (PLATFORM_X86)      : ARCH_X86,
        (PLATFORM_X86_64)   : ARCH_X86_64,
    ]

98 99 100 101 102
    /**
     * The version code that gives each ABI a value.
     * For each APK variant, use the following versions to override the version of the Universal APK.
     * Otherwise, the Play Store will complain that the APK variants have the same version.
     */
103 104 105 106 107 108 109
    private static final Map ABI_VERSION = [
        (ARCH_ARM32)        : 1,
        (ARCH_ARM64)        : 2,
        (ARCH_X86)          : 3,
        (ARCH_X86_64)       : 4,
    ]

110
    /** When split is enabled, multiple APKs are generated per each ABI. */
111 112 113
    private static final List DEFAULT_PLATFORMS = [
        PLATFORM_ARM32,
        PLATFORM_ARM64,
114
        PLATFORM_X86_64,
115 116
    ]

117 118 119 120 121 122 123
    /**
     * The name prefix for flutter builds. This is used to identify gradle tasks
     * where we expect the flutter tool to provide any error output, and skip the
     * standard Gradle error output in the FlutterEventLogger. If you change this,
     * be sure to change any instances of this string in symbols in the code below
     * to match.
     */
124 125
    static final String FLUTTER_BUILD_PREFIX = "flutterBuild"

126
    private Project project
127
    private Map baseJar = [:]
128
    private File flutterRoot
129
    private File flutterExecutable
130
    private String localEngine
131
    private String localEngineSrcPath
132
    private Properties localProperties
133
    private String engineVersion
134

135 136
    @Override
    void apply(Project project) {
137 138
        this.project = project

139 140 141 142 143 144 145 146 147 148 149 150 151
        def rootProject = project.rootProject
        rootProject.tasks.register('generateLockfiles') {
            rootProject.subprojects.each { subproject ->
                def gradlew = (OperatingSystem.current().isWindows()) ?
                    "${rootProject.projectDir}/gradlew.bat" : "${rootProject.projectDir}/gradlew"
                rootProject.exec {
                    workingDir rootProject.projectDir
                    executable gradlew
                    args ":${subproject.name}:dependencies", "--write-locks"
                }
            }
        }

152 153 154 155 156
        // Configure the Maven repository.
        String hostedRepository = System.env.FLUTTER_STORAGE_BASE_URL ?: DEFAULT_MAVEN_HOST
        String repository = useLocalEngine()
            ? project.property('local-engine-repo')
            : "$hostedRepository/download.flutter.io"
157
        rootProject.allprojects {
158 159 160 161 162 163 164
            repositories {
                maven {
                    url repository
                }
            }
        }

165
        project.extensions.create("flutter", FlutterExtension)
166 167
        this.addFlutterTasks(project)

168 169 170
        // By default, assembling APKs generates fat APKs if multiple platforms are passed.
        // Configuring split per ABI allows to generate separate APKs for each abi.
        // This is a noop when building a bundle.
171
        if (shouldSplitPerAbi()) {
172 173 174 175 176 177 178 179 180 181 182 183 184
            project.android {
                splits {
                    abi {
                        // Enables building multiple APKs per ABI.
                        enable true
                        // Resets the list of ABIs that Gradle should create APKs for to none.
                        reset()
                        // Specifies that we do not want to also generate a universal APK that includes all ABIs.
                        universalApk false
                    }
                }
            }
        }
185 186 187 188 189 190 191 192

        if (project.hasProperty('deferred-component-names')) {
            String[] componentNames = project.property('deferred-component-names').split(',').collect {":${it}"}
            project.android {
                dynamicFeatures = componentNames
            }
        }

193
        getTargetPlatforms().each { targetArch ->
194
            String abiValue = PLATFORM_ARCH_MAP[targetArch]
195
            project.android {
196
                if (shouldSplitPerAbi()) {
197 198 199 200 201
                    splits {
                        abi {
                            include abiValue
                        }
                    }
202 203 204
                }
            }
        }
205

206
        String flutterRootPath = resolveProperty("flutter.sdk", System.env.FLUTTER_ROOT)
207
        if (flutterRootPath == null) {
208
            throw new GradleException("Flutter SDK not found. Define location with flutter.sdk in the local.properties file or with a FLUTTER_ROOT environment variable.")
209
        }
210 211
        flutterRoot = project.file(flutterRootPath)
        if (!flutterRoot.isDirectory()) {
212 213 214
            throw new GradleException("flutter.sdk must point to the Flutter SDK directory")
        }

215 216 217
        engineVersion = useLocalEngine()
            ? "+" // Match any version since there's only one.
            : "1.0.0-" + Paths.get(flutterRoot.absolutePath, "bin", "internal", "engine.version").toFile().text.trim()
218

219 220 221
        String flutterExecutableName = Os.isFamily(Os.FAMILY_WINDOWS) ? "flutter.bat" : "flutter"
        flutterExecutable = Paths.get(flutterRoot.absolutePath, "bin", flutterExecutableName).toFile();

222 223
        String flutterProguardRules = Paths.get(flutterRoot.absolutePath, "packages", "flutter_tools",
                "gradle", "flutter_proguard_rules.pro")
224
        project.android.buildTypes {
225
            // Add profile build type.
226 227 228 229 230 231
            profile {
                initWith debug
                if (it.hasProperty("matchingFallbacks")) {
                    matchingFallbacks = ["debug", "release"]
                }
            }
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
            // TODO(garyq): Shrinking is only false for multi apk split aot builds, where shrinking is not allowed yet.
            // This limitation has been removed experimentally in gradle plugin version 4.2, so we can remove
            // this check when we upgrade to 4.2+ gradle. Currently, deferred components apps may see
            // increased app size due to this.
            if (shouldShrinkResources(project)) {
                release {
                    // Enables code shrinking, obfuscation, and optimization for only
                    // your project's release build type.
                    minifyEnabled true
                    // Enables resource shrinking, which is performed by the
                    // Android Gradle plugin.
                    // NOTE: The resource shrinker can't be used for libraries.
                    shrinkResources isBuiltAsApp(project)
                    // Fallback to `android/app/proguard-rules.pro`.
                    // This way, custom Proguard rules can be configured as needed.
                    proguardFiles project.android.getDefaultProguardFile("proguard-android.txt"), flutterProguardRules, "proguard-rules.pro"
                }
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
        if (project.hasProperty("multidex-enabled") &&
            project.property("multidex-enabled").toBoolean() &&
            project.android.defaultConfig.minSdkVersion <= 20) {
            String flutterMultidexKeepfile = Paths.get(flutterRoot.absolutePath, "packages", "flutter_tools",
                "gradle", "flutter_multidex_keepfile.txt")
            project.android {
                defaultConfig {
                    multiDexEnabled true
                    manifestPlaceholders = [applicationName: "io.flutter.app.FlutterMultiDexApplication"]
                }
                buildTypes {
                    release {
                        multiDexKeepFile project.file(flutterMultidexKeepfile)
                    }
                }
            }
            project.dependencies {
                implementation "androidx.multidex:multidex:2.0.1"
            }
        } else {
            String baseApplicationName = "android.app.Application"
            if (project.hasProperty("base-application-name")) {
                baseApplicationName = project.property("base-application-name")
            }
            project.android {
                defaultConfig {
                    // Setting to android.app.Application is the same as omitting the attribute.
                    manifestPlaceholders = [applicationName: baseApplicationName]
                }
            }
        }

284
        if (useLocalEngine()) {
285 286
            // This is required to pass the local engine to flutter build aot.
            String engineOutPath = project.property('local-engine-out')
287
            File engineOut = project.file(engineOutPath)
288
            if (!engineOut.isDirectory()) {
289
                throw new GradleException('local-engine-out must point to a local engine build')
290
            }
291 292
            localEngine = engineOut.name
            localEngineSrcPath = engineOut.parentFile.parent
293
        }
294
        project.android.buildTypes.all this.&addFlutterDependencies
295 296
    }

Shi-Hao Hong's avatar
Shi-Hao Hong committed
297
    private static Boolean shouldShrinkResources(Project project) {
298 299 300 301 302 303
        if (project.hasProperty("shrink")) {
            return project.property("shrink").toBoolean()
        }
        return true
    }

304 305 306 307 308 309 310
    /**
     * Adds the dependencies required by the Flutter project.
     * This includes:
     *    1. The embedding
     *    2. libflutter.so
     */
    void addFlutterDependencies(buildType) {
311 312 313 314
        String flutterBuildMode = buildModeFor(buildType)
        if (!supportsBuildMode(flutterBuildMode)) {
            return
        }
315 316 317 318 319 320 321 322 323
        // The embedding is set as an API dependency in a Flutter plugin.
        // Therefore, don't make the app project depend on the embedding if there are Flutter
        // plugins.
        // This prevents duplicated classes when using custom build types. That is, a custom build
        // type like profile is used, and the plugin and app projects have API dependencies on the
        // embedding.
        if (!isFlutterAppProject() || getPluginList().size() == 0) {
            addApiDependencies(project, buildType.name,
                    "io.flutter:flutter_embedding_$flutterBuildMode:$engineVersion")
324 325 326
        }
        List<String> platforms = getTargetPlatforms().collect()
        // Debug mode includes x86 and x64, which are commonly used in emulators.
327
        if (flutterBuildMode == "debug" && !useLocalEngine()) {
328 329 330 331 332 333 334
            platforms.add("android-x86")
            platforms.add("android-x64")
        }
        platforms.each { platform ->
            String arch = PLATFORM_ARCH_MAP[platform].replace("-", "_")
            // Add the `libflutter.so` dependency.
            addApiDependencies(project, buildType.name,
335
                    "io.flutter:${arch}_$flutterBuildMode:$engineVersion")
336
        }
337 338 339 340 341
    }

    /**
     * Returns the directory where the plugins are built.
     */
342
    private File getPluginBuildDir() {
343 344 345 346 347 348
        // Module projects specify this flag to include plugins in the same repo as the module project.
        if (project.ext.has("pluginBuildDir")) {
            return project.ext.get("pluginBuildDir")
        }
        return project.buildDir
    }
349

350 351 352 353 354 355 356 357
    /**
     * Configures the Flutter plugin dependencies.
     *
     * The plugins are added to pubspec.yaml. Then, upon running `flutter pub get`,
     * the tool generates a `.flutter-plugins` file, which contains a 1:1 map to each plugin location.
     * Finally, the project's `settings.gradle` loads each plugin's android directory as a subproject.
     */
    private void configurePlugins() {
358 359
        getPluginList().each this.&configurePluginProject
        getPluginDependencies().each this.&configurePluginDependencies
360 361
    }

362
    /** Adds the plugin project dependency to the app project. */
363 364
    private void configurePluginProject(String pluginName, String _) {
        Project pluginProject = project.rootProject.findProject(":$pluginName")
365
        if (pluginProject == null) {
366
            project.logger.error("Plugin project :$pluginName not found. Please update settings.gradle.")
367 368 369 370
            return
        }
        // Add plugin dependency to the app project.
        project.dependencies {
371
            api pluginProject
372
        }
373
        Closure addEmbeddingDependencyToPlugin = { buildType ->
374
            String flutterBuildMode = buildModeFor(buildType)
375 376 377
            // In AGP 3.5, the embedding must be added as an API implementation,
            // so java8 features are desugared against the runtime classpath.
            // For more, see https://github.com/flutter/flutter/issues/40126
378
            if (!supportsBuildMode(flutterBuildMode)) {
379 380
                return
            }
381 382 383
            if (!pluginProject.hasProperty('android')) {
                return
            }
384 385 386 387 388
            // Copy build types from the app to the plugin.
            // This allows to build apps with plugins and custom build types or flavors.
            pluginProject.android.buildTypes {
                "${buildType.name}" {}
            }
389 390
            // The embedding is API dependency of the plugin, so the AGP is able to desugar
            // default method implementations when the interface is implemented by a plugin.
391
            //
392 393 394 395 396 397 398
            // See https://issuetracker.google.com/139821726, and
            // https://github.com/flutter/flutter/issues/72185 for more details.
            addApiDependencies(
              pluginProject,
              buildType.name,
              "io.flutter:flutter_embedding_$flutterBuildMode:$engineVersion"
            )
399
        }
400
        // Wait until the Android plugin loaded.
401
        pluginProject.afterEvaluate {
402
            project.android.buildTypes.all addEmbeddingDependencyToPlugin
403 404 405
        }
    }

406 407 408
    /**
     * Returns `true` if the given path contains an `android/build.gradle` file.
     */
409 410 411 412 413
    private Boolean doesSupportAndroidPlatform(String path) {
        File editableAndroidProject = new File(path, 'android' + File.separator + 'build.gradle')
        return editableAndroidProject.exists()
    }

414 415 416 417 418
    /**
     * Add the dependencies on other plugin projects to the plugin project.
     * A plugin A can depend on plugin B. As a result, this dependency must be surfaced by
     * making the Gradle plugin project A depend on the Gradle plugin project B.
     */
419 420 421
    private void configurePluginDependencies(Object dependencyObject) {
        assert dependencyObject.name instanceof String
        Project pluginProject = project.rootProject.findProject(":${dependencyObject.name}")
422 423
        if (pluginProject == null ||
            !doesSupportAndroidPlatform(pluginProject.projectDir.parentFile.path)) {
424 425 426 427 428 429 430 431 432
            return
        }
        assert dependencyObject.dependencies instanceof List
        dependencyObject.dependencies.each { pluginDependencyName ->
            assert pluginDependencyName instanceof String
            if (pluginDependencyName.empty) {
                return
            }
            Project dependencyProject = project.rootProject.findProject(":$pluginDependencyName")
433 434
            if (dependencyProject == null ||
                !doesSupportAndroidPlatform(dependencyProject.projectDir.parentFile.path)) {
435 436
                return
            }
437 438 439 440 441
            // Wait for the Android plugin to load and add the dependency to the plugin project.
            pluginProject.afterEvaluate {
                pluginProject.dependencies {
                    implementation dependencyProject
                }
442 443 444 445
            }
        }
    }

446
    private Properties getPluginList() {
447 448
        File pluginsFile = new File(project.projectDir.parentFile.parentFile, '.flutter-plugins')
        Properties allPlugins = readPropertiesIfExist(pluginsFile)
449
        Properties androidPlugins = new Properties()
450 451 452 453 454 455 456
        allPlugins.each { name, path ->
            if (doesSupportAndroidPlatform(path)) {
                androidPlugins.setProperty(name, path)
            }
            // TODO(amirh): log an error if this plugin was specified to be an Android
            // plugin according to the new schema, and was missing a build.gradle file.
            // https://github.com/flutter/flutter/issues/40784
457
        }
458
        return androidPlugins
459 460
    }

461
    /** Gets the plugins dependencies from `.flutter-plugins-dependencies`. */
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
    private List getPluginDependencies() {
        // Consider a `.flutter-plugins-dependencies` file with the following content:
        // {
        //     "dependencyGraph": [
        //       {
        //         "name": "plugin-a",
        //         "dependencies": ["plugin-b","plugin-c"]
        //       },
        //       {
        //         "name": "plugin-b",
        //         "dependencies": ["plugin-c"]
        //       },
        //       {
        //         "name": "plugin-c",
        //         "dependencies": []'
        //       }
        //     ]
        //  }
        //
        // This means, `plugin-a` depends on `plugin-b` and `plugin-c`.
        // `plugin-b` depends on `plugin-c`.
        // `plugin-c` doesn't depend on anything.
        File pluginsDependencyFile = new File(project.projectDir.parentFile.parentFile, '.flutter-plugins-dependencies')
        if (pluginsDependencyFile.exists()) {
            def object = new JsonSlurper().parseText(pluginsDependencyFile.text)
            assert object instanceof Map
            assert object.dependencyGraph instanceof List
            return object.dependencyGraph
        }
        return []
    }

494 495 496 497 498 499 500
    private static String toCammelCase(List<String> parts) {
        if (parts.empty) {
            return ""
        }
        return "${parts[0]}${parts[1..-1].collect { it.capitalize() }.join('')}"
    }

501
    private String resolveProperty(String name, String defaultValue) {
502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
        if (localProperties == null) {
            localProperties = readPropertiesIfExist(new File(project.projectDir.parentFile, "local.properties"))
        }
        String result
        if (project.hasProperty(name)) {
            result = project.property(name)
        }
        if (result == null) {
            result = localProperties.getProperty(name)
        }
        if (result == null) {
            result = defaultValue
        }
        return result
    }

    private static Properties readPropertiesIfExist(File propertiesFile) {
        Properties result = new Properties()
        if (propertiesFile.exists()) {
            propertiesFile.withReader('UTF-8') { reader -> result.load(reader) }
        }
        return result
    }

526
    private List<String> getTargetPlatforms() {
527 528 529 530 531 532 533 534 535 536 537
        if (!project.hasProperty('target-platform')) {
            return DEFAULT_PLATFORMS
        }
        return project.property('target-platform').split(',').collect {
            if (!PLATFORM_ARCH_MAP[it]) {
                throw new GradleException("Invalid platform: $it.")
            }
            return it
        }
    }

538
    private Boolean shouldSplitPerAbi() {
539 540 541 542 543 544
        if (project.hasProperty('split-per-abi')) {
            return project.property('split-per-abi').toBoolean()
        }
        return false;
    }

545
    private Boolean useLocalEngine() {
546
        return project.hasProperty('local-engine-repo')
547 548
    }

549
    private Boolean isVerbose() {
550 551 552 553 554 555
        if (project.hasProperty('verbose')) {
            return project.property('verbose').toBoolean()
        }
        return false
    }

556
    /** Whether to build the debug app in "fast-start" mode. */
557 558 559 560 561 562 563
    private Boolean isFastStart() {
        if (project.hasProperty("fast-start")) {
            return project.property("fast-start").toBoolean()
        }
        return false
    }

564 565 566 567 568 569
    private static Boolean isBuiltAsApp(Project project) {
        // Projects are built as applications when the they use the `com.android.application`
        // plugin.
        return project.plugins.hasPlugin("com.android.application");
    }

570 571 572 573 574
    /**
     * Returns true if the build mode is supported by the current call to Gradle.
     * This only relevant when using a local engine. Because the engine
     * is built for a specific mode, the call to Gradle must match that mode.
     */
575 576 577 578 579 580 581 582 583 584
    private Boolean supportsBuildMode(String flutterBuildMode) {
        if (!useLocalEngine()) {
            return true;
        }
        assert project.hasProperty('local-engine-build-mode')
        // Don't configure dependencies for a build mode that the local engine
        // doesn't support.
        return project.property('local-engine-build-mode') == flutterBuildMode
    }

585
    private void addCompileOnlyDependency(Project project, String variantName, Object dependency, Closure config = null) {
586 587 588
        if (project.state.failure) {
            return
        }
589 590 591 592 593
        String configuration;
        if (project.getConfigurations().findByName("compileOnly")) {
            configuration = "${variantName}CompileOnly";
        } else {
            configuration = "${variantName}Provided";
594
        }
595
        project.dependencies.add(configuration, dependency, config)
596 597
    }

598 599 600 601 602 603 604
    private static void addApiDependencies(Project project, String variantName, Object dependency, Closure config = null) {
        String configuration;
        // `compile` dependencies are now `api` dependencies.
        if (project.getConfigurations().findByName("api")) {
            configuration = "${variantName}Api";
        } else {
            configuration = "${variantName}Compile";
605
        }
606
        project.dependencies.add(configuration, dependency, config)
607 608 609 610 611 612 613
    }

    /**
     * Returns a Flutter build mode suitable for the specified Android buildType.
     *
     * Note: The BuildType DSL type is not public, and is therefore omitted from the signature.
     *
614
     * @return "debug", "profile", or "release" (fall-back).
615 616 617 618 619 620 621 622 623 624
     */
    private static String buildModeFor(buildType) {
        if (buildType.name == "profile") {
            return "profile"
        } else if (buildType.debuggable) {
            return "debug"
        }
        return "release"
    }

625 626 627 628 629 630 631 632 633
    private static String getEngineArtifactDirName(buildType, targetArch) {
        if (buildType.name == "profile") {
            return "${targetArch}-profile"
        } else if (buildType.debuggable) {
            return "${targetArch}"
        }
        return "${targetArch}-release"
    }

634 635
    /**
     * Gets the directory that contains the Flutter source code.
Shi-Hao Hong's avatar
Shi-Hao Hong committed
636
     * This is the directory containing the `android/` directory.
637 638
     */
    private File getFlutterSourceDirectory() {
639 640 641
        if (project.flutter.source == null) {
            throw new GradleException("Must provide Flutter source directory")
        }
642 643 644 645 646 647 648
        return project.file(project.flutter.source)
    }

    /**
     * Gets the target file. This is typically `lib/main.dart`.
     */
    private String getFlutterTarget() {
649
        String target = project.flutter.target
650 651 652
        if (target == null) {
            target = 'lib/main.dart'
        }
653 654 655
        if (project.hasProperty('target')) {
            target = project.property('target')
        }
656 657 658
        return target
    }

659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
    /**
     * In AGP 4.0, the Android linter task depends on the JAR tasks that generate `libapp.so`.
     * When building APKs, this causes an issue where building release requires the debug JAR,
     * but Gradle won't build debug.
     *
     * To workaround this issue, only configure the JAR task that is required given the task
     * from the command line.
     *
     * The AGP team said that this issue is fixed in Gradle 7.0, which isn't released at the
     * time of adding this code. Once released, this can be removed.
     *
     * Tested cases:
     * * `./gradlew assembleRelease`
     * * `./gradlew app:assembleRelease.`
     * * `./gradlew assemble{flavorName}Release`
     * * `./gradlew app:assemble{flavorName}Release`
     * * `./gradlew assemble.`
     * * `./gradlew app:assemble.`
     * * `./gradlew bundle.`
     * * `./gradlew bundleRelease.`
     * * `./gradlew app:bundleRelease.`
     *
     * Related issues:
     * https://issuetracker.google.com/issues/158060799
     * https://issuetracker.google.com/issues/158753935
     */
685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
    private boolean shouldConfigureFlutterTask(Task assembleTask) {
        def cliTasksNames = project.gradle.startParameter.taskNames
        if (cliTasksNames.size() != 1 || !cliTasksNames.first().contains("assemble")) {
            return true
        }
        def taskName = cliTasksNames.first().split(":").last()
        if (taskName == "assemble") {
            return true
        }
        if (taskName == assembleTask.name) {
            return true
        }
        if (taskName.endsWith("Release") && assembleTask.name.endsWith("Release")) {
            return true
        }
        if (taskName.endsWith("Debug") && assembleTask.name.endsWith("Debug")) {
            return true
        }
        if (taskName.endsWith("Profile") && assembleTask.name.endsWith("Profile")) {
            return true
        }
        return false
    }

    private Task getAssembleTask(variant) {
        // `assemble` became `assembleProvider` in AGP 3.3.0.
        return variant.hasProperty("assembleProvider") ? variant.assembleProvider.get() : variant.assemble
    }

714 715 716 717
    private boolean isFlutterAppProject() {
        return project.android.hasProperty("applicationVariants")
    }

718 719 720 721
    private void addFlutterTasks(Project project) {
        if (project.state.failure) {
            return
        }
722 723 724 725 726 727 728 729
        String[] fileSystemRootsValue = null
        if (project.hasProperty('filesystem-roots')) {
            fileSystemRootsValue = project.property('filesystem-roots').split('\\|')
        }
        String fileSystemSchemeValue = null
        if (project.hasProperty('filesystem-scheme')) {
            fileSystemSchemeValue = project.property('filesystem-scheme')
        }
730
        Boolean trackWidgetCreationValue = true
731
        if (project.hasProperty('track-widget-creation')) {
732
            trackWidgetCreationValue = project.property('track-widget-creation').toBoolean()
733
        }
734 735 736 737 738 739 740 741
        String extraFrontEndOptionsValue = null
        if (project.hasProperty('extra-front-end-options')) {
            extraFrontEndOptionsValue = project.property('extra-front-end-options')
        }
        String extraGenSnapshotOptionsValue = null
        if (project.hasProperty('extra-gen-snapshot-options')) {
            extraGenSnapshotOptionsValue = project.property('extra-gen-snapshot-options')
        }
742 743 744 745
        String splitDebugInfoValue = null
        if (project.hasProperty('split-debug-info')) {
            splitDebugInfoValue = project.property('split-debug-info')
        }
746 747 748 749
        Boolean dartObfuscationValue = false
        if (project.hasProperty('dart-obfuscation')) {
            dartObfuscationValue = project.property('dart-obfuscation').toBoolean();
        }
750 751 752 753
        Boolean treeShakeIconsOptionsValue = false
        if (project.hasProperty('tree-shake-icons')) {
            treeShakeIconsOptionsValue = project.property('tree-shake-icons').toBoolean()
        }
754 755 756 757
        String dartDefinesValue = null
        if (project.hasProperty('dart-defines')) {
            dartDefinesValue = project.property('dart-defines')
        }
758 759 760 761
        String bundleSkSLPathValue;
        if (project.hasProperty('bundle-sksl-path')) {
            bundleSkSLPathValue = project.property('bundle-sksl-path')
        }
762 763 764 765
        String performanceMeasurementFileValue;
        if (project.hasProperty('performance-measurement-file')) {
            performanceMeasurementFileValue = project.property('performance-measurement-file')
        }
766 767 768 769
        String codeSizeDirectoryValue;
        if (project.hasProperty('code-size-directory')) {
            codeSizeDirectoryValue = project.property('code-size-directory')
        }
770 771 772 773 774 775 776 777
        Boolean deferredComponentsValue = false
        if (project.hasProperty('deferred-components')) {
            deferredComponentsValue = project.property('deferred-components').toBoolean()
        }
        Boolean validateDeferredComponentsValue = true
        if (project.hasProperty('validate-deferred-components')) {
            validateDeferredComponentsValue = project.property('validate-deferred-components').toBoolean()
        }
778
        def targetPlatforms = getTargetPlatforms()
779
        def addFlutterDeps = { variant ->
780
            if (shouldSplitPerAbi()) {
781 782 783 784 785 786 787 788 789 790 791 792
                variant.outputs.each { output ->
                    // Assigns the new version code to versionCodeOverride, which changes the version code
                    // for only the output APK, not for the variant itself. Skipping this step simply
                    // causes Gradle to use the value of variant.versionCode for the APK.
                    // For more, see https://developer.android.com/studio/build/configure-apk-splits
                    def abiVersionCode = ABI_VERSION.get(output.getFilter(OutputFile.ABI))
                    if (abiVersionCode != null) {
                        output.versionCodeOverride =
                            abiVersionCode * 1000 + variant.versionCode
                    }
                }
            }
793
            String variantBuildMode = buildModeFor(variant.buildType)
794 795 796 797 798 799 800
            String taskName = toCammelCase(["compile", FLUTTER_BUILD_PREFIX, variant.name])
            FlutterTask compileTask = project.tasks.create(name: taskName, type: FlutterTask) {
                flutterRoot this.flutterRoot
                flutterExecutable this.flutterExecutable
                buildMode variantBuildMode
                localEngine this.localEngine
                localEngineSrcPath this.localEngineSrcPath
801
                targetPath getFlutterTarget()
802
                verbose isVerbose()
803
                fastStart isFastStart()
804 805 806 807
                fileSystemRoots fileSystemRootsValue
                fileSystemScheme fileSystemSchemeValue
                trackWidgetCreation trackWidgetCreationValue
                targetPlatformValues = targetPlatforms
808
                sourceDir getFlutterSourceDirectory()
809 810 811
                intermediateDir project.file("${project.buildDir}/${AndroidProject.FD_INTERMEDIATES}/flutter/${variant.name}/")
                extraFrontEndOptions extraFrontEndOptionsValue
                extraGenSnapshotOptions extraGenSnapshotOptionsValue
812
                splitDebugInfo splitDebugInfoValue
813
                treeShakeIcons treeShakeIconsOptionsValue
814
                dartObfuscation dartObfuscationValue
815
                dartDefines dartDefinesValue
816
                bundleSkSLPath bundleSkSLPathValue
817
                performanceMeasurementFile performanceMeasurementFileValue
818
                codeSizeDirectory codeSizeDirectoryValue
819 820
                deferredComponents deferredComponentsValue
                validateDeferredComponents validateDeferredComponentsValue
821 822 823
                doLast {
                    project.exec {
                        if (Os.isFamily(Os.FAMILY_WINDOWS)) {
824
                            commandLine('cmd', '/c', "attrib -r ${assetsDirectory}/* /s")
825 826 827 828 829
                        } else {
                            commandLine('chmod', '-R', 'u+w', assetsDirectory)
                        }
                    }
                }
830
            }
831
            File libJar = project.file("${project.buildDir}/${AndroidProject.FD_INTERMEDIATES}/flutter/${variant.name}/libs.jar")
832
            Task packFlutterAppAotTask = project.tasks.create(name: "packLibs${FLUTTER_BUILD_PREFIX}${variant.name.capitalize()}", type: Jar) {
833 834
                destinationDir libJar.parentFile
                archiveName libJar.name
835 836 837 838 839
                dependsOn compileTask
                targetPlatforms.each { targetPlatform ->
                    String abi = PLATFORM_ARCH_MAP[targetPlatform]
                    from("${compileTask.intermediateDir}/${abi}") {
                        include "*.so"
840
                        // Move `app.so` to `lib/<abi>/libapp.so`
841
                        rename { String filename ->
842
                            return "lib/${abi}/lib${filename}"
843 844 845
                        }
                    }
                }
846
            }
847
            addApiDependencies(project, variant.name, project.files {
848
                packFlutterAppAotTask
849
            })
850 851 852 853
            // We build an AAR when this property is defined.
            boolean isBuildingAar = project.hasProperty('is-plugin')
            // In add to app scenarios, a Gradle project contains a `:flutter` and `:app` project.
            // We know that `:flutter` is used as a subproject when these tasks exists and we aren't building an AAR.
854 855
            Task packageAssets = project.tasks.findByPath(":flutter:package${variant.name.capitalize()}Assets")
            Task cleanPackageAssets = project.tasks.findByPath(":flutter:cleanPackage${variant.name.capitalize()}Assets")
856 857 858 859 860
            boolean isUsedAsSubproject = packageAssets && cleanPackageAssets && !isBuildingAar
            Task copyFlutterAssetsTask = project.tasks.create(
                name: "copyFlutterAssets${variant.name.capitalize()}",
                type: Copy,
            ) {
861 862
                dependsOn compileTask
                with compileTask.assets
863
                if (isUsedAsSubproject) {
864 865 866
                    dependsOn packageAssets
                    dependsOn cleanPackageAssets
                    into packageAssets.outputDir
867
                    return
868
                }
869 870 871 872 873 874 875 876 877
                // `variant.mergeAssets` will be removed at the end of 2019.
                def mergeAssets = variant.hasProperty("mergeAssetsProvider") ?
                    variant.mergeAssetsProvider.get() : variant.mergeAssets
                dependsOn mergeAssets
                dependsOn "clean${mergeAssets.name.capitalize()}"
                mergeAssets.mustRunAfter("clean${mergeAssets.name.capitalize()}")
                into mergeAssets.outputDir
            }
            if (!isUsedAsSubproject) {
878 879 880 881
                def variantOutput = variant.outputs.first()
                def processResources = variantOutput.hasProperty("processResourcesProvider") ?
                    variantOutput.processResourcesProvider.get() : variantOutput.processResources
                processResources.dependsOn(copyFlutterAssetsTask)
882
            }
883
            return copyFlutterAssetsTask
884
        } // end def addFlutterDeps
Shi-Hao Hong's avatar
Shi-Hao Hong committed
885

886
        if (isFlutterAppProject()) {
887
            project.android.applicationVariants.all { variant ->
888 889 890 891 892 893 894 895 896 897
                Task assembleTask = getAssembleTask(variant)
                if (!shouldConfigureFlutterTask(assembleTask)) {
                  return
                }
                Task copyFlutterAssetsTask = addFlutterDeps(variant)
                def variantOutput = variant.outputs.first()
                def processResources = variantOutput.hasProperty("processResourcesProvider") ?
                    variantOutput.processResourcesProvider.get() : variantOutput.processResources
                processResources.dependsOn(copyFlutterAssetsTask)

898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
                // Copy the output APKs into a known location, so `flutter run` or `flutter build apk`
                // can discover them. By default, this is `<app-dir>/build/app/outputs/flutter-apk/<filename>.apk`.
                //
                // The filename consists of `app<-abi>?<-flavor-name>?-<build-mode>.apk`.
                // Where:
                //   * `abi` can be `armeabi-v7a|arm64-v8a|x86|x86_64` only if the flag `split-per-abi` is set.
                //   * `flavor-name` is the flavor used to build the app in lower case if the assemble task is called.
                //   * `build-mode` can be `release|debug|profile`.
                variant.outputs.all { output ->
                    assembleTask.doLast {
                        // `packageApplication` became `packageApplicationProvider` in AGP 3.3.0.
                        def outputDirectory = variant.hasProperty("packageApplicationProvider")
                            ? variant.packageApplicationProvider.get().outputDirectory
                            : variant.packageApplication.outputDirectory
                        //  `outputDirectory` is a `DirectoryProperty` in AGP 4.1.
                        String outputDirectoryStr = outputDirectory.metaClass.respondsTo(outputDirectory, "get")
                            ? outputDirectory.get()
                            : outputDirectory
                        String filename = "app"
                        String abi = output.getFilter(OutputFile.ABI)
                        if (abi != null && !abi.isEmpty()) {
                            filename += "-${abi}"
                        }
                        if (variant.flavorName != null && !variant.flavorName.isEmpty()) {
                            filename += "-${variant.flavorName.toLowerCase()}"
                        }
                        filename += "-${buildModeFor(variant.buildType)}"
                        project.copy {
                            from new File("$outputDirectoryStr/${output.outputFileName}")
                            into new File("${project.buildDir}/outputs/flutter-apk");
                            rename {
                                return "${filename}.apk"
                            }
                        }
                    }
                }
            }
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
            configurePlugins()
            return
        }
        // Flutter host module project (Add-to-app).
        String hostAppProjectName = project.rootProject.hasProperty('flutter.hostAppProjectName') ? project.rootProject.property('flutter.hostAppProjectName') : "app"
        Project appProject = project.rootProject.findProject(":${hostAppProjectName}")
        assert appProject != null : "Project :${hostAppProjectName} doesn't exist. To custom the host app project name, set `org.gradle.project.flutter.hostAppProjectName=<project-name>` in gradle.properties."
        // Wait for the host app project configuration.
        appProject.afterEvaluate {
            assert appProject.android != null
            project.android.libraryVariants.all { libraryVariant ->
                Task copyFlutterAssetsTask
                appProject.android.applicationVariants.all { appProjectVariant ->
                    Task appAssembleTask = getAssembleTask(appProjectVariant)
                    if (!shouldConfigureFlutterTask(appAssembleTask)) {
                        return
                    }
                    // Find a compatible application variant in the host app.
                    //
                    // For example, consider a host app that defines the following variants:
                    // | ----------------- | ----------------------------- |
                    // |   Build Variant   |   Flutter Equivalent Variant  |
                    // | ----------------- | ----------------------------- |
958
                    // |   freeRelease     |   release                      |
959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
                    // |   freeDebug       |   debug                       |
                    // |   freeDevelop     |   debug                       |
                    // |   profile         |   profile                     |
                    // | ----------------- | ----------------------------- |
                    //
                    // This mapping is based on the following rules:
                    // 1. If the host app build variant name is `profile` then the equivalent
                    //    Flutter variant is `profile`.
                    // 2. If the host app build variant is debuggable
                    //    (e.g. `buildType.debuggable = true`), then the equivalent Flutter
                    //    variant is `debug`.
                    // 3. Otherwise, the equivalent Flutter variant is `release`.
                    String variantBuildMode = buildModeFor(libraryVariant.buildType)
                    if (buildModeFor(appProjectVariant.buildType) != variantBuildMode) {
                        return
                    }
                    if (copyFlutterAssetsTask == null) {
                        copyFlutterAssetsTask = addFlutterDeps(libraryVariant)
                    }
                    Task mergeAssets = project
                        .tasks
                        .findByPath(":${hostAppProjectName}:merge${appProjectVariant.name.capitalize()}Assets")
                    assert mergeAssets
                    mergeAssets.dependsOn(copyFlutterAssetsTask)
                }
            }
985
        }
986
        configurePlugins()
987 988 989
    }
}

990
abstract class BaseFlutterTask extends DefaultTask {
991
    @Internal
992
    File flutterRoot
993
    @Internal
994
    File flutterExecutable
995
    @Input
996
    String buildMode
997
    @Optional @Input
998
    String localEngine
999
    @Optional @Input
1000
    String localEngineSrcPath
1001
    @Optional @Input
1002 1003
    Boolean fastStart
    @Input
1004
    String targetPath
1005
    @Optional @Internal
1006 1007
    Boolean verbose
    @Optional @Input
1008 1009 1010
    String[] fileSystemRoots
    @Optional @Input
    String fileSystemScheme
1011
    @Input
1012 1013
    Boolean trackWidgetCreation
    @Optional @Input
1014
    List<String> targetPlatformValues
1015
    @Internal
1016
    File sourceDir
1017
    @Internal
1018
    File intermediateDir
1019 1020 1021 1022
    @Optional @Input
    String extraFrontEndOptions
    @Optional @Input
    String extraGenSnapshotOptions
1023
    @Optional @Input
1024 1025
    String splitDebugInfo
    @Optional @Input
1026
    Boolean treeShakeIcons
1027 1028
    @Optional @Input
    Boolean dartObfuscation
1029 1030
    @Optional @Input
    String dartDefines
1031 1032
    @Optional @Input
    String bundleSkSLPath
1033 1034
    @Optional @Input
    String codeSizeDirectory;
1035
    @Optional @Input
1036
    String performanceMeasurementFile;
1037 1038 1039 1040
    @Optional @Input
    Boolean deferredComponents
    @Optional @Input
    Boolean validateDeferredComponents
1041

1042 1043
    @OutputFiles
    FileCollection getDependenciesFiles() {
1044
        FileCollection depfiles = project.files()
1045

1046 1047
        // Includes all sources used in the flutter compilation.
        depfiles += project.files("${intermediateDir}/flutter_build.d")
1048
        return depfiles
1049 1050
    }

1051
    void buildBundle() {
1052 1053 1054 1055 1056 1057
        if (!sourceDir.isDirectory()) {
            throw new GradleException("Invalid Flutter source directory: ${sourceDir}")
        }

        intermediateDir.mkdirs()

1058 1059 1060 1061 1062 1063
        // Compute the rule name for flutter assemble. To speed up builds that contain
        // multiple ABIs, the target name is used to communicate which ones are required
        // rather than the TargetPlatform. This allows multiple builds to share the same
        // cache.
        String[] ruleNames;
        if (buildMode == "debug") {
1064
            ruleNames = ["debug_android_application"]
1065 1066
        } else if (deferredComponents) {
            ruleNames = targetPlatformValues.collect { "android_aot_deferred_components_bundle_${buildMode}_$it" }
1067
        } else {
1068
            ruleNames = targetPlatformValues.collect { "android_aot_bundle_${buildMode}_$it" }
1069
        }
1070
        project.exec {
1071
            logging.captureStandardError LogLevel.ERROR
1072 1073 1074 1075 1076 1077
            executable flutterExecutable.absolutePath
            workingDir sourceDir
            if (localEngine != null) {
                args "--local-engine", localEngine
                args "--local-engine-src-path", localEngineSrcPath
            }
1078 1079
            if (verbose) {
                args "--verbose"
1080 1081
            } else {
                args "--quiet"
1082
            }
1083
            args "assemble"
1084
            args "--no-version-check"
1085 1086
            args "--depfile", "${intermediateDir}/flutter_build.d"
            args "--output", "${intermediateDir}"
1087 1088 1089
            if (performanceMeasurementFile != null) {
                args "--performance-measurement-file=${performanceMeasurementFile}"
            }
1090 1091 1092 1093 1094
            if (!fastStart || buildMode != "debug") {
                args "-dTargetFile=${targetPath}"
            } else {
                args "-dTargetFile=${Paths.get(flutterRoot.absolutePath, "examples", "splash", "lib", "main.dart")}"
            }
1095
            args "-dTargetPlatform=android"
1096
            args "-dBuildMode=${buildMode}"
1097 1098 1099
            if (trackWidgetCreation != null) {
                args "-dTrackWidgetCreation=${trackWidgetCreation}"
            }
1100 1101 1102
            if (splitDebugInfo != null) {
                args "-dSplitDebugInfo=${splitDebugInfo}"
            }
1103 1104 1105
            if (treeShakeIcons == true) {
                args "-dTreeShakeIcons=true"
            }
1106 1107 1108
            if (dartObfuscation == true) {
                args "-dDartObfuscation=true"
            }
1109
            if (dartDefines != null) {
1110
                args "--DartDefines=${dartDefines}"
1111
            }
1112
            if (bundleSkSLPath != null) {
1113
                args "-dBundleSkSLPath=${bundleSkSLPath}"
1114
            }
1115 1116 1117
            if (codeSizeDirectory != null) {
                args "-dCodeSizeDirectory=${codeSizeDirectory}"
            }
1118
            if (extraGenSnapshotOptions != null) {
1119
                args "--ExtraGenSnapshotOptions=${extraGenSnapshotOptions}"
1120
            }
1121 1122 1123
            if (extraFrontEndOptions != null) {
                args "--ExtraFrontEndOptions=${extraFrontEndOptions}"
            }
1124
            args ruleNames
1125 1126 1127 1128 1129
        }
    }
}

class FlutterTask extends BaseFlutterTask {
1130
    @OutputDirectory
1131 1132 1133
    File getOutputDirectory() {
        return intermediateDir
    }
1134

1135
    @Internal
1136 1137 1138 1139
    String getAssetsDirectory() {
        return "${outputDirectory}/flutter_assets"
    }

1140
    @Internal
1141 1142
    CopySpec getAssets() {
        return project.copySpec {
1143 1144
            from "${intermediateDir}"
            include "flutter_assets/**" // the working dir and its files
1145 1146 1147
        }
    }

1148
    @Internal
1149 1150 1151
    CopySpec getSnapshots() {
        return project.copySpec {
            from "${intermediateDir}"
1152

1153
            if (buildMode == 'release' || buildMode == 'profile') {
1154 1155 1156
                targetPlatformValues.each {
                    include "${PLATFORM_ARCH_MAP[targetArch]}/app.so"
                }
1157
            }
1158
        }
1159 1160
    }

1161
    FileCollection readDependencies(File dependenciesFile, Boolean inputs) {
1162 1163 1164 1165 1166
      if (dependenciesFile.exists()) {
        // Dependencies file has Makefile syntax:
        //   <target> <files>: <source> <files> <separated> <by> <non-escaped space>
        String depText = dependenciesFile.text
        // So we split list of files by non-escaped(by backslash) space,
1167
        def matcher = depText.split(': ')[inputs ? 1 : 0] =~ /(\\ |[^\s])+/
1168 1169 1170 1171 1172
        // then we replace all escaped spaces with regular spaces
        def depList = matcher.collect{it[0].replaceAll("\\\\ ", " ")}
        return project.files(depList)
      }
      return project.files();
1173 1174
    }

1175 1176
    @InputFiles
    FileCollection getSourceFiles() {
1177 1178
        FileCollection sources = project.files()
        for (File depfile in getDependenciesFiles()) {
1179
          sources += readDependencies(depfile, true)
1180
        }
1181
        return sources + project.files('pubspec.yaml')
1182 1183
    }

1184 1185 1186 1187 1188 1189 1190 1191 1192
    @OutputFiles
    FileCollection getOutputFiles() {
        FileCollection sources = project.files()
        for (File depfile in getDependenciesFiles()) {
          sources += readDependencies(depfile, false)
        }
        return sources
    }

1193 1194
    @TaskAction
    void build() {
1195
        buildBundle()
1196 1197
    }
}