feat: add author different author view for studio #30

mariajgrimaldi · 2023-10-02T21:40:40Z

Description

This PR adds an author view that differs from the student view so we better manage what to show Studio authors. Before these changes, what was shown was manage by the same student view which shows the grading interface unless these conditions meet:

def show_staff_grading_interface(self) -> bool:
        """
        Return if current user is staff and not in studio.

        Returns:
            bool: True if current user is instructor and not in studio.
        """
        in_studio_preview = self.scope_ids.user_id is None
        return not in_studio_preview and self.is_course_team

In_studio_preview returns the user ID when we're in the studio preview, so the check returned True when it wasn't supposed to since self.scope_ids.user_id is different than None in Studio preview using edx-platforms' master branch (although it's supposed to return None according to these docs, I'm not sure what's wrong). It was probably working because the user wasn't course staff but an instructor, so the overall check returned false before the changes in this PR.

Also, in_student_view which allows loading the scripts for mindmaps, should indicate whether we're in the student view not if the user has a role like it was before.

How to test

Install the Xblock as usual, then go to the components' Studio preview. It should show the default mindmap. Also, when using a static mindmap it should show the default static mindmap. The Studio edit should work as well.

mariajgrimaldi · 2023-10-02T22:08:26Z

Do not review for now. I'll let you know!

mariajgrimaldi · 2023-10-04T14:40:58Z

@eduNEXT/athena-team: folks! This is ready for your review.

mariajgrimaldi · 2023-10-04T14:43:17Z

mindmap/mindmap.py

-        Returns:
-            bool: True if current user is instructor and not in studio.
-        """
-        in_studio_preview = self.scope_ids.user_id is None


Check yourself: self.scope_ids.user_id when in Studio preview returns the actual user ID, in Studio edit returns None as it should. So this check only works for the studio edit view

mariajgrimaldi · 2023-10-04T14:44:21Z

mindmap/mindmap.py

@@ -287,6 +287,27 @@ def student_view(self, _context=None) -> Fragment:

        return frag

+    def author_view(self, _context=None) -> Fragment:


Having an author view allows us to manage what to show in the Studio preview

johnvente · 2023-10-04T16:56:23Z

@mariajgrimaldi It's working good for me!

BryanttV · 2023-10-04T16:59:49Z

@mariajgrimaldi, I installed the xblock but currently, I am having the following error in the LMS:

tutor_nightly_dev-lms-1  |   File "/openedx/venv/lib/python3.8/site-packages/storages/backends/s3.py", line 36, in <module>
tutor_nightly_dev-lms-1  |     import s3transfer.constants
tutor_nightly_dev-lms-1  | ModuleNotFoundError: No module named 's3transfer.constants'
tutor_nightly_dev-lms-1  | 
tutor_nightly_dev-lms-1  | During handling of the above exception, another exception occurred:
tutor_nightly_dev-lms-1  | 
tutor_nightly_dev-lms-1  | Traceback (most recent call last):
tutor_nightly_dev-lms-1  |   File "./manage.py", line 103, in <module>
tutor_nightly_dev-lms-1  |     startup.run()
tutor_nightly_dev-lms-1  |   File "/openedx/edx-platform/lms/startup.py", line 20, in run
tutor_nightly_dev-lms-1  |     django.setup()
tutor_nightly_dev-lms-1  |   File "/openedx/venv/lib/python3.8/site-packages/django/__init__.py", line 24, in setup
tutor_nightly_dev-lms-1  |     apps.populate(settings.INSTALLED_APPS)
tutor_nightly_dev-lms-1  |   File "/openedx/venv/lib/python3.8/site-packages/django/apps/registry.py", line 114, in populate
tutor_nightly_dev-lms-1  |     app_config.import_models()
tutor_nightly_dev-lms-1  |   File "/openedx/venv/lib/python3.8/site-packages/django/apps/config.py", line 301, in import_models
tutor_nightly_dev-lms-1  |     self.models_module = import_module(models_module_name)
tutor_nightly_dev-lms-1  |   File "/opt/pyenv/versions/3.8.15/lib/python3.8/importlib/__init__.py", line 127, in import_module
tutor_nightly_dev-lms-1  |     return _bootstrap._gcd_import(name[level:], package, level)
tutor_nightly_dev-lms-1  |   File "<frozen importlib._bootstrap>", line 1014, in _gcd_import
tutor_nightly_dev-lms-1  |   File "<frozen importlib._bootstrap>", line 991, in _find_and_load
tutor_nightly_dev-lms-1  |   File "<frozen importlib._bootstrap>", line 975, in _find_and_load_unlocked
tutor_nightly_dev-lms-1  |   File "<frozen importlib._bootstrap>", line 671, in _load_unlocked
tutor_nightly_dev-lms-1  |   File "<frozen importlib._bootstrap_external>", line 843, in exec_module
tutor_nightly_dev-lms-1  |   File "<frozen importlib._bootstrap>", line 219, in _call_with_frames_removed
tutor_nightly_dev-lms-1  |   File "/openedx/edx-platform/common/djangoapps/student/models/__init__.py", line 4, in <module>
tutor_nightly_dev-lms-1  |     from .course_enrollment import *
tutor_nightly_dev-lms-1  |   File "/openedx/edx-platform/common/djangoapps/student/models/course_enrollment.py", line 46, in <module>
tutor_nightly_dev-lms-1  |     from lms.djangoapps.verify_student.models import SoftwareSecurePhotoVerification
tutor_nightly_dev-lms-1  |   File "/openedx/edx-platform/lms/djangoapps/verify_student/models.py", line 45, in <module>
tutor_nightly_dev-lms-1  |     from openedx.core.storage import get_storage
tutor_nightly_dev-lms-1  |   File "/openedx/edx-platform/openedx/core/storage.py", line 13, in <module>
tutor_nightly_dev-lms-1  |     from storages.backends.s3boto3 import S3Boto3Storage
tutor_nightly_dev-lms-1  |   File "/openedx/venv/lib/python3.8/site-packages/storages/backends/s3boto3.py", line 3, in <module>
tutor_nightly_dev-lms-1  |     from storages.backends.s3 import S3File as S3Boto3StorageFile  # noqa
tutor_nightly_dev-lms-1  |   File "/openedx/venv/lib/python3.8/site-packages/storages/backends/s3.py", line 42, in <module>
tutor_nightly_dev-lms-1  |     raise ImproperlyConfigured("Could not load Boto3's S3 bindings. %s" % e)
tutor_nightly_dev-lms-1  | django.core.exceptions.ImproperlyConfigured: Could not load Boto3's S3 bindings. No module named 's3transfer.constants'

I think we should remove the boto3 package from the requirements, we don't need it for the current version.

BryanttV · 2023-10-04T17:28:27Z

At the moment to solve the previous error I removed from the constraints.txt the boto3 and botocore packages and it works.

BryanttV · 2023-10-04T17:34:28Z

mindmap/mindmap.py

@@ -287,6 +287,27 @@ def student_view(self, _context=None) -> Fragment:

        return frag

+    def author_view(self, _context=None) -> Fragment:


Adding the author_view seems great, I only have one suggestion: From the student preview in Studio we should disable the ability to edit the mind map, you could only edit it from the edit modal (studio_view).

You're right! Thanks

Done! Thanks again

mariajgrimaldi · 2023-10-04T19:21:33Z

Merging since we all agree it works!

mariajgrimaldi force-pushed the MJG/add-author-view branch from 411928b to 56f2b2a Compare October 2, 2023 21:41

feat: add author different author view for studio

15f296b

mariajgrimaldi force-pushed the MJG/add-author-view branch from 56f2b2a to 15f296b Compare October 2, 2023 21:49

mariajgrimaldi requested a review from a team October 2, 2023 21:49

mariajgrimaldi marked this pull request as draft October 2, 2023 22:08

mariajgrimaldi added 5 commits October 3, 2023 07:24

fix: configure editable depending on configs

d85296e

fix: use in_student_view instead of checking if is student/course team

e73550e

fix: allow edition if in student view or is course team

5128962

refactor: allow edition when in studio view

ff7d2ba

fix: refactor tests after changes

e8eeb93

mariajgrimaldi marked this pull request as ready for review October 4, 2023 14:40

mariajgrimaldi commented Oct 4, 2023

View reviewed changes

johnvente approved these changes Oct 4, 2023

View reviewed changes

BryanttV reviewed Oct 4, 2023

View reviewed changes

mariajgrimaldi force-pushed the MJG/add-author-view branch from 26e2a66 to 09cbcf8 Compare October 4, 2023 18:01

refactor: avoid editions in author view

7894cb5

mariajgrimaldi force-pushed the MJG/add-author-view branch from 09cbcf8 to 7894cb5 Compare October 4, 2023 18:04

mariajgrimaldi merged commit 8eb145d into main Oct 4, 2023

mariajgrimaldi deleted the MJG/add-author-view branch October 4, 2023 19:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add author different author view for studio #30

feat: add author different author view for studio #30

mariajgrimaldi commented Oct 2, 2023 •

edited

Loading

mariajgrimaldi commented Oct 2, 2023

mariajgrimaldi commented Oct 4, 2023

mariajgrimaldi Oct 4, 2023 •

edited

Loading

mariajgrimaldi Oct 4, 2023

johnvente commented Oct 4, 2023 •

edited

Loading

BryanttV commented Oct 4, 2023

BryanttV commented Oct 4, 2023

BryanttV Oct 4, 2023 •

edited

Loading

mariajgrimaldi Oct 4, 2023

mariajgrimaldi Oct 4, 2023

mariajgrimaldi commented Oct 4, 2023

		@@ -287,6 +287,27 @@ def student_view(self, _context=None) -> Fragment:

		return frag

		def author_view(self, _context=None) -> Fragment:

feat: add author different author view for studio #30

feat: add author different author view for studio #30

Conversation

mariajgrimaldi commented Oct 2, 2023 • edited Loading

Description

How to test

mariajgrimaldi commented Oct 2, 2023

mariajgrimaldi commented Oct 4, 2023

mariajgrimaldi Oct 4, 2023 • edited Loading

Choose a reason for hiding this comment

mariajgrimaldi Oct 4, 2023

Choose a reason for hiding this comment

johnvente commented Oct 4, 2023 • edited Loading

BryanttV commented Oct 4, 2023

BryanttV commented Oct 4, 2023

BryanttV Oct 4, 2023 • edited Loading

Choose a reason for hiding this comment

mariajgrimaldi Oct 4, 2023

Choose a reason for hiding this comment

mariajgrimaldi Oct 4, 2023

Choose a reason for hiding this comment

mariajgrimaldi commented Oct 4, 2023

mariajgrimaldi commented Oct 2, 2023 •

edited

Loading

mariajgrimaldi Oct 4, 2023 •

edited

Loading

johnvente commented Oct 4, 2023 •

edited

Loading

BryanttV Oct 4, 2023 •

edited

Loading