store new construct uses locally. use a combination of those and stored analytics events to update mini analytics UI.
ggurdin
1 year ago
parent
a1a1d92f54
commit
4ede7c9bdd
@ -0,0 +1,212 @@
|
|||||||
|
import 'package:fluffychat/pangea/constants/class_default_values.dart';
|
||||||
|
import 'package:fluffychat/pangea/constants/local.key.dart';
|
||||||
|
import 'package:fluffychat/pangea/constants/match_rule_ids.dart';
|
||||||
|
import 'package:fluffychat/pangea/controllers/pangea_controller.dart';
|
||||||
|
import 'package:fluffychat/pangea/enum/construct_type_enum.dart';
|
||||||
|
import 'package:fluffychat/pangea/extensions/client_extension/client_extension.dart';
|
||||||
|
import 'package:fluffychat/pangea/extensions/pangea_room_extension/pangea_room_extension.dart';
|
||||||
|
import 'package:fluffychat/pangea/models/analytics/constructs_event.dart';
|
||||||
|
import 'package:fluffychat/pangea/models/analytics/constructs_model.dart';
|
||||||
|
import 'package:fluffychat/pangea/utils/error_handler.dart';
|
||||||
|
import 'package:flutter/material.dart';
|
||||||
|
import 'package:matrix/matrix.dart';
|
||||||
|
import 'package:sentry_flutter/sentry_flutter.dart';
|
||||||
|
|
||||||
|
/// A minimized version of AnalyticsController that get the logged in user's analytics
|
||||||
|
class GetAnalyticsController {
|
||||||
|
late PangeaController _pangeaController;
|
||||||
|
final List<AnalyticsCacheEntry> _cache = [];
|
||||||
|
|
||||||
|
GetAnalyticsController(PangeaController pangeaController) {
|
||||||
|
_pangeaController = pangeaController;
|
||||||
|
}
|
||||||
|
|
||||||
|
String? get l2Code => _pangeaController.languageController.userL2?.langCode;
|
||||||
|
|
||||||
|
// A local cache of eventIds and construct uses for messages sent since the last update
|
||||||
|
Map<String, List<OneConstructUse>> get messagesSinceUpdate {
|
||||||
|
try {
|
||||||
|
final dynamic locallySaved = _pangeaController.pStoreService.read(
|
||||||
|
PLocalKey.messagesSinceUpdate,
|
||||||
|
);
|
||||||
|
if (locallySaved == null) {
|
||||||
|
_pangeaController.myAnalytics.setMessagesSinceUpdate({});
|
||||||
|
return {};
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
// try to get the local cache of messages and format them as OneConstructUses
|
||||||
|
final Map<String, List<dynamic>> cache =
|
||||||
|
Map<String, List<dynamic>>.from(locallySaved);
|
||||||
|
final Map<String, List<OneConstructUse>> formattedCache = {};
|
||||||
|
for (final entry in cache.entries) {
|
||||||
|
formattedCache[entry.key] =
|
||||||
|
entry.value.map((e) => OneConstructUse.fromJson(e)).toList();
|
||||||
|
}
|
||||||
|
return formattedCache;
|
||||||
|
} catch (err) {
|
||||||
|
// if something goes wrong while trying to format the local data, clear it
|
||||||
|
_pangeaController.myAnalytics.setMessagesSinceUpdate({});
|
||||||
|
return {};
|
||||||
|
}
|
||||||
|
} catch (exception, stackTrace) {
|
||||||
|
ErrorHandler.logError(
|
||||||
|
e: PangeaWarningError(
|
||||||
|
"Failed to get messages since update: $exception",
|
||||||
|
),
|
||||||
|
s: stackTrace,
|
||||||
|
m: 'Failed to retrieve messages since update',
|
||||||
|
);
|
||||||
|
return {};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get a list of all the construct analytics events
|
||||||
|
/// for the logged in user in their current L2
|
||||||
|
Future<List<ConstructAnalyticsEvent>?> getConstructs({
|
||||||
|
bool forceUpdate = false,
|
||||||
|
ConstructTypeEnum? constructType,
|
||||||
|
}) async {
|
||||||
|
debugPrint("getting constructs");
|
||||||
|
await _pangeaController.matrixState.client.roomsLoading;
|
||||||
|
|
||||||
|
final DateTime? lastUpdated = await myAnalyticsLastUpdated();
|
||||||
|
final List<ConstructAnalyticsEvent>? local = getConstructsLocal(
|
||||||
|
constructType: constructType,
|
||||||
|
lastUpdated: lastUpdated,
|
||||||
|
);
|
||||||
|
if (local != null && !forceUpdate) {
|
||||||
|
debugPrint("returning local constructs");
|
||||||
|
return local;
|
||||||
|
}
|
||||||
|
debugPrint("fetching new constructs");
|
||||||
|
|
||||||
|
final unfilteredConstructs = await allMyConstructs();
|
||||||
|
final filteredConstructs = await filterConstructs(
|
||||||
|
unfilteredConstructs: unfilteredConstructs,
|
||||||
|
);
|
||||||
|
|
||||||
|
if (local == null) {
|
||||||
|
cacheConstructs(
|
||||||
|
constructType: constructType,
|
||||||
|
events: filteredConstructs,
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return filteredConstructs;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get the last time the user updated their analytics for their current l2
|
||||||
|
Future<DateTime?> myAnalyticsLastUpdated() async {
|
||||||
|
if (l2Code == null) return null;
|
||||||
|
final Room? analyticsRoom =
|
||||||
|
_pangeaController.matrixState.client.analyticsRoomLocal(l2Code!);
|
||||||
|
if (analyticsRoom == null) return null;
|
||||||
|
final DateTime? lastUpdated = await analyticsRoom.analyticsLastUpdated(
|
||||||
|
_pangeaController.matrixState.client.userID!,
|
||||||
|
);
|
||||||
|
return lastUpdated;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get the cached construct analytics events for the current user, if it exists
|
||||||
|
List<ConstructAnalyticsEvent>? getConstructsLocal({
|
||||||
|
DateTime? lastUpdated,
|
||||||
|
ConstructTypeEnum? constructType,
|
||||||
|
}) {
|
||||||
|
final index = _cache.indexWhere(
|
||||||
|
(e) => e.type == constructType && e.langCode == l2Code,
|
||||||
|
);
|
||||||
|
|
||||||
|
if (index > -1) {
|
||||||
|
if (_cache[index].needsUpdate(lastUpdated)) {
|
||||||
|
_cache.removeAt(index);
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
return _cache[index].events;
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get all the construct analytics events for the logged in user
|
||||||
|
Future<List<ConstructAnalyticsEvent>> allMyConstructs() async {
|
||||||
|
if (l2Code == null) return [];
|
||||||
|
final Room? analyticsRoom =
|
||||||
|
_pangeaController.matrixState.client.analyticsRoomLocal(l2Code!);
|
||||||
|
if (analyticsRoom == null) return [];
|
||||||
|
|
||||||
|
return await analyticsRoom.getAnalyticsEvents(
|
||||||
|
userId: _pangeaController.matrixState.client.userID!,
|
||||||
|
) ??
|
||||||
|
[];
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Filter out constructs that are not relevant to the user, specifically those from
|
||||||
|
/// rooms in which the user is a teacher and those that are interative translation span constructs
|
||||||
|
Future<List<ConstructAnalyticsEvent>> filterConstructs({
|
||||||
|
required List<ConstructAnalyticsEvent> unfilteredConstructs,
|
||||||
|
}) async {
|
||||||
|
final List<String> adminSpaceRooms =
|
||||||
|
await _pangeaController.matrixState.client.teacherRoomIds;
|
||||||
|
for (final construct in unfilteredConstructs) {
|
||||||
|
construct.content.uses.removeWhere(
|
||||||
|
(use) {
|
||||||
|
if (adminSpaceRooms.contains(use.chatId)) {
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
return use.lemma == "Try interactive translation" ||
|
||||||
|
use.lemma == "itStart" ||
|
||||||
|
use.lemma == MatchRuleIds.interactiveTranslation;
|
||||||
|
},
|
||||||
|
);
|
||||||
|
}
|
||||||
|
unfilteredConstructs.removeWhere((e) => e.content.uses.isEmpty);
|
||||||
|
return unfilteredConstructs;
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Cache the construct analytics events for the current user
|
||||||
|
void cacheConstructs({
|
||||||
|
required List<ConstructAnalyticsEvent> events,
|
||||||
|
ConstructTypeEnum? constructType,
|
||||||
|
}) {
|
||||||
|
if (l2Code == null) return;
|
||||||
|
final entry = AnalyticsCacheEntry(
|
||||||
|
type: constructType,
|
||||||
|
events: List.from(events),
|
||||||
|
langCode: l2Code!,
|
||||||
|
);
|
||||||
|
_cache.add(entry);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class AnalyticsCacheEntry {
|
||||||
|
final String langCode;
|
||||||
|
final ConstructTypeEnum? type;
|
||||||
|
final List<ConstructAnalyticsEvent> events;
|
||||||
|
late final DateTime _createdAt;
|
||||||
|
|
||||||
|
AnalyticsCacheEntry({
|
||||||
|
required this.langCode,
|
||||||
|
required this.type,
|
||||||
|
required this.events,
|
||||||
|
}) {
|
||||||
|
_createdAt = DateTime.now();
|
||||||
|
}
|
||||||
|
|
||||||
|
bool get isExpired =>
|
||||||
|
DateTime.now().difference(_createdAt).inMinutes >
|
||||||
|
ClassDefaultValues.minutesDelayToMakeNewChartAnalytics;
|
||||||
|
|
||||||
|
bool needsUpdate(DateTime? lastEventUpdated) {
|
||||||
|
// cache entry is invalid if it's older than the last event update
|
||||||
|
// if lastEventUpdated is null, that would indicate that no events
|
||||||
|
// of this type have been sent to the room. In this case, there
|
||||||
|
// shouldn't be any cached data.
|
||||||
|
if (lastEventUpdated == null) {
|
||||||
|
Sentry.addBreadcrumb(
|
||||||
|
Breadcrumb(message: "lastEventUpdated is null in needsUpdate"),
|
||||||
|
);
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
return _createdAt.isBefore(lastEventUpdated);
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,50 @@
|
|||||||
|
import 'package:fluffychat/pangea/enum/construct_type_enum.dart';
|
||||||
|
import 'package:fluffychat/pangea/models/analytics/constructs_model.dart';
|
||||||
|
|
||||||
|
/// A wrapper around a list of [OneConstructUse]s, used to simplify
|
||||||
|
/// the process of filtering / sorting / displaying the events.
|
||||||
|
/// Takes a construct type and a list of events
|
||||||
|
class ConstructListModel {
|
||||||
|
ConstructTypeEnum type;
|
||||||
|
List<OneConstructUse> uses;
|
||||||
|
|
||||||
|
ConstructListModel({
|
||||||
|
required this.type,
|
||||||
|
required this.uses,
|
||||||
|
});
|
||||||
|
|
||||||
|
/// All unique lemmas used in the construct events
|
||||||
|
List<String> get lemmas => constructs.map((e) => e.lemma).toSet().toList();
|
||||||
|
|
||||||
|
/// A list of ConstructUses, each of which contains a lemma and
|
||||||
|
/// a list of uses, sorted by the number of uses
|
||||||
|
List<ConstructUses> get constructs {
|
||||||
|
final List<OneConstructUse> filtered =
|
||||||
|
uses.where((use) => use.constructType == type).toList();
|
||||||
|
|
||||||
|
final Map<String, List<OneConstructUse>> lemmaToUses = {};
|
||||||
|
for (final use in filtered) {
|
||||||
|
if (use.lemma == null) continue;
|
||||||
|
lemmaToUses[use.lemma!] ??= [];
|
||||||
|
lemmaToUses[use.lemma!]!.add(use);
|
||||||
|
}
|
||||||
|
|
||||||
|
final constructUses = lemmaToUses.entries
|
||||||
|
.map(
|
||||||
|
(entry) => ConstructUses(
|
||||||
|
lemma: entry.key,
|
||||||
|
uses: entry.value,
|
||||||
|
constructType: type,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
.toList();
|
||||||
|
|
||||||
|
constructUses.sort((a, b) {
|
||||||
|
final comp = b.uses.length.compareTo(a.uses.length);
|
||||||
|
if (comp != 0) return comp;
|
||||||
|
return a.lemma.compareTo(b.lemma);
|
||||||
|
});
|
||||||
|
|
||||||
|
return constructUses;
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue