Skip to content

Fix flavor-conditional asset bundling for path dependencies #156687

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
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
3 changes: 2 additions & 1 deletion packages/flutter_tools/lib/src/asset.dart
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,7 @@ class ManifestAssetBundle implements AssetBundle {
targetPlatform,
packageName: package.name,
attributedPackage: package,
flavor: flavor,
);

if (packageAssets == null) {
Expand Down Expand Up @@ -873,7 +874,7 @@ class ManifestAssetBundle implements AssetBundle {
TargetPlatform? targetPlatform, {
String? packageName,
Package? attributedPackage,
String? flavor,
required String? flavor,
}) {
final Map<_Asset, List<_Asset>> result = <_Asset, List<_Asset>>{};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,14 @@ void main() {
return path.replaceAll('/', globals.fs.path.separator);
}

void writePubspecFile(String path, String name, { List<String>? assets }) {
void writePubspecFile(
String path,
String name, {
List<String>? assets,
List<(String path, String flavor)>? flavoredAssets,
}) {
String assetsSection;
if (assets == null) {
if (assets == null && flavoredAssets == null) {
assetsSection = '';
} else {
final StringBuffer buffer = StringBuffer();
Expand All @@ -38,11 +43,20 @@ flutter:
assets:
''');

for (final String asset in assets) {
for (final String asset in (assets ?? <String>[])) {
buffer.write('''
- $asset
''');
}

for (final (String path, String flavor) in flavoredAssets ?? <(String, String)>[]) {
buffer.write('''
- path: $path
flavors:
- $flavor
''');
}

assetsSection = buffer.toString();
}

Expand All @@ -57,7 +71,7 @@ $assetsSection
''');
}

void writePackageConfigFile(Map<String, String> packages) {
void writePackageConfigFile(Map<String, String> packages) {
globals.fs.directory('.dart_tool').childFile('package_config.json')
..createSync(recursive: true)
..writeAsStringSync(
Expand Down Expand Up @@ -89,11 +103,15 @@ void writePackageConfigFile(Map<String, String> packages) {
Future<void> buildAndVerifyAssets(
List<String> assets,
List<String> packages,
Map<Object,Object> expectedAssetManifest
) async {
Map<Object, Object> expectedAssetManifest, {
String? flavor,
}) async {

final AssetBundle bundle = AssetBundleFactory.instance.createBundle();
await bundle.build(packageConfigPath: '.dart_tool/package_config.json');
await bundle.build(
packageConfigPath: '.dart_tool/package_config.json',
flavor: flavor,
);

for (final String packageName in packages) {
for (final String asset in assets) {
Expand Down Expand Up @@ -532,6 +550,73 @@ void writePackageConfigFile(Map<String, String> packages) {
FileSystem: () => testFileSystem,
ProcessManager: () => FakeProcessManager.any(),
});

testUsingContext('Flavored assets are bundled when the app depends on a package', () async {
writePubspecFile(
'pubspec.yaml',
'test',
);
writePackageConfigFile(
<String, String>{
'test_package': 'p/p/',
},
);
writePubspecFile(
'p/p/pubspec.yaml',
'test_package',
flavoredAssets: <(String, String)>[('assets/vanilla.txt', 'vanilla')],
);

final List<String> assets = <String>['assets/vanilla.txt'];
writeAssets('p/p', assets);

const Map<Object, Object> expectedAssetManifest = <Object, Object>{
'packages/test_package/assets/vanilla.txt': <Map<String, Object>>[
<String, Object>{'asset': 'packages/test_package/assets/vanilla.txt'},
]
};

await buildAndVerifyAssets(
assets,
<String>['test_package'],
expectedAssetManifest,
flavor: 'vanilla',
);
}, overrides: <Type, Generator>{
FileSystem: () => testFileSystem,
ProcessManager: () => FakeProcessManager.any(),
});
});

testUsingContext('Asset paths can contain URL reserved characters', () async {
writePubspecFile('pubspec.yaml', 'test');
writePackageConfigFile(<String, String>{'test_package': 'p/p/'});

final List<String> assets = <String>['a/foo', 'a/foo [x]'];
writePubspecFile(
'p/p/pubspec.yaml',
'test_package',
assets: assets,
);

writeAssets('p/p/', assets);
const Map<Object, Object> expectedAssetManifest = <Object, Object>{
'packages/test_package/a/foo': <Map<String, Object>>[
<String, Object>{'asset': 'packages/test_package/a/foo'}
],
'packages/test_package/a/foo [x]': <Map<String, Object>>[
<String, Object>{'asset': 'packages/test_package/a/foo [x]'}
]
};

await buildAndVerifyAssets(
assets,
<String>['test_package'],
expectedAssetManifest,
);
}, overrides: <Type, Generator>{
FileSystem: () => testFileSystem,
ProcessManager: () => FakeProcessManager.any(),
});

testUsingContext('Asset paths can contain URL reserved characters', () async {
Expand Down
Loading