Repository navigation
Expand file tree
/
Copy pathdevice.dart
More file actions
1542 lines (1363 loc) · 57.1 KB
/
Copy pathdevice.dart
File metadata and controls
1542 lines (1363 loc) · 57.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'dart:async';
import 'package:flutter_tools_core/flutter_tools_core.dart' as tools_core;
import 'package:meta/meta.dart';
import 'android/android_engine_cli_flags.dart';
import 'application_package.dart';
import 'base/context.dart';
import 'base/dds.dart';
import 'base/file_system.dart';
import 'base/logger.dart';
import 'base/utils.dart';
import 'build_info.dart';
import 'devfs.dart';
import 'device_port_forwarder.dart';
import 'device_vm_service_discovery_for_attach.dart';
import 'project.dart';
import 'vmservice.dart';
import 'web/compile.dart';
import 'web/devfs_config.dart';
DeviceManager? get deviceManager => context.get<DeviceManager>();
/// The user-visible category of a [Device].
typedef Category = tools_core.Category;
/// The platform sub-folder that a device type supports.
enum PlatformType {
web,
android,
ios,
linux,
macos,
windows,
fuchsia,
custom;
@override
String toString() => name;
static PlatformType? fromString(String platformType) => values.asNameMap()[platformType];
}
/// A discovery mechanism for flutter-supported development devices.
abstract class DeviceManager {
DeviceManager({required this._logger});
final Logger _logger;
/// Constructing DeviceManagers is cheap; they only do expensive work if some
/// of their methods are called.
List<DeviceDiscovery> get deviceDiscoverers;
String? _specifiedDeviceId;
/// A user-specified device ID.
String? get specifiedDeviceId {
if (_specifiedDeviceId == null || _specifiedDeviceId == 'all') {
return null;
}
return _specifiedDeviceId;
}
set specifiedDeviceId(String? id) {
_specifiedDeviceId = id;
}
/// A minimum duration to use when discovering wireless iOS devices.
static const minimumWirelessDeviceDiscoveryTimeout = Duration(seconds: 5);
/// True when the user has specified a single specific device.
bool get hasSpecifiedDeviceId => specifiedDeviceId != null;
/// True when the user has specified all devices by setting
/// specifiedDeviceId = 'all'.
bool get hasSpecifiedAllDevices => _specifiedDeviceId == 'all';
/// Get devices filtered by [filter] that match the given device id/name.
///
/// If [filter] is not provided, a default filter that requires devices to be
/// connected will be used.
///
/// If an exact match is found, return it immediately. Otherwise wait for all
/// discoverers to complete and return any partial matches.
Future<List<Device>> getDevicesById(String deviceId, {DeviceDiscoveryFilter? filter}) async {
filter ??= DeviceDiscoveryFilter();
final String lowerDeviceId = deviceId.toLowerCase();
bool exactlyMatchesDeviceId(Device device) =>
device.id.toLowerCase() == lowerDeviceId || device.name.toLowerCase() == lowerDeviceId;
bool startsWithDeviceId(Device device) =>
device.id.toLowerCase().startsWith(lowerDeviceId) ||
device.name.toLowerCase().startsWith(lowerDeviceId);
// Some discoverers have hard-coded device IDs and return quickly, and others
// shell out to other processes and can take longer.
// If an ID was specified, first check if it was a "well-known" device id.
final Set<String> wellKnownIds = _platformDiscoverers
.expand((DeviceDiscovery discovery) => discovery.wellKnownIds)
.toSet();
final bool hasWellKnownId = hasSpecifiedDeviceId && wellKnownIds.contains(specifiedDeviceId);
// Process discoverers as they can return results, so if an exact match is
// found quickly, we don't wait for all the discoverers to complete.
final prefixMatches = <Device>[];
final exactMatchCompleter = Completer<Device>();
final futureDevices = <Future<List<Device>?>>[
for (final DeviceDiscovery discoverer in _platformDiscoverers)
if (!hasWellKnownId || discoverer.wellKnownIds.contains(specifiedDeviceId))
discoverer
.devices(filter: filter)
.then(
(List<Device> devices) {
for (final device in devices) {
if (exactlyMatchesDeviceId(device)) {
exactMatchCompleter.complete(device);
return null;
}
if (startsWithDeviceId(device)) {
prefixMatches.add(device);
}
}
return null;
},
onError: (dynamic error, StackTrace stackTrace) {
// Return matches from other discoverers even if one fails.
_logger.printTrace('Ignored error discovering $deviceId: $error');
},
),
];
// Wait for an exact match, or for all discoverers to return results.
await Future.any<Object>(<Future<Object>>[
exactMatchCompleter.future,
Future.wait<List<Device>?>(futureDevices),
]);
if (exactMatchCompleter.isCompleted) {
return <Device>[await exactMatchCompleter.future];
}
return prefixMatches;
}
/// Returns a list of devices filtered by the user-specified device
/// id/name (if applicable) and [filter].
///
/// If [filter] is not provided, a default filter that requires devices to be
/// connected will be used.
Future<List<Device>> getDevices({DeviceDiscoveryFilter? filter}) {
filter ??= DeviceDiscoveryFilter();
final String? id = specifiedDeviceId;
if (id == null) {
return getAllDevices(filter: filter);
}
return getDevicesById(id, filter: filter);
}
Iterable<DeviceDiscovery> get _platformDiscoverers {
return deviceDiscoverers.where((DeviceDiscovery discoverer) => discoverer.supportsPlatform);
}
/// Returns a list of devices filtered by [filter].
///
/// If [filter] is not provided, a default filter that requires devices to be
/// connected will be used.
Future<List<Device>> getAllDevices({DeviceDiscoveryFilter? filter}) async {
filter ??= DeviceDiscoveryFilter();
final List<List<Device>> devices = await Future.wait<List<Device>>(<Future<List<Device>>>[
for (final DeviceDiscovery discoverer in _platformDiscoverers)
discoverer.devices(filter: filter),
]);
return devices.expand<Device>((List<Device> deviceList) => deviceList).toList();
}
/// Returns a list of devices filtered by [filter]. Discards existing cache of devices.
///
/// If [filter] is not provided, a default filter that requires devices to be
/// connected will be used.
///
/// Search for devices to populate the cache for no longer than [timeout].
Future<List<Device>> refreshAllDevices({Duration? timeout, DeviceDiscoveryFilter? filter}) async {
filter ??= DeviceDiscoveryFilter();
final List<List<Device>> devices = await Future.wait<List<Device>>(<Future<List<Device>>>[
for (final DeviceDiscovery discoverer in _platformDiscoverers)
discoverer.discoverDevices(filter: filter, timeout: timeout),
]);
return devices.expand<Device>((List<Device> deviceList) => deviceList).toList();
}
/// Discard existing cache of discoverers that are known to take longer to
/// discover wireless devices.
///
/// Then, search for devices for those discoverers to populate the cache for
/// no longer than [timeout].
Future<void> refreshExtendedWirelessDeviceDiscoverers({
Duration? timeout,
DeviceDiscoveryFilter? filter,
}) async {
await Future.wait<List<Device>>(<Future<List<Device>>>[
for (final DeviceDiscovery discoverer in _platformDiscoverers)
if (discoverer.requiresExtendedWirelessDeviceDiscovery)
discoverer.discoverDevices(timeout: timeout, forWirelessDiscovery: true),
]);
}
/// Stop any running extended wireless device discoverers.
void stopExtendedWirelessDeviceDiscoverers() {
for (final PollingDeviceDiscovery deviceDiscoverer
in _platformDiscoverers.whereType<PollingDeviceDiscovery>()) {
if (deviceDiscoverer.requiresExtendedWirelessDeviceDiscovery) {
deviceDiscoverer.cancelWirelessDiscovery();
}
}
}
/// Whether we're capable of listing any devices given the current environment configuration.
bool get canListAnything {
return _platformDiscoverers.any((DeviceDiscovery discoverer) => discoverer.canListAnything);
}
/// Get diagnostics about issues with any connected devices.
Future<List<String>> getDeviceDiagnostics() async {
return <String>[
for (final DeviceDiscovery discoverer in _platformDiscoverers)
...await discoverer.getDiagnostics(),
];
}
/// Determines how to filter devices.
///
/// By default, filters to only include devices that are supported by Flutter.
///
/// If the user has not specified a device, filters to only include devices
/// that are supported by Flutter and supported by the project.
///
/// If the user has specified `--device all`, filters to only include devices
/// that are supported by Flutter, supported by the project, and supported for `all`.
///
/// If [includeDevicesUnsupportedByProject] is true, all devices will be
/// considered supported by the project, regardless of user specifications.
///
/// This also exists to allow the check to be overridden for google3 clients.
DeviceDiscoverySupportFilter deviceSupportFilter({
bool includeDevicesUnsupportedByProject = false,
}) {
FlutterProject? flutterProject;
if (!includeDevicesUnsupportedByProject) {
flutterProject = FlutterProject.current();
}
if (hasSpecifiedAllDevices) {
return DeviceDiscoverySupportFilter.excludeDevicesUnsupportedByFlutterOrProjectOrAll(
flutterProject: flutterProject,
);
} else if (!hasSpecifiedDeviceId) {
return DeviceDiscoverySupportFilter.excludeDevicesUnsupportedByFlutterOrProject(
flutterProject: flutterProject,
);
} else {
return DeviceDiscoverySupportFilter.excludeDevicesUnsupportedByFlutter();
}
}
/// If the user did not specify to run all or a specific device, then attempt
/// to prioritize ephemeral devices.
///
/// If there is not exactly one ephemeral device return null.
///
/// For example, if the user only typed 'flutter run' and both an Android
/// device and desktop device are available, choose the Android device.
///
/// Note: ephemeral is nullable for device types where this is not well
/// defined.
Device? getSingleEphemeralDevice(List<Device> devices) {
if (!hasSpecifiedDeviceId) {
try {
return devices.singleWhere((Device device) => device.ephemeral);
} on StateError {
return null;
}
}
return null;
}
}
/// A class for determining how to filter devices based on if they are supported.
class DeviceDiscoverySupportFilter {
/// Filter devices to only include those supported by Flutter.
DeviceDiscoverySupportFilter.excludeDevicesUnsupportedByFlutter()
: _excludeDevicesNotSupportedByProject = false,
_excludeDevicesNotSupportedByAll = false,
_flutterProject = null;
/// Filter devices to only include those supported by Flutter and the
/// provided [_flutterProject].
///
/// If [_flutterProject] is null, all devices will be considered supported by
/// the project.
DeviceDiscoverySupportFilter.excludeDevicesUnsupportedByFlutterOrProject({
required this._flutterProject,
}) : _excludeDevicesNotSupportedByProject = true,
_excludeDevicesNotSupportedByAll = false;
/// Filter devices to only include those supported by Flutter, the provided
/// [_flutterProject], and `--device all`.
///
/// If [_flutterProject] is null, all devices will be considered supported by
/// the project.
DeviceDiscoverySupportFilter.excludeDevicesUnsupportedByFlutterOrProjectOrAll({
required this._flutterProject,
}) : _excludeDevicesNotSupportedByProject = true,
_excludeDevicesNotSupportedByAll = true;
final FlutterProject? _flutterProject;
final bool _excludeDevicesNotSupportedByProject;
final bool _excludeDevicesNotSupportedByAll;
Future<bool> matchesRequirements(Device device) async {
final bool meetsSupportByFlutterRequirement = await device.isSupported();
final bool meetsSupportForProjectRequirement =
!_excludeDevicesNotSupportedByProject || await isDeviceSupportedForProject(device);
final bool meetsSupportForAllRequirement =
!_excludeDevicesNotSupportedByAll || await isDeviceSupportedForAll(device);
return meetsSupportByFlutterRequirement &&
meetsSupportForProjectRequirement &&
meetsSupportForAllRequirement;
}
/// User has specified `--device all`.
///
/// Always remove web and fuchsia devices from `all`. This setting
/// currently requires devices to share a frontend_server and resident
/// runner instance. Both web and fuchsia require differently configured
/// compilers, and web requires an entirely different resident runner.
Future<bool> isDeviceSupportedForAll(Device device) async {
final TargetOperatingSystem deviceOS = (await device.targetPlatform).os;
return await device.isSupported() &&
deviceOS != .fuchsia &&
deviceOS != .web &&
await isDeviceSupportedForProject(device);
}
/// Returns whether the device is supported for the project.
///
/// A device can be supported by Flutter but not supported for the project
/// (e.g. when the user has removed the iOS directory from their project).
///
/// This also exists to allow the check to be overridden for google3 clients. If
/// [_flutterProject] is null then return true.
Future<bool> isDeviceSupportedForProject(Device device) async {
if (!await device.isSupported()) {
return false;
}
if (_flutterProject == null) {
return true;
}
return await device.isSupportedForProject(_flutterProject);
}
}
/// A class for filtering devices.
///
/// If [excludeDisconnected] is true, only devices detected as connected will be included.
///
/// If [supportFilter] is provided, only devices matching the requirements will be included.
///
/// If [deviceConnectionInterface] is provided, only devices matching the DeviceConnectionInterface will be included.
class DeviceDiscoveryFilter {
DeviceDiscoveryFilter({
this.excludeDisconnected = true,
this.supportFilter,
this.deviceConnectionInterface,
});
final bool excludeDisconnected;
final DeviceDiscoverySupportFilter? supportFilter;
final DeviceConnectionInterface? deviceConnectionInterface;
Future<bool> matchesRequirements(Device device) async {
final DeviceDiscoverySupportFilter? localSupportFilter = supportFilter;
final bool meetsConnectionRequirement = !excludeDisconnected || device.isConnected;
final bool meetsSupportRequirements =
localSupportFilter == null || (await localSupportFilter.matchesRequirements(device));
final bool meetsConnectionInterfaceRequirement = matchesDeviceConnectionInterface(
device,
deviceConnectionInterface,
);
return meetsConnectionRequirement &&
meetsSupportRequirements &&
meetsConnectionInterfaceRequirement;
}
Future<List<Device>> filterDevices(List<Device> devices) async {
devices = <Device>[
for (final Device device in devices)
if (await matchesRequirements(device)) device,
];
return devices;
}
bool matchesDeviceConnectionInterface(
Device device,
DeviceConnectionInterface? deviceConnectionInterface,
) {
if (deviceConnectionInterface == null) {
return true;
}
return device.connectionInterface == deviceConnectionInterface;
}
}
/// An abstract class to discover and enumerate a specific type of devices.
abstract class DeviceDiscovery {
bool get supportsPlatform;
/// Whether this device discovery is capable of listing any devices given the
/// current environment configuration.
bool get canListAnything;
/// Whether this device discovery is known to take longer to discover
/// wireless devices.
bool get requiresExtendedWirelessDeviceDiscovery => false;
/// Return all connected devices, cached on subsequent calls.
Future<List<Device>> devices({DeviceDiscoveryFilter? filter});
/// Return all connected devices. Discards existing cache of devices.
Future<List<Device>> discoverDevices({
Duration? timeout,
DeviceDiscoveryFilter? filter,
bool forWirelessDiscovery = false,
});
/// Gets a list of diagnostic messages pertaining to issues with any connected
/// devices (will be an empty list if there are no issues).
Future<List<String>> getDiagnostics() => Future<List<String>>.value(<String>[]);
/// Hard-coded device IDs that the discoverer can produce.
///
/// These values are used by the device discovery to determine if it can
/// short-circuit the other detectors if a specific ID is provided. If a
/// discoverer has no valid fixed IDs, these should be left empty.
///
/// For example, 'windows' or 'linux'.
List<String> get wellKnownIds;
}
/// A [DeviceDiscovery] implementation that uses polling to discover device adds
/// and removals.
abstract class PollingDeviceDiscovery extends DeviceDiscovery {
PollingDeviceDiscovery(this.name);
static const _pollingInterval = Duration(seconds: 4);
static const _pollingTimeout = Duration(seconds: 30);
final String name;
@protected
@visibleForTesting
final deviceNotifier = ItemListNotifier<Device>();
Timer? _timer;
Future<List<Device>> pollingGetDevices({Duration? timeout, bool forWirelessDiscovery = false});
void startPolling() {
// Make initial population the default, fast polling timeout.
_timer ??= _initTimer(null, initialCall: true);
}
Timer _initTimer(Duration? pollingTimeout, {bool initialCall = false}) {
// Poll for devices immediately on the initial call for faster initial population.
return Timer(initialCall ? Duration.zero : _pollingInterval, () async {
try {
final List<Device> devices = await pollingGetDevices(timeout: pollingTimeout);
deviceNotifier.updateWithNewList(devices);
} on TimeoutException {
// Do nothing on a timeout.
}
// Subsequent timeouts after initial population should wait longer.
_timer = _initTimer(_pollingTimeout);
});
}
void stopPolling() {
_timer?.cancel();
_timer = null;
}
/// Cancels any in-progress, long-running wireless discovery processes.
Future<void> cancelWirelessDiscovery() async {}
/// Get devices from cache filtered by [filter].
///
/// If the cache is empty, populate the cache.
///
/// If [filter] is null, it may return devices that are not connected.
@override
Future<List<Device>> devices({DeviceDiscoveryFilter? filter}) {
return _populateDevices(filter: filter);
}
/// Empty the cache and repopulate it before getting devices from cache filtered by [filter].
///
/// Search for devices to populate the cache for no longer than [timeout].
///
/// If [filter] is null, it may return devices that are not connected.
@override
Future<List<Device>> discoverDevices({
Duration? timeout,
DeviceDiscoveryFilter? filter,
bool forWirelessDiscovery = false,
}) {
return _populateDevices(
timeout: timeout,
filter: filter,
resetCache: true,
forWirelessDiscovery: forWirelessDiscovery,
);
}
/// Get devices from cache filtered by [filter].
///
/// If the cache is empty or [resetCache] is true, populate the cache.
///
/// Search for devices to populate the cache for no longer than [timeout].
Future<List<Device>> _populateDevices({
Duration? timeout,
DeviceDiscoveryFilter? filter,
bool resetCache = false,
bool forWirelessDiscovery = false,
}) async {
if (!deviceNotifier.isPopulated || resetCache) {
final List<Device> devices = await pollingGetDevices(
timeout: timeout,
forWirelessDiscovery: forWirelessDiscovery,
);
// If the cache was populated while the polling was ongoing, do not
// overwrite the cache unless it's explicitly refreshing the cache.
if (!deviceNotifier.isPopulated || resetCache) {
deviceNotifier.updateWithNewList(devices);
}
}
// If a filter is provided, filter cache to only return devices matching.
if (filter != null) {
return filter.filterDevices(deviceNotifier.items);
}
return deviceNotifier.items;
}
Stream<Device> get onAdded {
return deviceNotifier.onAdded;
}
Stream<Device> get onRemoved {
return deviceNotifier.onRemoved;
}
void dispose() => stopPolling();
@override
String toString() => '$name device discovery';
}
/// How a device is connected.
enum DeviceConnectionInterface { attached, wireless }
/// Returns the `DeviceConnectionInterface` enum based on its string name.
DeviceConnectionInterface getDeviceConnectionInterfaceForName(String name) {
return switch (name) {
'attached' => DeviceConnectionInterface.attached,
'wireless' => DeviceConnectionInterface.wireless,
_ => throw Exception('Unsupported DeviceConnectionInterface name "$name"'),
};
}
/// Returns a `DeviceConnectionInterface`'s string name.
String getNameForDeviceConnectionInterface(DeviceConnectionInterface connectionInterface) {
return switch (connectionInterface) {
DeviceConnectionInterface.attached => 'attached',
DeviceConnectionInterface.wireless => 'wireless',
};
}
/// A device is a physical hardware that can run a Flutter application.
///
/// This may correspond to a connected iOS or Android device, or represent
/// the host operating system in the case of Flutter Desktop.
abstract class Device {
Device(
this.id, {
required Logger logger,
required this.category,
required this.platformType,
required this.ephemeral,
}) : dds = DartDevelopmentService(logger: logger);
final String id;
/// The [Category] for this device type.
final Category? category;
/// The [PlatformType] for this device.
final PlatformType? platformType;
/// Whether this is an ephemeral device.
final bool ephemeral;
bool get isConnected => true;
DeviceConnectionInterface get connectionInterface => DeviceConnectionInterface.attached;
bool get isWirelesslyConnected => connectionInterface == DeviceConnectionInterface.wireless;
String get name;
String get displayName {
String result = name;
if (isWirelesslyConnected) {
result += ' (wireless)';
}
return result;
}
bool get supportsStartPaused => true;
/// Whether it is an emulated device running on localhost.
///
/// This may return `true` for certain physical Android devices, and is
/// generally only a best effort guess.
Future<bool> get isLocalEmulator;
/// The unique identifier for the emulator that corresponds to this device, or
/// null if it is not an emulator.
///
/// The ID returned matches that in the output of `flutter emulators`. Fetching
/// this name may require connecting to the device and if an error occurs null
/// will be returned.
Future<String?> get emulatorId;
/// Whether this device can run the provided [buildMode].
///
/// For example, some emulator architectures cannot run profile or
/// release builds.
FutureOr<bool> supportsRuntimeMode(BuildMode buildMode) => true;
/// Whether the device is a simulator on a platform which supports hardware rendering.
// This is soft-deprecated since the logic is not correct expect for iOS simulators.
Future<bool> get supportsHardwareRendering async {
return true;
}
/// Whether the device is supported for the current project directory.
FutureOr<bool> isSupportedForProject(FlutterProject flutterProject);
/// Check if a version of the given app is already installed.
///
/// Specify [userIdentifier] to check if installed for a particular user (Android only).
Future<bool> isAppInstalled(ApplicationPackage app, {String? userIdentifier});
/// Check if the latest build of the [app] is already installed.
Future<bool> isLatestBuildInstalled(ApplicationPackage app);
/// Install an app package on the current device.
///
/// Specify [userIdentifier] to install for a particular user (Android only).
Future<bool> installApp(ApplicationPackage app, {String? userIdentifier});
/// Uninstall an app package from the current device.
///
/// Specify [userIdentifier] to uninstall for a particular user,
/// defaults to all users (Android only).
Future<bool> uninstallApp(ApplicationPackage app, {String? userIdentifier});
/// Check if the device is supported by Flutter.
Future<bool> isSupported();
// String meant to be displayed to the user indicating if the device is
// supported by Flutter, and, if not, why.
Future<String> supportMessage() async => await isSupported() ? 'Supported' : 'Unsupported';
/// The device's platform.
Future<TargetPlatform> get targetPlatform;
/// The CPU architecture of the device.
Future<CpuArch> get cpuArch;
/// Platform name for display only.
Future<String> get targetPlatformDisplayName async => (await targetPlatform).getName();
Future<String> get sdkNameAndVersion;
/// Create a platform-specific [DevFSWriter] for the given [app], or
/// null if the device does not support them.
///
/// For example, the desktop device classes can use a writer which
/// copies the files across the local file system.
DevFSWriter? createDevFSWriter(ApplicationPackage? app, String? userIdentifier) {
return null;
}
/// Get a log reader for this device.
///
/// If `app` is specified, this will return a log reader specific to that
/// application. Otherwise, a global log reader will be returned.
///
/// If `includePastLogs` is true and the device type supports it, the log
/// reader will also include log messages from before the invocation time.
/// Defaults to false.
FutureOr<DeviceLogReader> getLogReader({ApplicationPackage? app, bool includePastLogs = false});
/// Get the port forwarder for this device.
DevicePortForwarder? get portForwarder;
/// Get the DDS instance for this device.
final DartDevelopmentService dds;
/// Get the DevTools URI for the application instance.
Uri? get devToolsUri => dds.devToolsUri;
/// Clear the device's logs.
void clearLogs();
/// Get the [VMServiceDiscoveryForAttach] instance for this device, which
/// discovers, and forwards any necessary ports to the vm service uri of a
/// running app on the device.
///
/// If `appId` is specified, on supported platforms, the service discovery
/// will only return the VM service URI from the given app.
///
/// If `fuchsiaModule` is specified, this will only return the VM service uri
/// from the specified Fuchsia module.
///
/// If `filterDevicePort` is specified, this will only return the VM service
/// uri that matches the given port on the device.
VMServiceDiscoveryForAttach getVMServiceDiscoveryForAttach({
String? appId,
String? fuchsiaModule,
int? filterDevicePort,
int? expectedHostPort,
required bool ipv6,
required Logger logger,
}) => LogScanningVMServiceDiscoveryForAttach(
Future<DeviceLogReader>.value(getLogReader()),
portForwarder: portForwarder,
devicePort: filterDevicePort,
hostPort: expectedHostPort,
ipv6: ipv6,
logger: logger,
);
/// Start an app package on the current device.
///
/// [platformArgs] allows callers to pass platform-specific arguments to the
/// start call. The build mode is not used by all platforms.
Future<LaunchResult> startApp(
covariant ApplicationPackage? package, {
String? mainPath,
String? route,
required DebuggingOptions debuggingOptions,
Map<String, Object?> platformArgs,
bool prebuiltApplication = false,
String? userIdentifier,
});
/// Whether this device implements support for hot reload.
bool get supportsHotReload => true;
/// Whether this device implements support for hot restart.
bool get supportsHotRestart => true;
/// Whether Flutter applications running on this device can be terminated
/// from the VM Service.
bool get supportsFlutterExit => true;
/// Whether the device supports taking screenshots of a running flutter
/// application.
bool get supportsScreenshot => false;
/// Whether the Flavors feature ('--flavor') is supported for this device.
bool get supportsFlavors => false;
/// Stop an app package on the current device.
///
/// Specify [userIdentifier] to stop app installed to a profile (Android only).
Future<bool> stopApp(ApplicationPackage? app, {String? userIdentifier});
/// Query the current application memory usage..
///
/// If the device does not support this callback, an empty map
/// is returned.
Future<MemoryInfo> queryMemoryInfo() {
return Future<MemoryInfo>.value(const MemoryInfo.empty());
}
Future<void> takeScreenshot(File outputFile) => Future<void>.error('unimplemented');
@nonVirtual
@override
// ignore: avoid_equals_and_hash_code_on_mutable_classes
int get hashCode => id.hashCode;
@nonVirtual
@override
// ignore: avoid_equals_and_hash_code_on_mutable_classes
bool operator ==(Object other) {
if (identical(this, other)) {
return true;
}
return other is Device && other.id == id;
}
@override
String toString() => name;
static Future<List<String>> descriptions(List<Device> devices) async {
if (devices.isEmpty) {
return const <String>[];
}
// Extract device information
final table = <List<String>>[];
for (final device in devices) {
var supportIndicator = await device.isSupported() ? '' : ' (unsupported)';
final TargetPlatform targetPlatform = await device.targetPlatform;
if (await device.isLocalEmulator) {
final type = targetPlatform == TargetPlatform.ios ? 'simulator' : 'emulator';
supportIndicator += ' ($type)';
}
table.add(<String>[
'${device.displayName} (${device.category})',
device.id,
await device.targetPlatformDisplayName,
'${await device.sdkNameAndVersion}$supportIndicator',
]);
}
// Join columns into lines of text
return formatTable(table);
}
static Future<void> printDevices(
List<Device> devices,
Logger logger, {
String prefix = '',
}) async {
for (final String line in await descriptions(devices)) {
logger.printStatus('$prefix$line');
}
}
static List<String> devicesPlatformTypes(List<Device> devices) {
return devices.map((Device d) => d.platformType.toString()).toSet().toList()..sort();
}
/// Convert the Device object to a JSON representation suitable for serialization.
Future<Map<String, Object>> toJson() async {
final bool isLocalEmu = await isLocalEmulator;
return <String, Object>{
'name': name,
'id': id,
'isSupported': await isSupported(),
'targetPlatform': (await targetPlatform).getName(),
'cpuArch': (await cpuArch).name,
'emulator': isLocalEmu,
'sdk': await sdkNameAndVersion,
'capabilities': <String, Object>{
'hotReload': supportsHotReload,
'hotRestart': supportsHotRestart,
'screenshot': supportsScreenshot,
'flutterExit': supportsFlutterExit,
'hardwareRendering': isLocalEmu && await supportsHardwareRendering,
'startPaused': supportsStartPaused,
},
};
}
/// Clean up resources allocated by device.
///
/// For example log readers or port forwarders.
Future<void> dispose();
}
/// Information about an application's memory usage.
abstract class MemoryInfo {
/// Const constructor to allow subclasses to be const.
const MemoryInfo();
/// Create a [MemoryInfo] object with no information.
const factory MemoryInfo.empty() = _NoMemoryInfo;
/// Convert the object to a JSON representation suitable for serialization.
Map<String, Object> toJson();
}
class _NoMemoryInfo implements MemoryInfo {
const _NoMemoryInfo();
@override
Map<String, Object> toJson() => <String, Object>{};
}
enum ImpellerStatus {
platformDefault._(null),
enabled._(true),
disabled._(false);
const ImpellerStatus._(this.asBool);
factory ImpellerStatus.fromBool(bool? b) => switch (b) {
true => enabled,
false => disabled,
null => platformDefault,
};
final bool? asBool;
}
class DebuggingOptions {
DebuggingOptions.enabled(
this.buildInfo, {
this.startPaused = false,
this.disableServiceAuthCodes = false,
this.disableServiceOriginCheck = false,
this.enableDds = true,
this.cacheStartupProfile = false,
this.dartEntrypointArgs = const <String>[],
this.dartFlags = '',
this.enableSoftwareRendering = false,
this.skiaDeterministicRendering = false,
this.traceSkia = false,
this.traceAllowlist,
this.traceSkiaAllowlist,
this.traceSystrace = false,
this.traceToFile,
this.endlessTraceBuffer = false,
this.profileMicrotasks = false,
this.purgePersistentCache = false,
this.useTestFonts = false,
this.verboseSystemLogs = false,
this.hostVmServicePort,
this.disablePortPublication = false,
this.deviceVmServicePort,
this.ddsPort,
this.devToolsServerAddress,
this.webEnableExposeUrl,
this.webUseSseForDebugProxy = true,
this.webUseSseForDebugBackend = true,
this.webUseSseForInjectedClient = true,
this.webRunHeadless = false,
this.webBrowserDebugPort,
this.webBrowserFlags = const <String>[],
this.webEnableExpressionEvaluation = false,
this.webLaunchUrl,
bool? webCrossOriginIsolation,
WebRendererMode? webRenderer,
this.webUseWasm = false,
this.vmserviceOutFile,
this.nativeNullAssertions = false,
this.enableImpeller = ImpellerStatus.platformDefault,
this.enableFlutterGpu = false,
this.enableVulkanValidation = false,
this.uninstallFirst = false,
this.uninstallApp = true,
this.enableDartProfiling = true,
this.enableHcpp,
this.profileStartup = false,
this.enableEmbedderApi = false,
this.usingCISystem = false,
this.debugLogsDirectoryPath,
this.enableDevTools = true,
this.ipv6 = false,
this.google3WorkspaceRoot,
this.printDtd = false,
this.webDevServerConfig,
this.testFlag = false,
this.adbLogFiltering = true,
this.iosProfileDebugger,
}) : debuggingEnabled = true,
webCrossOriginIsolation = webCrossOriginIsolation ?? webUseWasm,
webRenderer = webRenderer ?? WebRendererMode.getDefault(useWasm: webUseWasm);
DebuggingOptions.disabled(
this.buildInfo, {
this.dartEntrypointArgs = const <String>[],
this.webEnableExposeUrl,
this.webUseSseForDebugProxy = true,
this.webUseSseForDebugBackend = true,
this.webUseSseForInjectedClient = true,
this.webRunHeadless = false,
this.webBrowserDebugPort,