fluffychat/lib/pangea/analytics_practice/analytics_practice_session_model.dart
ggurdin 117a03089e
5720 vocab practice should have feedback flag (#5761)
* chore: split up analytics activity page widgets into separate files

* started analytics practice refactor

* refactor how UI updates are triggered in analytics practice page

* some fixes
2026-02-20 13:25:21 -05:00

361 lines
11 KiB
Dart

import 'package:flutter/material.dart';
import 'package:fluffychat/l10n/l10n.dart';
import 'package:fluffychat/pangea/analytics_misc/construct_type_enum.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_practice/analytics_practice_constants.dart';
import 'package:fluffychat/pangea/events/models/pangea_token_model.dart';
import 'package:fluffychat/pangea/practice_activities/message_activity_request.dart';
import 'package:fluffychat/pangea/practice_activities/practice_target.dart';
class ExampleMessageInfo {
final List<InlineSpan> exampleMessage;
const ExampleMessageInfo({required this.exampleMessage});
Map<String, dynamic> toJson() {
final segments = <Map<String, dynamic>>[];
for (final span in exampleMessage) {
if (span is TextSpan) {
segments.add({
'text': span.text ?? '',
'isBold': span.style?.fontWeight == FontWeight.bold,
});
}
}
return {'segments': segments};
}
factory ExampleMessageInfo.fromJson(Map<String, dynamic> json) {
final segments = json['segments'] as List<dynamic>? ?? [];
final spans = <InlineSpan>[];
for (final segment in segments) {
final text = segment['text'] as String? ?? '';
final isBold = segment['isBold'] as bool? ?? false;
spans.add(
TextSpan(
text: text,
style: isBold ? const TextStyle(fontWeight: FontWeight.bold) : null,
),
);
}
return ExampleMessageInfo(exampleMessage: spans);
}
}
/// An extended example message that includes both formatted display spans and tokens to generate audio practice activities.
/// eventId/roomId are needed for audio playback.
class AudioExampleMessage {
final List<PangeaToken> tokens;
final String? eventId;
final String? roomId;
final ExampleMessageInfo exampleMessage;
const AudioExampleMessage({
required this.tokens,
this.eventId,
this.roomId,
required this.exampleMessage,
});
Map<String, dynamic> toJson() {
return {'eventId': eventId, 'roomId': roomId};
}
factory AudioExampleMessage.fromJson(Map<String, dynamic> json) {
return AudioExampleMessage(
tokens: const [],
eventId: json['eventId'] as String?,
roomId: json['roomId'] as String?,
exampleMessage: const ExampleMessageInfo(exampleMessage: []),
);
}
}
class AnalyticsActivityTarget {
final PracticeTarget target;
final GrammarErrorRequestInfo? grammarErrorInfo;
final ExampleMessageInfo? exampleMessage;
final AudioExampleMessage? audioExampleMessage;
AnalyticsActivityTarget({
required this.target,
this.grammarErrorInfo,
this.exampleMessage,
this.audioExampleMessage,
});
Map<String, dynamic> toJson() => {
'target': target.toJson(),
'grammarErrorInfo': grammarErrorInfo?.toJson(),
'exampleMessage': exampleMessage?.toJson(),
'audioExampleMessage': audioExampleMessage?.toJson(),
};
factory AnalyticsActivityTarget.fromJson(Map<String, dynamic> json) =>
AnalyticsActivityTarget(
target: PracticeTarget.fromJson(json['target']),
grammarErrorInfo: json['grammarErrorInfo'] != null
? GrammarErrorRequestInfo.fromJson(json['grammarErrorInfo'])
: null,
exampleMessage: json['exampleMessage'] != null
? ExampleMessageInfo.fromJson(json['exampleMessage'])
: null,
audioExampleMessage: json['audioExampleMessage'] != null
? AudioExampleMessage.fromJson(json['audioExampleMessage'])
: null,
);
}
class AnalyticsPracticeSessionModel {
final DateTime startedAt;
final ConstructTypeEnum type;
final List<AnalyticsActivityTarget> practiceTargets;
final String userL1;
final String userL2;
AnalyticsPracticeSessionState state;
AnalyticsPracticeSessionModel({
required this.startedAt,
required this.type,
required this.practiceTargets,
required this.userL1,
required this.userL2,
AnalyticsPracticeSessionState? state,
}) : state = state ?? const AnalyticsPracticeSessionState();
// Maximum activities to attempt (including skips)
int get _maxAttempts => AnalyticsPracticeConstants.targetsToGenerate
.clamp(0, practiceTargets.length)
.toInt();
int get _completionGoal => AnalyticsPracticeConstants.practiceGroupSize.clamp(
0,
practiceTargets.length,
);
// Total attempted so far (completed + skipped)
int get _totalAttempted => state.currentIndex + state.skippedActivities;
bool get isComplete {
final complete =
state.finished ||
state.currentIndex >= _completionGoal ||
_totalAttempted >= _maxAttempts;
return complete;
}
double get progress {
final possibleCompletions =
(state.currentIndex + _maxAttempts - _totalAttempted).clamp(
0,
_completionGoal,
);
return possibleCompletions > 0
? (state.currentIndex / possibleCompletions).clamp(0.0, 1.0)
: 1.0;
}
List<MessageActivityRequest> get activityRequests {
return practiceTargets.map((target) {
return MessageActivityRequest(
userL1: userL1,
userL2: userL2,
activityQualityFeedback: null,
target: target.target,
grammarErrorInfo: target.grammarErrorInfo,
exampleMessage: target.exampleMessage,
audioExampleMessage: target.audioExampleMessage,
);
}).toList();
}
/// Returns congratulations message based on performance
String getCompletionMessage(BuildContext context) {
final hasTimeBonus =
state.elapsedSeconds <= AnalyticsPracticeConstants.timeForBonus;
final hintsUsed = state.hintsUsed;
final bool perfectAccuracy = state.accuracy == 100;
final bool noHintsUsed = hintsUsed == 0;
final bool hintsAvailable = type == ConstructTypeEnum.morph;
//check how many conditions for bonuses the user met and return message accordingly
final conditionsMet = [
perfectAccuracy,
!hintsAvailable || noHintsUsed,
hasTimeBonus,
].where((c) => c).length;
if (conditionsMet == 3) {
return L10n.of(context).perfectPractice;
}
if (conditionsMet >= 2) {
return L10n.of(context).greatPractice;
}
if (hintsAvailable && noHintsUsed) {
return L10n.of(context).usedNoHints;
}
return L10n.of(context).youveCompletedPractice;
}
void setElapsedSeconds(int seconds) =>
state = state.copyWith(elapsedSeconds: seconds);
void finishSession() => state = state.copyWith(finished: true);
void completeActivity() =>
state = state.copyWith(currentIndex: state.currentIndex + 1);
void incrementSkippedActivities() =>
state = state.copyWith(skippedActivities: state.skippedActivities + 1);
void submitAnswer(List<OneConstructUse> uses) =>
state = state.copyWith(completedUses: [...state.completedUses, ...uses]);
void useHint() => state = state.copyWith(hintsUsed: state.hintsUsed + 1);
factory AnalyticsPracticeSessionModel.fromJson(Map<String, dynamic> json) {
return AnalyticsPracticeSessionModel(
startedAt: DateTime.parse(json['startedAt'] as String),
type: ConstructTypeEnum.values.firstWhere(
(e) => e.name == json['type'] as String,
orElse: () => ConstructTypeEnum.vocab,
),
practiceTargets: (json['practiceTargets'] as List<dynamic>)
.map((e) => AnalyticsActivityTarget.fromJson(e))
.whereType<AnalyticsActivityTarget>()
.toList(),
userL1: json['userL1'] as String,
userL2: json['userL2'] as String,
state: AnalyticsPracticeSessionState.fromJson(json),
);
}
Map<String, dynamic> toJson() {
return {
'startedAt': startedAt.toIso8601String(),
'type': type.name,
'practiceTargets': practiceTargets.map((e) => e.toJson()).toList(),
'userL1': userL1,
'userL2': userL2,
...state.toJson(),
};
}
}
class AnalyticsPracticeSessionState {
final List<OneConstructUse> completedUses;
final int currentIndex;
final bool finished;
final int hintsUsed;
final int elapsedSeconds;
final int skippedActivities;
const AnalyticsPracticeSessionState({
this.completedUses = const [],
this.currentIndex = 0,
this.finished = false,
this.hintsUsed = 0,
this.elapsedSeconds = 0,
this.skippedActivities = 0,
});
int get totalXpGained => completedUses.fold(0, (sum, use) => sum + use.xp);
double get accuracy {
if (completedUses.isEmpty) return 0.0;
final correct = completedUses.where((use) => use.xp > 0).length;
final result = correct / completedUses.length;
return (result * 100).truncateToDouble();
}
bool get _giveAccuracyBonus => accuracy >= 100.0;
bool get _giveTimeBonus =>
elapsedSeconds <= AnalyticsPracticeConstants.timeForBonus;
int get bonusXP => accuracyBonusXP + timeBonusXP;
int get accuracyBonusXP => _giveAccuracyBonus ? _bonusXP : 0;
int get timeBonusXP => _giveTimeBonus ? _bonusXP : 0;
int get _bonusXP => _bonusUses.fold(0, (sum, use) => sum + use.xp);
int get allXPGained => totalXpGained + bonusXP;
List<OneConstructUse> get _bonusUses =>
completedUses.where((use) => use.xp > 0).map(_bonusUse).toList();
List<OneConstructUse> get allBonusUses => [
if (_giveAccuracyBonus) ..._bonusUses,
if (_giveTimeBonus) ..._bonusUses,
];
OneConstructUse _bonusUse(OneConstructUse originalUse) => OneConstructUse(
useType: ConstructUseTypeEnum.bonus,
constructType: originalUse.constructType,
metadata: ConstructUseMetaData(
roomId: originalUse.metadata.roomId,
timeStamp: DateTime.now(),
),
category: originalUse.category,
lemma: originalUse.lemma,
form: originalUse.form,
xp: ConstructUseTypeEnum.bonus.pointValue,
);
AnalyticsPracticeSessionState copyWith({
List<OneConstructUse>? completedUses,
int? currentIndex,
bool? finished,
int? hintsUsed,
int? elapsedSeconds,
int? skippedActivities,
}) {
return AnalyticsPracticeSessionState(
completedUses: completedUses ?? this.completedUses,
currentIndex: currentIndex ?? this.currentIndex,
finished: finished ?? this.finished,
hintsUsed: hintsUsed ?? this.hintsUsed,
elapsedSeconds: elapsedSeconds ?? this.elapsedSeconds,
skippedActivities: skippedActivities ?? this.skippedActivities,
);
}
Map<String, dynamic> toJson() {
return {
'completedUses': completedUses.map((e) => e.toJson()).toList(),
'currentIndex': currentIndex,
'finished': finished,
'hintsUsed': hintsUsed,
'elapsedSeconds': elapsedSeconds,
'skippedActivities': skippedActivities,
};
}
factory AnalyticsPracticeSessionState.fromJson(Map<String, dynamic> json) {
return AnalyticsPracticeSessionState(
completedUses:
(json['completedUses'] as List<dynamic>?)
?.map((e) => OneConstructUse.fromJson(e))
.whereType<OneConstructUse>()
.toList() ??
[],
currentIndex: json['currentIndex'] as int? ?? 0,
finished: json['finished'] as bool? ?? false,
hintsUsed: json['hintsUsed'] as int? ?? 0,
elapsedSeconds: json['elapsedSeconds'] as int? ?? 0,
skippedActivities: json['skippedActivities'] as int? ?? 0,
);
}
}