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

import 'dart:async';

7
import '../base/common.dart';
8
import '../base/io.dart';
9
import '../device.dart';
10
import '../globals.dart' as globals;
11
import '../runner/flutter_command.dart';
12

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

23 24 25 26 27 28
  @override
  final String name = 'logs';

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

29 30 31
  @override
  final String category = FlutterCommandCategory.tools;

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

35
  Device? device;
36

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

46
  @override
47
  Future<FlutterCommandResult> runCommand() async {
48
    final Device cachedDevice = device!;
49
    if (boolArg('clear')) {
50
      cachedDevice.clearLogs();
51
    }
52

53
    final DeviceLogReader logReader = await cachedDevice.getLogReader();
54

55
    globals.printStatus('Showing $logReader logs:');
56

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

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

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

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

88
    return FlutterCommandResult.success();
89 90
  }
}