fluffychat/lib/pangea/constructs/construct_identifier.dart
ggurdin 660b92fdf1
refactor: reorganize / simplify practice mode (#4755)
* refactor: reorganize / simplify practice mode

* cleanup

* remove unreferenced code

* only use content words in emoji activities
2025-12-01 13:33:51 -05:00

261 lines
7.7 KiB
Dart

import 'dart:developer';
import 'package:flutter/foundation.dart';
import 'package:collection/collection.dart';
import 'package:sentry_flutter/sentry_flutter.dart';
import 'package:fluffychat/pangea/analytics_misc/client_analytics_extension.dart';
import 'package:fluffychat/pangea/analytics_misc/construct_type_enum.dart';
import 'package:fluffychat/pangea/analytics_misc/construct_use_model.dart';
import 'package:fluffychat/pangea/analytics_misc/construct_use_type_enum.dart';
import 'package:fluffychat/pangea/analytics_misc/constructs_model.dart';
import 'package:fluffychat/pangea/analytics_misc/put_analytics_controller.dart';
import 'package:fluffychat/pangea/common/utils/error_handler.dart';
import 'package:fluffychat/pangea/extensions/pangea_room_extension.dart';
import 'package:fluffychat/pangea/learning_settings/constants/language_constants.dart';
import 'package:fluffychat/pangea/lemmas/lemma_info_repo.dart';
import 'package:fluffychat/pangea/lemmas/lemma_info_request.dart';
import 'package:fluffychat/pangea/lemmas/lemma_info_response.dart';
import 'package:fluffychat/pangea/lemmas/user_set_lemma_info.dart';
import 'package:fluffychat/pangea/morphs/morph_features_enum.dart';
import 'package:fluffychat/pangea/morphs/parts_of_speech_enum.dart';
import 'package:fluffychat/widgets/matrix.dart';
class ConstructIdentifier {
final String lemma;
final ConstructTypeEnum type;
final String _category;
ConstructIdentifier({
required this.lemma,
required this.type,
required String category,
}) : _category = category {
if (type == ConstructTypeEnum.morph &&
MorphFeaturesEnumExtension.fromString(category) ==
MorphFeaturesEnum.Unknown) {
debugger(when: kDebugMode);
ErrorHandler.logError(
e: Exception("Morph feature not found"),
data: {
"category": category,
"lemma": lemma,
"type": type,
},
);
}
}
factory ConstructIdentifier.fromJson(Map<String, dynamic> json) {
final categoryEntry = json['cat'] ?? json['categories'];
String? category;
if (categoryEntry != null) {
if (categoryEntry is String) {
category = categoryEntry;
} else if (categoryEntry is List) {
category = categoryEntry.first;
}
}
final type = ConstructTypeEnum.values.firstWhereOrNull(
(e) => e.string == json['type'],
);
if (type == null) {
Sentry.addBreadcrumb(Breadcrumb(message: "type is: ${json['type']}"));
Sentry.addBreadcrumb(Breadcrumb(data: json));
throw Exception("Matching construct type not found");
}
try {
return ConstructIdentifier(
lemma: json['lemma'] as String,
type: type,
category: category ?? "",
);
} catch (e, s) {
debugger(when: kDebugMode);
ErrorHandler.logError(e: e, s: s, data: json);
rethrow;
}
}
String get category {
if (_category.isEmpty) return "other";
return _category.toLowerCase();
}
Map<String, dynamic> toJson() {
return {
'lemma': lemma,
'type': type.string,
'cat': category,
};
}
// override operator == and hashCode
@override
bool operator ==(Object other) {
if (identical(this, other)) return true;
return other is ConstructIdentifier &&
other.lemma == lemma &&
other.type == type &&
(category == other.category ||
category.toLowerCase() == "other" ||
other.category.toLowerCase() == "other");
}
@override
int get hashCode {
return lemma.hashCode ^ type.hashCode ^ category.hashCode;
}
String get string {
return "$lemma:${type.string}-$category".toLowerCase();
}
static ConstructIdentifier? fromString(String s) {
final parts = s.split(':');
if (parts.length != 2) return null;
final lemma = parts[0];
final typeAndCategory = parts[1].split('-');
if (typeAndCategory.length != 2) return null;
final typeString = typeAndCategory[0];
final category = typeAndCategory[1];
final type = ConstructTypeEnum.values.firstWhereOrNull(
(e) => e.string == typeString,
);
if (type == null) return null;
return ConstructIdentifier(
lemma: lemma,
type: type,
category: category,
);
}
ConstructUses get constructUses =>
MatrixState.pangeaController.getAnalytics.constructListModel
.getConstructUses(
this,
) ??
ConstructUses(
lemma: lemma,
constructType: ConstructTypeEnum.morph,
category: category,
uses: [],
);
List<String> get userSetEmoji => userLemmaInfo?.emojis ?? [];
UserSetLemmaInfo? get userLemmaInfo {
switch (type) {
case ConstructTypeEnum.vocab:
return MatrixState.pangeaController.matrixState.client
.analyticsRoomLocal()
?.getUserSetLemmaInfo(this);
case ConstructTypeEnum.morph:
debugger(when: kDebugMode);
ErrorHandler.logError(
e: Exception("Morphs should not have userSetEmoji"),
data: toJson(),
);
return null;
}
}
/// Sets emoji and awards XP if it's a NEW emoji selection or from game
Future<void> setEmojiWithXP({
required String emoji,
bool isFromCorrectAnswer = false,
String? eventId,
String? roomId,
}) async {
final hadEmojiPreviously = userSetEmoji.isNotEmpty;
//correct answers already award xp so we don't here, but we do still need to set the emoji if it isn't already set
final shouldAwardXP = !hadEmojiPreviously && !isFromCorrectAnswer;
//Set emoji representation
await setUserLemmaInfo(UserSetLemmaInfo(emojis: [emoji]));
if (shouldAwardXP) {
await _recordEmojiAnalytics(
eventId: eventId,
roomId: roomId,
);
}
}
Future<void> _recordEmojiAnalytics({
String? eventId,
String? roomId,
}) async {
const useType = ConstructUseTypeEnum.em;
MatrixState.pangeaController.putAnalytics.setState(
AnalyticsStream(
eventId: eventId,
roomId: roomId,
constructs: [
OneConstructUse(
useType: useType,
lemma: lemma,
constructType: type,
metadata: ConstructUseMetaData(
roomId: roomId,
timeStamp: DateTime.now(),
eventId: eventId,
),
category: category,
form: lemma,
xp: useType.pointValue,
),
],
),
);
}
Future<void> setUserLemmaInfo(UserSetLemmaInfo newLemmaInfo) async {
final client = MatrixState.pangeaController.matrixState.client;
final l2 = MatrixState.pangeaController.languageController.userL2;
if (l2 == null) return;
final analyticsRoom = await client.getMyAnalyticsRoom(l2);
if (analyticsRoom == null) return;
if (userLemmaInfo == newLemmaInfo) return;
try {
await analyticsRoom.setUserSetLemmaInfo(this, newLemmaInfo);
} catch (err, s) {
debugger(when: kDebugMode);
ErrorHandler.logError(
e: err,
data: newLemmaInfo.toJson(),
s: s,
);
}
}
LemmaInfoRequest get _lemmaInfoRequest => LemmaInfoRequest(
partOfSpeech: category,
lemmaLang: MatrixState
.pangeaController.languageController.userL2?.langCodeShort ??
LanguageKeys.defaultLanguage,
userL1: MatrixState
.pangeaController.languageController.userL1?.langCodeShort ??
LanguageKeys.defaultLanguage,
lemma: lemma,
);
/// [lemmmaLang] if not set, assumed to be userL2
Future<LemmaInfoResponse> getLemmaInfo() => LemmaInfoRepo.get(
_lemmaInfoRequest,
);
bool get isContentWord =>
PartOfSpeechEnumExtensions.fromString(category)?.isContentWord ?? false;
}