logs.dart 2.36 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5 6
// @dart = 2.8

7 8
import 'dart:async';

9
import '../base/common.dart';
10
import '../base/io.dart';
11
import '../device.dart';
12
import '../globals_null_migrated.dart' as globals;
13
import '../runner/flutter_command.dart';
14

15 16
class LogsCommand extends FlutterCommand {
  LogsCommand() {
17
    argParser.addFlag('clear',
Devon Carew's avatar
Devon Carew committed
18 19
      negatable: false,
      abbr: 'c',
20
      help: 'Clear log history before reading from logs.',
Devon Carew's avatar
Devon Carew committed
21
    );
22
    usesDeviceTimeoutOption();
23 24
  }

25 26 27 28 29 30
  @override
  final String name = 'logs';

  @override
  final String description = 'Show log output for running Flutter apps.';

31 32 33
  @override
  Future<Set<DevelopmentArtifact>> get requiredArtifacts async => const <DevelopmentArtifact>{};

34
  Device device;
35

36
  @override
37
  Future<FlutterCommandResult> verifyThenRunCommand(String commandPath) async {
38
    device = await findTargetDevice(includeUnsupportedDevices: true);
39
    if (device == null) {
40
      throwToolExit(null);
41 42
    }
    return super.verifyThenRunCommand(commandPath);
43
  }
44

45
  @override
46
  Future<FlutterCommandResult> runCommand() async {
47
    if (boolArg('clear')) {
48
      device.clearLogs();
49
    }
50

51
    final DeviceLogReader logReader = await device.getLogReader();
52

53
    globals.printStatus('Showing $logReader logs:');
54

55
    final Completer<int> exitCompleter = Completer<int>();
Devon Carew's avatar
Devon Carew committed
56

57
    // Start reading.
58
    final StreamSubscription<String> subscription = logReader.logLines.listen(
59
      (String message) => globals.printStatus(message, wrap: false),
Devon Carew's avatar
Devon Carew committed
60 61 62 63 64
      onDone: () {
        exitCompleter.complete(0);
      },
      onError: (dynamic error) {
        exitCompleter.complete(error is int ? error : 1);
65
      },
Devon Carew's avatar
Devon Carew committed
66
    );
Devon Carew's avatar
Devon Carew committed
67

Devon Carew's avatar
Devon Carew committed
68
    // When terminating, close down the log reader.
69
    ProcessSignal.sigint.watch().listen((ProcessSignal signal) {
Devon Carew's avatar
Devon Carew committed
70
      subscription.cancel();
71
      globals.printStatus('');
Devon Carew's avatar
Devon Carew committed
72 73
      exitCompleter.complete(0);
    });
74
    ProcessSignal.sigterm.watch().listen((ProcessSignal signal) {
75 76 77
      subscription.cancel();
      exitCompleter.complete(0);
    });
78

79
    // Wait for the log reader to be finished.
80
    final int result = await exitCompleter.future;
81
    await subscription.cancel();
82
    if (result != 0) {
83
      throwToolExit('Error listening to $logReader logs.');
84
    }
85

86
    return FlutterCommandResult.success();
87 88
  }
}