1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
use crate::{
    exercise_slide_submissions::ExerciseSlideSubmission,
    exercises::Exercise,
    peer_or_self_review_configs::{self, PeerOrSelfReviewConfig},
    peer_or_self_review_question_submissions::PeerOrSelfReviewQuestionSubmission,
    peer_or_self_review_questions::{self, PeerOrSelfReviewQuestion, PeerOrSelfReviewQuestionType},
    peer_or_self_review_submissions::{self, PeerOrSelfReviewSubmission},
    peer_review_queue_entries::PeerReviewQueueEntry,
    prelude::*,
    teacher_grading_decisions::{self, TeacherGradingDecision},
    user_exercise_slide_states::{self, UserExerciseSlideStateGradingSummary},
    user_exercise_states::UserExerciseState,
};

use super::{
    UserExerciseStateUpdateAlreadyLoadedRequiredData,
    UserExerciseStateUpdateAlreadyLoadedRequiredDataPeerReviewInformation,
    UserExerciseStateUpdateRequiredData, UserExerciseStateUpdateRequiredDataPeerReviewInformation,
};

/// Returns an object with all dependencies for the user_exercise_state update loaded. Either uses a preloaded value from already_loaded_internal_dependencies or fetches the necessary information from the database.
pub(super) async fn load_required_data(
    conn: &mut PgConnection,
    user_exercise_state_id: Uuid,
    already_loaded_internal_dependencies: UserExerciseStateUpdateAlreadyLoadedRequiredData,
) -> ModelResult<UserExerciseStateUpdateRequiredData> {
    info!("Loading required data for user_exercise_state update");
    let UserExerciseStateUpdateAlreadyLoadedRequiredData {
        exercise,
        current_user_exercise_state,
        peer_or_self_review_information,
        latest_teacher_grading_decision,
        user_exercise_slide_state_grading_summary,
    } = already_loaded_internal_dependencies;

    let loaded_user_exercise_state =
        load_current_user_exercise_state(conn, current_user_exercise_state, user_exercise_state_id)
            .await?;
    let loaded_exercise = load_exercise(conn, exercise, &loaded_user_exercise_state).await?;

    Ok(UserExerciseStateUpdateRequiredData {
        peer_or_self_review_information: load_peer_or_self_review_information(
            conn,
            peer_or_self_review_information,
            &loaded_user_exercise_state,
            &loaded_exercise,
        )
        .await?,
        exercise: loaded_exercise,
        latest_teacher_grading_decision: load_latest_teacher_grading_decision(
            conn,
            latest_teacher_grading_decision,
            &loaded_user_exercise_state,
        )
        .await?,
        user_exercise_slide_state_grading_summary: load_user_exercise_slide_state_grading_summary(
            conn,
            user_exercise_slide_state_grading_summary,
            &loaded_user_exercise_state,
        )
        .await?,
        current_user_exercise_state: loaded_user_exercise_state,
    })
}

async fn load_user_exercise_slide_state_grading_summary(
    conn: &mut PgConnection,
    user_exercise_slide_state_grading_summary: Option<UserExerciseSlideStateGradingSummary>,
    loaded_user_exercise_state: &UserExerciseState,
) -> ModelResult<UserExerciseSlideStateGradingSummary> {
    if let Some(user_exercise_slide_state_grading_summary) =
        user_exercise_slide_state_grading_summary
    {
        info!("Using already loaded user exercise slide state grading summary");
        Ok(user_exercise_slide_state_grading_summary)
    } else {
        info!("Loading user exercise slide state grading summary");
        user_exercise_slide_states::get_grading_summary_by_user_exercise_state_id(
            conn,
            loaded_user_exercise_state.id,
        )
        .await
    }
}

async fn load_latest_teacher_grading_decision(
    conn: &mut PgConnection,
    latest_teacher_grading_decision: Option<Option<TeacherGradingDecision>>,
    loaded_user_exercise_state: &UserExerciseState,
) -> ModelResult<Option<TeacherGradingDecision>> {
    if let Some(latest_teacher_grading_decision) = latest_teacher_grading_decision {
        info!("Using already loaded latest teacher grading decision");
        Ok(latest_teacher_grading_decision)
    } else {
        info!("Loading latest teacher grading decision");
        Ok(teacher_grading_decisions::try_to_get_latest_grading_decision_by_user_exercise_state_id(conn, loaded_user_exercise_state.id).await?)
    }
}

async fn load_current_user_exercise_state(
    conn: &mut PgConnection,
    already_loaded_user_exercise_state: Option<UserExerciseState>,
    user_exercise_state_id: Uuid,
) -> ModelResult<UserExerciseState> {
    if let Some(user_exercise_state) = already_loaded_user_exercise_state {
        info!("Using already loaded user exercise state");
        Ok(user_exercise_state)
    } else {
        info!("Loading user exercise state");
        Ok(crate::user_exercise_states::get_by_id(conn, user_exercise_state_id).await?)
    }
}

async fn load_exercise(
    conn: &mut PgConnection,
    already_loaded_exercise: Option<Exercise>,
    current_user_exercise_state: &UserExerciseState,
) -> ModelResult<Exercise> {
    if let Some(exercise) = already_loaded_exercise {
        info!("Using already loaded exercise");
        Ok(exercise)
    } else {
        info!("Loading exercise");
        Ok(crate::exercises::get_by_id(conn, current_user_exercise_state.exercise_id).await?)
    }
}

async fn load_peer_or_self_review_information(
    conn: &mut PgConnection,
    already_loaded_peer_or_self_review_information: Option<
        UserExerciseStateUpdateAlreadyLoadedRequiredDataPeerReviewInformation,
    >,
    loaded_user_exercise_state: &UserExerciseState,
    loaded_exercise: &Exercise,
) -> ModelResult<Option<UserExerciseStateUpdateRequiredDataPeerReviewInformation>> {
    info!("Loading peer or self review information");
    if loaded_exercise.needs_peer_review || loaded_exercise.needs_self_review {
        if loaded_exercise.needs_peer_review {
            info!("Exercise needs peer review");
        }
        if loaded_exercise.needs_self_review {
            info!("Exercise needs self review");
        }

        // Destruct the contents of already_loaded_peer_or_self_review_information so that we can use the fields of the parent struct independently
        let UserExerciseStateUpdateAlreadyLoadedRequiredDataPeerReviewInformation {
            given_peer_or_self_review_submissions,
            given_self_review_submission,
            latest_exercise_slide_submission,
            latest_exercise_slide_submission_received_peer_or_self_review_question_submissions,
            peer_review_queue_entry,
            peer_or_self_review_config,
            peer_or_self_review_questions,
        } = if let Some(already_loaded_peer_or_self_review_information) =
            already_loaded_peer_or_self_review_information
        {
            already_loaded_peer_or_self_review_information
        } else {
            Default::default()
        };

        let loaded_latest_exercise_slide_submission = load_latest_exercise_slide_submission(
            conn,
            latest_exercise_slide_submission,
            loaded_user_exercise_state,
        )
        .await?;

        let loaded_peer_or_self_review_config =
            load_peer_or_self_review_config(conn, peer_or_self_review_config, loaded_exercise)
                .await?;

        Ok(Some(
            UserExerciseStateUpdateRequiredDataPeerReviewInformation {
                given_peer_or_self_review_submissions: load_given_peer_or_self_review_submissions(
                    conn,
                    given_peer_or_self_review_submissions,
                    loaded_user_exercise_state,
                )
                .await?,
                given_self_review_submission: load_given_self_review_submission(
                    conn,
                    given_self_review_submission,
                    loaded_user_exercise_state,
                )
                .await?,
                latest_exercise_slide_submission_received_peer_or_self_review_question_submissions:
                    load_latest_exercise_slide_submission_received_peer_or_self_review_question_submissions(
                        conn,
                        latest_exercise_slide_submission_received_peer_or_self_review_question_submissions,
                        loaded_latest_exercise_slide_submission.id,
                    )
                    .await?,
                peer_review_queue_entry: load_peer_review_queue_entry(
                    conn,
                    peer_review_queue_entry,
                    loaded_latest_exercise_slide_submission.id,
                    loaded_user_exercise_state,
                )
                .await?,
                peer_or_self_review_config: loaded_peer_or_self_review_config.clone(),
                peer_or_self_review_questions: load_peer_or_self_review_questions(
                    conn,
                    peer_or_self_review_questions,
                    &loaded_peer_or_self_review_config,
                )
                .await?,
            },
        ))
    } else {
        info!("Exercise does not need peer or self review");
        // Peer review disabled for the exercise, no need to load any information related to peer reviews.
        Ok(None)
    }
}

async fn load_peer_or_self_review_config(
    conn: &mut PgConnection,
    already_loaded_peer_or_self_review_config: Option<
        crate::peer_or_self_review_configs::PeerOrSelfReviewConfig,
    >,
    loaded_exercise: &Exercise,
) -> ModelResult<PeerOrSelfReviewConfig> {
    if let Some(prc) = already_loaded_peer_or_self_review_config {
        info!("Using already loaded peer review config");
        Ok(prc)
    } else {
        info!("Loading peer review config");
        Ok(peer_or_self_review_configs::get_by_exercise_or_course_id(
            conn,
            loaded_exercise,
            loaded_exercise.course_id.ok_or_else(|| {
                ModelError::new(
                    ModelErrorType::InvalidRequest,
                    "Peer reviews work only on courses (and not, for example, on exams)"
                        .to_string(),
                    None,
                )
            })?,
        )
        .await?)
    }
}

/** Loads peer review config and normalizes weights, if necessary */
async fn load_peer_or_self_review_questions(
    conn: &mut PgConnection,
    already_loaded_peer_or_self_review_questions: Option<Vec<PeerOrSelfReviewQuestion>>,
    loaded_peer_or_self_review_config: &PeerOrSelfReviewConfig,
) -> ModelResult<Vec<PeerOrSelfReviewQuestion>> {
    if let Some(prq) = already_loaded_peer_or_self_review_questions {
        info!("Using already loaded peer review questions");
        Ok(prq)
    } else {
        info!("Loading peer review questions");
        let mut questions =
            peer_or_self_review_questions::get_all_by_peer_or_self_review_config_id(
                conn,
                loaded_peer_or_self_review_config.id,
            )
            .await?;

        if !loaded_peer_or_self_review_config.points_are_all_or_nothing {
            questions = normalize_weights(questions);
        }
        Ok(questions)
    }
}

fn normalize_weights(
    mut questions: Vec<PeerOrSelfReviewQuestion>,
) -> Vec<PeerOrSelfReviewQuestion> {
    info!("Normalizing peer review question weights to sum to 1");
    questions.sort_by(|a, b| a.order_number.cmp(&b.order_number));
    info!(
        "Weights before normalization: {:?}",
        questions.iter().map(|q| q.weight).collect::<Vec<_>>()
    );
    let (mut allowed_to_have_weight, mut not_allowed_to_have_weight) = questions
        .into_iter()
        .partition::<Vec<_>, _>(|q| q.question_type == PeerOrSelfReviewQuestionType::Scale);
    let number_of_questions = allowed_to_have_weight.len();
    let sum_of_weights = allowed_to_have_weight.iter().map(|q| q.weight).sum::<f32>();
    if sum_of_weights < 0.000001 {
        info!("All weights are zero, setting all weights to 1/number_of_questions so that they sum to 1.");
        for question in &mut allowed_to_have_weight {
            question.weight = 1.0 / number_of_questions as f32;
        }
    } else {
        for question in &mut allowed_to_have_weight {
            question.weight /= sum_of_weights;
        }
    }
    for question in &mut not_allowed_to_have_weight {
        question.weight = 0.0;
    }
    let mut new_vec = not_allowed_to_have_weight;
    new_vec.append(&mut allowed_to_have_weight);
    new_vec.sort_by(|a, b| a.order_number.cmp(&b.order_number));
    questions = new_vec;
    info!(
        "Weights after normalization: {:?}",
        questions.iter().map(|q| q.weight).collect::<Vec<_>>()
    );
    questions
}

async fn load_peer_review_queue_entry(
    conn: &mut PgConnection,
    already_loaded_peer_review_queue_entry: Option<Option<PeerReviewQueueEntry>>,
    latest_exercise_submission_id: Uuid,
    loaded_user_exercise_state: &UserExerciseState,
) -> ModelResult<Option<PeerReviewQueueEntry>> {
    if let Some(prqe) = already_loaded_peer_review_queue_entry {
        info!("Using already loaded peer review queue entry");
        Ok(prqe)
    } else {
        info!("Loading peer review queue entry");
        let course_instance_id =
            loaded_user_exercise_state
                .course_instance_id
                .ok_or_else(|| {
                    ModelError::new(
                        ModelErrorType::InvalidRequest,
                        "Peer reviews work only on courses (and not, for example, on exams)"
                            .to_string(),
                        None,
                    )
                })?;
        // The result is optinal because not all answers are in the peer review queue yet. For example, we don't place any answers to the queue if their giver has not given enough peer reviews.
        Ok(crate::peer_review_queue_entries::try_to_get_by_receiving_submission_and_course_instance_ids(conn, latest_exercise_submission_id, course_instance_id ).await?)
    }
}

async fn load_latest_exercise_slide_submission_received_peer_or_self_review_question_submissions(
    conn: &mut PgConnection,
    latest_exercise_slide_submission_received_peer_or_self_review_question_submissions: Option<
        Vec<PeerOrSelfReviewQuestionSubmission>,
    >,
    latest_exercise_slide_submission_id: Uuid,
) -> ModelResult<Vec<PeerOrSelfReviewQuestionSubmission>> {
    if let Some(
        latest_exercise_slide_submission_received_peer_or_self_review_question_submissions,
    ) = latest_exercise_slide_submission_received_peer_or_self_review_question_submissions
    {
        info!("Using already loaded latest exercise slide submission received peer review question submissions");
        Ok(latest_exercise_slide_submission_received_peer_or_self_review_question_submissions)
    } else {
        info!("Loading latest exercise slide submission received peer review question submissions");
        Ok(crate::peer_or_self_review_question_submissions::get_received_question_submissions_for_exercise_slide_submission(conn, latest_exercise_slide_submission_id).await?)
    }
}

async fn load_latest_exercise_slide_submission(
    conn: &mut PgConnection,
    already_loaded_latest_exercise_slide_submission: Option<ExerciseSlideSubmission>,
    loaded_user_exercise_state: &UserExerciseState,
) -> ModelResult<ExerciseSlideSubmission> {
    if let Some(latest_exercise_slide_submission) = already_loaded_latest_exercise_slide_submission
    {
        info!("Using already loaded latest exercise slide submission");
        Ok(latest_exercise_slide_submission)
    } else {
        info!("Loading latest exercise slide submission");
        let selected_exercise_slide_id = loaded_user_exercise_state.selected_exercise_slide_id.ok_or_else(|| ModelError::new(ModelErrorType::PreconditionFailed, "No selected exercise slide id found: presumably the user has not answered the exercise.".to_string(), None))?;
        // Received peer reviews are only considered for the latest submission.
        let latest_exercise_slide_submission =
            crate::exercise_slide_submissions::get_users_latest_exercise_slide_submission(
                conn,
                selected_exercise_slide_id,
                loaded_user_exercise_state.user_id,
            )
            .await?;
        Ok(latest_exercise_slide_submission)
    }
}

async fn load_given_peer_or_self_review_submissions(
    conn: &mut PgConnection,
    already_loaded_given_peer_or_self_review_submissions: Option<Vec<PeerOrSelfReviewSubmission>>,
    loaded_user_exercise_state: &UserExerciseState,
) -> ModelResult<Vec<PeerOrSelfReviewSubmission>> {
    if let Some(given_peer_or_self_review_submissions) =
        already_loaded_given_peer_or_self_review_submissions
    {
        info!("Using already loaded given peer review submissions");
        Ok(given_peer_or_self_review_submissions)
    } else {
        info!("Loading given peer review submissions");
        let course_instance_id =
            loaded_user_exercise_state
                .course_instance_id
                .ok_or_else(|| {
                    ModelError::new(
                        ModelErrorType::InvalidRequest,
                        "Peer reviews work only on courses (and not, for example, on exams)"
                            .to_string(),
                        None,
                    )
                })?;
        Ok(peer_or_self_review_submissions::get_peer_reviews_given_by_user_and_course_instance_and_exercise(conn, loaded_user_exercise_state.user_id, course_instance_id, loaded_user_exercise_state.exercise_id).await?)
    }
}

async fn load_given_self_review_submission(
    conn: &mut PgConnection,
    already_loaded_given_self_review_submission: Option<Option<PeerOrSelfReviewSubmission>>,
    loaded_user_exercise_state: &UserExerciseState,
) -> ModelResult<Option<PeerOrSelfReviewSubmission>> {
    if let Some(given_self_review_submission) = already_loaded_given_self_review_submission {
        info!("Using already loaded given self review submission");
        Ok(given_self_review_submission)
    } else if let Some(course_instance_id) = loaded_user_exercise_state.course_instance_id {
        info!("Loading given self review submission");
        Ok(
            peer_or_self_review_submissions::get_self_review_submission_by_user_and_exercise(
                conn,
                loaded_user_exercise_state.user_id,
                loaded_user_exercise_state.exercise_id,
                course_instance_id,
            )
            .await?,
        )
    } else {
        Err(ModelError::new(
            ModelErrorType::PreconditionFailed,
            "No course instance found: self review is only possible on courses".to_string(),
            None,
        ))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    mod normalize_weights {
        use super::*;

        #[test]
        fn test_normalize_weights() {
            let peer_or_self_review_questions = vec![
                PeerOrSelfReviewQuestion {
                    id: Uuid::new_v4(),
                    peer_or_self_review_config_id: Uuid::new_v4(),
                    question_type: PeerOrSelfReviewQuestionType::Scale,
                    order_number: 1,
                    weight: 0.3,
                    question: "Scale question".to_string(),
                    created_at: chrono::Utc::now(),
                    updated_at: chrono::Utc::now(),
                    deleted_at: None,
                    answer_required: true,
                },
                PeerOrSelfReviewQuestion {
                    id: Uuid::new_v4(),
                    peer_or_self_review_config_id: Uuid::new_v4(),
                    question_type: PeerOrSelfReviewQuestionType::Essay,
                    order_number: 2,
                    weight: 0.1,
                    question: "Text question".to_string(),
                    created_at: chrono::Utc::now(),
                    updated_at: chrono::Utc::now(),
                    deleted_at: None,
                    answer_required: true,
                },
                PeerOrSelfReviewQuestion {
                    id: Uuid::new_v4(),
                    peer_or_self_review_config_id: Uuid::new_v4(),
                    question_type: PeerOrSelfReviewQuestionType::Scale,
                    order_number: 3,
                    weight: 0.1,
                    question: "Scale question".to_string(),
                    created_at: chrono::Utc::now(),
                    updated_at: chrono::Utc::now(),
                    deleted_at: None,
                    answer_required: true,
                },
            ];
            let normalized_peer_or_self_review_questions =
                normalize_weights(peer_or_self_review_questions);
            assert_eq!(normalized_peer_or_self_review_questions[0].weight, 0.75);
            assert_eq!(normalized_peer_or_self_review_questions[1].weight, 0.0);
            assert_eq!(normalized_peer_or_self_review_questions[2].weight, 0.25);
        }
    }
}