Skip to content

Commit 8bae903

Browse files
faheemabbas766gmackallmboetger
authored
[flutter_tools] Use resolved application ID for app link settings (flutter#189488)
Fixes flutter#179705 The AppLinkSettings Gradle task was writing `variant.namespace` into the generated JSON. When an app sets `applicationId` from an environment variable or Gradle property, the namespace can differ from the resolved application ID. This updates the task to use AGP's resolved `ApplicationVariant.applicationId` and adds an integration test covering an environment-backed `applicationId`. Tests: - `dart run test -j1 test/integration.shard/android_gradle_outputs_app_link_settings_test.dart` - `FLUTTER_TEST_DISABLE_FS_GUARD=true dart run test -j1 test/commands.shard/hermetic/android_analyze_test.dart` Co-authored-by: Gray Mackall <[email protected]> Co-authored-by: Matt Boetger <[email protected]>
1 parent 325d3b9 commit 8bae903

3 files changed

Lines changed: 67 additions & 4 deletions

File tree

‎packages/flutter_tools/gradle/src/main/kotlin/FlutterPluginUtils.kt‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import com.android.build.api.dsl.ApplicationExtension
1111
import com.android.build.api.dsl.DynamicFeatureBuildType
1212
import com.android.build.api.dsl.LibraryExtension
1313
import com.android.build.api.variant.AndroidComponentsExtension
14+
import com.android.build.api.variant.ApplicationVariant
1415
import com.android.build.gradle.BaseExtension
1516
import com.flutter.gradle.plugins.PluginHandler
1617
import com.flutter.gradle.tasks.DeepLinkJsonFromManifestTask
@@ -1175,9 +1176,12 @@ object FlutterPluginUtils {
11751176
// flutter/flutter/packages/flutter_tools/test/integration.shard/android_gradle_outputs_app_link_settings_test.dart
11761177
val androidComponents = project.extensions.getByType(AndroidComponentsExtension::class.java)
11771178
androidComponents.onVariants { variant ->
1179+
if (variant !is ApplicationVariant) {
1180+
return@onVariants
1181+
}
11781182
val manifestUpdater =
11791183
project.tasks.register("output${capitalize(variant.name)}AppLinkSettings", DeepLinkJsonFromManifestTask::class.java) {
1180-
namespace.set(variant.namespace)
1184+
applicationId.set(variant.applicationId)
11811185
// Flutter should always use project.layout.buildDirectory.file("deeplink.json")
11821186
// instead of relying on passing in a path.
11831187
if (project.hasProperty("outputPath")) {

‎packages/flutter_tools/gradle/src/main/kotlin/tasks/DeepLinkJsonFromManifestTask.kt‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ abstract class DeepLinkJsonFromManifestTask : DefaultTask() {
2929
@get:PathSensitive(PathSensitivity.RELATIVE)
3030
abstract val manifestFile: RegularFileProperty
3131

32-
// In the past for this task namespace was the ApplicationId.
32+
// The resolved application ID for this variant.
3333
@get:Input
34-
abstract val namespace: Property<String>
34+
abstract val applicationId: Property<String>
3535

3636
// Does not need to transform manifest at all but there does not appear to be another dsl
3737
// supported way to depend on the merged manifest.
@@ -46,7 +46,11 @@ abstract class DeepLinkJsonFromManifestTask : DefaultTask() {
4646
manifestFile.get().asFile.copyTo(updatedManifest.get().asFile, overwrite = true)
4747
logger.debug("DeepLinkJsonFromManifestTask: Unmodified manifest written.")
4848

49-
DeepLinkJsonFromManifestTaskHelper.createAppLinkSettingsFile(namespace.get(), manifestFile, deepLinkJson)
49+
DeepLinkJsonFromManifestTaskHelper.createAppLinkSettingsFile(
50+
applicationId.get(),
51+
manifestFile,
52+
deepLinkJson
53+
)
5054
logger.debug("DeepLinkJsonFromManifestTask: appLinkSettings written to ${deepLinkJson.get().asFile.absolutePath}.")
5155
}
5256
}

‎packages/flutter_tools/test/integration.shard/android_gradle_outputs_app_link_settings_test.dart‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -427,6 +427,61 @@ void main() {
427427
},
428428
);
429429

430+
testWithoutContext(
431+
'gradle task outputs<mode>AppLinkSettings uses resolved application ID',
432+
() async {
433+
ProcessResult result = await processManager.run(<String>[
434+
flutterBin,
435+
'create',
436+
tempDir.path,
437+
'--project-name=testapp',
438+
], workingDirectory: tempDir.path);
439+
expect(result, const ProcessResultMatcher());
440+
441+
final File buildGradle = tempDir
442+
.childDirectory('android')
443+
.childDirectory('app')
444+
.childFile('build.gradle.kts');
445+
buildGradle.writeAsStringSync(
446+
buildGradle.readAsStringSync().replaceFirst(
447+
'applicationId = "com.example.testapp"',
448+
'applicationId = System.getenv("TEST_APPLICATION_ID") ?: "com.example.testapp"',
449+
),
450+
);
451+
452+
// Ensure that gradle files exists from templates.
453+
result = await processManager.run(<String>[
454+
flutterBin,
455+
'build',
456+
'apk',
457+
'--config-only',
458+
], workingDirectory: tempDir.path);
459+
expect(result, const ProcessResultMatcher());
460+
461+
final Directory androidApp = tempDir.childDirectory('android');
462+
final io.File fileDump = tempDir
463+
.childDirectory('build')
464+
.childDirectory('app')
465+
.childFile('app-link-settings-release.json');
466+
result = await processManager.run(
467+
<String>[
468+
'.${platform.pathSeparator}${getGradlewFileName(platform)}',
469+
...getLocalEngineArguments(),
470+
'-q', // quiet output.
471+
'-PoutputPath=${fileDump.path}',
472+
'outputReleaseAppLinkSettings',
473+
],
474+
workingDirectory: androidApp.path,
475+
environment: <String, String>{'TEST_APPLICATION_ID': 'com.example.fromenv'},
476+
);
477+
478+
expect(result, const ProcessResultMatcher());
479+
expect(fileDump.existsSync(), true);
480+
final json = jsonDecode(fileDump.readAsStringSync()) as Map<String, dynamic>;
481+
expect(json['applicationId'], 'com.example.fromenv');
482+
},
483+
);
484+
430485
testWithoutContext(
431486
'gradle task outputs<mode>AppLinkSettings is resolved FROM-CACHE after clean build if manifest does not change with build caching enabled',
432487
() async {

0 commit comments

Comments
 (0)