Skip to content

Commit 9b04ad5

Browse files
authored
[flutter_tools] Verify native assets tree-shaking during linking (flutter#191637)
Add a unit test verifying that unused native code assets filtered out by link hooks are tree-shaken and excluded from the installed application bundle and native assets manifest. Fixes flutter#130811
1 parent 8151540 commit 9b04ad5

1 file changed

Lines changed: 75 additions & 0 deletions

File tree

‎packages/flutter_tools/test/general.shard/isolated/native_assets_test.dart‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,81 @@ void main() {
250250
},
251251
);
252252

253+
testUsingContext(
254+
'Native assets: unused code assets are tree-shaken during linking when not recorded as used',
255+
overrides: <Type, Generator>{ProcessManager: () => FakeProcessManager.empty()},
256+
() async {
257+
final File packageConfig = environment.projectDir.childFile('.dart_tool/package_config.json');
258+
final Uri nonFlutterTesterAssetUri = environment.buildDir
259+
.childFile(InstallCodeAssets.nativeAssetsFilename)
260+
.uri;
261+
await packageConfig.parent.create();
262+
await packageConfig.create();
263+
264+
final File unusedSoFile = environment.projectDir.childFile('unused.so');
265+
unusedSoFile.writeAsBytesSync(<int>[]);
266+
final File usedSoFile = environment.projectDir.childFile('used.so');
267+
usedSoFile.writeAsBytesSync(<int>[]);
268+
269+
CodeAsset makeCodeAsset(String name, Uri file, LinkMode linkMode) =>
270+
CodeAsset(package: 'bar', name: name, linkMode: linkMode, file: file);
271+
272+
final environmentDefines = <String, String>{kBuildMode: BuildMode.release.cliName};
273+
final DartHooksResult result = await runFlutterSpecificHooks(
274+
environmentDefines: environmentDefines,
275+
targetPlatform: TargetPlatform.linux_x64,
276+
projectUri: projectUri,
277+
fileSystem: fileSystem,
278+
buildRunner: FakeFlutterNativeAssetsBuildRunner(
279+
packagesWithNativeAssetsResult: <String>['bar'],
280+
buildResult: FakeFlutterNativeAssetsBuilderResult.fromAssets(
281+
codeAssetsForLinking: <String, List<CodeAsset>>{
282+
'package:bar': <CodeAsset>[
283+
makeCodeAsset('unused', unusedSoFile.uri, DynamicLoadingBundled()),
284+
makeCodeAsset('used', usedSoFile.uri, DynamicLoadingBundled()),
285+
],
286+
},
287+
),
288+
// Link hook receives both assets, but tree-shakes 'unused' and only outputs 'used'.
289+
linkResult: FakeFlutterNativeAssetsBuilderResult.fromAssets(
290+
codeAssets: <CodeAsset>[makeCodeAsset('used', usedSoFile.uri, DynamicLoadingBundled())],
291+
),
292+
),
293+
buildCodeAssets: const BuildCodeAssetsOptions(appBuildDirectory: null),
294+
buildDataAssets: true,
295+
recordedUsesFile: null,
296+
);
297+
298+
expect(
299+
result.codeAssets.map((FlutterCodeAsset c) => c.codeAsset.file!.toString()).toList(),
300+
<String>[usedSoFile.uri.toString()],
301+
);
302+
303+
final List<File> installedFiles = await installCodeAssets(
304+
dartHookResult: result,
305+
environmentDefines: environmentDefines,
306+
targetPlatform: TargetPlatform.linux_x64,
307+
projectUri: projectUri,
308+
fileSystem: fileSystem,
309+
nativeAssetsFileUri: nonFlutterTesterAssetUri,
310+
targetUri: projectUri.resolve('${getBuildDirectory()}/native_assets/linux/'),
311+
);
312+
313+
// Verify installed files only contain native_assets.json and used.so, but not unused.so.
314+
expect(
315+
installedFiles.map(
316+
(File f) => f.path.split(RegExp(r'[/\\]')).lastWhere((String s) => s.isNotEmpty),
317+
),
318+
unorderedEquals(<String>[InstallCodeAssets.nativeAssetsFilename, 'used.so']),
319+
);
320+
final File nativeAssetsJsonFile = fileSystem.file(nonFlutterTesterAssetUri);
321+
expect(nativeAssetsJsonFile, exists);
322+
final String jsonContent = nativeAssetsJsonFile.readAsStringSync();
323+
expect(jsonContent, contains('package:bar/used'));
324+
expect(jsonContent, isNot(contains('package:bar/unused')));
325+
},
326+
);
327+
253328
testUsingContext(
254329
'Native assets: duplicate assets throws tool exit listing duplicate IDs',
255330
overrides: <Type, Generator>{ProcessManager: () => FakeProcessManager.empty()},

0 commit comments

Comments
 (0)