feat: level up summary (#2182)

* remove send local analytics to matrix on level up

* complete implementation of level up summary

* generated

* fix model key issues that prevents parsing request and response

* fix env

* generated

* improve level up summary to utilize existing state event

* generated

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: ggurdin <46800240+ggurdin@users.noreply.github.com>

Author: 3 people

assets/l10n/intl_en.arb

@@ -4814,8 +4814,18 @@
   "home": "Home",
   "join": "Join",
   "learnByTexting": "Learn by texting",
+  "levelSummaryTrigger": "View summary",
+  "levelSummaryPopupTitle": "Level {level} Summary",
+  "@levelSummaryPopupTitle": {
+    "type": "String",
+    "placeholders": {
+      "level": {
+        "type": "int"
+      }
+    }
+  },
   "startChatting": "Start chatting",
   "referFriends": "Refer friends",
   "referFriendDialogTitle": "Invite a friend to your conversation",
   "referFriendDialogDesc": "Do you have a friend who is excited to learn a new language with you? Then copy and send this invitation link to join and start chatting with you today."
-} 
+}

assets/l10n/intl_vi.arb

@@ -3793,5 +3793,15 @@
   "@createASpace": {
     "type": "String",
     "placeholders": {}
+  },
+  "levelSummaryTrigger": "Đọc báo cáo",
+  "levelSummaryPopupTitle": "Tóm tắt cấp {level}",
+  "@levelSummaryPopupTitle": {
+    "type": "String",
+    "placeholders": {
+      "level": {
+        "type": "int"
+      }
+    }
   }
 }

lib/pages/chat/chat.dart

@@ -365,18 +365,30 @@ class ChatController extends State<ChatPageWithRoom>
 
     _levelSubscription = pangeaController.getAnalytics.stateStream
         .where(
-          (update) =>
-              update is Map<String, dynamic> && update['level_up'] != null,
-        )
+      (update) => update is Map<String, dynamic> && update['level_up'] != null,
+    )
+        // .listen(
+        //   (update) => Future.delayed(
+        //     const Duration(milliseconds: 500),
+        //     () => LevelUpUtil.showLevelUpDialog(
+        //       update['level_up'],
+        //       context,
+        //     ),
+        //   ),
+        // )
         .listen(
-          (update) => Future.delayed(
-            const Duration(milliseconds: 500),
-            () => LevelUpUtil.showLevelUpDialog(
-              update['level_up'],
-              context,
-            ),
-          ),
+      // remove delay now that GetAnalyticsController._onLevelUp
+      // is async is should take roughly 500ms to make requests anyway
+      (update) {
+        LevelUpUtil.showLevelUpDialog(
+          update['level_up'],
+          update['analytics_room_id'],
+          update["construct_summary_state_event_id"],
+          update['construct_summary'],
+          context,
         );
+      },
+    );
     // Pangea#
     _tryLoadTimeline();
     if (kIsWeb) {

lib/pangea/analytics_misc/get_analytics_controller.dart

@@ -18,6 +18,8 @@ import 'package:fluffychat/pangea/common/constants/local.key.dart';
 import 'package:fluffychat/pangea/common/controllers/base_controller.dart';
 import 'package:fluffychat/pangea/common/controllers/pangea_controller.dart';
 import 'package:fluffychat/pangea/common/utils/error_handler.dart';
+import 'package:fluffychat/pangea/constructs/construct_repo.dart';
+import 'package:fluffychat/pangea/events/constants/pangea_event_types.dart';
 import 'package:fluffychat/pangea/extensions/pangea_room_extension.dart';
 import 'package:fluffychat/pangea/learning_settings/models/language_model.dart';
 
@@ -141,8 +143,12 @@ class GetAnalyticsController extends BaseController {
     if (analyticsUpdate.type == AnalyticsUpdateType.server) {
       await _getConstructs(forceUpdate: true);
     }
-    if (oldLevel < constructListModel.level) _onLevelUp();
-    if (oldLevel > constructListModel.level) await _onLevelDown(oldLevel);
+    if (oldLevel < constructListModel.level) {
+      await _onLevelUp(oldLevel, constructListModel.level);
+    }
+    if (oldLevel > constructListModel.level) {
+      await _onLevelDown(constructListModel.level, oldLevel);
+    }
     _updateAnalyticsStream(origin: analyticsUpdate.origin);
     // Update public profile each time that new analytics are added.
     // If the level hasn't changed, this will not send an update to the server.
@@ -158,13 +164,22 @@ class GetAnalyticsController extends BaseController {
   }) =>
       analyticsStream.add(AnalyticsStreamUpdate(origin: origin));
 
-  void _onLevelUp() {
-    setState({'level_up': constructListModel.level});
+  Future<void> _onLevelUp(final int lowerLevel, final int upperLevel) async {
+    final result = await _generateLevelUpAnalyticsAndSaveToStateEvent(
+      lowerLevel,
+      upperLevel,
+    );
+    setState({
+      'level_up': constructListModel.level,
+      'analytics_room_id': _client.analyticsRoomLocal(_l2!)?.id,
+      "construct_summary_state_event_id": result?.stateEventId,
+      "construct_summary": result?.summary,
+    });
   }
 
-  Future<void> _onLevelDown(final prevLevel) async {
+  Future<void> _onLevelDown(final int lowerLevel, final int upperLevel) async {
     final offset =
-        _calculateMinXpForLevel(prevLevel) - constructListModel.totalXP;
+        _calculateMinXpForLevel(lowerLevel) - constructListModel.totalXP;
     await _pangeaController.userController.addXPOffset(offset);
     constructListModel.updateConstructs(
       [],
@@ -344,6 +359,90 @@ class GetAnalyticsController extends BaseController {
     );
     _cache.add(entry);
   }
+
+  Future<GenerateConstructSummaryResult?>
+      _generateLevelUpAnalyticsAndSaveToStateEvent(
+    final int lowerLevel,
+    final int upperLevel,
+  ) async {
+    // generate level up analytics as a construct summary
+    ConstructSummary summary;
+    try {
+      final int maxXP = _calculateMinXpForLevel(upperLevel);
+      final int minXP = _calculateMinXpForLevel(lowerLevel);
+      int diffXP = maxXP - minXP;
+      if (diffXP < 0) diffXP = 0;
+
+      // compute construct use of current level
+      final List<OneConstructUse> constructUseOfCurrentLevel = [];
+      int score = 0;
+      for (final use in constructListModel.uses) {
+        constructUseOfCurrentLevel.add(use);
+        score += use.pointValue;
+        if (score >= diffXP) break;
+      }
+
+      // extract construct use message bodies for analytics
+      List<String?>? constructUseMessageContentBodies = [];
+      for (final use in constructUseOfCurrentLevel) {
+        try {
+          final useMessage = await use.getEvent(_client);
+          final useMessageBody = useMessage?.content["body"];
+          if (useMessageBody is String) {
+            constructUseMessageContentBodies.add(useMessageBody);
+          } else {
+            constructUseMessageContentBodies.add(null);
+          }
+        } catch (e) {
+          constructUseMessageContentBodies.add(null);
+        }
+      }
+      if (constructUseMessageContentBodies.length !=
+          constructUseOfCurrentLevel.length) {
+        constructUseMessageContentBodies = null;
+      }
+
+      final request = ConstructSummaryRequest(
+        constructs: constructUseOfCurrentLevel,
+        constructUseMessageContentBodies: constructUseMessageContentBodies,
+        language: _l2!.langCodeShort,
+        upperLevel: upperLevel,
+        lowerLevel: lowerLevel,
+      );
+
+      final response = await ConstructRepo.generateConstructSummary(request);
+      summary = response.summary;
+    } catch (e) {
+      debugPrint("Error generating level up analytics: $e");
+      ErrorHandler.logError(e: e, data: {'e': e});
+      return null;
+    }
+    String stateEventId;
+    try {
+      final Room? analyticsRoom = _client.analyticsRoomLocal(_l2!);
+      if (analyticsRoom == null) {
+        ErrorHandler.logError(
+          e: e,
+          data: {'e': e, 'message': "Analytics room not found for user"},
+        );
+        return null;
+      }
+      stateEventId = await _client.setRoomStateWithKey(
+        analyticsRoom.id,
+        PangeaEventTypes.constructSummary,
+        '',
+        summary.toJson(),
+      );
+    } catch (e) {
+      debugPrint("Error saving construct summary room: $e");
+      ErrorHandler.logError(e: e, data: {'e': e});
+      return null;
+    }
+    return GenerateConstructSummaryResult(
+      stateEventId: stateEventId,
+      summary: summary,
+    );
+  }
 }
 
 class AnalyticsCacheEntry {

lib/pangea/analytics_misc/level_summary.dart

@@ -0,0 +1,87 @@
+import 'package:flutter/material.dart';
+
+import 'package:flutter_gen/gen_l10n/l10n.dart';
+import 'package:matrix/matrix.dart';
+
+import 'package:fluffychat/pangea/constructs/construct_repo.dart';
+import 'package:fluffychat/widgets/matrix.dart';
+
+// New component renamed to ConstructSummaryAlertDialog with a max width
+class ConstructSummaryAlertDialog extends StatelessWidget {
+  final String title;
+  final String content;
+
+  const ConstructSummaryAlertDialog({
+    super.key,
+    required this.title,
+    required this.content,
+  });
+
+  @override
+  Widget build(BuildContext context) {
+    return AlertDialog(
+      title: Text(title),
+      content: ConstrainedBox(
+        constraints: const BoxConstraints(maxWidth: 400),
+        child: Text(content),
+      ),
+      actions: [
+        TextButton(
+          onPressed: () => Navigator.of(context).pop(),
+          child: Text(L10n.of(context).close),
+        ),
+      ],
+    );
+  }
+}
+
+class LevelSummaryDialog extends StatelessWidget {
+  final int level;
+  final String analyticsRoomId;
+  final String summaryStateEventId;
+  final ConstructSummary? constructSummary;
+
+  const LevelSummaryDialog({
+    super.key,
+    required this.analyticsRoomId,
+    required this.level,
+    required this.summaryStateEventId,
+    this.constructSummary,
+  });
+
+  @override
+  Widget build(BuildContext context) {
+    final Client client = Matrix.of(context).client;
+    final futureSummary = client
+        .getOneRoomEvent(analyticsRoomId, summaryStateEventId)
+        .then((rawEvent) => ConstructSummary.fromJson(rawEvent.content));
+    if (constructSummary != null) {
+      return ConstructSummaryAlertDialog(
+        title: L10n.of(context).levelSummaryPopupTitle(level),
+        content: constructSummary!.textSummary,
+      );
+    } else {
+      return FutureBuilder<ConstructSummary>(
+        future: futureSummary,
+        builder: (context, snapshot) {
+          if (snapshot.connectionState == ConnectionState.waiting) {
+            return const Center(child: CircularProgressIndicator());
+          } else if (snapshot.hasError) {
+            return ConstructSummaryAlertDialog(
+              title: L10n.of(context).levelSummaryPopupTitle(level),
+              content: L10n.of(context).error502504Desc,
+            );
+          } else if (snapshot.hasData) {
+            final constructSummary = snapshot.data!;
+            return ConstructSummaryAlertDialog(
+              title: L10n.of(context).levelSummaryPopupTitle(level),
+              content: constructSummary.textSummary,
+            );
+          } else {
+            return const SizedBox.shrink();
+          }
+        },
+      );
+    }
+  }
+}