Skip to content

Commit a19b343

Browse files
authored
Log all lines from ios-deploy (#127502)
Reland flutter/flutter#127222 that was reverted in flutter/flutter#127405. Fixed `Mac_ios microbenchmarks_ios` test failure by not echoing logs twice.
1 parent 555326b commit a19b343

4 files changed

Lines changed: 118 additions & 21 deletions

File tree

‎packages/flutter_tools/lib/src/ios/ios_deploy.dart‎

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,12 @@ class IOSDeployDebugger {
348348
.transform<String>(utf8.decoder)
349349
.transform<String>(const LineSplitter())
350350
.listen((String line) {
351+
352+
// TODO(vashworth): Revert after https://github.com/flutter/flutter/issues/121231 is resolved.
353+
if (line.isNotEmpty) {
354+
_logger.printTrace(line);
355+
}
356+
351357
_monitorIOSDeployFailure(line, _logger);
352358

353359
// (lldb) platform select remote-'ios' --sysroot
@@ -365,7 +371,6 @@ class IOSDeployDebugger {
365371
}
366372
final String prompt = line.substring(0, promptEndIndex);
367373
lldbRun = RegExp(RegExp.escape(prompt) + r'\s*run');
368-
_logger.printTrace(line);
369374
return;
370375
}
371376

@@ -384,7 +389,6 @@ class IOSDeployDebugger {
384389
// success
385390
// 2020-09-15 13:42:25.185474-0700 Runner[477:181141] flutter: The Dart VM service is listening on http://127.0.0.1:57782/
386391
if (lldbRun.hasMatch(line)) {
387-
_logger.printTrace(line);
388392
_debuggerState = _IOSDeployDebuggerState.launching;
389393
// TODO(vashworth): Remove all debugger state comments when https://github.com/flutter/flutter/issues/126412 is resolved.
390394
_logger.printTrace('Debugger state set to launching.');
@@ -393,7 +397,6 @@ class IOSDeployDebugger {
393397
// Next line after "run" must be "success", or the attach failed.
394398
// Example: "error: process launch failed"
395399
if (_debuggerState == _IOSDeployDebuggerState.launching) {
396-
_logger.printTrace(line);
397400
final bool attachSuccess = line == 'success';
398401
_debuggerState = attachSuccess ? _IOSDeployDebuggerState.attached : _IOSDeployDebuggerState.detached;
399402
_logger.printTrace('Debugger state set to ${attachSuccess ? 'attached' : 'detached'}.');
@@ -408,7 +411,6 @@ class IOSDeployDebugger {
408411
// process signal SIGSTOP
409412
if (line.contains(_signalStop)) {
410413
// The app is about to be stopped. Only show in verbose mode.
411-
_logger.printTrace(line);
412414
return;
413415
}
414416

@@ -421,7 +423,6 @@ class IOSDeployDebugger {
421423

422424
if (line == _backTraceAll) {
423425
// The app is stopped and the backtrace for all threads will be printed.
424-
_logger.printTrace(line);
425426
// Even though we're not "detached", just stopped, mark as detached so the backtrace
426427
// is only show in verbose.
427428
_debuggerState = _IOSDeployDebuggerState.detached;
@@ -438,7 +439,6 @@ class IOSDeployDebugger {
438439

439440
if (line.contains('PROCESS_STOPPED') || _lldbProcessStopped.hasMatch(line)) {
440441
// The app has been stopped. Dump the backtrace, and detach.
441-
_logger.printTrace(line);
442442
_iosDeployProcess?.stdin.writeln(_backTraceAll);
443443
if (_processResumeCompleter == null) {
444444
detach();
@@ -449,28 +449,24 @@ class IOSDeployDebugger {
449449
if (line.contains('PROCESS_EXITED') || _lldbProcessExit.hasMatch(line)) {
450450
// The app exited or crashed, so exit. Continue passing debugging
451451
// messages to the log reader until it exits to capture crash dumps.
452-
_logger.printTrace(line);
453452
exit();
454453
return;
455454
}
456455
if (_lldbProcessDetached.hasMatch(line)) {
457456
// The debugger has detached from the app, and there will be no more debugging messages.
458457
// Kill the ios-deploy process.
459-
_logger.printTrace(line);
460458
exit();
461459
return;
462460
}
463461

464462
if (_lldbProcessResuming.hasMatch(line)) {
465-
_logger.printTrace(line);
466463
// we marked this detached when we received [_backTraceAll]
467464
_debuggerState = _IOSDeployDebuggerState.attached;
468465
_logger.printTrace('Debugger state set to attached.');
469466
return;
470467
}
471468

472469
if (_debuggerState != _IOSDeployDebuggerState.attached) {
473-
_logger.printTrace(line);
474470
return;
475471
}
476472
if (lastLineFromDebugger != null && lastLineFromDebugger!.isNotEmpty && line.isEmpty) {
@@ -488,7 +484,7 @@ class IOSDeployDebugger {
488484
.transform<String>(const LineSplitter())
489485
.listen((String line) {
490486
_monitorIOSDeployFailure(line, _logger);
491-
_logger.printTrace(line);
487+
_logger.printTrace('error: $line');
492488
});
493489
unawaited(_iosDeployProcess!.exitCode.then((int status) async {
494490
_logger.printTrace('ios-deploy exited with code $exitCode');

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

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ import 'devfs.dart';
3636
import 'device.dart';
3737
import 'features.dart';
3838
import 'globals.dart' as globals;
39+
import 'ios/devices.dart';
3940
import 'project.dart';
4041
import 'resident_devtools_handler.dart';
4142
import 'run_cold.dart';
@@ -228,8 +229,9 @@ class FlutterDevice {
228229
FlutterVmService? vmService;
229230
DevFS? devFS;
230231
ApplicationPackage? package;
232+
@visibleForTesting
231233
// ignore: cancel_subscriptions
232-
StreamSubscription<String>? _loggingSubscription;
234+
StreamSubscription<String>? loggingSubscription;
233235
bool? _isListeningForVmServiceUri;
234236

235237
/// Whether the stream [vmServiceUris] is still open.
@@ -392,23 +394,26 @@ class FlutterDevice {
392394
}
393395

394396
Future<void> startEchoingDeviceLog() async {
395-
if (_loggingSubscription != null) {
397+
if (loggingSubscription != null) {
396398
return;
397399
}
398-
final Stream<String> logStream = (await device!.getLogReader(app: package)).logLines;
399-
_loggingSubscription = logStream.listen((String line) {
400-
if (!line.contains(globals.kVMServiceMessageRegExp)) {
400+
final DeviceLogReader logReader = await device!.getLogReader(app: package);
401+
final Stream<String> logStream = logReader.logLines;
402+
// TODO(vashworth): Remove check for IOSDeviceLogReader after
403+
// https://github.com/flutter/flutter/issues/121231 is resolved.
404+
loggingSubscription = logStream.listen((String line) {
405+
if (logReader is! IOSDeviceLogReader && !line.contains(globals.kVMServiceMessageRegExp)) {
401406
globals.printStatus(line, wrap: false);
402407
}
403408
});
404409
}
405410

406411
Future<void> stopEchoingDeviceLog() async {
407-
if (_loggingSubscription == null) {
412+
if (loggingSubscription == null) {
408413
return;
409414
}
410-
await _loggingSubscription!.cancel();
411-
_loggingSubscription = null;
415+
await loggingSubscription!.cancel();
416+
loggingSubscription = null;
412417
}
413418

414419
Future<void> initLogReader() async {

‎packages/flutter_tools/test/general.shard/ios/ios_deploy_test.dart‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,26 @@ void main () {
9494
logger = BufferLogger.test();
9595
});
9696

97+
testWithoutContext('print all lines', () async {
98+
final StreamController<List<int>> stdin = StreamController<List<int>>();
99+
final FakeProcessManager processManager = FakeProcessManager.list(<FakeCommand>[
100+
FakeCommand(
101+
command: const <String>['ios-deploy'],
102+
stdout: "(mylldb) platform select remote-'ios' --sysroot\r\n(mylldb) run\r\nsuccess\r\nrandom string\r\n",
103+
stdin: IOSink(stdin.sink),
104+
),
105+
]);
106+
final IOSDeployDebugger iosDeployDebugger = IOSDeployDebugger.test(
107+
processManager: processManager,
108+
logger: logger,
109+
);
110+
expect(await iosDeployDebugger.launchAndAttach(), isTrue);
111+
expect(logger.traceText, contains("(mylldb) platform select remote-'ios' --sysroot"));
112+
expect(logger.traceText, contains('(mylldb) run'));
113+
expect(logger.traceText, contains('success'));
114+
expect(logger.traceText, contains('random string'));
115+
});
116+
97117
testWithoutContext('custom lldb prompt', () async {
98118
final StreamController<List<int>> stdin = StreamController<List<int>>();
99119
final FakeProcessManager processManager = FakeProcessManager.list(<FakeCommand>[

‎packages/flutter_tools/test/general.shard/resident_runner_test.dart‎

Lines changed: 78 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,16 @@ import 'package:flutter_tools/src/base/platform.dart';
2020
import 'package:flutter_tools/src/build_info.dart';
2121
import 'package:flutter_tools/src/build_system/targets/scene_importer.dart';
2222
import 'package:flutter_tools/src/build_system/targets/shader_compiler.dart';
23+
import 'package:flutter_tools/src/cache.dart';
2324
import 'package:flutter_tools/src/compile.dart';
2425
import 'package:flutter_tools/src/convert.dart';
2526
import 'package:flutter_tools/src/devfs.dart';
2627
import 'package:flutter_tools/src/device.dart';
2728
import 'package:flutter_tools/src/device_port_forwarder.dart';
2829
import 'package:flutter_tools/src/features.dart';
2930
import 'package:flutter_tools/src/globals.dart' as globals;
31+
import 'package:flutter_tools/src/ios/devices.dart';
32+
import 'package:flutter_tools/src/ios/mac.dart';
3033
import 'package:flutter_tools/src/project.dart';
3134
import 'package:flutter_tools/src/reporting/reporting.dart';
3235
import 'package:flutter_tools/src/resident_devtools_handler.dart';
@@ -41,6 +44,7 @@ import 'package:vm_service/vm_service.dart' as vm_service;
4144

4245
import '../src/common.dart';
4346
import '../src/context.dart';
47+
import '../src/fake_devices.dart';
4448
import '../src/fake_vm_services.dart';
4549
import '../src/fakes.dart';
4650
import '../src/testbed.dart';
@@ -2438,6 +2442,70 @@ flutter:
24382442
expect(flutterDevice.devFS!.hasSetAssetDirectory, true);
24392443
expect(fakeVmServiceHost!.hasRemainingExpectations, false);
24402444
}));
2445+
2446+
group('startEchoingDeviceLog', () {
2447+
late FakeProcessManager processManager;
2448+
late Artifacts artifacts;
2449+
late Cache fakeCache;
2450+
late BufferLogger logger;
2451+
2452+
setUp(() {
2453+
processManager = FakeProcessManager.empty();
2454+
fakeCache = Cache.test(processManager: FakeProcessManager.any());
2455+
artifacts = Artifacts.test();
2456+
logger = BufferLogger.test();
2457+
});
2458+
2459+
testUsingContext('IOSDeviceLogReader does not print logs', () async {
2460+
final IOSDeviceLogReader logReader = IOSDeviceLogReader.test(
2461+
iMobileDevice: IMobileDevice(
2462+
artifacts: artifacts,
2463+
processManager: processManager,
2464+
cache: fakeCache,
2465+
logger: logger,
2466+
),
2467+
useSyslog: false,
2468+
);
2469+
device = FakeDevice(deviceLogReader: logReader);
2470+
final TestFlutterDevice flutterDevice = TestFlutterDevice(
2471+
device,
2472+
);
2473+
2474+
await flutterDevice.startEchoingDeviceLog();
2475+
final Future<List<String>> linesFromStream = logReader.logLines.toList();
2476+
logReader.linesController.add('event');
2477+
await logReader.linesController.close();
2478+
final List<String> lines = await linesFromStream;
2479+
2480+
expect(lines, contains('event'));
2481+
expect(logger.statusText, isEmpty);
2482+
2483+
await flutterDevice.stopEchoingDeviceLog();
2484+
}, overrides: <Type, Generator>{
2485+
Logger: () => logger,
2486+
});
2487+
2488+
testUsingContext('Non-IOSDeviceLogReader does print logs', () async {
2489+
final FakeDeviceLogReader logReader = FakeDeviceLogReader();
2490+
device = FakeDevice(deviceLogReader: logReader);
2491+
final TestFlutterDevice flutterDevice = TestFlutterDevice(
2492+
device,
2493+
);
2494+
2495+
await flutterDevice.startEchoingDeviceLog();
2496+
final Future<List<String>> linesFromStream = logReader.logLines.toList();
2497+
logReader.addLine('event');
2498+
await logReader.dispose();
2499+
final List<String> lines = await linesFromStream;
2500+
2501+
expect(lines, contains('event'));
2502+
expect(logger.statusText, contains('event'));
2503+
2504+
await flutterDevice.stopEchoingDeviceLog();
2505+
}, overrides: <Type, Generator>{
2506+
Logger: () => logger,
2507+
});
2508+
});
24412509
}
24422510

24432511
// This implements [dds.DartDevelopmentService], not the [DartDevelopmentService]
@@ -2676,13 +2744,16 @@ class FakeDevice extends Fake implements Device {
26762744
this.supportsHotRestart = true,
26772745
this.supportsScreenshot = true,
26782746
this.supportsFlutterExit = true,
2747+
DeviceLogReader? deviceLogReader,
26792748
}) : _isLocalEmulator = isLocalEmulator,
26802749
_targetPlatform = targetPlatform,
2681-
_sdkNameAndVersion = sdkNameAndVersion;
2750+
_sdkNameAndVersion = sdkNameAndVersion,
2751+
_deviceLogReader = deviceLogReader;
26822752

26832753
final bool _isLocalEmulator;
26842754
final TargetPlatform _targetPlatform;
26852755
final String _sdkNameAndVersion;
2756+
final DeviceLogReader? _deviceLogReader;
26862757

26872758
bool disposed = false;
26882759
bool appStopped = false;
@@ -2740,7 +2811,12 @@ class FakeDevice extends Fake implements Device {
27402811
FutureOr<DeviceLogReader> getLogReader({
27412812
ApplicationPackage? app,
27422813
bool includePastLogs = false,
2743-
}) => NoOpDeviceLogReader(name);
2814+
}) {
2815+
if (_deviceLogReader != null) {
2816+
return _deviceLogReader!;
2817+
}
2818+
return NoOpDeviceLogReader(name);
2819+
}
27442820

27452821
@override
27462822
DevicePortForwarder portForwarder = const NoOpDevicePortForwarder();

0 commit comments

Comments
 (0)