expand feedback diagnostics

Author: stephane-archer

.github/workflows/ci.yml

@@ -16,19 +16,19 @@ jobs:
       fail-fast: false
       matrix:
         sdk:
-          - '3.27.0'
+          - '3.29.0'
           - stable
 
     steps:
       - name: Check out repository
         uses: actions/checkout@v6
 
-      - name: Set up Flutter 3.27.0
-        if: matrix.sdk == '3.27.0'
+      - name: Set up Flutter 3.29.0
+        if: matrix.sdk == '3.29.0'
         uses: subosito/flutter-action@v2
         with:
           channel: stable
-          flutter-version: '3.27.0'
+          flutter-version: '3.29.0'
           cache: true
 
       - name: Set up current Flutter stable

CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.4.0
+
+* Add system and resolved application locales to runtime diagnostics.
+* Add current-view logical size and device pixel ratio when a diagnostics
+  context is available.
+* Add native process architecture and a privacy-safe device model where the
+  platform exposes one reliably.
+* Add an optional `diagnosticsContext` argument to `sendEmail`; the packaged
+  widget supplies it automatically.
+* Keep package and device metadata collection independent and best-effort.
+* Add `device_info_plus` 11.3.3 through 11.x and raise the package minimums to
+  Dart 3.7 and Flutter 3.29.
+
 ## 0.3.0
 
 * Add an optional pre-filled email body.

README.md

@@ -8,14 +8,16 @@ client with a pre-filled feedback message.
 ## Features
 
 - Pre-fills the recipient, subject, and optional email body.
-- Optionally includes application and operating-system diagnostics.
+- Optionally includes privacy-safe application, operating-system, device, and
+  display diagnostics.
 - Accepts application-specific diagnostic fields.
 
 ## Requirements
 
-- Dart 3.6 or later.
-- Flutter 3.27 or later.
+- Dart 3.7 or later.
+- Flutter 3.29 or later.
 - This package uses `package_info_plus` 8.3.1 through 8.x.
+- This package uses `device_info_plus` 11.3.3 through 11.x.
 - Android builds require API 19 or later, compile SDK 34, Java 17, Android
   Gradle Plugin 8.3 or later, and Gradle 8.4 or later.
 - Apple builds require iOS 12 or later and macOS 10.14 or later.
@@ -47,9 +49,16 @@ class FeedbackButton extends StatelessWidget {
 ```
 
 When runtime diagnostics are enabled, the package includes the application
-name, package identifier, version/build number, operating-system name, and OS
-version. Values passed through `additionalDiagnostics` are controlled entirely
-by the calling application.
+name, package identifier, version/build number, operating-system name and
+version, system locales, native process architecture, and a non-identifying
+device model where the platform provides one reliably. The widget also reports
+the resolved app locale, logical window size, and device pixel ratio from its
+own widget context.
+
+The default diagnostics deliberately exclude CPU names, emulator status,
+user-assigned device and host names, usernames, GUIDs, machine IDs, vendor
+identifiers, and other unique identifiers. Values passed through
+`additionalDiagnostics` are controlled entirely by the calling application.
 
 If runtime metadata cannot be collected, the email launch is still attempted
 and the message reports that runtime diagnostics were unavailable.
@@ -70,6 +79,7 @@ final launchRequested = await sendEmail(
   emailSubject: 'App feedback',
   emailBody: 'Please describe the issue:',
   includeRuntimeDiagnostics: true,
+  diagnosticsContext: context,
   additionalDiagnostics: {
     'Current screen': 'Export',
   },
@@ -79,3 +89,9 @@ if (!launchRequested) {
   // Show an alternative contact method.
 }
 ```
+
+Passing `diagnosticsContext` lets the utility report the locale resolved by the
+nearest Flutter `Localizations` widget and metrics for the current view. It is
+optional: calls without it still receive system locales and the other global
+runtime diagnostics. This distinction matters when an app falls back to a
+different language than the user's first system locale.

example/macos/Flutter/GeneratedPluginRegistrant.swift

@@ -5,10 +5,12 @@
 import FlutterMacOS
 import Foundation
 
+import device_info_plus
 import package_info_plus
 import url_launcher_macos
 
 func RegisterGeneratedPlugins(registry: FlutterPluginRegistry) {
+  DeviceInfoPlusMacosPlugin.register(with: registry.registrar(forPlugin: "DeviceInfoPlusMacosPlugin"))
   FPPPackageInfoPlusPlugin.register(with: registry.registrar(forPlugin: "FPPPackageInfoPlusPlugin"))
   UrlLauncherPlugin.register(with: registry.registrar(forPlugin: "UrlLauncherPlugin"))
 }

example/pubspec.lock

@@ -49,6 +49,22 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.0.9"
+  device_info_plus:
+    dependency: transitive
+    description:
+      name: device_info_plus
+      sha256: "98f28b42168cc509abc92f88518882fd58061ea372d7999aecc424345c7bff6a"
+      url: "https://pub.dev"
+    source: hosted
+    version: "11.5.0"
+  device_info_plus_platform_interface:
+    dependency: transitive
+    description:
+      name: device_info_plus_platform_interface
+      sha256: e1ea89119e34903dca74b883d0dd78eb762814f97fb6c76f35e9ff74d261a18f
+      url: "https://pub.dev"
+    source: hosted
+    version: "7.0.3"
   fake_async:
     dependency: transitive
     description:
@@ -65,6 +81,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "2.2.0"
+  file:
+    dependency: transitive
+    description:
+      name: file
+      sha256: a3b4f84adafef897088c160faf7dfffb7696046cb13ae90b508c2cbc95d3b8d4
+      url: "https://pub.dev"
+    source: hosted
+    version: "7.0.1"
   flutter:
     dependency: "direct main"
     description: flutter
@@ -140,10 +164,10 @@ packages:
     dependency: transitive
     description:
       name: matcher
-      sha256: dc0b7dc7651697ea4ff3e69ef44b0407ea32c487a39fff6a4004fa585e901861
+      sha256: "31bd099b47c10cd1aeb55146a2d46ce0277630ecef3f7dae54ad7873f36696cd"
       url: "https://pub.dev"
     source: hosted
-    version: "0.12.19"
+    version: "0.12.20"
   material_color_utilities:
     dependency: transitive
     description:
@@ -156,10 +180,10 @@ packages:
     dependency: transitive
     description:
       name: meta
-      sha256: "1741988757a65eb6b36abe716829688cf01910bbf91c34354ff7ec1c3de2b349"
+      sha256: "307249ce4ff29d58a18e97f6345f539382eb9c9c29ecda628900f31de0443dd9"
       url: "https://pub.dev"
     source: hosted
-    version: "1.18.0"
+    version: "1.19.0"
   package_info_plus:
     dependency: transitive
     description:
@@ -198,7 +222,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.3.0"
+    version: "0.4.0"
   sky_engine:
     dependency: transitive
     description: flutter
@@ -248,10 +272,10 @@ packages:
     dependency: transitive
     description:
       name: test_api
-      sha256: "949a932224383300f01be9221c39180316445ecb8e7547f70a41a35bf421fb9e"
+      sha256: "2a122cbe059f8b610d3a5415f42e255b6c17b1f21eee1d960f31080237fb4f11"
       url: "https://pub.dev"
     source: hosted
-    version: "0.7.11"
+    version: "0.7.12"
   typed_data:
     dependency: transitive
     description:
@@ -328,10 +352,10 @@ packages:
     dependency: transitive
     description:
       name: vector_math
-      sha256: d530bd74fea330e6e364cda7a85019c434070188383e1cd8d9777ee586914c5b
+      sha256: f36f9f3be64c6198714492bb455c11056e33e2f85d9a0b676a48301e44fdcf47
       url: "https://pub.dev"
     source: hosted
-    version: "2.2.0"
+    version: "2.4.2"
   vm_service:
     dependency: transitive
     description:
@@ -356,6 +380,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "5.15.0"
+  win32_registry:
+    dependency: transitive
+    description:
+      name: win32_registry
+      sha256: "6f1b564492d0147b330dd794fee8f512cec4977957f310f9951b5f9d83618dae"
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.1.0"
 sdks:
   dart: ">=3.12.0 <4.0.0"
   flutter: ">=3.44.0"

example/pubspec.yaml

@@ -19,7 +19,7 @@ publish_to: 'none' # Remove this line if you wish to publish to pub.dev
 version: 1.0.0+1
 
 environment:
-  sdk: ^3.6.0
+  sdk: ^3.7.0
 
 # Dependencies specify other packages that your package needs in order to work.
 # To automatically upgrade your package dependencies to the latest versions

lib/src/feedback_context_diagnostics.dart

@@ -0,0 +1,30 @@
+import 'package:flutter/material.dart';
+
+/// Collects diagnostics that are scoped to a specific Flutter widget tree.
+///
+/// The resolved application locale and current view metrics cannot be inferred
+/// reliably without a [BuildContext], particularly in multi-view apps.
+Map<String, String> collectFeedbackContextDiagnostics(
+  final BuildContext? context,
+) {
+  if (context == null) {
+    return const {};
+  }
+
+  final values = <String, String>{};
+  final appLocale = Localizations.maybeLocaleOf(context);
+  if (appLocale != null) {
+    values['App locale'] = appLocale.toLanguageTag();
+  }
+
+  final view = View.maybeOf(context);
+  if (view != null) {
+    final devicePixelRatio = view.devicePixelRatio;
+    final logicalSize = view.physicalSize / devicePixelRatio;
+    values['Window size (logical pixels)'] =
+        '${logicalSize.width.round()}x${logicalSize.height.round()}';
+    values['Device pixel ratio'] = devicePixelRatio.toStringAsFixed(2);
+  }
+
+  return values;
+}

lib/src/feedback_email.dart

@@ -1,6 +1,8 @@
 import 'package:flutter/foundation.dart' show visibleForTesting;
+import 'package:flutter/widgets.dart' show BuildContext;
 import 'package:url_launcher/url_launcher.dart';
 
+import 'feedback_context_diagnostics.dart';
 import 'feedback_runtime_diagnostics.dart';
 
 const Duration _defaultRuntimeDiagnosticsTimeout = Duration(seconds: 2);
@@ -123,12 +125,15 @@ Future<Uri> buildFeedbackEmailUri({
 /// allowed URI schemes are reported as successful because the browser does not
 /// expose whether the navigation completed. Runtime metadata collection is
 /// limited to two seconds; if it fails or times out, the launch is still
-/// attempted with an unavailable diagnostic marker.
+/// attempted with an unavailable diagnostic marker. When
+/// [diagnosticsContext] is provided, the resolved app locale and current view
+/// metrics are also included.
 Future<bool> sendEmail({
   required final String emailAddress,
   required final String emailSubject,
   final String? emailBody,
   final bool includeRuntimeDiagnostics = false,
+  final BuildContext? diagnosticsContext,
   final Map<String, String?> additionalDiagnostics = const {},
   final String diagnosticsHeading = 'Diagnostics:',
 }) async {
@@ -148,12 +153,21 @@ Future<bool> sendEmail({
     return launchUrl(uri);
   }
 
+  // Context-dependent values must be read before the first asynchronous gap.
+  // Caller-provided values retain the existing override behavior.
+  final contextDiagnostics = collectFeedbackContextDiagnostics(
+    diagnosticsContext,
+  );
+  final resolvedAdditionalDiagnostics = <String, String?>{
+    ...contextDiagnostics,
+    ...additionalDiagnostics,
+  };
   final uri = await buildFeedbackEmailUri(
     emailAddress: emailAddress,
     emailSubject: emailSubject,
     emailBody: emailBody,
     includeRuntimeDiagnostics: true,
-    additionalDiagnostics: additionalDiagnostics,
+    additionalDiagnostics: resolvedAdditionalDiagnostics,
     diagnosticsHeading: diagnosticsHeading,
   );
   // Using the current browsing context keeps web launches working after an