[device_info_plus] add toMap

packages/device_info_plus/device_info_plus/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.2.0
+
+- add `deviceInfo`
+
 ## 3.1.1
 
 - add toMap to WebBrowserInfo

packages/device_info_plus/device_info_plus/README.md

@@ -37,6 +37,17 @@ WebBrowserInfo webBrowserInfo = await deviceInfo.webBrowserInfo;
 print('Running on ${webBrowserInfo.userAgent}');  // e.g. "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:61.0) Gecko/20100101 Firefox/61.0"
 ```
 
+One common use case for this plugin is obtaining device information for telemetry or crash-reporting purposes. In this scenario your app is not interested in specific properties, instead it wants to send all it knows about the device to your backend service for further analysis. You can leverage `deviceInfo` property, which returns platform-specific device information in a generic way. You then use it's `toMap` method to serialize all known properties to a `Map`. Your backend service should be prepared to handle new properties, which can be added to this plugin in the future.
+
+```dart
+import 'package:device_info_plus/device_info_plus.dart';
+
+final deviceInfoPlugin = DeviceInfoPlugin();
+final deviceInfo = await deviceInfoPlugin.deviceInfo;
+final map = deviceInfo.toMap();
+// Push [map] to your service.
+```
+
 You will find links to the API docs on the [pub page](https://pub.dev/packages/device_info_plus).
 
 Check out our documentation website to learn more. [Plus plugins documentation](https://plus.fluttercommunity.dev/docs/overview)

packages/device_info_plus/device_info_plus/example/test_driver/device_info_plus_e2e.dart

@@ -19,41 +19,50 @@ void main() {
   WindowsDeviceInfo windowsInfo;
   LinuxDeviceInfo linuxInfo;
   MacOsDeviceInfo macosInfo;
+  BaseDeviceInfo deviceInfo;
 
   setUpAll(() async {
     final deviceInfoPlugin = DeviceInfoPlugin();
-    if (Platform.isIOS) {
-      iosInfo = await deviceInfoPlugin.iosInfo;
-    } else if (Platform.isAndroid) {
-      androidInfo = await deviceInfoPlugin.androidInfo;
-    } else if (Platform.isWindows) {
-      windowsInfo = await deviceInfoPlugin.windowsInfo;
-    } else if (Platform.isLinux) {
-      linuxInfo = await deviceInfoPlugin.linuxInfo;
-    } else if (Platform.isMacOS) {
-      macosInfo = await deviceInfoPlugin.macOsInfo;
-    }
-
     if (kIsWeb) {
       webBrowserInfo = await deviceInfoPlugin.webBrowserInfo;
+    } else {
+      if (Platform.isIOS) {
+        iosInfo = await deviceInfoPlugin.iosInfo;
+      } else if (Platform.isAndroid) {
+        androidInfo = await deviceInfoPlugin.androidInfo;
+      } else if (Platform.isWindows) {
+        windowsInfo = await deviceInfoPlugin.windowsInfo;
+      } else if (Platform.isLinux) {
+        linuxInfo = await deviceInfoPlugin.linuxInfo;
+      } else if (Platform.isMacOS) {
+        macosInfo = await deviceInfoPlugin.macOsInfo;
+      }
     }
+
+    deviceInfo = await deviceInfoPlugin.deviceInfo;
   });
 
   testWidgets('Can get non-null device model', (WidgetTester tester) async {
-    if (Platform.isIOS) {
-      expect(iosInfo.model, isNotNull);
-    } else if (Platform.isAndroid) {
-      expect(androidInfo.model, isNotNull);
-    } else if (Platform.isWindows) {
-      expect(windowsInfo.computerName, isNotNull);
-    } else if (Platform.isLinux) {
-      expect(linuxInfo.name, isNotNull);
-    } else if (Platform.isMacOS) {
-      expect(macosInfo.computerName, isNotNull);
-    }
-
     if (kIsWeb) {
       expect(webBrowserInfo.userAgent, isNotNull);
+      expect(deviceInfo, same(webBrowserInfo));
+    } else {
+      if (Platform.isIOS) {
+        expect(iosInfo.model, isNotNull);
+        expect(deviceInfo, same(iosInfo));
+      } else if (Platform.isAndroid) {
+        expect(androidInfo.model, isNotNull);
+        expect(deviceInfo, same(androidInfo));
+      } else if (Platform.isWindows) {
+        expect(windowsInfo.computerName, isNotNull);
+        expect(deviceInfo, same(windowsInfo));
+      } else if (Platform.isLinux) {
+        expect(linuxInfo.name, isNotNull);
+        expect(deviceInfo, same(linuxInfo));
+      } else if (Platform.isMacOS) {
+        expect(macosInfo.computerName, isNotNull);
+        expect(deviceInfo, same(macosInfo));
+      }
     }
   });
 }

packages/device_info_plus/device_info_plus/example/test_driver/device_info_plus_e2e_test.dart

@@ -4,16 +4,6 @@
 
 // @dart=2.9
 
-import 'dart:async';
-import 'dart:convert';
-import 'dart:io';
-import 'package:flutter_driver/flutter_driver.dart';
+import 'package:integration_test/integration_test_driver.dart';
 
-Future<void> main() async {
-  final driver = await FlutterDriver.connect();
-  final data =
-      await driver.requestData(null, timeout: const Duration(minutes: 1));
-  await driver.close();
-  final Map<String, dynamic> result = jsonDecode(data);
-  exit(result['result'] == 'true' ? 0 : 1);
-}
+Future<void> main() => integrationDriver();

packages/device_info_plus/device_info_plus/lib/device_info_plus.dart

@@ -3,12 +3,15 @@
 // found in the LICENSE file.
 
 import 'dart:async';
+import 'dart:io';
 
 import 'package:device_info_plus_platform_interface/device_info_plus_platform_interface.dart';
+import 'package:flutter/foundation.dart';
 export 'package:device_info_plus_platform_interface/device_info_plus_platform_interface.dart'
     show
         AndroidBuildVersion,
         AndroidDeviceInfo,
+        BaseDeviceInfo,
         IosDeviceInfo,
         IosUtsname,
         LinuxDeviceInfo,
@@ -76,4 +79,25 @@ class DeviceInfoPlugin {
   /// Returns device information for Windows.
   Future<WindowsDeviceInfo> get windowsInfo async =>
       _cachedWindowsDeviceInfo ??= await _platform.windowsInfo()!;
+
+  /// Returns device information for the current platform.
+  Future<BaseDeviceInfo> get deviceInfo async {
+    if (kIsWeb) {
+      return webBrowserInfo;
+    } else {
+      if (Platform.isAndroid) {
+        return androidInfo;
+      } else if (Platform.isIOS) {
+        return iosInfo;
+      } else if (Platform.isLinux) {
+        return linuxInfo;
+      } else if (Platform.isMacOS) {
+        return macOsInfo;
+      } else if (Platform.isWindows) {
+        return windowsInfo;
+      }
+    }
+
+    throw UnsupportedError('Unsupported platform');
+  }
 }

packages/device_info_plus/device_info_plus/pubspec.yaml

@@ -1,7 +1,7 @@
 name: device_info_plus
 description: Flutter plugin providing detailed information about the device
   (make, model, etc.), and Android or iOS version the app is running on.
-version: 3.1.1
+version: 3.2.0
 homepage: https://plus.fluttercommunity.dev/
 repository: https://github.com/fluttercommunity/plus_plugins/tree/main/packages/
 
@@ -25,7 +25,7 @@ flutter:
 dependencies:
   flutter:
     sdk: flutter
-  device_info_plus_platform_interface: ^2.2.0
+  device_info_plus_platform_interface: ^2.3.0
   device_info_plus_linux: ^2.1.0
   device_info_plus_macos: ^2.2.0
   device_info_plus_web: ^2.1.0

packages/device_info_plus/device_info_plus_platform_interface/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 2.3.0
+
+- add `BaseDeviceInfo`
+
 ## 2.2.1
 
 - add toMap to WebBrowserInfo

packages/device_info_plus/device_info_plus_platform_interface/lib/device_info_plus_platform_interface.dart

@@ -17,11 +17,11 @@ import 'model/web_browser_info.dart';
 import 'model/windows_device_info.dart';
 
 export 'model/android_device_info.dart';
+export 'model/base_device_info.dart';
 export 'model/ios_device_info.dart';
 export 'model/linux_device_info.dart';
 export 'model/macos_device_info.dart';
 export 'model/web_browser_info.dart';
-export 'model/macos_device_info.dart';
 export 'model/windows_device_info.dart';
 
 /// The interface that implementations of device_info must implement.

packages/device_info_plus/device_info_plus_platform_interface/lib/model/android_device_info.dart

@@ -2,10 +2,12 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import 'base_device_info.dart';
+
 /// Information derived from `android.os.Build`.
 ///
 /// See: https://developer.android.com/reference/android/os/Build.html
-class AndroidDeviceInfo {
+class AndroidDeviceInfo implements BaseDeviceInfo {
   /// Android device Info class.
   AndroidDeviceInfo({
     required this.version,
@@ -110,7 +112,8 @@ class AndroidDeviceInfo {
   /// https://developer.android.com/reference/android/content/pm/PackageManager
   final List<String?> systemFeatures;
 
-  /// Serializes [ AndroidDeviceInfo ] to map.
+  /// Serializes [AndroidDeviceInfo] to map.
+  @override
   Map<String, dynamic> toMap() {
     return {
       'id': id,

packages/device_info_plus/device_info_plus_platform_interface/lib/model/base_device_info.dart

@@ -0,0 +1,5 @@
+/// The base class for platform's device info.
+abstract class BaseDeviceInfo {
+  /// Serializes device info properties to a map.
+  Map<String, dynamic> toMap();
+}

packages/device_info_plus/device_info_plus_platform_interface/lib/model/ios_device_info.dart

@@ -2,10 +2,12 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import 'base_device_info.dart';
+
 /// Information derived from `UIDevice`.
 ///
 /// See: https://developer.apple.com/documentation/uikit/uidevice
-class IosDeviceInfo {
+class IosDeviceInfo implements BaseDeviceInfo {
   /// IOS device info class.
   const IosDeviceInfo({
     this.name,
@@ -57,7 +59,8 @@ class IosDeviceInfo {
     );
   }
 
-  /// Serializes [ IosDeviceInfo ] to a map.
+  /// Serializes [IosDeviceInfo] to a map.
+  @override
   Map<String, dynamic> toMap() {
     return {
       'name': name,

packages/device_info_plus/device_info_plus_platform_interface/lib/model/linux_device_info.dart

@@ -2,12 +2,14 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import 'base_device_info.dart';
+
 /// Device information for a Linux system.
 ///
 /// See:
 /// - https://www.freedesktop.org/software/systemd/man/os-release.html
 /// - https://www.freedesktop.org/software/systemd/man/machine-id.html
-class LinuxDeviceInfo {
+class LinuxDeviceInfo implements BaseDeviceInfo {
   /// Constructs a LinuxDeviceInfo.
   /// A string identifying the operating system, without a version component,
 
@@ -137,4 +139,22 @@ class LinuxDeviceInfo {
   /// boot. The machine ID is hexadecimal, 32-character, lowercase ID. When
   /// decoded from hexadecimal, this corresponds to a 16-byte/128-bit value.
   final String? machineId;
+
+  /// Serializes [LinuxDeviceInfo] to a map.
+  @override
+  Map<String, dynamic> toMap() {
+    return {
+      'name': name,
+      'version': version,
+      'id': id,
+      'idLike': idLike,
+      'versionCodename': versionCodename,
+      'versionId': versionId,
+      'prettyName': prettyName,
+      'buildId': buildId,
+      'variant': variant,
+      'variantId': variantId,
+      'machineId': machineId,
+    };
+  }
 }

packages/device_info_plus/device_info_plus_platform_interface/lib/model/macos_device_info.dart

@@ -2,8 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import 'base_device_info.dart';
+
 /// Object encapsulating MACOS device information.
-class MacOsDeviceInfo {
+class MacOsDeviceInfo implements BaseDeviceInfo {
   /// Constructs a MacOsDeviceInfo.
   const MacOsDeviceInfo({
     required this.computerName,
@@ -52,7 +54,8 @@ class MacOsDeviceInfo {
   /// Device GUID
   final String? systemGUID;
 
-  /// Serializes [ MacOsDeviceInfo ] to map.
+  /// Serializes [MacOsDeviceInfo] to map.
+  @override
   Map<String, dynamic> toMap() {
     return {
       'arch': arch,

packages/device_info_plus/device_info_plus_platform_interface/lib/model/web_browser_info.dart

@@ -2,6 +2,8 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import 'base_device_info.dart';
+
 /// List of supported browsers
 enum BrowserName {
   /// Mozilla Firefox
@@ -32,7 +34,7 @@ enum BrowserName {
 /// Information derived from `navigator`.
 ///
 /// See: https://developer.mozilla.org/en-US/docs/Web/API/Window/navigator
-class WebBrowserInfo {
+class WebBrowserInfo implements BaseDeviceInfo {
   /// Web Browser info class.
   WebBrowserInfo({
     required this.appCodeName,
@@ -126,7 +128,8 @@ class WebBrowserInfo {
     );
   }
 
-  /// Serializes [ WebBrowserInfo ] to a map.
+  /// Serializes [WebBrowserInfo] to a map.
+  @override
   Map<String, dynamic> toMap() {
     return {
       'browserName': browserName,

packages/device_info_plus/device_info_plus_platform_interface/lib/model/windows_device_info.dart

@@ -2,8 +2,10 @@
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
+import 'base_device_info.dart';
+
 /// Object encapsulating WINDOWS device information.
-class WindowsDeviceInfo {
+class WindowsDeviceInfo implements BaseDeviceInfo {
   /// Constructs a [WindowsDeviceInfo].
   WindowsDeviceInfo({
     required this.computerName,
@@ -20,4 +22,14 @@ class WindowsDeviceInfo {
   /// The physically installed memory in the computer.
   /// This may not be the same as available memory.
   final int systemMemoryInMegabytes;
+
+  /// Serializes [WindowsDeviceInfo] to a map.
+  @override
+  Map<String, dynamic> toMap() {
+    return {
+      'computerName': computerName,
+      'numberOfCores': numberOfCores,
+      'systemMemoryInMegabytes': systemMemoryInMegabytes,
+    };
+  }
 }

packages/device_info_plus/device_info_plus_platform_interface/pubspec.yaml

@@ -1,6 +1,6 @@
 name: device_info_plus_platform_interface
 description: A common platform interface for the device_info_plus plugin.
-version: 2.2.1
+version: 2.3.0
 homepage: https://plus.fluttercommunity.dev/
 repository: https://github.com/fluttercommunity/plus_plugins/tree/main/packages/