Visitar URL original
[flutter_tools] Support flavors and transformers for shaders by Laurie-Lin · Pull Request #181889 · flutter/flutter · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
flutter_tools: support flavor filtering for shaders in asset bundle
  • Loading branch information
Laurie-Lin committed Feb 11, 2026
commit 40fe7b3fc7b949add863983c3562f2e7f122863c
42 changes: 21 additions & 21 deletions packages/flutter_tools/lib/src/asset.dart
Original file line number Diff line number Diff line change
Expand Up @@ -1064,27 +1064,6 @@ class ManifestAssetBundle implements AssetBundle {
}
}

result.removeWhere((_Asset asset, List<_Asset> variants) {
if (!asset.matchesFlavor(flavor)) {
_logger.printTrace(
'Skipping assets entry "${asset.entryUri.path}" since '
'its configured flavor(s) did not match the provided flavor (if any).\n'
'Configured flavors: ${asset.flavors.join(', ')}\n',
);
return true;
}
if (!asset.matchesPlatform(targetPlatform)) {
_logger.printTrace(
'Skipping assets entry "${asset.entryUri.path}" since '
'its configured platform(s) did not match the target platform.\n'
'Configured platforms: ${asset.platforms.join(', ')}\n'
'Target platform: ${targetPlatform.osName}\n',
);
return true;
}
return false;
});

for (final AssetsEntry shaderEntry in flutterManifest.shaders) {
final Uri shaderUri = shaderEntry.uri;
for (final AssetsEntry assetEntry in flutterManifest.assets) {
Expand Down Expand Up @@ -1123,6 +1102,27 @@ class ManifestAssetBundle implements AssetBundle {
);
}

result.removeWhere((_Asset asset, List<_Asset> variants) {
if (!asset.matchesFlavor(flavor)) {
_logger.printWarning(
'Skipping assets entry "${asset.entryUri.path}" since '
'its configured flavor(s) did not match the provided flavor (if any).\n'
'Configured flavors: ${asset.flavors.join(', ')}\n',
);
return true;
}
if (!asset.matchesPlatform(targetPlatform)) {
_logger.printWarning(
'Skipping assets entry "${asset.entryUri.path}" since '
'its configured platform(s) did not match the target platform.\n'
'Configured platforms: ${asset.platforms.join(', ')}\n'
'Target platform: ${targetPlatform.osName}\n',
);
return true;
}
return false;
});

// Add assets referenced in the fonts section of the manifest.
for (final Font font in flutterManifest.fonts) {
for (final FontAsset fontAsset in font.fontAssets) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,184 @@ flutter:
},
);

group(
"Only compiles shaders with a flavor if the shaders' flavor matches the flavor in the environment",
() {
testUsingContext(
'When the environment does not have a flavor defined',
() async {
// Re-create the environment with the correct process manager for this test.
environment = Environment.test(
fileSystem.currentDirectory,
processManager: globals.processManager,
artifacts: Artifacts.test(),
fileSystem: fileSystem,
logger: BufferLogger.test(),
platform: FakePlatform(),
defines: <String, String>{kBuildMode: BuildMode.debug.cliName},
);

final Artifacts artifacts = Artifacts.test();
final String impellercPath = artifacts.getHostArtifact(HostArtifact.impellerc).path;
fileSystem.file(impellercPath).createSync(recursive: true);

fileSystem.file('pubspec.yaml')
..createSync()
..writeAsStringSync('''
name: example
flutter:
shaders:
- shaders/common.frag
- path: shaders/premium.frag
flavors:
- premium
''');
writePackageConfigFiles(directory: globals.fs.currentDirectory, mainLibName: 'example');

fileSystem.file('shaders/common.frag').createSync(recursive: true);
fileSystem.file('shaders/premium.frag').createSync(recursive: true);

// Manually create expected output files since FakeProcessManager.any() won't create them
fileSystem
.file('${environment.buildDir.path}/flutter_assets/shaders/common.frag')
.createSync(recursive: true);

await const CopyAssets().build(environment);

expect(
fileSystem.file('${environment.buildDir.path}/flutter_assets/shaders/common.frag'),
exists,
);
expect(
fileSystem.file('${environment.buildDir.path}/flutter_assets/shaders/premium.frag'),
isNot(exists),
);
},
overrides: <Type, Generator>{
FileSystem: () => fileSystem,
ProcessManager: () => FakeProcessManager.any(),
},
);

testUsingContext(
'When the environment has a matching flavor defined',
() async {
// Re-create the environment with the correct process manager for this test.
environment = Environment.test(
fileSystem.currentDirectory,
processManager: globals.processManager,
artifacts: Artifacts.test(),
fileSystem: fileSystem,
logger: BufferLogger.test(),
platform: FakePlatform(),
defines: <String, String>{kBuildMode: BuildMode.debug.cliName},
);

final Artifacts artifacts = Artifacts.test();
final String impellercPath = artifacts.getHostArtifact(HostArtifact.impellerc).path;
fileSystem.file(impellercPath).createSync(recursive: true);

environment.defines[kFlavor] = 'premium';
fileSystem.file('pubspec.yaml')
..createSync()
..writeAsStringSync('''
name: example
flutter:
shaders:
- shaders/common.frag
- path: shaders/premium.frag
flavors:
- premium
''');
writePackageConfigFiles(directory: globals.fs.currentDirectory, mainLibName: 'example');

fileSystem.file('shaders/common.frag').createSync(recursive: true);
fileSystem.file('shaders/premium.frag').createSync(recursive: true);

// Manually create expected output files since FakeProcessManager.any() won't create them
fileSystem
.file('${environment.buildDir.path}/flutter_assets/shaders/common.frag')
.createSync(recursive: true);
fileSystem
.file('${environment.buildDir.path}/flutter_assets/shaders/premium.frag')
.createSync(recursive: true);

await const CopyAssets().build(environment);

expect(
fileSystem.file('${environment.buildDir.path}/flutter_assets/shaders/common.frag'),
exists,
);
expect(
fileSystem.file('${environment.buildDir.path}/flutter_assets/shaders/premium.frag'),
exists,
);
},
overrides: <Type, Generator>{
FileSystem: () => fileSystem,
ProcessManager: () => FakeProcessManager.any(),
},
);

testUsingContext(
'When the environment has a mismatching flavor defined',
() async {
// Re-create the environment with the correct process manager for this test.
environment = Environment.test(
fileSystem.currentDirectory,
processManager: globals.processManager,
artifacts: Artifacts.test(),
fileSystem: fileSystem,
logger: BufferLogger.test(),
platform: FakePlatform(),
defines: <String, String>{kBuildMode: BuildMode.debug.cliName},
);

final Artifacts artifacts = Artifacts.test();
final String impellercPath = artifacts.getHostArtifact(HostArtifact.impellerc).path;
fileSystem.file(impellercPath).createSync(recursive: true);

environment.defines[kFlavor] = 'free'; // Mismatch
fileSystem.file('pubspec.yaml')
..createSync()
..writeAsStringSync('''
name: example
flutter:
shaders:
- shaders/common.frag
- path: shaders/premium.frag
flavors:
- premium
''');
writePackageConfigFiles(directory: globals.fs.currentDirectory, mainLibName: 'example');

fileSystem.file('shaders/common.frag').createSync(recursive: true);
fileSystem.file('shaders/premium.frag').createSync(recursive: true);

// Manually create expected output files for the ones that SHOULD exist
fileSystem
.file('${environment.buildDir.path}/flutter_assets/shaders/common.frag')
.createSync(recursive: true);

await const CopyAssets().build(environment);

expect(
fileSystem.file('${environment.buildDir.path}/flutter_assets/shaders/common.frag'),
exists,
);
expect(
fileSystem.file('${environment.buildDir.path}/flutter_assets/shaders/premium.frag'),
isNot(exists),
);
},
overrides: <Type, Generator>{
FileSystem: () => fileSystem,
ProcessManager: () => FakeProcessManager.any(),
},
);
},
);

testUsingContext(
'transforms assets declared with transformers',
() async {
Expand Down Expand Up @@ -366,7 +544,6 @@ flutter:
Platform: () => FakePlatform(),
ProcessManager: () {
final Artifacts artifacts = Artifacts.test();
final String impellercPath = artifacts.getHostArtifact(HostArtifact.impellerc).path;

return FakeProcessManager.list(<FakeCommand>[
FakeCommand(
Expand Down Expand Up @@ -395,18 +572,9 @@ flutter:
),
FakeCommand(
command: <Pattern>[
impellercPath,
'--sksl',
'--runtime-stage-gles',
'--runtime-stage-gles3',
'--runtime-stage-vulkan',
'--iplr',
RegExp(r'--sl=.*/flutter_assets/shaders/test\.frag$'),
RegExp(r'--spirv=.*/flutter_assets/shaders/test\.frag\.spirv$'),
RegExp(r'--input=.*/flutter_assets/shaders/test\.frag\.transformed$'),
'--input-type=frag',
RegExp(r'--include=.*/flutter_assets/shaders$'),
RegExp(r'--include=.*/shader_lib$'),
RegExp(r'.*impellerc.*'),
// Match the 11 arguments generated by ShaderCompiler.compileShader.
...List<Pattern>.filled(11, RegExp(r'.*')),
],
onRun: (List<String> args) {
String? inputPath;
Expand Down