[flutter_tools] eagerly set asset directory path, cache flutter views, simplify error handling (#68978)
Performs some small cleanup on the hot reload code path.
- Combines nested try/catch into single try catch, update on clause now that package:vm_service is used and Map does not need to be caught.
- Cache FlutterViews for the lifetime of the hot reload method handler
- Set asset directory path once during startup and remove conditional set during hot reload
diff --git a/packages/flutter_tools/test/general.shard/resident_runner_test.dart b/packages/flutter_tools/test/general.shard/resident_runner_test.dart
index e51dd65..d6ef19f 100644
--- a/packages/flutter_tools/test/general.shard/resident_runner_test.dart
+++ b/packages/flutter_tools/test/general.shard/resident_runner_test.dart
@@ -112,6 +112,15 @@
},
);
+const FakeVmServiceRequest setAssetBundlePath = FakeVmServiceRequest(
+ method: '_flutter.setAssetBundlePath',
+ args: <String, Object>{
+ 'viewId': 'a',
+ 'assetDirectory': 'build/flutter_assets',
+ 'isolateId': '1',
+ }
+);
+
void main() {
final Uri testUri = Uri.parse('foo://bar');
Testbed testbed;
@@ -168,7 +177,7 @@
return UpdateFSReport(
success: true,
syncedBytes: 0,
- invalidatedSourcesCount: 0,
+ invalidatedSourcesCount: 1,
);
});
when(mockFlutterDevice.devFS).thenReturn(mockDevFS);
@@ -194,6 +203,7 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
]);
final Completer<DebugConnectionInfo> onConnectionInfo = Completer<DebugConnectionInfo>.sync();
final Completer<void> onAppStart = Completer<void>.sync();
@@ -219,6 +229,7 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
]);
final MockResidentCompiler residentCompiler = MockResidentCompiler();
residentRunner = HotRunner(
@@ -345,6 +356,7 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
]);
final MockResidentCompiler residentCompiler = MockResidentCompiler();
residentRunner = HotRunner(
@@ -387,6 +399,7 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
listViews,
FakeVmServiceRequest(
method: 'getIsolate',
@@ -465,6 +478,7 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
listViews,
]);
when(mockDevice.sdkNameAndVersion).thenAnswer((Invocation invocation) async {
@@ -514,10 +528,66 @@
Usage: () => MockUsage(),
}));
+ testUsingContext('ResidentRunner can handle an reload-barred exception from hot reload', () => testbed.run(() async {
+ fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
+ listViews,
+ listViews,
+ setAssetBundlePath,
+ listViews,
+ ]);
+ when(mockDevice.sdkNameAndVersion).thenAnswer((Invocation invocation) async {
+ return 'Example';
+ });
+ when(mockDevice.targetPlatform).thenAnswer((Invocation invocation) async {
+ return TargetPlatform.android_arm;
+ });
+ when(mockDevice.isLocalEmulator).thenAnswer((Invocation invocation) async {
+ return false;
+ });
+ final Completer<DebugConnectionInfo> onConnectionInfo = Completer<DebugConnectionInfo>.sync();
+ final Completer<void> onAppStart = Completer<void>.sync();
+ unawaited(residentRunner.attach(
+ appStartedCompleter: onAppStart,
+ connectionInfoCompleter: onConnectionInfo,
+ ));
+ await onAppStart.future;
+ when(mockFlutterDevice.updateDevFS(
+ mainUri: anyNamed('mainUri'),
+ target: anyNamed('target'),
+ bundle: anyNamed('bundle'),
+ firstBuildTime: anyNamed('firstBuildTime'),
+ bundleFirstUpload: anyNamed('bundleFirstUpload'),
+ bundleDirty: anyNamed('bundleDirty'),
+ fullRestart: anyNamed('fullRestart'),
+ projectRootPath: anyNamed('projectRootPath'),
+ pathToReload: anyNamed('pathToReload'),
+ invalidatedFiles: anyNamed('invalidatedFiles'),
+ dillOutputPath: anyNamed('dillOutputPath'),
+ packageConfig: anyNamed('packageConfig'),
+ )).thenThrow(vm_service.RPCError('something bad happened', kIsolateReloadBarred, ''));
+
+ final OperationResult result = await residentRunner.restart(fullRestart: false);
+ expect(result.fatal, true);
+ expect(result.code, kIsolateReloadBarred);
+ expect(result.message, contains('Unable to hot reload application due to an unrecoverable error'));
+ verify(globals.flutterUsage.sendEvent('hot', 'reload-barred', parameters: <String, String>{
+ cdKey(CustomDimensions.hotEventTargetPlatform):
+ getNameForTargetPlatform(TargetPlatform.android_arm),
+ cdKey(CustomDimensions.hotEventSdkName): 'Example',
+ cdKey(CustomDimensions.hotEventEmulator): 'false',
+ cdKey(CustomDimensions.hotEventFullRestart): 'false',
+ cdKey(CustomDimensions.nullSafety): 'false',
+ })).called(1);
+ expect(fakeVmServiceHost.hasRemainingExpectations, false);
+ }, overrides: <Type, Generator>{
+ Usage: () => MockUsage(),
+ }));
+
testUsingContext('ResidentRunner reports hot reload event with null safety analytics', () => testbed.run(() async {
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
listViews,
]);
residentRunner = HotRunner(
@@ -582,16 +652,8 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
listViews,
- listViews,
- const FakeVmServiceRequest(
- method: '_flutter.setAssetBundlePath',
- args: <String, Object>{
- 'viewId': 'a',
- 'assetDirectory': 'build/flutter_assets',
- 'isolateId': '1',
- }
- ),
FakeVmServiceRequest(
method: 'getVM',
jsonResponse: vm_service.VM.parse(<String, Object>{
@@ -615,7 +677,6 @@
},
},
),
- listViews,
FakeVmServiceRequest(
method: 'getIsolate',
args: <String, Object>{
@@ -660,7 +721,7 @@
dillOutputPath: anyNamed('dillOutputPath'),
packageConfig: anyNamed('packageConfig'),
)).thenAnswer((Invocation invocation) async {
- return UpdateFSReport(success: true);
+ return UpdateFSReport(success: true, invalidatedSourcesCount: 1);
});
final OperationResult result = await residentRunner.restart(fullRestart: false);
@@ -675,16 +736,8 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
listViews,
- listViews,
- const FakeVmServiceRequest(
- method: '_flutter.setAssetBundlePath',
- args: <String, Object>{
- 'viewId': 'a',
- 'assetDirectory': 'build/flutter_assets',
- 'isolateId': '1',
- }
- ),
FakeVmServiceRequest(
method: 'getVM',
jsonResponse: vm_service.VM.parse(<String, Object>{
@@ -756,7 +809,7 @@
dillOutputPath: anyNamed('dillOutputPath'),
packageConfig: anyNamed('packageConfig'),
)).thenAnswer((Invocation invocation) async {
- return UpdateFSReport(success: true);
+ return UpdateFSReport(success: true, invalidatedSourcesCount: 1);
});
final OperationResult result = await residentRunner.restart(fullRestart: false);
@@ -772,15 +825,7 @@
listViews,
listViews,
listViews,
- listViews,
- const FakeVmServiceRequest(
- method: '_flutter.setAssetBundlePath',
- args: <String, Object>{
- 'viewId': 'a',
- 'assetDirectory': 'build/flutter_assets',
- 'isolateId': '1',
- }
- ),
+ setAssetBundlePath,
FakeVmServiceRequest(
method: 'getVM',
jsonResponse: vm_service.VM.parse(<String, Object>{
@@ -804,7 +849,6 @@
},
},
),
- listViews,
FakeVmServiceRequest(
method: 'getIsolate',
args: <String, Object>{
@@ -856,19 +900,11 @@
),
listViews,
listViews,
- listViews,
- const FakeVmServiceRequest(
- method: '_flutter.setAssetBundlePath',
- args: <String, Object>{
- 'viewId': 'a',
- 'assetDirectory': 'build/flutter_assets',
- 'isolateId': '1',
- }
- ),
FakeVmServiceRequest(
method: 'getVM',
jsonResponse: fakeVM.toJson(),
),
+ setAssetBundlePath,
const FakeVmServiceRequest(
method: 'reloadSources',
args: <String, Object>{
@@ -884,7 +920,6 @@
},
},
),
- listViews,
FakeVmServiceRequest(
method: 'getIsolate',
args: <String, Object>{
@@ -938,7 +973,11 @@
invalidatedFiles: anyNamed('invalidatedFiles'),
packageConfig: anyNamed('packageConfig'),
)).thenAnswer((Invocation invocation) async {
- return UpdateFSReport(success: true, fastReassembleClassName: 'FOO');
+ return UpdateFSReport(
+ success: true,
+ fastReassembleClassName: 'FOO',
+ invalidatedSourcesCount: 1,
+ );
});
final Completer<DebugConnectionInfo> onConnectionInfo = Completer<DebugConnectionInfo>.sync();
@@ -969,6 +1008,7 @@
listViews,
listViews,
listViews,
+ setAssetBundlePath,
FakeVmServiceRequest(
method: 'getIsolate',
args: <String, Object>{
@@ -1038,6 +1078,7 @@
listViews,
listViews,
listViews,
+ setAssetBundlePath,
FakeVmServiceRequest(
method: 'getIsolate',
args: <String, Object>{
@@ -1113,6 +1154,7 @@
listViews,
listViews,
listViews,
+ setAssetBundlePath,
FakeVmServiceRequest(
method: 'getIsolate',
args: <String, Object>{
@@ -1243,6 +1285,7 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
]);
when(mockDevice.sdkNameAndVersion).thenAnswer((Invocation invocation) async {
return 'Example';
@@ -2112,6 +2155,7 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
]);
setWsAddress(testUri, fakeVmServiceHost.vmService);
globals.fs.file(globals.fs.path.join('lib', 'main.dart')).createSync(recursive: true);
@@ -2137,6 +2181,7 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
]);
setWsAddress(testUri, fakeVmServiceHost.vmService);
globals.fs.file(globals.fs.path.join('lib', 'main.dart')).createSync(recursive: true);
@@ -2163,6 +2208,7 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
]);
setWsAddress(testUri, fakeVmServiceHost.vmService);
globals.fs.file(globals.fs.path.join('lib', 'main.dart')).createSync(recursive: true);
@@ -2197,6 +2243,7 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
]);
setWsAddress(testUri, fakeVmServiceHost.vmService);
globals.fs.file(globals.fs.path.join('lib', 'main.dart')).createSync(recursive: true);
@@ -2231,6 +2278,7 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
]);
setWsAddress(testUri, fakeVmServiceHost.vmService);
globals.fs.file(globals.fs.path.join('lib', 'main.dart')).createSync(recursive: true);
@@ -2258,6 +2306,7 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
]);
setWsAddress(testUri, fakeVmServiceHost.vmService);
globals.fs.file(globals.fs.path.join('lib', 'main.dart')).createSync(recursive: true);
@@ -2322,6 +2371,7 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
]);
final MockDevicePortForwarder mockPortForwarder = MockDevicePortForwarder();
when(mockDevice.portForwarder).thenReturn(mockPortForwarder);
@@ -2353,6 +2403,7 @@
fakeVmServiceHost = FakeVmServiceHost(requests: <VmServiceExpectation>[
listViews,
listViews,
+ setAssetBundlePath,
]);
globals.fs.file(globals.fs.path.join('lib', 'main.dart')).createSync(recursive: true);
residentRunner = HotRunner(
