Refactor Live Feedback Settings for Assessment Edit and Submission Form #7553

bivanalhar · 2024-09-14T00:04:08Z

Background

It's been found out that recently, only Manager/Owner can access the Assessment Edit Page, and that accessing this page while having Codaveri Component disabled caused unexpected error. Upon further inspection, it's found out that the attempt to fetch the Codaveri Settings for Assessment, which is being done while accessing the Assessment Edit Page, calls out the controller in which only Manager/Owner has the ability to do so.

Fix

Upon this inspection, we decided to do several fixes, as well as the further enhancement towards the Assessment Edit Page, as follows:

decouple the logic for fetching codaveri settings and toggling on/off codaveri settings for assessment from codaveri settings controller. We placed the logic for these 2 inside the Assessment controller, in which Teaching Assistant also has right to access the controller
we do not return any programming questions (regardless of whether some of them is support-ible by codaveri) and disable Get Help in the assessment level if the Codaveri Component is disabled for the course, and give info to user to enable the codaveri component first

Miscellaneous

Within this PR, we also do the refactor of Submission Form, not to render Get Help button if Codaveri Component is disabled

cysjonathan · 2024-09-19T08:31:50Z

client/app/bundles/course/assessment/components/AssessmentForm/translations.ts

+  isCourseCodaveriDisabled: {
+    id: 'course.assessment.AssessmentForm.isCourseCodaveriDisabled',
+    defaultMessage:
+      'Please contact the Course Administrator to enable Codaveri Evaluator\


There is no terminology "Course Administrator", update and follow existing example

app/views/course/assessment/assessments/edit.json.jbuilder

cysjonathan · 2024-09-19T08:39:47Z

...submission/pages/SubmissionEditIndex/components/NonAutogradedProgrammingActionButtonsRow.tsx

@@ -30,6 +32,8 @@ const NonAutogradedProgrammingActionButtonsRow: FC<Props> = (props) => {
  const question = questions[questionId];
  const { viewHistory } = question;

+  const { isCodaveriEnabled } = assessment;


in my opinion, this should be isCourseCodaveriEnabled to make it clear that this is the course attribute, but since this comes from a very old commit, we can leave this for now, since there are already many changes in this PR.

cysjonathan · 2024-09-19T08:43:37Z

spec/controllers/course/assessment/assessments_controller_spec.rb

+    describe '#live_feedback_settings' do
+      render_views
+      let(:assessment) { create(:assessment, course: course) }
+      let(:lang_valid_for_codaveri) { Coursemology::Polyglot::Language::Python::Python3Point12.instance }


Leave a TODO that this should be updated when codaveri_language_whitelist changes in coursemology2/app/services/codaveri_async_api_service.rb. Eventually we will have a dynamic list pulled from Codaveri during production, and mock a list during tests.

cysjonathan · 2024-09-19T08:48:41Z

config/routes.rb

          get :requirements, on: :member
          get :statistics, on: :member
          get :monitoring, on: :member
+          patch :update_live_feedback_settings, on: :member


GET and PATCH are different HTTP request types, and should use the same route :live_feedback_settings, don't make a new route. See other routes for examples.

cysjonathan · 2024-09-19T08:52:04Z

client/app/bundles/course/assessment/operations/assessments.ts

+            tabs: [],
+            categories: [],


any reason why tabs / categories are set to empty array?

actually we couldn't care less about the tabs and categories; this is for assessmentEdit only.. However, the input of tabs and categories are required to be stored in redux, and hence it's technically can be set to anything. I just put empty array there.

I ended up refactoring the action call for this (so now tabs and categories can be undefined, and in that case, we don't update tabs and categories on redux)

cysjonathan · 2024-09-19T08:56:34Z

.../bundles/course/admin/pages/CodaveriSettings/components/buttons/LiveFeedbackToggleButton.tsx

@@ -15,11 +16,17 @@ import CodaveriSettingsChip from '../CodaveriSettingsChip';
 interface LiveFeedbackToggleButtonProps {
  assessmentIds: number[];
  for: string;
-  hideChipIndicator?: boolean;
+  forSpecificAssessment?: boolean;


booleans please follow is has prefix convention where possible instead of custom naming, unless absolutely necessary.
isSpecificAssessment will work fine here.

cysjonathan · 2024-09-19T08:57:20Z

client/app/api/course/Assessment/Assessments.js

+
+  updateLiveFeedbackSettings(assessmentId, params) {
+    return this.client.patch(
+      `${this.#urlPrefix}/${assessmentId}/update_live_feedback_settings`,


Update this route to follow updated routes.rb

app/views/course/assessment/assessments/live_feedback_settings.json.jbuilder

- simplify logic for live feedback toggle in Assessment Edit

- for assessment edit page

- remove "Get Help" button inside SubmissionForm, regardless of whether question has live feedback enabled or not - disable Live Feedback Toggle inside Assessment Edit - Not returning any programming questions for live feedback inside assessment edit - Add Info Label when course has its codaveri disabled, and when no programming questions supportible by codaveri is present

bivanalhar force-pushed the bivan/codaveri-assessment-fix branch 2 times, most recently from c6bf788 to 6ff1bbb Compare September 14, 2024 00:31

bivanalhar changed the title ~~Refactor Live Feedback Settings for Assessment Edit~~ Refactor Live Feedback Settings for Assessment Edit and Submission Form Sep 14, 2024

bivanalhar force-pushed the bivan/codaveri-assessment-fix branch from f2972b3 to 8d31b52 Compare September 14, 2024 14:53

bivanalhar requested a review from cysjonathan September 15, 2024 12:50

cysjonathan requested changes Sep 19, 2024

View reviewed changes

bivanalhar force-pushed the bivan/codaveri-assessment-fix branch 2 times, most recently from 384c8b5 to bc3e702 Compare September 20, 2024 07:15

bivanalhar mentioned this pull request Sep 27, 2024

Heartbeat Monitoring for Exams: Safe Exam Browser (SEB) browser authorisation #7542

Merged

bivanalhar added 2 commits October 28, 2024 17:14

refactor(settings): live feedback for assessment

3fcbc75

- simplify logic for live feedback toggle in Assessment Edit

chore(test): add live feedback settings test

74a4777

- for assessment edit page

bivanalhar force-pushed the bivan/codaveri-assessment-fix branch from bc3e702 to 089b1e3 Compare October 28, 2024 09:21

bivanalhar force-pushed the bivan/codaveri-assessment-fix branch from 089b1e3 to 6bcab50 Compare October 28, 2024 09:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor Live Feedback Settings for Assessment Edit and Submission Form #7553

Refactor Live Feedback Settings for Assessment Edit and Submission Form #7553

bivanalhar commented Sep 14, 2024 •

edited

Loading

cysjonathan Sep 19, 2024

bivanalhar Sep 20, 2024

cysjonathan Sep 19, 2024

bivanalhar Sep 20, 2024

cysjonathan Sep 19, 2024

bivanalhar Sep 20, 2024

cysjonathan Sep 19, 2024

bivanalhar Sep 20, 2024

cysjonathan Sep 19, 2024

bivanalhar Sep 19, 2024

bivanalhar Sep 20, 2024

cysjonathan Sep 19, 2024

bivanalhar Sep 20, 2024

cysjonathan Sep 19, 2024

bivanalhar Sep 20, 2024

Refactor Live Feedback Settings for Assessment Edit and Submission Form #7553

Are you sure you want to change the base?

Refactor Live Feedback Settings for Assessment Edit and Submission Form #7553

Conversation

bivanalhar commented Sep 14, 2024 • edited Loading

Background

Fix

Miscellaneous

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bivanalhar commented Sep 14, 2024 •

edited

Loading