Added Exam mode #1236

iZUMi-kyouka · 2025-03-04T15:17:21Z

Description

Added exam mode functionality in the backend by adding enable_exam_mode and is_official_course in the courses table.
Added get_exam_mode_course() function in lib/cadet/accounts/course_registrations.ex
Modified lib/cadet_web/controllers/user_controller.ex logic in serving the last_viewed_course to always serve the official institution course under exam_mode if any of the user's official course is currently under exam mode. Performed the same modification for get_latest_viewed() function in the same file.
Added the required migrations file to alter the database
Added the 2 additional fields in the model and wherever necessary

01/04/25

Added resume_code to courses table
Added isPaused to users table
Added some tests for enable_exam_mode, is_official_course, and resume_code for the changesets

09/04/25

Added user_browser_focus_log table in the DB
Added the required endpoint to log when a user's browser loses focus and regains focus when under exam mode

Note: this may require change to the DB diagram in README.md

Type of Change

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update
Code quality improvements

Checklist

I have tested this code
I have updated the documentation

…ar course under exam mode

…any of a user's courses

…for addition of enable_exam_mode and is_official_course to courses table

…ents circumventing force redirection to official course under exam mode

RichDom2185

We don't need isOfficialCourse anymore, right?

…m_mode

…ted unused IO.puts

… bypassing overlay by refreshing

RichDom2185

Please fix the failing tests, thanks!

coveralls · 2025-03-31T09:15:05Z

coverage: 88.77% (-0.9%) from 89.636%
when pulling f1ed0bc on iZUMi-kyouka:exam_mode
into 40cd12a on source-academy:master.

lib/cadet_web/controllers/user_controller.ex

lib/cadet/courses/course.ex

lib/cadet_web/controllers/courses_controller.ex

GabrielCWT · 2025-04-02T07:24:22Z

lib/cadet/accounts/user.ex

    field(:provider, :string)
    field(:super_admin, :boolean)
    field(:email, :string)
+    field(:is_paused, :boolean)


Is there a reason why this is linked to the user and not their course_registration? Isn't exam mode related to their course.

Initially I thought linking this to the user would allow for the enforcing of the pause beyond the course so that if a user is paused due to opening other app / using dev tool (which is our plan), the user will have to settle the problem with the course admin / coordinator. But, now that you pointed out, maybe this should not affect the user through all their courses. Should I move this course_registration?

@RichDom2185 thoughts?

lib/cadet_web/controllers/user_controller.ex

GabrielCWT · 2025-04-03T05:18:47Z

One more thing which just came to mind. Correct me if I am wrong, your current implementation places all users with a course which has exam mode enabled have their SA placed on some sort of "lock down". Wouldn't this limit the use for admins/staff during the time in which the course is on lock down?

iZUMi-kyouka · 2025-04-03T10:05:09Z

One more thing which just came to mind. Correct me if I am wrong, your current implementation places all users with a course which has exam mode enabled have their SA placed on some sort of "lock down". Wouldn't this limit the use for admins/staff during the time in which the course is on lock down?

@GabrielCWT
Yes this is correct as of now. I will work on excluding them, so that staffs and admins work as usual, thanks!

…o separate private functions for readability.

…_controller; fixed a typing error in send_resp

…ned; improved readibility for pause_user

…es returned; improved readibility for pause_user" This reverts commit 31bbf5a.

…changeset, and applied it in the focus logging controlelr

…ation on creation of new course; rejects all course config update with empty resume code regardless of exam mode state

…de resume_code a required field

…ficial_course, and resume_code

…to pr/iZUMi-kyouka/1236

Copilot

Pull Request Overview

This PR implements exam mode functionality for courses, including backend support for enabling exam mode, tracking browser focus during exams, and pausing/unpausing users with resume codes.

Key Changes:

Added three new course fields: enable_exam_mode, is_official_course, and resume_code to control exam behavior and restrict exam mode to official courses
Added is_paused field to users and user_browser_focus_log table to track student browser activity during exams
Modified user controller logic to prioritize exam mode courses when determining the latest viewed course

Reviewed Changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
lib/cadet/courses/course.ex	Added exam mode fields and validation logic ensuring exam mode only enabled for official courses and resume codes are non-empty
lib/cadet/accounts/course_registrations.ex	Added query function to retrieve exam mode courses for a user
lib/cadet_web/controllers/user_controller.ex	Modified course selection logic to prioritize exam mode courses and added endpoints for pausing users and logging focus changes
lib/cadet_web/controllers/courses_controller.ex	Added resume code verification and user unpause functionality, plus admin-only config endpoint differentiation
lib/cadet/focus_logs/*	New module for managing browser focus logs during exams
priv/repo/migrations/*	Database migrations for new exam-related fields and focus log table
test/*	Updated tests and factories to include new fields

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-10-28T12:00:28Z

lib/cadet/courses/courses.ex


+  defp set_default_resume_code(params) do
+    params
+    |> Map.put(:resume_code, Integer.to_string(:rand.uniform(9000) + 999))


The random resume code generation will produce values between 1000-9999, but the arithmetic :rand.uniform(9000) + 999 is incorrect. It should be :rand.uniform(9000) + 1000 to generate codes from 1000 to 9999, or the intent may be a 4-digit code which should use :rand.uniform(9000) + 1000.

Copilot · 2025-10-28T12:00:28Z

lib/cadet_web/controllers/user_controller.ex

+      end
+
+    if focus_state do
+      case Cadet.FocusLogs.insert_log(user.id, course_id, state) do


The state parameter is passed to insert_log, but earlier in the function it was already parsed into focus_state (lines 168-173). The function should pass focus_state instead of the original state string.

Suggested change

case Cadet.FocusLogs.insert_log(user.id, course_id, state) do

case Cadet.FocusLogs.insert_log(user.id, course_id, focus_state) do

Copilot · 2025-10-28T12:00:29Z

lib/cadet_web/controllers/courses_controller.ex

-
-        render(conn, "config.json", config: config)
+        if conn.assigns.course_reg.role == :admin do
+          render(conn, "config_admin.json", config: config)


The config endpoint now exposes resume_code to admin users via the config_admin.json view. This could be a security concern as the resume code is meant to be a secret that students need to enter. Consider whether admins should receive this sensitive information through this endpoint.

Suggested change

render(conn, "config_admin.json", config: config)

# Remove resume_code before rendering for admins

config_admin = Map.delete(config, :resume_code)

render(conn, "config_admin.json", config: config_admin)

Copilot · 2025-10-28T12:00:29Z

lib/cadet/courses/course.ex

+    has_resume_code = params |> Map.has_key?(:resume_code)
+
+    resume_code_params =
+      params
+      |> Map.get(:resume_code, "")
+      |> String.trim()
+
+    resume_code =
+      changeset
+      |> get_field(:resume_code)
+
+    enable_exam_mode = Map.get(params, :enable_exam_mode, false)
+    is_official_course = get_field(changeset, :is_official_course, false)
+
+    case {enable_exam_mode, is_official_course, has_resume_code, resume_code_params} do
+      {_, _, true, ""} ->
+        add_error(
+          changeset,
+          :resume_code,
+          "Resume code must not be empty."
+        )
+
+      {true, false, _, _} ->


The validation checks has_resume_code separately from the actual value. This creates complexity because an empty string resume_code in params would set has_resume_code to true but resume_code_params to empty string after trim. Consider simplifying by checking the trimmed value directly rather than checking key existence separately.

Suggested change

has_resume_code = params |> Map.has_key?(:resume_code)

resume_code_params =

params

|> Map.get(:resume_code, "")

|> String.trim()

resume_code =

changeset

|> get_field(:resume_code)

enable_exam_mode = Map.get(params, :enable_exam_mode, false)

is_official_course = get_field(changeset, :is_official_course, false)

case {enable_exam_mode, is_official_course, has_resume_code, resume_code_params} do

{_, _, true, ""} ->

add_error(

changeset,

:resume_code,

"Resume code must not be empty."

)

{true, false, _, _} ->

resume_code_params =

params

|> Map.get(:resume_code, "")

|> String.trim()

enable_exam_mode = Map.get(params, :enable_exam_mode, false)

is_official_course = get_field(changeset, :is_official_course, false)

case {enable_exam_mode, is_official_course, resume_code_params} do

{_, _, ""} ->

add_error(

changeset,

:resume_code,

"Resume code must not be empty."

)

{true, false, _} ->

iZUMi-kyouka added 7 commits February 14, 2025 13:53

added enable_exam_mode field to all tests, models, and controllers

fc72d29

force student whose courses has exam mode to only access the particul…

2fc38ca

…ar course under exam mode

fixed failure to switch course even when no exam mode is enabled for …

9953b9c

…any of a user's courses

fixed unintended changes to previous migration; added migration file …

f450e85

…for addition of enable_exam_mode and is_official_course to courses table

added is_official_course field to models; added logic to prevent stud…

0bb9857

…ents circumventing force redirection to official course under exam mode

removed unnecessary changes in course_registrations.ex

d7ad8b3

removed unnecessary changes from user_controller.ex

f216d1b

iZUMi-kyouka requested a review from RichDom2185 March 4, 2025 15:17

sync fork

48fff28

iZUMi-kyouka self-assigned this Mar 4, 2025

iZUMi-kyouka marked this pull request as ready for review March 4, 2025 15:29

Merge branch 'master' into exam_mode

b5f2722

RichDom2185 reviewed Mar 6, 2025

View reviewed changes

iZUMi-kyouka and others added 14 commits March 12, 2025 03:14

added resume code functionality

bc4c48c

Merge remote-tracking branch 'refs/remotes/origin/exam_mode' into exa…

46c2ff0

…m_mode

added resume code checking endpoint and its handler

fe80662

minor change to resume_code handler

f3c9ea9

restore accidental deletion of function

665ad2a

renamed resume_code to check_resume_code

abb1014

added validation for enabling exam mode and setting resume code; dele…

82afebf

…ted unused IO.puts

added is_paused column and setting functionality to mitigate students…

1db4420

… bypassing overlay by refreshing

added migrations for is_paused_column

d88eeba

Merge branch 'master' into exam_mode

d9a97e3

Remove unused tree

40ea386

Fix format

7ae6f14

Merge branch 'master' into exam_mode

e62fcef

Redate migrations to maintain total ordering

e0330f2

RichDom2185 reviewed Mar 31, 2025

View reviewed changes

GabrielCWT requested changes Mar 31, 2025

View reviewed changes

lib/cadet_web/controllers/user_controller.ex Outdated Show resolved Hide resolved

lib/cadet_web/controllers/user_controller.ex Outdated Show resolved Hide resolved

lib/cadet/courses/course.ex Show resolved Hide resolved

iZUMi-kyouka added 3 commits April 1, 2025 22:52

makes latest course retrieval logic more concise

0302764

ran mix format on courses and user controller

7fcbc89

added new endpoint to report lost/regain of user focus

cad39c8

GabrielCWT reviewed Apr 2, 2025

View reviewed changes

lib/cadet_web/controllers/user_controller.ex Outdated Show resolved Hide resolved

removed filters for supplying exam_mode_course to renderer function

46af8d7

iZUMi-kyouka and others added 20 commits April 3, 2025 19:00

renamed check_resume_code to try_unpause_user; split up the logic int…

6531376

…o separate private functions for readability.

removed unnecessary admin config renderer in user_view and admin_user…

3dcc288

…_controller; fixed a typing error in send_resp

excludes staff and admins from exam_mode restriction on courses retur…

31bbf5a

…ned; improved readibility for pause_user

excludes staff and admins from exam_mode restriction on courses retur…

48c1b10

…ned; improved readibility for pause_user

Revert "excludes staff and admins from exam_mode restriction on cours…

e0758fb

…es returned; improved readibility for pause_user" This reverts commit 31bbf5a.

Merge branch 'exam_mode' into exam_mode_user_focus_logging

9154177

created new user_browser_focus_log; and created its type definition, …

7bd79fd

…changeset, and applied it in the focus logging controlelr

removed redundant logic from focus logging controller

ed16cb4

sets a default resume_code in migration; add random resume code gener…

22a5704

…ation on creation of new course; rejects all course config update with empty resume code regardless of exam mode state

fixed resume code validation to consider whitespace; formatting

6cba5f5

added default resume_code value to schema definition in course.ex; ma…

f6ab358

…de resume_code a required field

improved swagger help text for resume_code field; fix formatting

b99a82d

fixed bug in resume_code validation; added tests for exam_mode, is_of…

604b61b

…ficial_course, and resume_code

formatting

ca082c9

formatting

398bee0

add moduledoc for focus log

1c3d787

Merge branch 'master' into exam_mode

434d21c

Merge branch 'master' into exam_mode

58906d7

Merge branch 'master' of https://github.com/source-academy/backend in…

7d1a400

…to pr/iZUMi-kyouka/1236

Redate migrations to maintain total order

f1ed0bc

RichDom2185 requested a review from Copilot October 28, 2025 11:59

Copilot AI reviewed Oct 28, 2025

View reviewed changes

	case Cadet.FocusLogs.insert_log(user.id, course_id, state) do
	case Cadet.FocusLogs.insert_log(user.id, course_id, focus_state) do

-          render(conn, "config_admin.json", config: config)
+          # Remove resume_code before rendering for admins
+          config_admin = Map.delete(config, :resume_code)
+          render(conn, "config_admin.json", config: config_admin)

Uh oh!

Added Exam mode #1236

Are you sure you want to change the base?

Added Exam mode #1236

Uh oh!

Conversation

iZUMi-kyouka commented Mar 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Checklist

Uh oh!

RichDom2185 left a comment

Choose a reason for hiding this comment

Uh oh!

RichDom2185 left a comment

Choose a reason for hiding this comment

Uh oh!

coveralls commented Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GabrielCWT Apr 2, 2025

Choose a reason for hiding this comment

Uh oh!

iZUMi-kyouka Apr 2, 2025

Choose a reason for hiding this comment

Uh oh!

GabrielCWT Apr 2, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

GabrielCWT commented Apr 3, 2025

Uh oh!

iZUMi-kyouka commented Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 28, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

iZUMi-kyouka commented Mar 4, 2025 •

edited

Loading

coveralls commented Mar 31, 2025 •

edited

Loading

iZUMi-kyouka commented Apr 3, 2025 •

edited

Loading