Add personal user_id & full_name data, updating latter via events & in UI

lib/api/model/events.dart

@@ -19,6 +19,12 @@ abstract class Event {
     final type = json['type'] as String;
     switch (type) {
       case 'alert_words': return AlertWordsEvent.fromJson(json);
+      case 'realm_user':
+        switch(json['op'] as String) {
+          case 'update': return RealmUserUpdateEvent.fromJson(json);
+            // TODO add realm_user/add and realm_user/remove events
+          default: return UnexpectedEvent.fromJson(json);
+        }
       case 'message': return MessageEvent.fromJson(json);
       case 'heartbeat': return HeartbeatEvent.fromJson(json);
       // TODO add many more event types
@@ -63,6 +69,76 @@ class AlertWordsEvent extends Event {
   Map<String, dynamic> toJson() => _$AlertWordsEventToJson(this);
 }
 
+/// A Zulip event of type `realm_user` (only for op:update).
+@JsonSerializable()
+class RealmUserUpdateEvent extends Event {
+  @override
+  @JsonKey(includeToJson: true)
+  String get type => 'realm_user';
+
+  @override
+  @JsonKey(includeToJson: true)
+  String get op => 'update';
+
+  final RealmUserUpdateEventPerson person;
+
+  RealmUserUpdateEvent({required super.id, required this.person});
+
+  factory RealmUserUpdateEvent.fromJson(Map<String, dynamic> json) =>
+      _$RealmUserUpdateEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$RealmUserUpdateEventToJson(this);
+}
+
+@JsonSerializable()
+class RealmUserUpdateEventPerson {
+  final int user_id;
+
+  final String? full_name;
+
+  // TODO express that all four avatar-related properties will be present if any of them is
+  final String? avatar_url;
+  final String? avatar_url_medium;
+  final String? avatar_source;
+  final String? avatar_version;
+
+  final String? timezone;
+  // final String? email;  // Deprecated as redundant with user_id
+
+  final int? bot_owner_id;
+
+  final int? role;
+
+  final bool? is_billing_admin;
+
+  final String? delivery_email; // TODO Can also be 'None', distinct from null
+
+  // final CustomProfileFieldValueUpdate? custom_profile_field; // TODO handle
+
+  final String? new_email;
+
+  RealmUserUpdateEventPerson({
+    required this.user_id,
+    this.full_name,
+    this.avatar_url,
+    this.avatar_url_medium,
+    this.avatar_source,
+    this.avatar_version,
+    this.timezone,
+    this.bot_owner_id,
+    this.role,
+    this.is_billing_admin, // Can also be null?
+    this.delivery_email,
+    this.new_email,
+  });
+
+  factory RealmUserUpdateEventPerson.fromJson(Map<String, dynamic> json) =>
+      _$RealmUserUpdateEventPersonFromJson(json);
+
+  Map<String, dynamic> toJson() => _$RealmUserUpdateEventPersonToJson(this);
+}
+
 /// A Zulip event of type `message`.
 // TODO use [JsonSerializable] here too, using its customization features,
 //   in order to skip the boilerplate in [fromJson] and [toJson].

lib/api/model/initial_snapshot.dart

@@ -25,6 +25,9 @@ class InitialSnapshot {
 
   // TODO etc., etc.
 
+  final int user_id;
+  final String full_name;
+
   InitialSnapshot({
     this.queue_id,
     required this.last_event_id,
@@ -34,6 +37,8 @@ class InitialSnapshot {
     required this.alert_words,
     required this.custom_profile_fields,
     required this.subscriptions,
+    required this.user_id,
+    required this.full_name,
   });
 
   factory InitialSnapshot.fromJson(Map<String, dynamic> json) =>

lib/model/store.dart

@@ -65,6 +65,8 @@ class PerAccountStore extends ChangeNotifier {
     required this.last_event_id,
     required this.zulip_version,
     required this.subscriptions,
+    required this.user_id,
+    required this.full_name,
   });
 
   /// Load the user's data from the server, and start an event queue going.
@@ -93,6 +95,9 @@ class PerAccountStore extends ChangeNotifier {
   final String zulip_version;
   final Map<int, Subscription> subscriptions;
 
+  final int user_id;
+  String full_name;
+
   // TODO lots more data.  When adding, be sure to update handleEvent too.
 
   final Set<MessageListView> _messageListViews = {};
@@ -144,6 +149,15 @@ class PerAccountStore extends ChangeNotifier {
       for (final view in _messageListViews) {
         view.maybeAddMessage(event.message);
       }
+    } else if (event is RealmUserUpdateEvent) {
+      debugPrint("server event: realm_user op:update");
+      if (event.person.user_id == user_id) {
+        final String? new_full_name = event.person.full_name;
+        if (new_full_name != null) {
+          full_name = new_full_name;
+          notifyListeners();
+        }
+      }
     } else if (event is UnexpectedEvent) {
       debugPrint("server event: ${jsonEncode(event.toJson())}"); // TODO log better
     } else {
@@ -201,5 +215,7 @@ PerAccountStore processInitialSnapshot(Account account,
     last_event_id: initialSnapshot.last_event_id,
     zulip_version: initialSnapshot.zulip_version,
     subscriptions: subscriptions,
+    user_id: initialSnapshot.user_id,
+    full_name: initialSnapshot.full_name,
   );
 }

lib/widgets/app.dart

@@ -57,6 +57,9 @@ class HomePage extends StatelessWidget {
               child: Column(children: [
                 const Text('🚧 Under construction 🚧'),
                 const SizedBox(height: 12),
+                Text.rich(TextSpan(
+                    text: 'You are: ',
+                    children: [bold(store.full_name)])),
                 Text.rich(TextSpan(
                     text: 'Connected to: ',
                     children: [bold(store.account.realmUrl)])),

test/api/model/events_checks.dart

@@ -17,6 +17,10 @@ extension AlertWordsEventChecks on Subject<AlertWordsEvent> {
   Subject<List<String>> get alert_words => has((e) => e.alert_words, 'alert_words');
 }
 
+extension RealmUserEventChecks on Subject<RealmUserEvent> {
+  Subject<RealmUserEventPerson> get person => has((e) => e.person, 'realm_user');
+}
+
 extension MessageEventChecks on Subject<MessageEvent> {
   Subject<Message> get message => has((e) => e.message, 'message');
 }