Skip to content

Commit 00337d5

Browse files
committed
[flutter_tools] Harden extension plugins and Dart hooks interop
Addresses design audit findings for custom platform plugins and Dart hooks interop: - Fall back to a data-assets-only `CustomDataAssetTarget` when `BuildTarget.resolveNativeAssetsConfig` returns `null` (or `buildCodeAssets` is `null`) so transitive hook packages and `DataAsset` hooks succeed without failing `BuildHooks`. - Validate `targetOs` and `targetArchitecture` against `^[a-z][a-z0-9_]*$` in `ExtensionNativeAssetsConfig`, `parseNativeOS`, and `parseNativeArchitecture`, reject `android`/`ios`/`macos` in `CustomCodeAssetTarget`, and populate `WindowsCCompilerConfig()` when `targetOs == OS.windows` without `envScript`. - Add `ExtensionBuildTarget.buildTargetDefine` (`ExtensionBuildTarget`) so `AssembleCommand` resolves cross-compiler defines and `pluginPlatformKey` on built-in `TargetPlatform` names, reject ambiguous custom `targetPlatform` matches and disabled-feature `ExtensionBuildTarget` defines, resolve target `outputDir` via `resolveExtensionOutputDir`, and treat CLI `ExtensionCCompiler*` overrides atomically. - Keep `CopyAssets` free of `InstallCodeAssets` and write `flutter_assets/NativeAssetsManifest.json` in `InstallCodeAssets` when extension platform defines are present. - Reserve `FLUTTER_CUSTOM_PLATFORM` in `FlutterCommand`, drop the `kExtensionTargetOs` fallback in `resolveCustomPluginPlatformKey`, validate CLI `ExtensionPluginPlatformKey` values, preserve raw `pubspec.yaml` stanzas in `ExtensionPlugin.configuration` across built-in and custom keys, reject empty custom platform stanzas, and exclude `dev_dependencies` plugins in release builds. Part of flutter#190755 Part of flutter#190754
1 parent 71bd90d commit 00337d5

17 files changed

Lines changed: 1136 additions & 300 deletions

File tree

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

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1140,14 +1140,22 @@ const String kExtensionCCompilerEnvScriptArgs =
11401140
/// Dart plugins on an extension target.
11411141
const kExtensionPluginPlatformKey = 'ExtensionPluginPlatformKey';
11421142

1143+
/// Optional explicit [tools_core.ExtensionBuildTarget.name] used to resolve
1144+
/// extension native assets and plugin defines in `flutter assemble`.
1145+
const String kExtensionBuildTarget = tools_core.ExtensionBuildTarget.buildTargetDefine;
1146+
11431147
/// Marks [kTargetPlatform] as a custom target platform registered by an active
11441148
/// tool extension (`'true'`).
11451149
const kExtensionCustomTargetPlatform = 'ExtensionCustomTargetPlatform';
11461150

11471151
/// Whether [defines] contains custom platform configuration from a tool
1148-
/// extension ([kExtensionTargetOs], [kExtensionPluginPlatformKey], or
1149-
/// [kExtensionCustomTargetPlatform]).
1152+
/// extension ([kExtensionBuildTarget], [kExtensionTargetOs],
1153+
/// [kExtensionPluginPlatformKey], or [kExtensionCustomTargetPlatform]).
11501154
bool hasExtensionPlatformDefines(Map<String, String> defines) {
1155+
final String? extensionBuildTarget = defines[kExtensionBuildTarget];
1156+
if (extensionBuildTarget != null && extensionBuildTarget.trim().isNotEmpty) {
1157+
return true;
1158+
}
11511159
final String? extensionTargetOs = defines[kExtensionTargetOs];
11521160
if (extensionTargetOs != null && extensionTargetOs.trim().isNotEmpty) {
11531161
return true;

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

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -280,11 +280,7 @@ class CopyAssets extends Target {
280280
String get name => 'copy_assets';
281281

282282
@override
283-
List<Target> get dependencies => const <Target>[
284-
LinkHooks(),
285-
KernelSnapshot(),
286-
InstallCodeAssets(),
287-
];
283+
List<Target> get dependencies => const <Target>[LinkHooks(), KernelSnapshot()];
288284

289285
@override
290286
List<Source> get inputs => const <Source>[
@@ -315,16 +311,9 @@ class CopyAssets extends Target {
315311
final Directory output = environment.buildDir.childDirectory('flutter_assets');
316312
output.createSync(recursive: true);
317313
final DartHooksResult dartHookResult = await LinkHooks.loadHookResult(environment);
318-
final File nativeAssetsFile = environment.buildDir.childFile(
319-
InstallCodeAssets.nativeAssetsFilename,
320-
);
321314
final Depfile depfile = await copyAssets(
322315
environment,
323316
output,
324-
additionalContent: <String, DevFSContent>{
325-
if (nativeAssetsFile.existsSync())
326-
'NativeAssetsManifest.json': DevFSFileContent(nativeAssetsFile),
327-
},
328317
dartHookResult: dartHookResult,
329318
targetPlatform: targetPlatform,
330319
buildMode: buildMode,

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

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22
// Use of this source code is governed by a BSD-style license that can be
33
// found in the LICENSE file.
44

5+
import 'package:flutter_tools_core/flutter_tools_core.dart' show ExtensionBuildTarget;
56
import 'package:meta/meta.dart';
67
import 'package:package_config/package_config.dart';
78

9+
import '../../base/common.dart';
810
import '../../base/file_system.dart';
911
import '../../base/template.dart';
1012
import '../../build_info.dart';
@@ -16,18 +18,25 @@ import '../../project.dart';
1618
import '../build_system.dart';
1719

1820
/// Resolves the custom extension plugin platform key from [defines], or returns
19-
/// `null` if none is configured or if the key matches a built-in Flutter
20-
/// platform.
21+
/// `null` if [kExtensionPluginPlatformKey] is unset or matches a built-in
22+
/// Flutter platform.
23+
///
24+
/// Throws a [ToolExit] if [kExtensionPluginPlatformKey] is non-empty and does
25+
/// not match [ExtensionBuildTarget.isValidPluginPlatformKey].
2126
String? resolveCustomPluginPlatformKey(Map<String, String> defines) {
22-
final String? rawPluginPlatformKey = defines[kExtensionPluginPlatformKey]?.trim();
23-
final String? customPlatformKey = rawPluginPlatformKey != null && rawPluginPlatformKey.isNotEmpty
24-
? rawPluginPlatformKey
25-
: defines[kExtensionTargetOs]?.trim().toLowerCase();
27+
final String? customPlatformKey = defines[kExtensionPluginPlatformKey]?.trim();
2628
if (customPlatformKey == null ||
2729
customPlatformKey.isEmpty ||
2830
Plugin.builtInPlatformKeys.contains(customPlatformKey)) {
2931
return null;
3032
}
33+
if (!ExtensionBuildTarget.isValidPluginPlatformKey(customPlatformKey)) {
34+
throwToolExit(
35+
'Invalid "$kExtensionPluginPlatformKey" define "$customPlatformKey": '
36+
'plugin platform keys must start with a lowercase ASCII letter and contain '
37+
'only lowercase ASCII letters, digits, and underscores.',
38+
);
39+
}
3140
return customPlatformKey;
3241
}
3342

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

Lines changed: 33 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import '../../base/file_system.dart';
2121
import '../../build_info.dart';
2222
import '../../convert.dart';
2323
import '../../dart/package_map.dart';
24-
import '../../features.dart' show featureFlags;
24+
import '../../features.dart' show FeatureFlags, featureFlags;
2525
import '../../isolated/native_assets/dart_hook_result.dart';
2626
import '../../isolated/native_assets/native_assets.dart';
2727
import '../../isolated/native_assets/targets.dart' show resolveCustomNativeTarget;
@@ -34,9 +34,14 @@ enum HookPlatform { native, web }
3434

3535
/// Runs the dart build of the app.
3636
class BuildHooks extends Target {
37-
const BuildHooks({this.platform = HookPlatform.native, @visibleForTesting this._buildRunner});
37+
const BuildHooks({
38+
this.platform = HookPlatform.native,
39+
@visibleForTesting this._buildRunner,
40+
@visibleForTesting this._featureFlags,
41+
});
3842

3943
final FlutterNativeAssetsBuildRunner? _buildRunner;
44+
final FeatureFlags? _featureFlags;
4045

4146
final HookPlatform platform;
4247

@@ -65,7 +70,7 @@ class BuildHooks extends Target {
6570
targetPlatform: targetPlatform,
6671
projectUri: projectUri,
6772
fileSystem: fileSystem,
68-
featureFlags: featureFlags,
73+
featureFlags: _featureFlags ?? featureFlags,
6974
logger: environment.logger,
7075
buildCodeAssets: BuildCodeAssetsOptions(appBuildDirectory: environment.outputDir),
7176
buildDataAssets: true,
@@ -133,19 +138,24 @@ class LinkHooks extends Target {
133138
this.platform = HookPlatform.native,
134139
this.extraDependencies = const <Target>[],
135140
this._buildRunner,
141+
@visibleForTesting this._featureFlags,
136142
});
137143

138144
final HookPlatform platform;
139145
final List<Target> extraDependencies;
140146
final FlutterNativeAssetsBuildRunner? _buildRunner;
147+
final FeatureFlags? _featureFlags;
148+
149+
FeatureFlags get _activeFeatureFlags => _featureFlags ?? featureFlags;
141150

142151
@override
143152
List<Target> get dependencies => <Target>[
144153
if (platform == HookPlatform.web)
145-
const BuildHooks(platform: HookPlatform.web)
154+
BuildHooks(platform: HookPlatform.web, featureFlags: _featureFlags)
146155
else
147-
const BuildHooks(),
148-
if (platform == HookPlatform.native && featureFlags.isRecordUseEnabled) const KernelSnapshot(),
156+
BuildHooks(featureFlags: _featureFlags),
157+
if (platform == HookPlatform.native && _activeFeatureFlags.isRecordUseEnabled)
158+
const KernelSnapshot(),
149159
...extraDependencies, // Dart2WasmTarget, Dart2JSTarget
150160
];
151161

@@ -162,12 +172,12 @@ class LinkHooks extends Target {
162172
@override
163173
List<Source> get inputs => <Source>[
164174
const Source.pattern('{BUILD_DIR}/${BuildHooks.resultFilename}'),
165-
if (featureFlags.isRecordUseEnabled)
175+
if (_activeFeatureFlags.isRecordUseEnabled)
166176
for (final String filename in _recordedUsesFileNames) Source.pattern('{BUILD_DIR}/$filename'),
167177
];
168178

169179
File? getRecordedUsesFile(Environment environment, BuildMode buildMode) {
170-
if (!featureFlags.isRecordUseEnabled) {
180+
if (!_activeFeatureFlags.isRecordUseEnabled) {
171181
return null;
172182
}
173183
if (platform == HookPlatform.native && !buildMode.isPrecompiled) {
@@ -229,7 +239,7 @@ class LinkHooks extends Target {
229239
targetPlatform: targetPlatform,
230240
projectUri: projectUri,
231241
fileSystem: fileSystem,
232-
featureFlags: featureFlags,
242+
featureFlags: _activeFeatureFlags,
233243
logger: environment.logger,
234244
buildCodeAssets: BuildCodeAssetsOptions(appBuildDirectory: environment.outputDir),
235245
buildDataAssets: true,
@@ -245,7 +255,7 @@ class LinkHooks extends Target {
245255
environmentDefines: environment.defines,
246256
targetPlatform: targetPlatform,
247257
fileSystem: fileSystem,
248-
featureFlags: featureFlags,
258+
featureFlags: _activeFeatureFlags,
249259
buildCodeAssets: BuildCodeAssetsOptions(appBuildDirectory: environment.outputDir),
250260
buildDataAssets: true,
251261
buildResults: buildResults,
@@ -359,11 +369,22 @@ class InstallCodeAssets extends Target {
359369
targetUri: targetUri,
360370
);
361371
}
362-
assert(fileSystem.file(nativeAssetsFileUri).existsSync());
372+
final File nativeAssetsFile = fileSystem.file(nativeAssetsFileUri);
373+
assert(nativeAssetsFile.existsSync());
374+
375+
final allInstalledFiles = <File>[...installedFiles];
376+
if (hasExtensionPlatformDefines(environment.defines)) {
377+
final File flutterAssetsManifest = environment.buildDir
378+
.childDirectory('flutter_assets')
379+
.childFile('NativeAssetsManifest.json');
380+
flutterAssetsManifest.parent.createSync(recursive: true);
381+
await nativeAssetsFile.copy(flutterAssetsManifest.path);
382+
allInstalledFiles.add(flutterAssetsManifest);
383+
}
363384

364385
final depfile = Depfile(<File>[
365386
for (final Uri file in combinedResult.filesToBeBundled) fileSystem.file(file),
366-
], installedFiles);
387+
], allInstalledFiles);
367388
final File outputDepfile = environment.buildDir.childFile(depFilename);
368389
environment.depFileService.writeToFile(depfile, outputDepfile);
369390
if (!outputDepfile.existsSync()) {

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

Lines changed: 102 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import 'package:unified_analytics/unified_analytics.dart';
1111

1212
import '../artifacts.dart';
1313
import '../base/common.dart';
14+
import '../base/config.dart';
1415
import '../base/file_system.dart';
1516
import '../base/logger.dart';
1617
import '../base/platform.dart';
@@ -231,8 +232,8 @@ class AssembleCommand extends FlutterCommand {
231232
try {
232233
targetPlatform = TargetPlatform.fromName(platform);
233234
} on Exception {
234-
await _resolveExtensionEnvironmentDefines();
235-
if (hasExtensionPlatformDefines(_environment.defines)) {
235+
if (hasExtensionPlatformDefines(_environment.defines) ||
236+
await _isRegisteredExtensionPlatform(platform)) {
236237
return super.requiredArtifacts;
237238
}
238239
rethrow;
@@ -244,29 +245,103 @@ class AssembleCommand extends FlutterCommand {
244245
return super.requiredArtifacts;
245246
}
246247

248+
Future<bool> _isRegisteredExtensionPlatform(String platform) async {
249+
if (!_featureFlags.isToolExtensionsEnabled) {
250+
return false;
251+
}
252+
final ExtensionBuildManager? buildManager = _extensionBuildManager;
253+
if (buildManager == null) {
254+
return false;
255+
}
256+
final List<ExtensionBuildTarget> buildTargets = await buildManager.getBuildTargets();
257+
if (buildTargets.any(
258+
(ExtensionBuildTarget t) => t.name == platform || t.targetPlatform == platform,
259+
)) {
260+
return true;
261+
}
262+
final List<ExtensionAssembleTarget> assembleTargets = await buildManager.getAssembleTargets();
263+
return assembleTargets.any((ExtensionAssembleTarget t) => t.targetPlatform == platform);
264+
}
265+
266+
static const _cCompilerDefineKeys = <String>{
267+
kExtensionCCompilerCc,
268+
kExtensionCCompilerAr,
269+
kExtensionCCompilerLd,
270+
kExtensionCCompilerEnvScript,
271+
kExtensionCCompilerEnvScriptArgs,
272+
};
273+
247274
Future<void> _resolveExtensionEnvironmentDefines() async {
248-
if (_extensionDefinesResolved || !_featureFlags.isToolExtensionsEnabled) {
275+
// `requiredArtifacts` evaluates `_environment` before `validateCommand()`
276+
// runs; refresh the cached environment if `project.directory` changed.
277+
if (_cachedEnvironment != null &&
278+
_cachedEnvironment!.projectDir.path != project.directory.path) {
279+
_cachedEnvironment = _createEnvironment();
280+
}
281+
if (_extensionDefinesResolved) {
249282
return;
250283
}
251284
_extensionDefinesResolved = true;
285+
final String? explicitTargetName = _environment.defines[kExtensionBuildTarget]?.trim();
286+
final bool hasExplicitBuildTarget = explicitTargetName != null && explicitTargetName.isNotEmpty;
252287
final ExtensionBuildManager? buildManager = _extensionBuildManager;
253-
if (buildManager == null) {
288+
if (!_featureFlags.isToolExtensionsEnabled || buildManager == null) {
289+
if (hasExplicitBuildTarget) {
290+
throwToolExit(
291+
'"$kExtensionBuildTarget" requires the tool extensions feature to be enabled.',
292+
);
293+
}
254294
return;
255295
}
256296
final String? platform = _environment.defines[kTargetPlatform];
257-
if (platform == null || platform.isEmpty) {
258-
return;
297+
var isBuiltInTargetPlatform = false;
298+
if (platform != null && platform.isNotEmpty) {
299+
try {
300+
TargetPlatform.fromName(platform);
301+
isBuiltInTargetPlatform = true;
302+
} on Exception {
303+
isBuiltInTargetPlatform = false;
304+
}
259305
}
260-
try {
261-
TargetPlatform.fromName(platform);
306+
if (!hasExplicitBuildTarget &&
307+
(platform == null || platform.isEmpty || isBuiltInTargetPlatform)) {
262308
return;
263-
} on Exception {
264-
// Custom target platform; query extension build targets below.
265309
}
310+
266311
final List<ExtensionBuildTarget> buildTargets = await buildManager.getBuildTargets();
267-
final ExtensionBuildTarget? matchedTarget =
268-
buildTargets.where((ExtensionBuildTarget t) => t.name == platform).firstOrNull ??
269-
buildTargets.where((ExtensionBuildTarget t) => t.targetPlatform == platform).firstOrNull;
312+
final ExtensionBuildTarget? matchedTarget;
313+
if (hasExplicitBuildTarget) {
314+
matchedTarget = buildTargets
315+
.where((ExtensionBuildTarget t) => t.name == explicitTargetName)
316+
.firstOrNull;
317+
if (matchedTarget == null) {
318+
throwToolExit(
319+
'Unknown extension build target "$explicitTargetName" specified in "$kExtensionBuildTarget".',
320+
);
321+
}
322+
} else {
323+
final ExtensionBuildTarget? nameMatch = buildTargets
324+
.where((ExtensionBuildTarget t) => t.name == platform)
325+
.firstOrNull;
326+
if (nameMatch != null) {
327+
matchedTarget = nameMatch;
328+
} else {
329+
final List<ExtensionBuildTarget> platformMatches = buildTargets
330+
.where((ExtensionBuildTarget t) => t.targetPlatform == platform)
331+
.toList();
332+
if (platformMatches.length > 1) {
333+
final String matchingNames = platformMatches
334+
.map((ExtensionBuildTarget t) => '"${t.name}"')
335+
.join(', ');
336+
throwToolExit(
337+
'Ambiguous custom target platform "$platform" matches multiple extension '
338+
'build targets ($matchingNames); pass -d$kExtensionBuildTarget=<name> to '
339+
'select a specific build target.',
340+
);
341+
}
342+
matchedTarget = platformMatches.firstOrNull;
343+
}
344+
}
270345
if (matchedTarget == null) {
271346
final List<ExtensionAssembleTarget> assembleTargets = await buildManager.getAssembleTargets();
272347
if (assembleTargets.any((ExtensionAssembleTarget t) => t.targetPlatform == platform) &&
@@ -293,25 +368,37 @@ class AssembleCommand extends FlutterCommand {
293368
buildMode: buildMode,
294369
target: matchedTarget,
295370
);
371+
final ToolContext(:Config config, :FileSystem fs) = toolContext;
372+
final Directory targetOutputDir = resolveExtensionOutputDir(
373+
buildMode: buildMode,
374+
buildOutputDir: _environment.projectDir.childDirectory(getBuildDirectory(config, fs)),
375+
fileSystem: fs,
376+
projectDir: _environment.projectDir,
377+
target: matchedTarget,
378+
);
296379
final ExtensionNativeAssetsConfig? nativeAssetsConfig = await buildManager
297380
.resolveNativeAssetsConfig(
298381
buildMode: buildMode,
299382
flutterRoot: _environment.flutterRootDir.uri,
300383
mainPath: mainPath,
301-
outputDir: _environment.outputDir.uri,
384+
outputDir: targetOutputDir.uri,
302385
projectRoot: _environment.projectDir.uri,
303386
resolvedArtifacts: resolvedArtifacts,
304387
targetName: matchedTarget.name,
305388
);
306389
final extensionDefines = <String, String>{
307-
kExtensionCustomTargetPlatform: 'true',
390+
if (!isBuiltInTargetPlatform) kExtensionCustomTargetPlatform: 'true',
308391
...buildManager.environmentDefinesForTarget(
309392
matchedTarget.name,
310393
nativeAssetsConfig: nativeAssetsConfig,
311394
),
312395
};
396+
final bool hasCliCompilerOverride = _cCompilerDefineKeys.any(_environment.defines.containsKey);
313397
var addedDefines = false;
314398
for (final MapEntry(:String key, :String value) in extensionDefines.entries) {
399+
if (hasCliCompilerOverride && _cCompilerDefineKeys.contains(key)) {
400+
continue;
401+
}
315402
_environment.defines.putIfAbsent(key, () {
316403
addedDefines = true;
317404
return value;

0 commit comments

Comments
 (0)