feat: set course for wiki based on the wiki_slug by Cup0fCoffee · Pull Request #33338 · openedx/openedx-platform

Cup0fCoffee · 2023-09-25T14:19:23Z

Description

Learners want to have the usual course navigation when viewing a wiki, so that they can go back to the course related to the wiki and browse other tabs/sections of the course.

Wiki reads the course from the request.course. If it's not present, i.e. None or not set on the request, it will not show the course navigation UI.

It seems like WikiAccessMiddleware already has the code that parses course id from the request (when the request is for a wiki view) and sets the course for the request. However, it doesn't work in most scenarios, because the course id is not in the it's normal format in most requests that go to wiki.

For example, when a leaner clicks on a wiki tab from the course overview, they are redirected to /wiki/<wiki_slug>/ path. The wiki slug is taken from course's wiki_slug field. This slug can be used to figure out what course this wiki belongs to in most (not all) cases.

This commit adds code to the WikiAccessMiddleware that attempts to find a course based on wiki slug, and in case of success, sets the course to the request.course, so that wiki can display course navigation UI.

Testing instructions

Setup devstack of latest version
make dev.up.lms+cms+frontend-app-learning
Log in at localhost:18000 as edx@example.com (edx as password)
Enroll into the demo course
Go to studio for this course, in the navigation find "Content -> Pages", click on it, and make the Wiki tab visible by clicking the crossed eye icon
Go back to the course, and click the wiki tab
You will see that the wiki doesn't have any course tabs, there is no way to go back to the course you came from, etc.

Screenshot
Now checkout the branch from the PR
Go back to the wiki page and reload (it might need a minute for the dev server to restart)
You will now see that the course navigation UI is showing correctly.

Screenshot
Check that the links are pointing to the correct course

Deadline

"None"

Notes

This solution doesn't work well when there a lot of courses that have the same wiki_slug. (#31794 (comment))

And alternative or complementary solution could be to, when the learners click on the wiki tab, instead of redirecting them to /wiki/<path>, redirect them to /courses/<course_id>/wiki/<path>. Such urls are supported, and the middleware would be able to pick up the course id from the url. One of the issue with this solution, is that it seems like these views were deliberately made un-reversable, so we would have to hard code the url. Essentially, the solution that would not rely on the wiki_slug would only require the following change:

--- a/lms/djangoapps/course_wiki/views.py
+++ b/lms/djangoapps/course_wiki/views.py
@@ -98,7 +98,7 @@ def course_wiki_redirect(request, course_id, wiki_path=""):
                             'other_write': True,
                             })

-    return redirect("wiki:get", path=urlpath.path)
+    return redirect(f"/courses/{course_id}/wiki/{urlpath.path}")

openedx-webhooks · 2023-09-25T14:19:30Z

Thanks for the pull request, @Cup0fCoffee! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

supporting documentation
Open edX discussion forum threads
timeline information ("this must be merged by XX date", and why that is)
partner information ("this is a course on edx.org")
any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

mphilbrick211 · 2023-10-02T17:46:12Z

Hi @Cup0fCoffee! Is this ready for review?

Cup0fCoffee · 2023-10-03T13:49:01Z

@mphilbrick211 Yes. I think @Agrendalath was planning to review it in the upcoming week or two as a core committer.

Agrendalath

👍

I tested this: verified that the "Course" tab is displayed in wiki
I read through the code
I checked for accessibility issues: n/a
Includes documentation: n/a
I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository: n/a

lms/djangoapps/course_wiki/middleware.py

Cup0fCoffee · 2023-10-16T12:41:06Z

@Agrendalath I'm not sure why the checks are marked as failed. Something cancelled the jobs that were running. I'll leave it as is for now.

Learners want to have the usual course navigation when viewing a wiki, so that they can go back to the course related to the wiki and browse other tabs/sections of the course. Wiki reads the course from the `request.course`. If it's not present, i.e. None or not set on the request, it will not show the course navigation UI. It seems like `WikiAccessMiddleware` already has the code that parses course id from the request (when the request is for a wiki view) and sets the course for the request. However, it doesn't work in most scenarios, because the course id is not in the it's normal format in most requests that go to wiki. For example, when a leaner clicks on a wiki tab from the course overview, they are redirected to `/wiki/<wiki_slug>/` path. The wiki slug is taken from course's `wiki_slug` field. This slug can be used to figure out what course this wiki belongs to in most (not all) cases. This commit adds code to the `WikiAccessMiddleware` that attempts to find a course based on wiki slug, and in case of success, sets the course to the `request.course`, so that wiki can display course navigation UI.

edx-pipeline-bot · 2023-10-16T20:25:51Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

openedx-webhooks · 2023-10-16T20:25:54Z

@Cup0fCoffee 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

edx-pipeline-bot · 2023-10-16T20:46:44Z