fix: make it work in library v2 [FC-0076] #2272

DanielVZ96 · 2025-01-30T18:42:05Z

TL;DR - Modifies functionality so that the xblock can be edited and used in the new Library page.

JIRA: JIRA-XXXX
Private-ref

What changed?

Uses display name alongside title element in order to correctly display the name in Library Page
Adds a few checks to avoid course specific logic when being edited in a Library V2 context
Update tests with display name changes

Developer Checklist

Reviewed the release process
Translations and JS/SASS compiled (N/A)
Bumped version number in openassessment/__init__.py and package.json

Testing Instructions

Run the following branch of edx-platform fix: Broken CSS styles of ora2 block editor [FC-0076] edx-platform#36220
Run course authoring
Create a Library and an opeassessment block in it
Assert the block displays correctly, and you can modify

Any field
The title

Reviewer Checklist

Collectively, these should be completed by reviewers of this PR:

I've done a visual code review
I've tested the new functionality

FYI: @openedx/content-aurora

openedx-webhooks · 2025-01-30T18:42:10Z

Thanks for the pull request, @DanielVZ96!

This repository is currently maintained by @openedx/2u-aurora.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

codecov · 2025-01-30T18:46:35Z

Codecov Report

Attention: Patch coverage is 96.36364% with 2 lines in your changes missing coverage. Please review.

Project coverage is 95.29%. Comparing base (90d5de9) to head (952b5d3).
Report is 9 commits behind head on master.

Files with missing lines	Patch %	Lines
openassessment/xblock/utils/xml.py	88.23%	0 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2272      +/-   ##
==========================================
- Coverage   95.29%   95.29%   -0.01%     
==========================================
  Files         195      195              
  Lines       21625    21664      +39     
  Branches     1502     1509       +7     
==========================================
+ Hits        20607    20644      +37     
  Misses        771      771              
- Partials      247      249       +2

Flag	Coverage Δ
unittests	`95.29% <96.36%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

itsjeyd · 2025-03-14T08:06:40Z

Hey @DanielVZ96, just checking in to see if you're still planning to continue working on this PR?

DanielVZ96 · 2025-03-15T14:22:30Z

@itsjeyd yep. I'll work on this before I go to holidays

DanielVZ96 · 2025-03-16T01:15:41Z

I'm only missing updating the tests.

itsjeyd · 2025-04-10T08:16:04Z

@DanielVZ96 I see you marked this PR as ready for review, but it still has a bunch of failing tests as well as some merge conflicts to resolve.

Could you address those before we get the engineering review process going? Or were you looking for some early input on your approach before spending more time on this PR?

DanielVZ96 · 2025-04-11T17:19:57Z

@itsjeyd sorry i didn't notice the tests were failing after merging master. I'll fix them now

This reverts commit 824067f.

ChrisChV

Looks good 👍

I tested this: I followed the testing instructions
I read through the code and considered the security, stability and performance implications of the changes.
Includes tests for bugfixes and/or features added.
Includes documentation

pomegranited

👍 this is working great! Thank you @DanielVZ96 .

I tested this by adding a new ORA2 block to a library, copying an ORA2 block from a course to a library, copying an ORA2 block from a library to a course, and editing an ORA2 block in a library and in a course.
I read through the code
I checked for accessibility issues by using my keyboard to navigate
~~Includes documentation~~ N/A
~~User-facing strings are extracted for translation~~ N/A

pomegranited · 2025-04-15T05:28:53Z

openassessment/xblock/studio_mixin.py

@@ -454,7 +455,7 @@ def get_base_url_path_for_course_assets(self, course_key):
        """
        Returns base url path for course assets
        """
-        if course_key is None:
+        if (course_key is None) or isinstance(course_key, LibraryLocatorV2):


nit: maybe use the OpaqueKey is_course property here instead, for consistency?

Suggested change

if (course_key is None) or isinstance(course_key, LibraryLocatorV2):

if (course_key is None) or not course_key.is_course:

Nudge @DanielVZ96 :) Does this suggestion not work?

pomegranited · 2025-04-15T05:29:17Z

openassessment/xblock/studio_mixin.py

@@ -478,6 +479,8 @@ def get_teamsets(self, course_id):
        """
        Wrapper around get_team_configuration that returns team names only for display
        """
+        if isinstance(course_id, LibraryLocatorV2):


ditto here:

Suggested change

if isinstance(course_id, LibraryLocatorV2):

if not course_id.is_course:

pomegranited · 2025-04-15T06:10:06Z

@DanielVZ96 Could you please bump the version here?

Bumped version number in openassessment/init.py and package.json

DanielVZ96 · 2025-04-15T20:25:42Z

@pomegranited done!

…rary-v2

fix: make it work in library v2

bce1829

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 30, 2025

fix: set default values for library v2 rendering

c8de642

itsjeyd added the inactive PR author has been unresponsive for several months label Mar 14, 2025

fix: allow changing display name from mfe

c3c8a19

itsjeyd added waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. and removed inactive PR author has been unresponsive for several months labels Apr 1, 2025

DanielVZ96 and others added 3 commits April 5, 2025 19:18

fix: tests

a944728

chore: bump version

d0e9861

Merge branch 'master' into dvz/prepare-for-library-v2

09bc19d

DanielVZ96 marked this pull request as ready for review April 5, 2025 22:44

DanielVZ96 removed the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label Apr 5, 2025

DanielVZ96 and others added 10 commits April 11, 2025 13:28

fix: lint and coverage

ca17b7f

Merge branch 'master' into dvz/prepare-for-library-v2

c6262f1

fix: lint and coverage

56b67aa

fix: super call pylint fix

f65621f

feat: add openedx-learning to dependencies

824067f

Revert "feat: add openedx-learning to dependencies"

6dc3b1b

This reverts commit 824067f.

fix: patch test

e3fffdd

fix: increase coverage

f2147b8

fix: increase coverage

051bacb

fix: increase coverage

d9a29b0

DanielVZ96 added the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Apr 13, 2025

DanielVZ96 moved this from Waiting on Author to Ready for Review in Contributions Apr 13, 2025

ChrisChV mentioned this pull request Apr 14, 2025

fix: Broken CSS styles of ora2 block editor [FC-0076] openedx/edx-platform#36220

Merged

ChrisChV approved these changes Apr 14, 2025

View reviewed changes

pomegranited changed the title ~~fix: make it work in library v2~~ fix: make it work in library v2 [FC-0076] Apr 15, 2025

pomegranited approved these changes Apr 15, 2025

View reviewed changes

chore: update package version

b5d2447

Merge remote-tracking branch 'origin/master' into dvz/prepare-for-lib…

952b5d3

…rary-v2

pomegranited merged commit 078e789 into openedx:master Apr 17, 2025
13 checks passed

openedx-webhooks removed the waiting for eng review PR is ready for review. Review and merge it, or suggest changes. label Apr 17, 2025

github-project-automation bot moved this from Ready for Review to Done in Contributions Apr 17, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: make it work in library v2 [FC-0076] #2272

fix: make it work in library v2 [FC-0076] #2272

Uh oh!

DanielVZ96 commented Jan 30, 2025 •

edited

Loading

Uh oh!

openedx-webhooks commented Jan 30, 2025 •

edited

Loading

Uh oh!

codecov bot commented Jan 30, 2025 •

edited

Loading

Uh oh!

itsjeyd commented Mar 14, 2025

Uh oh!

DanielVZ96 commented Mar 15, 2025

Uh oh!

DanielVZ96 commented Mar 16, 2025

Uh oh!

itsjeyd commented Apr 10, 2025

Uh oh!

DanielVZ96 commented Apr 11, 2025

Uh oh!

ChrisChV left a comment

Uh oh!

pomegranited left a comment

Uh oh!

pomegranited Apr 15, 2025

Uh oh!

pomegranited Apr 16, 2025

Uh oh!

pomegranited Apr 15, 2025

Uh oh!

pomegranited commented Apr 15, 2025

Uh oh!

DanielVZ96 commented Apr 15, 2025

Uh oh!

Uh oh!

Uh oh!

	if (course_key is None) or isinstance(course_key, LibraryLocatorV2):
	if (course_key is None) or not course_key.is_course:

	if isinstance(course_id, LibraryLocatorV2):
	if not course_id.is_course:

fix: make it work in library v2 [FC-0076] #2272

fix: make it work in library v2 [FC-0076] #2272

Uh oh!

Conversation

DanielVZ96 commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openedx-webhooks commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

itsjeyd commented Mar 14, 2025

Uh oh!

DanielVZ96 commented Mar 15, 2025

Uh oh!

DanielVZ96 commented Mar 16, 2025

Uh oh!

itsjeyd commented Apr 10, 2025

Uh oh!

DanielVZ96 commented Apr 11, 2025

Uh oh!

ChrisChV left a comment

Choose a reason for hiding this comment

Uh oh!

pomegranited left a comment

Choose a reason for hiding this comment

Uh oh!

pomegranited Apr 15, 2025

Choose a reason for hiding this comment

Uh oh!

pomegranited Apr 16, 2025

Choose a reason for hiding this comment

Uh oh!

pomegranited Apr 15, 2025

Choose a reason for hiding this comment

Uh oh!

pomegranited commented Apr 15, 2025

Uh oh!

DanielVZ96 commented Apr 15, 2025

Uh oh!

Uh oh!

Uh oh!

DanielVZ96 commented Jan 30, 2025 •

edited

Loading

openedx-webhooks commented Jan 30, 2025 •

edited

Loading

codecov bot commented Jan 30, 2025 •

edited

Loading