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
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
//! Collection of functions used for processing and evaluating user submissions for exercises.

use futures::future::BoxFuture;
use std::collections::HashMap;
use url::Url;

use crate::{
    exercise_service_info::ExerciseServiceInfoApi,
    exercise_slide_submissions::{self, ExerciseSlideSubmission, NewExerciseSlideSubmission},
    exercise_task_gradings::{
        self, ExerciseTaskGrading, ExerciseTaskGradingResult, UserPointsUpdateStrategy,
    },
    exercise_task_regrading_submissions::ExerciseTaskRegradingSubmission,
    exercise_task_submissions::{self, ExerciseTaskSubmission},
    exercise_tasks::{self, CourseMaterialExerciseTask, ExerciseTask},
    exercises::{self, Exercise, ExerciseStatus, GradingProgress},
    peer_or_self_review_configs::PeerReviewProcessingStrategy,
    peer_or_self_review_question_submissions::{
        self, PeerOrSelfReviewQuestionSubmission, PeerReviewWithQuestionsAndAnswers,
    },
    prelude::*,
    regradings,
    user_course_instance_exercise_service_variables::UserCourseInstanceExerciseServiceVariable,
    user_exercise_slide_states::{self, UserExerciseSlideState},
    user_exercise_states::{
        self, CourseInstanceOrExamId, ExerciseWithUserState, UserExerciseState,
    },
    user_exercise_task_states,
};

use super::user_exercise_state_updater;

/// Contains data sent by the student when they make a submission for an exercise slide.
#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)]
#[cfg_attr(feature = "ts_rs", derive(TS))]
pub struct StudentExerciseSlideSubmission {
    pub exercise_slide_id: Uuid,
    pub exercise_task_submissions: Vec<StudentExerciseTaskSubmission>,
}

#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)]
#[cfg_attr(feature = "ts_rs", derive(TS))]
pub struct StudentExerciseSlideSubmissionResult {
    pub exercise_status: Option<ExerciseStatus>,
    pub exercise_task_submission_results: Vec<StudentExerciseTaskSubmissionResult>,
    pub user_course_instance_exercise_service_variables:
        Vec<UserCourseInstanceExerciseServiceVariable>,
}

impl StudentExerciseSlideSubmissionResult {
    pub fn clear_grading_information(&mut self) {
        self.exercise_status = None;
        self.exercise_task_submission_results
            .iter_mut()
            .for_each(|result| {
                result.grading = None;
                result.model_solution_spec = None;
            });
    }

    pub fn clear_model_solution_specs(&mut self) {
        self.exercise_task_submission_results
            .iter_mut()
            .for_each(|result| {
                result.model_solution_spec = None;
            })
    }
}

#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)]
#[cfg_attr(feature = "ts_rs", derive(TS))]
pub struct StudentExerciseTaskSubmission {
    pub exercise_task_id: Uuid,
    pub data_json: serde_json::Value,
}

#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)]
#[cfg_attr(feature = "ts_rs", derive(TS))]
pub struct StudentExerciseTaskSubmissionResult {
    pub submission: ExerciseTaskSubmission,
    pub grading: Option<ExerciseTaskGrading>,
    pub model_solution_spec: Option<serde_json::Value>,
    pub exercise_task_exercise_service_slug: String,
}

#[derive(Debug)]
pub struct ExerciseSlideSubmissionWithTasks {
    pub exercise_slide_submission: ExerciseSlideSubmission,
    pub exercise_slide_submission_tasks: Vec<ExerciseTaskSubmission>,
}

/// If passed to to an exercise state update, it will update the peer review status with the given information
#[derive(Debug)]
pub struct ExerciseStateUpdateNeedToUpdatePeerReviewStatusWithThis {
    pub given_enough_peer_reviews: bool,
    pub received_enough_peer_reviews: bool,
    pub peer_review_processing_strategy: PeerReviewProcessingStrategy,
    pub peer_review_accepting_threshold: f32,
    /// Used to for calculating averages when acting on PeerReviewProcessingStrategy
    pub received_peer_or_self_review_question_submissions: Vec<PeerOrSelfReviewQuestionSubmission>,
}

/// Inserts user submission to database. Tasks within submission are validated to make sure that
/// they belong to the correct exercise slide.
pub async fn create_user_exercise_slide_submission(
    conn: &mut PgConnection,
    exercise_with_user_state: &ExerciseWithUserState,
    user_exercise_slide_submission: &StudentExerciseSlideSubmission,
) -> ModelResult<ExerciseSlideSubmissionWithTasks> {
    let selected_exercise_slide_id = exercise_with_user_state
        .user_exercise_state()
        .selected_exercise_slide_id
        .ok_or_else(|| {
            ModelError::new(
                ModelErrorType::PreconditionFailed,
                "Exercise slide not selected for the student.".to_string(),
                None,
            )
        })?;
    let exercise_tasks: HashMap<Uuid, ExerciseTask> =
        exercise_tasks::get_exercise_tasks_by_exercise_slide_id(conn, &selected_exercise_slide_id)
            .await?;
    let user_points_update_strategy = if exercise_with_user_state.is_exam_exercise() {
        UserPointsUpdateStrategy::CanAddPointsAndCanRemovePoints
    } else {
        UserPointsUpdateStrategy::CanAddPointsButCannotRemovePoints
    };

    let mut tx = conn.begin().await?;

    let exercise_slide_submission = exercise_slide_submissions::insert_exercise_slide_submission(
        &mut tx,
        NewExerciseSlideSubmission {
            exercise_slide_id: selected_exercise_slide_id,
            course_id: exercise_with_user_state.exercise().course_id,
            course_instance_id: exercise_with_user_state
                .user_exercise_state()
                .course_instance_id,
            exam_id: exercise_with_user_state.exercise().exam_id,
            exercise_id: exercise_with_user_state.exercise().id,
            user_id: exercise_with_user_state.user_exercise_state().user_id,
            user_points_update_strategy,
        },
    )
    .await?;
    let user_exercise_task_submissions = &user_exercise_slide_submission.exercise_task_submissions;
    let mut exercise_slide_submission_tasks =
        Vec::with_capacity(user_exercise_task_submissions.len());
    for task_submission in user_exercise_task_submissions {
        let exercise_task = exercise_tasks
            .get(&task_submission.exercise_task_id)
            .ok_or_else(|| {
                ModelError::new(
                    ModelErrorType::PreconditionFailed,
                    "Attempting to submit exercise for illegal exercise_task_id.".to_string(),
                    None,
                )
            })?;
        let submission_id = exercise_task_submissions::insert(
            &mut tx,
            PKeyPolicy::Generate,
            exercise_slide_submission.id,
            exercise_task.exercise_slide_id,
            exercise_task.id,
            &task_submission.data_json,
        )
        .await?;
        let submission = exercise_task_submissions::get_by_id(&mut tx, submission_id).await?;
        exercise_slide_submission_tasks.push(submission)
    }

    tx.commit().await?;
    Ok(ExerciseSlideSubmissionWithTasks {
        exercise_slide_submission,
        exercise_slide_submission_tasks,
    })
}

// Relocated regrading logic to condensate score update logic in a single place.
// Needs better separation of concerns in the far future.
pub async fn update_grading_with_single_regrading_result(
    conn: &mut PgConnection,
    exercise: &Exercise,
    regrading_submission: &ExerciseTaskRegradingSubmission,
    exercise_task_grading: &ExerciseTaskGrading,
    exercise_task_grading_result: &ExerciseTaskGradingResult,
) -> ModelResult<()> {
    let task_submission = exercise_task_submissions::get_by_id(
        &mut *conn,
        regrading_submission.exercise_task_submission_id,
    )
    .await?;
    let slide_submission = exercise_slide_submissions::get_by_id(
        &mut *conn,
        task_submission.exercise_slide_submission_id,
    )
    .await?;
    let user_exercise_state = user_exercise_states::get_or_create_user_exercise_state(
        conn,
        slide_submission.user_id,
        exercise.id,
        slide_submission.course_instance_id,
        slide_submission.exam_id,
    )
    .await?;
    let user_exercise_slide_state = user_exercise_slide_states::get_or_insert_by_unique_index(
        &mut *conn,
        user_exercise_state.id,
        slide_submission.exercise_slide_id,
    )
    .await?;
    let regrading = regradings::get_by_id(&mut *conn, regrading_submission.regrading_id).await?;
    propagate_user_exercise_state_update_from_exercise_task_grading_result(
        conn,
        exercise,
        exercise_task_grading,
        exercise_task_grading_result,
        user_exercise_slide_state,
        regrading.user_points_update_strategy,
    )
    .await?;
    Ok(())
}

pub enum GradingPolicy {
    /// Grades exercise tasks by sending a request to their respective services.
    Default,
    /// Intended for test purposes only.
    Fixed(HashMap<Uuid, ExerciseTaskGradingResult>),
}

pub async fn grade_user_submission(
    conn: &mut PgConnection,
    exercise_with_user_state: &mut ExerciseWithUserState,
    user_exercise_slide_submission: &StudentExerciseSlideSubmission,
    grading_policy: GradingPolicy,
    fetch_service_info: impl Fn(Url) -> BoxFuture<'static, ModelResult<ExerciseServiceInfoApi>>,
    send_grading_request: impl Fn(
        Url,
        &ExerciseTask,
        &ExerciseTaskSubmission,
    ) -> BoxFuture<'static, ModelResult<ExerciseTaskGradingResult>>,
) -> ModelResult<StudentExerciseSlideSubmissionResult> {
    let mut tx = conn.begin().await?;

    let ExerciseSlideSubmissionWithTasks {
        exercise_slide_submission,
        exercise_slide_submission_tasks,
    } = create_user_exercise_slide_submission(
        &mut tx,
        exercise_with_user_state,
        user_exercise_slide_submission,
    )
    .await?;
    let user_exercise_state = exercise_with_user_state.user_exercise_state();
    let user_exercise_slide_state = user_exercise_slide_states::get_or_insert_by_unique_index(
        &mut tx,
        user_exercise_state.id,
        exercise_slide_submission.exercise_slide_id,
    )
    .await?;
    let results = match grading_policy {
        GradingPolicy::Default => {
            let mut results = Vec::with_capacity(exercise_slide_submission_tasks.len());
            for task_submission in exercise_slide_submission_tasks {
                let submission = grade_user_submission_task(
                    &mut tx,
                    &task_submission,
                    exercise_with_user_state.exercise(),
                    user_exercise_slide_state.id,
                    user_exercise_state,
                    &fetch_service_info,
                    &send_grading_request,
                )
                .await?;
                results.push(submission);
            }
            results
        }
        GradingPolicy::Fixed(fixed_results) => {
            let mut results = Vec::with_capacity(exercise_slide_submission_tasks.len());
            for task_submission in exercise_slide_submission_tasks {
                let fixed_result = fixed_results
                    .get(&task_submission.exercise_task_id)
                    .ok_or_else(|| {
                        ModelError::new(
                            ModelErrorType::Generic,
                            "Could not find fixed test result for testing".to_string(),
                            None,
                        )
                    })?
                    .clone();
                let submission = create_fixed_grading_for_submission_task(
                    &mut tx,
                    &task_submission,
                    exercise_with_user_state.exercise(),
                    user_exercise_slide_state.id,
                    &fixed_result,
                )
                .await?;
                results.push(submission);
            }
            results
        }
    };
    let user_exercise_state = update_user_exercise_slide_state_and_user_exercise_state(
        &mut tx,
        user_exercise_slide_state,
        exercise_slide_submission.user_points_update_strategy,
    )
    .await?;

    let course_instance_or_exam_id = CourseInstanceOrExamId::from_instance_and_exam_ids(
        user_exercise_state.course_instance_id,
        user_exercise_state.exam_id,
    )?;

    let user_course_instance_exercise_service_variables  = crate::user_course_instance_exercise_service_variables::get_all_variables_for_user_and_course_instance_or_exam(&mut tx, user_exercise_state.user_id, course_instance_or_exam_id).await?;

    let result = StudentExerciseSlideSubmissionResult {
        exercise_status: Some(ExerciseStatus {
            score_given: user_exercise_state.score_given,
            activity_progress: user_exercise_state.activity_progress,
            grading_progress: user_exercise_state.grading_progress,
            reviewing_stage: user_exercise_state.reviewing_stage,
        }),
        exercise_task_submission_results: results,
        user_course_instance_exercise_service_variables,
    };
    exercise_with_user_state.set_user_exercise_state(user_exercise_state)?;
    tx.commit().await?;
    Ok(result)
}

async fn grade_user_submission_task(
    conn: &mut PgConnection,
    submission: &ExerciseTaskSubmission,
    exercise: &Exercise,
    user_exercise_slide_state_id: Uuid,
    user_exercise_state: &UserExerciseState,
    fetch_service_info: impl Fn(Url) -> BoxFuture<'static, ModelResult<ExerciseServiceInfoApi>>,
    send_grading_request: impl Fn(
        Url,
        &ExerciseTask,
        &ExerciseTaskSubmission,
    ) -> BoxFuture<'static, ModelResult<ExerciseTaskGradingResult>>,
) -> ModelResult<StudentExerciseTaskSubmissionResult> {
    let grading = exercise_task_gradings::new_grading(conn, exercise, submission).await?;
    let updated_submission =
        exercise_task_submissions::set_grading_id(conn, grading.id, submission.id).await?;
    let exercise_task =
        exercise_tasks::get_exercise_task_by_id(conn, submission.exercise_task_id).await?;
    let grading = exercise_task_gradings::grade_submission(
        conn,
        submission,
        &exercise_task,
        exercise,
        &grading,
        user_exercise_state,
        fetch_service_info,
        send_grading_request,
    )
    .await?;
    user_exercise_task_states::upsert_with_grading(conn, user_exercise_slide_state_id, &grading)
        .await?;
    let model_solution_spec = exercise_tasks::get_exercise_task_model_solution_spec_by_id(
        conn,
        submission.exercise_task_id,
    )
    .await?;

    Ok(StudentExerciseTaskSubmissionResult {
        submission: updated_submission,
        grading: Some(grading),
        model_solution_spec,
        exercise_task_exercise_service_slug: exercise_task.exercise_type,
    })
}

async fn create_fixed_grading_for_submission_task(
    conn: &mut PgConnection,
    submission: &ExerciseTaskSubmission,
    exercise: &Exercise,
    user_exercise_slide_state_id: Uuid,
    fixed_result: &ExerciseTaskGradingResult,
) -> ModelResult<StudentExerciseTaskSubmissionResult> {
    let grading = exercise_task_gradings::new_grading(conn, exercise, submission).await?;
    let updated_submission =
        exercise_task_submissions::set_grading_id(conn, grading.id, submission.id).await?;
    let updated_grading =
        exercise_task_gradings::update_grading(conn, &grading, fixed_result, exercise).await?;
    user_exercise_task_states::upsert_with_grading(
        conn,
        user_exercise_slide_state_id,
        &updated_grading,
    )
    .await?;
    let exercise_task =
        exercise_tasks::get_exercise_task_by_id(conn, submission.exercise_task_id).await?;
    let model_solution_spec = exercise_task.model_solution_spec;

    Ok(StudentExerciseTaskSubmissionResult {
        submission: updated_submission,
        grading: Some(grading),
        model_solution_spec,
        exercise_task_exercise_service_slug: exercise_task.exercise_type,
    })
}

/// Updates the user exercise state starting from a slide state, and propagates the update up to the
/// whole user exercise state.
async fn update_user_exercise_slide_state_and_user_exercise_state(
    conn: &mut PgConnection,
    user_exercise_slide_state: UserExerciseSlideState,
    user_points_update_strategy: UserPointsUpdateStrategy,
) -> ModelResult<UserExerciseState> {
    update_user_exercise_slide_state(
        conn,
        &user_exercise_slide_state,
        user_points_update_strategy,
    )
    .await?;
    let user_exercise_state = user_exercise_state_updater::update_user_exercise_state(
        conn,
        user_exercise_slide_state.user_exercise_state_id,
    )
    .await?;

    Ok(user_exercise_state)
}

async fn update_user_exercise_slide_state(
    conn: &mut PgConnection,
    user_exercise_slide_state: &UserExerciseSlideState,
    user_points_update_strategy: UserPointsUpdateStrategy,
) -> ModelResult<()> {
    let (points_from_tasks, grading_progress) =
        user_exercise_task_states::get_grading_summary_by_user_exercise_slide_state_id(
            conn,
            user_exercise_slide_state.id,
        )
        .await?;
    let new_score_given = user_exercise_task_states::figure_out_new_score_given(
        user_exercise_slide_state.score_given,
        points_from_tasks,
        user_points_update_strategy,
    );
    let changes = user_exercise_slide_states::update(
        conn,
        user_exercise_slide_state.id,
        new_score_given,
        grading_progress,
    )
    .await?;
    info!(
        "Updating user exercise slide state {} affected {} rows.",
        user_exercise_slide_state.id, changes
    );
    Ok(())
}

/// Updates the user exercise state starting from a single task, and propagates the update up to the
/// whole user exercise state.
pub async fn propagate_user_exercise_state_update_from_exercise_task_grading_result(
    conn: &mut PgConnection,
    exercise: &Exercise,
    exercise_task_grading: &ExerciseTaskGrading,
    exercise_task_grading_result: &ExerciseTaskGradingResult,
    user_exercise_slide_state: UserExerciseSlideState,
    user_points_update_strategy: UserPointsUpdateStrategy,
) -> ModelResult<UserExerciseState> {
    let updated_exercise_task_grading = exercise_task_gradings::update_grading(
        conn,
        exercise_task_grading,
        exercise_task_grading_result,
        exercise,
    )
    .await?;
    exercise_task_submissions::set_grading_id(
        conn,
        updated_exercise_task_grading.id,
        updated_exercise_task_grading.exercise_task_submission_id,
    )
    .await?;
    let user_exercise_task_state = user_exercise_task_states::upsert_with_grading(
        conn,
        user_exercise_slide_state.id,
        &updated_exercise_task_grading,
    )
    .await?;
    let user_exercise_slide_state = user_exercise_slide_states::get_by_id(
        conn,
        user_exercise_task_state.user_exercise_slide_state_id,
    )
    .await?;
    let user_exercise_state = update_user_exercise_slide_state_and_user_exercise_state(
        conn,
        user_exercise_slide_state,
        user_points_update_strategy,
    )
    .await?;
    Ok(user_exercise_state)
}

#[derive(Debug, Serialize)]
#[cfg_attr(feature = "ts_rs", derive(TS))]
pub struct AnswersRequiringAttention {
    pub exercise_max_points: i32,
    pub data: Vec<AnswerRequiringAttentionWithTasks>,
    pub total_pages: u32,
}

#[derive(Debug, Serialize, Deserialize, PartialEq, Clone)]
#[cfg_attr(feature = "ts_rs", derive(TS))]
pub struct AnswerRequiringAttentionWithTasks {
    pub id: Uuid,
    pub user_id: Uuid,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
    pub deleted_at: Option<DateTime<Utc>>,
    pub data_json: Option<serde_json::Value>,
    pub grading_progress: GradingProgress,
    pub score_given: Option<f32>,
    pub submission_id: Uuid,
    pub exercise_id: Uuid,
    pub tasks: Vec<CourseMaterialExerciseTask>,
    pub given_peer_reviews: Vec<PeerReviewWithQuestionsAndAnswers>,
    pub received_peer_or_self_reviews: Vec<PeerReviewWithQuestionsAndAnswers>,
}

/// Gets submissions that require input from the teacher to continue processing.
pub async fn get_paginated_answers_requiring_attention_for_exercise(
    conn: &mut PgConnection,
    exercise_id: Uuid,
    pagination: Pagination,
    viewer_user_id: Uuid,
    fetch_service_info: impl Fn(Url) -> BoxFuture<'static, ModelResult<ExerciseServiceInfoApi>>,
) -> ModelResult<AnswersRequiringAttention> {
    let exercise = exercises::get_exercise_by_id(conn, exercise_id).await?;
    let answer_requiring_attention_count =
        exercise_slide_submissions::answer_requiring_attention_count(conn, exercise_id).await?;
    let data = exercise_slide_submissions::get_all_answers_requiring_attention(
        conn,
        exercise.id,
        pagination,
    )
    .await?;
    let mut answers = Vec::with_capacity(data.len());
    for answer in &data {
        let tasks = exercise_task_submissions::get_exercise_task_submission_info_by_exercise_slide_submission_id(
            conn,
            answer.submission_id,
            viewer_user_id,
            &fetch_service_info,
        )
        .await?;
        let given_peer_reviews = if let Some(course_instance_id) = answer.course_instance_id {
            peer_or_self_review_question_submissions::get_given_peer_reviews(
                conn,
                answer.user_id,
                answer.exercise_id,
                course_instance_id,
            )
            .await?
        } else {
            vec![]
        };
        let received_peer_or_self_reviews =
            peer_or_self_review_question_submissions::get_questions_and_answers_by_submission_id(
                conn,
                answer.submission_id,
            )
            .await?;
        let new_answer = AnswerRequiringAttentionWithTasks {
            id: answer.id,
            user_id: answer.user_id,
            created_at: answer.created_at,
            updated_at: answer.updated_at,
            deleted_at: answer.deleted_at,
            data_json: answer.data_json.to_owned(),
            grading_progress: answer.grading_progress,
            score_given: answer.score_given,
            submission_id: answer.submission_id,
            exercise_id: answer.exercise_id,
            tasks,
            given_peer_reviews,
            received_peer_or_self_reviews,
        };
        answers.push(new_answer);
    }
    Ok(AnswersRequiringAttention {
        exercise_max_points: exercise.score_maximum,
        data: answers,
        total_pages: pagination.total_pages(answer_requiring_attention_count),
    })
}