Skip to content

Commit a8d355c

Browse files
committed
[flutter_tools] Support default hooks config and canonical compiler URIs
- Allow custom extension target platforms whose `BuildTarget.resolveNativeAssetsConfig` returns `null` to complete `CopyAssets`, `KernelSnapshot`, `DartPluginRegistrantTarget`, `BuildHooks`, `LinkHooks`, and `InstallCodeAssets` for apps without Dart hooks, while throwing an actionable `ToolExit` if packages define hooks without `ExtensionTargetOs` and `ExtensionTargetArch`. - Map custom extension target platforms to `TargetPlatform.unsupported` (with `platform: null` on `Artifact.flutterPatchedSdkPath`) in `KernelSnapshot` to avoid Xcode project flavor parsing. - Emit canonical `file:` URI strings from `ExtensionNativeAssetsConfig.toEnvironmentDefines()` and resolve filesystem paths via the injected `FileSystem` in `cCompilerConfigFromDefines` and `resolveExtensionPluginsForPlatform` for Windows compatibility. - Remove partial sibling-executable guessing in `_cCompilerConfigForCustomTarget` and require `cc`, `ar`, and `ld` together when configuring a C compiler via defines. - Expose `BuiltInTargets.installCodeAssets`, preserve plugin error logging in `ExtensionBuildManager`, and validate `ExtensionBuildTarget.pluginPlatformKey` and `ExtensionNativeAssetsConfig` whitespace invariants. Part of flutter#190755 Part of flutter#190754
1 parent 795749d commit a8d355c

17 files changed

Lines changed: 688 additions & 212 deletions

File tree

‎packages/flutter_tools/lib/src/build_info.dart‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1173,6 +1173,25 @@ const String kExtensionCCompilerEnvScriptArgs =
11731173
/// Dart plugins on an extension target.
11741174
const kExtensionPluginPlatformKey = 'ExtensionPluginPlatformKey';
11751175

1176+
/// Marks [kTargetPlatform] as a custom target platform registered by an active
1177+
/// tool extension (`'true'`).
1178+
const kExtensionCustomTargetPlatform = 'ExtensionCustomTargetPlatform';
1179+
1180+
/// Whether [defines] contains custom platform configuration from a tool
1181+
/// extension ([kExtensionTargetOs], [kExtensionPluginPlatformKey], or
1182+
/// [kExtensionCustomTargetPlatform]).
1183+
bool hasExtensionPlatformDefines(Map<String, String> defines) {
1184+
final String? extensionTargetOs = defines[kExtensionTargetOs];
1185+
if (extensionTargetOs != null && extensionTargetOs.trim().isNotEmpty) {
1186+
return true;
1187+
}
1188+
final String? extensionPluginPlatformKey = defines[kExtensionPluginPlatformKey];
1189+
if (extensionPluginPlatformKey != null && extensionPluginPlatformKey.trim().isNotEmpty) {
1190+
return true;
1191+
}
1192+
return defines[kExtensionCustomTargetPlatform] == 'true';
1193+
}
1194+
11761195
/// Compile-time Dart environment define (`-DFLUTTER_CUSTOM_PLATFORM=<platform>`)
11771196
/// used by `dart_plugin_registrant.dart` to select Dart plugin implementations
11781197
/// for a custom extension target platform.

‎packages/flutter_tools/lib/src/build_system/targets/common.dart‎

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -206,28 +206,25 @@ class KernelSnapshot extends Target {
206206
// everything besides 'false' is considered to be enabled.
207207
final trackWidgetCreation = environment.defines[kTrackWidgetCreation] != 'false';
208208
// Custom extension platforms are not part of the built-in TargetPlatform
209-
// enum. When TargetPlatform.fromName fails and kExtensionTargetOs is
210-
// explicitly provided, fall back to a representative TargetPlatform so
211-
// KernelCompiler can resolve the host engine's Artifact.platformKernelDill
212-
// and link the platform kernel into the output dill for custom embedders.
209+
// enum. Map recognized custom extension target platforms to
210+
// TargetPlatform.unsupported and resolve Artifact.flutterPatchedSdkPath
211+
// against the host engine (platform: null) without triggering built-in
212+
// platform-specific side effects such as Xcode flavor parsing.
213213
TargetPlatform targetPlatform;
214214
OS? customTargetOs;
215+
var isExtensionTargetPlatform = false;
215216
try {
216217
targetPlatform = TargetPlatform.fromName(targetPlatformEnvironment);
217218
} on Exception {
218-
final String? extensionTargetOs = environment.defines[kExtensionTargetOs];
219-
if (extensionTargetOs == null || extensionTargetOs.trim().isEmpty) {
219+
if (!hasExtensionPlatformDefines(environment.defines)) {
220220
rethrow;
221221
}
222-
customTargetOs = parseNativeOS(extensionTargetOs);
223-
targetPlatform = switch (customTargetOs) {
224-
OS.android => TargetPlatform.android,
225-
OS.fuchsia => TargetPlatform.fuchsia_arm64,
226-
OS.iOS => TargetPlatform.ios,
227-
OS.macOS => TargetPlatform.darwin,
228-
OS.windows => TargetPlatform.windows_x64,
229-
_ => TargetPlatform.linux_x64,
230-
};
222+
isExtensionTargetPlatform = true;
223+
targetPlatform = TargetPlatform.unsupported;
224+
final String? extensionTargetOs = environment.defines[kExtensionTargetOs];
225+
if (extensionTargetOs != null && extensionTargetOs.trim().isNotEmpty) {
226+
customTargetOs = parseNativeOS(extensionTargetOs);
227+
}
231228
}
232229

233230
// This configuration is all optional.
@@ -278,7 +275,13 @@ class KernelSnapshot extends Target {
278275
case TargetPlatform.web_javascript:
279276
forceLinkPlatform = false;
280277
case TargetPlatform.unsupported:
281-
TargetPlatform.throwUnsupportedTarget();
278+
if (!isExtensionTargetPlatform) {
279+
TargetPlatform.throwUnsupportedTarget();
280+
}
281+
forceLinkPlatform = switch (customTargetOs) {
282+
OS.android || OS.fuchsia || OS.iOS => false,
283+
_ => true,
284+
};
282285
}
283286

284287
// frontend_server's --target-os flag only accepts the six built-in VM
@@ -288,11 +291,13 @@ class KernelSnapshot extends Target {
288291
// For custom extension platforms, only pass --target-os when
289292
// customTargetOs is one of those six operating systems (for example, a
290293
// Linux-based embedded target that sets ExtensionTargetOs=linux). For
291-
// custom operating systems not in OS.values, omit --target-os (null) so
292-
// Platform.operatingSystem is evaluated at runtime by the embedder instead
293-
// of being constant-folded to 'linux'.
294-
final String? targetOS = customTargetOs != null
295-
? (OS.values.contains(customTargetOs) ? customTargetOs.name : null)
294+
// custom operating systems not in OS.values or when ExtensionTargetOs is
295+
// unset, omit --target-os (null) so Platform.operatingSystem is evaluated
296+
// at runtime by the embedder instead of being constant-folded.
297+
final String? targetOS = isExtensionTargetPlatform
298+
? (customTargetOs != null && OS.values.contains(customTargetOs)
299+
? customTargetOs.name
300+
: null)
296301
: switch (targetPlatform.os) {
297302
.fuchsia || .android || .macos || .ios || .linux || .windows => targetPlatform.os.name,
298303
.tester || .web => null,
@@ -318,7 +323,7 @@ class KernelSnapshot extends Target {
318323
final CompilerOutput? output = await compiler.compile(
319324
sdkRoot: environment.artifacts.getArtifactPath(
320325
Artifact.flutterPatchedSdkPath,
321-
platform: targetPlatform,
326+
platform: targetPlatform == TargetPlatform.unsupported ? null : targetPlatform,
322327
mode: buildMode,
323328
),
324329
aot: buildMode.isPrecompiled,

‎packages/flutter_tools/lib/src/build_system/targets/dart_plugin_registrant.dart‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -88,12 +88,7 @@ class DartPluginRegistrantTarget extends Target {
8888
try {
8989
targetPlatform = TargetPlatform.fromName(platformName);
9090
} on Exception {
91-
final String? extensionTargetOs = environment.defines[kExtensionTargetOs];
92-
final String? extensionPluginPlatformKey = environment.defines[kExtensionPluginPlatformKey];
93-
final bool hasExtensionPlatform =
94-
(extensionTargetOs != null && extensionTargetOs.trim().isNotEmpty) ||
95-
(extensionPluginPlatformKey != null && extensionPluginPlatformKey.trim().isNotEmpty);
96-
if (!hasExtensionPlatform) {
91+
if (!hasExtensionPlatformDefines(environment.defines)) {
9792
rethrow;
9893
}
9994
// Custom extension target platforms are not part of the built-in

‎packages/flutter_tools/lib/src/build_system/targets/native_assets.dart‎

Lines changed: 37 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -326,28 +326,39 @@ class InstallCodeAssets extends Target {
326326
// native_asset.yaml that can be used by the final AOT compilation.
327327
final Uri nativeAssetsFileUri = environment.buildDir.childFile(nativeAssetsFilename).uri;
328328

329-
final OS targetOS = getNativeOSFromTargetPlatform(
330-
targetPlatform,
331-
environmentDefines: environment.defines,
332-
);
333-
Uri targetUri = environment.outputDir.childDirectory('native_assets').uri;
334-
if (targetOS == OS.linux || targetOS == OS.windows || !OS.values.contains(targetOS)) {
335-
// Avoid needing migration for CMake files, keep old directory structure,
336-
// and place custom extension OS assets under native_assets/<os>/.
337-
targetUri = targetUri.resolve('${targetOS.name}/');
338-
}
329+
final List<File> installedFiles;
330+
if (targetPlatform == TargetPlatform.unsupported &&
331+
resolveCustomNativeTarget(environment.defines) == null &&
332+
combinedResult.codeAssets.isEmpty) {
333+
installedFiles = await writeEmptyNativeAssetsJson(
334+
fileSystem: fileSystem,
335+
logger: environment.logger,
336+
nativeAssetsFileUri: nativeAssetsFileUri,
337+
);
338+
} else {
339+
final OS targetOS = getNativeOSFromTargetPlatform(
340+
targetPlatform,
341+
environmentDefines: environment.defines,
342+
);
343+
Uri targetUri = environment.outputDir.childDirectory('native_assets').uri;
344+
if (targetOS == OS.linux || targetOS == OS.windows || !OS.values.contains(targetOS)) {
345+
// Avoid needing migration for CMake files, keep old directory structure,
346+
// and place custom extension OS assets under native_assets/<os>/.
347+
targetUri = targetUri.resolve('${targetOS.name}/');
348+
}
339349

340-
final List<File> installedFiles = await installCodeAssets(
341-
dartHookResult: combinedResult,
342-
environmentDefines: environment.defines,
343-
targetPlatform: targetPlatform,
344-
projectUri: projectUri,
345-
fileSystem: fileSystem,
346-
logger: environment.logger,
347-
processManager: environment.processManager,
348-
nativeAssetsFileUri: nativeAssetsFileUri,
349-
targetUri: targetUri,
350-
);
350+
installedFiles = await installCodeAssets(
351+
dartHookResult: combinedResult,
352+
environmentDefines: environment.defines,
353+
targetPlatform: targetPlatform,
354+
projectUri: projectUri,
355+
fileSystem: fileSystem,
356+
logger: environment.logger,
357+
processManager: environment.processManager,
358+
nativeAssetsFileUri: nativeAssetsFileUri,
359+
targetUri: targetUri,
360+
);
361+
}
351362
assert(fileSystem.file(nativeAssetsFileUri).existsSync());
352363

353364
final depfile = Depfile(<File>[
@@ -397,9 +408,11 @@ TargetPlatform _getTargetPlatformFromEnvironment(Environment environment, String
397408
return TargetPlatform.fromName(targetPlatformEnvironment);
398409
} on Exception {
399410
// Custom extension platforms are not part of the built-in TargetPlatform
400-
// enum. Map them to TargetPlatform.unsupported when a native OS and
401-
// architecture can be resolved from extension defines.
402-
if (resolveCustomNativeTarget(environment.defines) != null) {
411+
// enum. Map recognized custom extension target platforms to
412+
// TargetPlatform.unsupported so projects without hooks skip cleanly while
413+
// projects with hooks validate kExtensionTargetOs and kExtensionTargetArch.
414+
if (resolveCustomNativeTarget(environment.defines) != null ||
415+
hasExtensionPlatformDefines(environment.defines)) {
403416
return TargetPlatform.unsupported;
404417
}
405418
rethrow;

‎packages/flutter_tools/lib/src/commands/assemble.dart‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -232,10 +232,7 @@ class AssembleCommand extends FlutterCommand {
232232
targetPlatform = TargetPlatform.fromName(platform);
233233
} on Exception {
234234
await _resolveExtensionEnvironmentDefines();
235-
final String? extensionTargetOs = _environment.defines[kExtensionTargetOs];
236-
final String? extensionPluginPlatformKey = _environment.defines[kExtensionPluginPlatformKey];
237-
if ((extensionTargetOs != null && extensionTargetOs.trim().isNotEmpty) ||
238-
(extensionPluginPlatformKey != null && extensionPluginPlatformKey.trim().isNotEmpty)) {
235+
if (hasExtensionPlatformDefines(_environment.defines)) {
239236
return super.requiredArtifacts;
240237
}
241238
rethrow;
@@ -271,6 +268,12 @@ class AssembleCommand extends FlutterCommand {
271268
buildTargets.where((ExtensionBuildTarget t) => t.name == platform).firstOrNull ??
272269
buildTargets.where((ExtensionBuildTarget t) => t.targetPlatform == platform).firstOrNull;
273270
if (matchedTarget == null) {
271+
final List<ExtensionAssembleTarget> assembleTargets = await buildManager.getAssembleTargets();
272+
if (assembleTargets.any((ExtensionAssembleTarget t) => t.targetPlatform == platform) &&
273+
!_environment.defines.containsKey(kExtensionCustomTargetPlatform)) {
274+
_environment.defines[kExtensionCustomTargetPlatform] = 'true';
275+
_cachedEnvironment = _createEnvironment(definesOverride: _environment.defines);
276+
}
274277
return;
275278
}
276279
final String? buildModeName = _environment.defines[kBuildMode];
@@ -300,10 +303,13 @@ class AssembleCommand extends FlutterCommand {
300303
resolvedArtifacts: resolvedArtifacts,
301304
targetName: matchedTarget.name,
302305
);
303-
final Map<String, String> extensionDefines = buildManager.environmentDefinesForTarget(
304-
matchedTarget.name,
305-
nativeAssetsConfig: nativeAssetsConfig,
306-
);
306+
final extensionDefines = <String, String>{
307+
kExtensionCustomTargetPlatform: 'true',
308+
...buildManager.environmentDefinesForTarget(
309+
matchedTarget.name,
310+
nativeAssetsConfig: nativeAssetsConfig,
311+
),
312+
};
307313
var addedDefines = false;
308314
for (final MapEntry(:String key, :String value) in extensionDefines.entries) {
309315
_environment.defines.putIfAbsent(key, () {

‎packages/flutter_tools/lib/src/experimental/extension_build_manager.dart‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -475,7 +475,6 @@ base class ExtensionBuildManager {
475475
pluginPlatformKey,
476476
fileSystem: _fileSystem,
477477
logger: _logger,
478-
quiet: true,
479478
);
480479
}
481480
}

‎packages/flutter_tools/lib/src/flutter_plugins.dart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1745,7 +1745,7 @@ List<ExtensionPlugin> resolveExtensionPluginsForPlatform(
17451745
for (final Plugin plugin in resolved)
17461746
ExtensionPlugin(
17471747
name: plugin.name,
1748-
path: Uri.directory(plugin.path),
1748+
path: fileSystem.directory(plugin.path).uri,
17491749
configuration: switch (plugin.platforms[platformKey]) {
17501750
final CustomPlatformPlugin custom => custom.configuration,
17511751
final PluginPlatform platform => platform.toMap(fileSystem: fileSystem),

‎packages/flutter_tools/lib/src/isolated/native_assets/native_assets.dart‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -424,6 +424,9 @@ DartHooksResult combineBuildAndLinkResults({
424424
required SerializedBuildResults buildResults,
425425
required DartHooksResult linkResult,
426426
}) {
427+
if (buildResults.isEmpty && linkResult.codeAssets.isEmpty && linkResult.dataAssets.isEmpty) {
428+
return linkResult;
429+
}
427430
final List<AssetBuildTarget> targets = _getTargets(
428431
androidSdkProvider: null,
429432
environmentDefines: environmentDefines,
@@ -570,6 +573,21 @@ Future<List<File>> installCodeAssets({
570573
return <File>[fileSystem.file(nativeAssetsFileUri), ...installedFiles];
571574
}
572575

576+
/// Writes an empty `native_assets.json` manifest when a custom extension target
577+
/// platform has no bundled [FlutterCodeAsset]s and did not configure native
578+
/// asset target OS/architecture defines.
579+
Future<List<File>> writeEmptyNativeAssetsJson({
580+
required FileSystem fileSystem,
581+
required Logger logger,
582+
required Uri nativeAssetsFileUri,
583+
}) async {
584+
final manifest = NativeAssetsManifest.fromTargetLocations(
585+
const <FlutterCodeAsset, FlutterCodeAssetTargetLocation>{},
586+
);
587+
await _writeNativeAssetsJson(manifest, nativeAssetsFileUri, fileSystem, logger: logger);
588+
return <File>[fileSystem.file(nativeAssetsFileUri)];
589+
}
590+
573591
/// Programmatic API to be used by Dart launchers to invoke native builds.
574592
///
575593
/// It enables mocking `package:hooks_runner` package.

0 commit comments

Comments
 (0)