api: Embed platform and app info in user-agent

Author: rajveermalviya

lib/api/core.dart

@@ -4,6 +4,7 @@ import 'dart:io';
 import 'package:http/http.dart' as http;
 
 import '../log.dart';
+import '../model/binding.dart';
 import '../model/localizations.dart';
 import 'exception.dart';
 
@@ -214,9 +215,33 @@ Map<String, String> authHeader({required String email, required String apiKey})
 }
 
 Map<String, String> userAgentHeader() {
+  final osInfo = switch (ZulipBinding.instance.deviceInfo) {
+    AndroidDeviceInfo(
+      :var release)       => 'Android $release', // "Android 14"
+    IosDeviceInfo(
+      :var systemVersion) => 'iOS $systemVersion', // "iOS 17.4"
+    MacOsDeviceInfo(
+      :var majorVersion,
+      :var minorVersion,
+      :var patchVersion)  => 'macOS $majorVersion.$minorVersion.$patchVersion', // "macOS 14.5.0"
+    WindowsDeviceInfo()   => 'Windows', // "Windows"
+    LinuxDeviceInfo(
+      :var name,
+      :var versionId)     => 'Linux; $name${versionId != null ? ' $versionId' : ''}', // "Linux; Fedora Linux 40" or "Linux; Fedora Linux"
+    _                     => throw UnimplementedError(),
+  };
+  final PackageInfo(
+    version: appVersion,
+    buildNumber: appBuildNumber) = ZulipBinding.instance.packageInfo;
+
   return {
-    // TODO(#467) include platform, platform version, and app version
-    'User-Agent': 'ZulipFlutter',
+    // Possible examples:
+    //  'ZulipFlutter/0.0.15+15 (Android 14)'
+    //  'ZulipFlutter/0.0.15+15 (iOS 17.4)'
+    //  'ZulipFlutter/0.0.15+15 (macOS 14.5.0)'
+    //  'ZulipFlutter/0.0.15+15 (Windows)'
+    //  'ZulipFlutter/0.0.15+15 (Linux; Fedora Linux 40)'
+    'User-Agent': 'ZulipFlutter/$appVersion+$appBuildNumber ($osInfo)',
   };
 }
 

lib/main.dart

@@ -7,14 +7,14 @@ import 'model/binding.dart';
 import 'notifications/receive.dart';
 import 'widgets/app.dart';
 
-void main() {
+Future<void> main() async {
   assert(() {
     debugLogEnabled = true;
     return true;
   }());
   LicenseRegistry.addLicense(additionalLicenses);
-  LiveZulipBinding.ensureInitialized();
   WidgetsFlutterBinding.ensureInitialized();
+  await LiveZulipBinding.ensureInitialized();
   NotificationService.instance.start();
   runApp(const ZulipApp());
 }

lib/model/binding.dart

@@ -3,6 +3,7 @@ import 'package:firebase_core/firebase_core.dart' as firebase_core;
 import 'package:firebase_messaging/firebase_messaging.dart' as firebase_messaging;
 import 'package:flutter/foundation.dart';
 import 'package:flutter_local_notifications/flutter_local_notifications.dart';
+import 'package:package_info_plus/package_info_plus.dart' as package_info_plus;
 import 'package:url_launcher/url_launcher.dart' as url_launcher;
 
 import '../host/android_notifications.dart';
@@ -66,6 +67,18 @@ abstract class ZulipBinding {
     _instance = this;
   }
 
+  /// Provides device and operating system information,
+  /// via package:device_info_plus.
+  ///
+  /// This wraps [device_info_plus.DeviceInfoPlugin.deviceInfo].
+  BaseDeviceInfo get deviceInfo;
+
+  /// Provides application package information,
+  /// via package:package_info_plus.
+  ///
+  /// This wraps [package_info_plus.PackageInfo.fromPlatform].
+  PackageInfo get packageInfo;
+
   /// Prepare the app's [GlobalStore], loading the necessary data.
   ///
   /// Generally the app should call this function only once.
@@ -98,12 +111,6 @@ abstract class ZulipBinding {
   /// This wraps [url_launcher.closeInAppWebView].
   Future<void> closeInAppWebView();
 
-  /// Provides device and operating system information,
-  /// via package:device_info_plus.
-  ///
-  /// This wraps [device_info_plus.DeviceInfoPlugin.deviceInfo].
-  Future<BaseDeviceInfo> deviceInfo();
-
   /// Initialize Firebase, to use for notifications.
   ///
   /// This wraps [firebase_core.Firebase.initializeApp].
@@ -133,13 +140,23 @@ abstract class BaseDeviceInfo {
 
 /// Like [device_info_plus.AndroidDeviceInfo], but without things we don't use.
 class AndroidDeviceInfo extends BaseDeviceInfo {
+  /// The user-visible version string.
+  ///
+  /// E.g., "1.0" or "3.4b5" or "bananas". This field is an opaque string.
+  /// Do not assume that its value has any particular structure or that
+  /// values of RELEASE from different releases can be somehow ordered.
+  final String release;
+
   /// The Android SDK version.
   ///
   /// Possible values are defined in:
   ///   https://developer.android.com/reference/android/os/Build.VERSION_CODES.html
   final int sdkInt;
 
-  AndroidDeviceInfo({required this.sdkInt});
+  AndroidDeviceInfo({
+    required this.release,
+    required this.sdkInt,
+  });
 }
 
 /// Like [device_info_plus.IosDeviceInfo], but without things we don't use.
@@ -152,6 +169,41 @@ class IosDeviceInfo extends BaseDeviceInfo {
   IosDeviceInfo({required this.systemVersion});
 }
 
+class MacOsDeviceInfo extends BaseDeviceInfo {
+  final int majorVersion;
+  final int minorVersion;
+  final int patchVersion;
+
+  MacOsDeviceInfo({
+    required this.majorVersion,
+    required this.minorVersion,
+    required this.patchVersion,
+  });
+}
+
+class WindowsDeviceInfo implements BaseDeviceInfo {}
+
+class LinuxDeviceInfo implements BaseDeviceInfo {
+  final String name;
+  final String? versionId;
+
+  LinuxDeviceInfo({
+    required this.name,
+    required this.versionId,
+  });
+}
+
+/// Like [package_info_plus.PackageInfo], but without things we don't use.
+class PackageInfo {
+  final String version;
+  final String buildNumber;
+
+  PackageInfo({
+    required this.version,
+    required this.buildNumber,
+  });
+}
+
 /// A concrete binding for use in the live application.
 ///
 /// The global store returned by [loadGlobalStore], and consequently by
@@ -162,13 +214,49 @@ class IosDeviceInfo extends BaseDeviceInfo {
 /// underlying plugin method.
 class LiveZulipBinding extends ZulipBinding {
   /// Initialize the binding if necessary, and ensure it is a [LiveZulipBinding].
-  static LiveZulipBinding ensureInitialized() {
+  static Future<LiveZulipBinding> ensureInitialized() async {
     if (ZulipBinding._instance == null) {
-      LiveZulipBinding();
+      final binding = LiveZulipBinding();
+      await Future.wait(<Future<void>>[
+        binding._prefetchDeviceInfo(),
+        binding._prefetchPackageInfo(),
+      ]);
     }
     return ZulipBinding.instance as LiveZulipBinding;
   }
 
+  @override
+  BaseDeviceInfo get deviceInfo => _deviceInfo!;
+  BaseDeviceInfo? _deviceInfo;
+
+  @override
+  PackageInfo get packageInfo => _packageInfo!;
+  PackageInfo? _packageInfo;
+
+  Future<void> _prefetchDeviceInfo() async {
+    final info = await device_info_plus.DeviceInfoPlugin().deviceInfo;
+    _deviceInfo = switch (info) {
+      device_info_plus.AndroidDeviceInfo() => AndroidDeviceInfo(release: info.version.release,
+                                                sdkInt: info.version.sdkInt),
+      device_info_plus.IosDeviceInfo()     => IosDeviceInfo(systemVersion: info.systemVersion),
+      device_info_plus.MacOsDeviceInfo()   => MacOsDeviceInfo(majorVersion: info.majorVersion,
+                                                minorVersion: info.minorVersion,
+                                                patchVersion: info.patchVersion),
+      device_info_plus.WindowsDeviceInfo() => WindowsDeviceInfo(),
+      device_info_plus.LinuxDeviceInfo()   => LinuxDeviceInfo(name: info.name,
+                                                versionId: info.versionId),
+      _                                    => throw UnimplementedError(),
+    };
+  }
+
+  Future<void> _prefetchPackageInfo() async {
+    final info = await package_info_plus.PackageInfo.fromPlatform();
+    _packageInfo =  PackageInfo(
+      version: info.version,
+      buildNumber: info.buildNumber,
+    );
+  }
+
   @override
   Future<GlobalStore> loadGlobalStore() {
     return LiveGlobalStore.load();
@@ -195,16 +283,6 @@ class LiveZulipBinding extends ZulipBinding {
     return url_launcher.closeInAppWebView();
   }
 
-  @override
-  Future<BaseDeviceInfo> deviceInfo() async {
-    final deviceInfo = await device_info_plus.DeviceInfoPlugin().deviceInfo;
-    return switch (deviceInfo) {
-      device_info_plus.AndroidDeviceInfo(:var version)   => AndroidDeviceInfo(sdkInt: version.sdkInt),
-      device_info_plus.IosDeviceInfo(:var systemVersion) => IosDeviceInfo(systemVersion: systemVersion),
-      _                                                  => throw UnimplementedError(),
-    };
-  }
-
   @override
   Future<void> firebaseInitializeApp({
       required firebase_core.FirebaseOptions options}) {

lib/widgets/clipboard.dart

@@ -18,11 +18,10 @@ void copyWithPopup({
   required Widget successContent,
 }) async {
   await Clipboard.setData(data);
-  final deviceInfo = await ZulipBinding.instance.deviceInfo();
 
   if (!context.mounted) return;
 
-  final shouldShowSnackbar = switch (deviceInfo) {
+  final shouldShowSnackbar = switch (ZulipBinding.instance.deviceInfo) {
     // Android 13+ shows its own popup on copying to the clipboard,
     // so we suppress ours, following the advice at:
     //   https://developer.android.com/develop/ui/views/touch-and-input/copy-paste#duplicate-notifications

test/api/core_test.dart

@@ -8,12 +8,15 @@ import 'package:zulip/api/core.dart';
 import 'package:zulip/api/exception.dart';
 import 'package:zulip/model/localizations.dart';
 
+import '../model/binding.dart';
 import '../stdlib_checks.dart';
 import 'exception_checks.dart';
 import 'fake_api.dart';
 import '../example_data.dart' as eg;
 
 void main() {
+  TestZulipBinding.ensureInitialized();
+
   test('ApiConnection.get', () async {
     Future<void> checkRequest(Map<String, dynamic>? params, String expectedRelativeUrl) {
       return FakeApiConnection.with_(account: eg.selfAccount, (connection) async {

test/api/route/messages_test.dart

@@ -10,11 +10,14 @@ import 'package:zulip/api/route/messages.dart';
 import 'package:zulip/model/narrow.dart';
 
 import '../../example_data.dart' as eg;
+import '../../model/binding.dart';
 import '../../stdlib_checks.dart';
 import '../fake_api.dart';
 import 'route_checks.dart';
 
 void main() {
+  TestZulipBinding.ensureInitialized();
+
   group('getMessageCompat', () {
     Future<Message?> checkGetMessageCompat(FakeApiConnection connection, {
       required bool expectLegacy,

test/api/route/notifications_test.dart

@@ -3,10 +3,13 @@ import 'package:http/http.dart' as http;
 import 'package:test/scaffolding.dart';
 import 'package:zulip/api/route/notifications.dart';
 
+import '../../model/binding.dart';
 import '../../stdlib_checks.dart';
 import '../fake_api.dart';
 
 void main() {
+  TestZulipBinding.ensureInitialized();
+
   group('registerFcmToken', () {
     Future<void> checkRegisterFcmToken(FakeApiConnection connection, {
       required String token,

test/model/binding.dart

@@ -204,20 +204,24 @@ class TestZulipBinding extends ZulipBinding {
     _closeInAppWebViewCallCount++;
   }
 
-  /// The value that `ZulipBinding.instance.deviceInfo()` should return.
+  @override
+  BaseDeviceInfo get deviceInfo => deviceInfoResult;
+
+  /// The value that `ZulipBinding.instance.deviceInfo` should return.
   ///
   /// See also [takeDeviceInfoCalls].
   BaseDeviceInfo deviceInfoResult = _defaultDeviceInfoResult;
-  static final _defaultDeviceInfoResult = AndroidDeviceInfo(sdkInt: 33);
+  static final _defaultDeviceInfoResult = AndroidDeviceInfo(sdkInt: 33, release: '13');
 
   void _resetDeviceInfo() {
     deviceInfoResult = _defaultDeviceInfoResult;
   }
 
   @override
-  Future<BaseDeviceInfo> deviceInfo() {
-    return Future(() => deviceInfoResult);
-  }
+  PackageInfo get packageInfo => packageInfoResult;
+
+  PackageInfo packageInfoResult = _defaultPacakgeInfo;
+  static final _defaultPacakgeInfo = PackageInfo(version: '0.0.1', buildNumber: '1');
 
   void _resetFirebase() {
     _firebaseInitialized = false;

test/model/message_list_test.dart

@@ -17,10 +17,13 @@ import '../api/fake_api.dart';
 import '../api/model/model_checks.dart';
 import '../example_data.dart' as eg;
 import '../stdlib_checks.dart';
+import 'binding.dart';
 import 'content_checks.dart';
 import 'test_store.dart';
 
 void main() {
+  TestZulipBinding.ensureInitialized();
+
   // These variables are the common state operated on by each test.
   // Each test case calls [prepare] to initialize them.
   late Subscription subscription;

test/model/message_test.dart

@@ -10,11 +10,14 @@ import '../api/fake_api.dart';
 import '../api/model/model_checks.dart';
 import '../example_data.dart' as eg;
 import '../stdlib_checks.dart';
+import 'binding.dart';
 import 'message_list_test.dart';
 import 'store_checks.dart';
 import 'test_store.dart';
 
 void main() {
+  TestZulipBinding.ensureInitialized();
+
   // These "late" variables are the common state operated on by each test.
   // Each test case calls [prepare] to initialize them.
   late Subscription subscription;

test/widgets/clipboard_test.dart

@@ -65,14 +65,14 @@ void main() {
     });
 
     testWidgets('Android', (WidgetTester tester) async {
-      testBinding.deviceInfoResult = AndroidDeviceInfo(sdkInt: 33);
+      testBinding.deviceInfoResult = AndroidDeviceInfo(sdkInt: 33, release: '13');
       await call(tester, text: 'asdf');
       await checkClipboardText('asdf');
       await checkSnackBar(tester, expected: false);
     });
 
     testWidgets('Android <13', (WidgetTester tester) async {
-      testBinding.deviceInfoResult = AndroidDeviceInfo(sdkInt: 32);
+      testBinding.deviceInfoResult = AndroidDeviceInfo(sdkInt: 32, release: '12L');
       await call(tester, text: 'asdf');
       await checkClipboardText('asdf');
       await checkSnackBar(tester, expected: true);