feat: show assignment information to students #22

BryanttV · 2023-09-19T22:45:42Z

Description

This PR adds:

Information on the assignment in the LMS.
The list of submissions only shows those in submitted and completed status.

How To Test

Install this branch in your environment.
Add a block in a unit from Studio.
As a student, you should be able to see your assignment information.
As an instructor, you should only see submissions in submitted and completed status.

Screenshots

As Student

Not Attempted
Submitted
Completed

As Instructor

Ian2012 · 2023-09-20T17:33:30Z

mindmap/mindmap.py

+            StudentModule: A StudentModule object
+        """
+        # pylint: disable=no-member
+        student_module, created = StudentModule.objects.get_or_create(


Why are we using StudentModule objects directly?

edx-sga does something similar. Could we implement it in a better way?

Ian2012 · 2023-09-20T18:02:21Z

@BryanttV I don't think is a good approach to load the StudentModule object directly as it's not a good practice. All those implementations are behind the XBlock abstractions.

If your final goal is to store the state of the submission and show it to students, you can use some of the available scopes that will be best suited to your implementation. In the case none of the scopes is suitable for your purpose, try to compute the value your are searching for instead of storing it

mariajgrimaldi · 2023-09-20T18:44:22Z

mindmap/mindmap.py

+        module = self.get_student_module(data.get("module_id"))
+        state = json.loads(module.state)
+        state["submission_status"] = SubmissionStatus.SUBMITTED.value
+        module.state = json.dumps(state)
+        module.save()


Can we move this to a function? These lines are very similar the ones above

mariajgrimaldi · 2023-09-20T18:45:56Z

@Ian2012: I agree that there must be a better way of doing this, but we don't have much more time left to invest in this. So it's better to use what we know works and integrates well with what we already have.

mariajgrimaldi · 2023-09-20T19:36:08Z

@BryanttV @Ian2012 and I got to a better but similar solution: we can use the submissions API instead the Student Module, so we don't have to use the Django ORM.

johnvente · 2023-09-20T23:57:14Z

mindmap/public/js/src/mindmap.js

        const data = {
          student_id: student_id,
+          module_id: module_id,
        };
        console.log(data);


Please remove this

johnvente · 2023-09-21T00:01:18Z

mindmap/public/js/src/mindmap.js

@@ -295,9 +298,11 @@ function MindMapXBlock(runtime, element, context) {
      .click(function () {


I would create a constant called xblockId and would replace all these for xblockId instead of having context.xblock_id

const xblockId = context.xblock_id; const grade = $(element).find(`#grade-input_${xblockId}`).val(); const submission_id = $(element).find(`#submission-id-input_${xblockId}`).val(); const module_id = $(element).find(`#module-id-input_${xblockId`).val();

johnvente · 2023-09-21T00:01:35Z

mindmap/public/js/src/mindmap.js

        const data = {
          grade: grade,
          submission_id: submission_id,
+          module_id: module_id,
        };
        console.log(data);


Remove this

johnvente · 2023-09-21T00:01:53Z

mindmap/public/js/src/mindmap.js

@@ -313,8 +318,10 @@ function MindMapXBlock(runtime, element, context) {
      .find(`#remove-grade-button_${context.xblock_id}`)
      .click(function () {
        const student_id = $(element).find(`#student-id-input_${context.xblock_id}`).val();


Same as here

BryanttV · 2023-09-21T22:01:55Z

For state management, we evaluated different solutions among them:

implementation similar to SGA, reading the state information of a student using Django ORM to interact with the StudentModule.
Using the Submissions API to store the status of the submission.
Use an XBlock field of type user_summary_state to store shared information from all students about the submission status.

The second option we tried to implement, but it still has some edge cases that need to be evaluated in detail. The third option is still just an idea, but it has a caveat, when deleting the status of a student using the staff support tool, the update of this field must be fixed.

Finally, we decided to use the first option since it is already implemented and works correctly.

@mariajgrimaldi @Ian2012

mariajgrimaldi

This is working as expected!

BryanttV marked this pull request as ready for review September 20, 2023 17:21

BryanttV requested review from Ian2012, mariajgrimaldi, johnvente and nandodev-net and removed request for Ian2012 and mariajgrimaldi September 20, 2023 17:21

BryanttV changed the title ~~feat: show submission information to students~~ feat: show assignment information to students Sep 20, 2023

Ian2012 reviewed Sep 20, 2023

View reviewed changes

mariajgrimaldi reviewed Sep 20, 2023

View reviewed changes

BryanttV mentioned this pull request Sep 20, 2023

feat: show assignment information to students v2 #23

Closed

johnvente reviewed Sep 20, 2023

View reviewed changes

johnvente reviewed Sep 21, 2023

View reviewed changes

BryanttV requested review from Ian2012, johnvente and mariajgrimaldi September 21, 2023 21:44

mariajgrimaldi approved these changes Sep 21, 2023

View reviewed changes

Ian2012 approved these changes Sep 22, 2023

View reviewed changes

BryanttV added 4 commits September 22, 2023 08:42

feat: show submission information to students

2509a7c

chore: update translations

ce77ad0

test: update current unit test

0cd0269

refactor: address PR review

e758703

BryanttV force-pushed the bav/show-submission-info branch from c7bce9c to e758703 Compare September 22, 2023 15:20

BryanttV merged commit c27b707 into main Sep 22, 2023
5 checks passed

BryanttV deleted the bav/show-submission-info branch September 22, 2023 15:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: show assignment information to students #22

feat: show assignment information to students #22

BryanttV commented Sep 19, 2023 •

edited

Loading

Ian2012 Sep 20, 2023

BryanttV Sep 20, 2023

Ian2012 commented Sep 20, 2023

mariajgrimaldi Sep 20, 2023

BryanttV Sep 21, 2023

mariajgrimaldi commented Sep 20, 2023 •

edited

Loading

mariajgrimaldi commented Sep 20, 2023

johnvente Sep 20, 2023

BryanttV Sep 21, 2023

johnvente Sep 21, 2023 •

edited

Loading

BryanttV Sep 21, 2023

johnvente Sep 21, 2023

johnvente Sep 21, 2023

BryanttV commented Sep 21, 2023

mariajgrimaldi left a comment

		@@ -295,9 +298,11 @@ function MindMapXBlock(runtime, element, context) {
		.click(function () {

feat: show assignment information to students #22

feat: show assignment information to students #22

Conversation

BryanttV commented Sep 19, 2023 • edited Loading

Description

How To Test

Screenshots

As Student

As Instructor

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ian2012 commented Sep 20, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mariajgrimaldi commented Sep 20, 2023 • edited Loading

mariajgrimaldi commented Sep 20, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

johnvente Sep 21, 2023 • edited Loading

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

BryanttV commented Sep 21, 2023

mariajgrimaldi left a comment

Choose a reason for hiding this comment

BryanttV commented Sep 19, 2023 •

edited

Loading

mariajgrimaldi commented Sep 20, 2023 •

edited

Loading

johnvente Sep 21, 2023 •

edited

Loading