Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PADV 1025 - Notes tab does not display notes for ccx #117

Merged
merged 1 commit into from
Mar 4, 2024

Conversation

alexjmpb
Copy link

Ticket

https://agile-jira.pearson.com/browse/PADV-1025

Description

As 1025 describes, the notes for a CCX are failing to show in the Notes tab. The problem is caused because when the note is saved, the course_id value is passed containing branch and version, causing the Notes tab to not find any notes since it is searching with the CCX course_id without branch nor version. This PR applies a hotfix for the issue, the problem is more complex and requires further review to conclude if this is the best solution.

Changes

  • Change edx notes saving function to use not versioned course id.

How to test?

  • Setup devstack.
  • Setup edx notes api, here are the steps:
  1. uncomment these lines from your devstack https://github.com/Pearson-Advance/devstack/blob/pearson-release/olive.main/docker-compose.yml#L384-L411 and https://github.com/Pearson-Advance/devstack/blob/pearson-release/olive.main/docker-compose-host.yml#L34-L37
  2. execute make dev.up.edx_notes_api
  3. In edx notes go to notesserver/settings/devstack.py and configure the values to match your devstack
  4. attach a shell to the edx notes container and cd to /edx/apps/edx_notes_api/edx_notes_api
  5. Create a virtualenv and execute make create-index

@@ -58,7 +59,7 @@ def get_html(self, *args, **kwargs):
"params": {
# Use camelCase to name keys.
"usageId": self.scope_ids.usage_id,
"courseId": course.id,
"courseId": course.id if not is_ccx_course(course.id) else course.id.for_branch(None),

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"courseId": course.id if not is_ccx_course(course.id) else course.id.for_branch(None),
#
"courseId": course.id if not is_ccx_course(course.id) else course.id.for_branch(branch=None),

@alexjmpb alexjmpb merged commit 45d5fa7 into pearson-release/olive.stage Mar 4, 2024
5 of 35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants