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

[backport] feat: add publish status to library meilisearch index #36242

Open
wants to merge 47 commits into
base: master
Choose a base branch
from

Conversation

DanielVZ96
Copy link
Contributor

Description

Adds the publish status field to the libraries v2 meilisearch index in order to support filtering by component publish status: published, modified, never.

Supporting information

Testing instructions

  1. [If needed] Create a new library with new components in http://apps.local.openedx.io:2001/course-authoring/libraries
  2. With the tutor stack running execute the following command: tutor dev exec cms bash -c './manage.py cms reindex_studio --experimental '
  3. Navigate to http://localhost:7700/
  4. Assert that the publish_status of the documents matches their respective components:
    • Published when the component was published and not modified since
    • Modified when the component has been modified after being published
    • Never when the component has never been published

Deadline

ASAP

Other information

Private-Ref

navinkarkera and others added 30 commits October 30, 2024 13:30
This is to benefit from the latest changes concerning meilisearch index
creation: openedx/edx-search#166
…date_sumac

build: kickoff the Sumac release
fix: adds content.search to docs apps (Sumac backport)
…penedx#35736) (openedx#35792)

Removes the "Legacy Library" button from the legacy Studio "new block" button array if Libraries v1 are disabled, either via waffle flag or via the ENABLE_CONTENT_LIBRARIES feature flag.

(cherry picked from commit 9bfdfeb)
…m library (openedx#35784) (openedx#35801)

Sets upstream link to library block for blocks that were copied from a course block which were originally copied/imported from a library.

(cherry picked from commit d82aada)
) (openedx#35810)

* test: run content_libraries runtime tests

* test: fix broken tests

* test: fix lms tests

Co-authored-by: Kyle D. McCormick <[email protected]>
(cherry picked from commit db587bd)
Uses drf view to authenticate user before allowing them to access library static assets.

(cherry picked from commit ca7da37)
…) (openedx#35773)

Hide options to add library_v2 and itembank blocks in legacy library
page.

(cherry picked from commit 68739ce)
…t/upstream_PR_active_inactive_courses_API

feat: [FC-0047] Implement user's enrolments status API (openedx#2530)
…-api

[BACKPORT][SUMAC] feat: [FC-0047] Implement user's enrolments status API (openedx#2530)
…enedx#35734) (openedx#35886)

* fix: keep library collection card component count in sync (openedx#35734)

Fixed component counter synchronization in these cases:

* When deleting a component inside a collection.
* With the library published, when adding a new component in a collection and reverting library changes.
* With the library published, when deleting a component inside a collection and reverting library changes.

Also adds a published > num_counts field in collections in the search index.

* fix: remove learner_downloadable field references from libraries (openedx#35788)

Also bumps openedx-learning to v0.17.0, which no longer has this field.

* chore: Update common_contraints.txt

---------

Co-authored-by: Cristhian Garcia <[email protected]>
[Backport] fix: bypass access checks when populating course blocks cache
rpenido and others added 17 commits December 6, 2024 09:18
This PR changes the permissions for content libraries so that only
people who can create courses should be allowed to create new content
libraries.
This commit introduces the new Forum V2 application, allowing users to choose between the legacy Forum V1 and the new Forum V2 at the course level.

Key Changes:
- Added waffle flag `discussions.enable_forum_v2` to enable Forum V2 for selected courses, allowing coexistence with Forum V1.
- Default data storage for Forum V2 is set to MongoDB, with an option to switch to MySQL using the waffle flag `forum_v2.enable_mysql_backend`.
- Introduced management command `forum_migrate_course_from_mongodb_to_mysql` for per-course data migration from MongoDB to MySQL.

Note: This PR does not include all unit tests for the Forum V2 native API due to ongoing migration efforts. Further updates will follow to ensure full test coverage before final release.

Co-authored-by: [Muhammad Faraz Maqsood] <[email protected]>
Co-authored-by: [Ali Salman] <[email protected]>
To reproduce the error:
- switch to mongodb from mysql for a specific course.
- create a thread and report the thread. It'll throw an error due to wrong positioning of the arguments.

So, this commit
- uses keyword arguments in flag APIs
- adds mock tests for code coverage
…dx#35981)

Backported because this fixes an issue where large instances couldn't use this command/feature at all.
…#35942)

This change addresses an issue reported while testing Sumac, where the API V2 is on by default in the authoring MFE: openedx/wg-build-test-release#428. It fails when retrieving an empty list of courses with the queryparams api/contentstore/v2/home/courses?page=1&order=display_name. When this was implemented, the course authoring MFE rendered the empty lists only with page=1 query param (didn't do any filtering/ordering by default), which was later changed to page=1&order=display_name which now ordered by default.

This issue occurs because all the filtering and ordering are done under the assumption that course_overviews is always a query set. However, that's only true when there are courses available and CourseOverview.get_all_courses is used. When not, an empty list is returned instead, raising a 500 error in Studio.
The previous pattern for matching was too broad and would break
the rendering of assets that were prefixed with "xblock".
We're still running with 3.11 in sumac so we should be building the docs
with python 3.11
We introduce a setting that allows us to bypass any course waffle flag
check. The advantage of such a setting is that we don't need to find the
course ID: in some cases, we might not have access to the course ID, and
we need to look for it... in forum v2.

See discussion here: openedx/forum#137
This should fix an issue with index creation on edX.org.
When checking whether forum v2 is enabled, the course waffle flag
argument should be a CourseKey, not a str.
The Zooming Image Tool does not load properly, currently, and even if it
did, relying on an external Javascript to function across releases is
not something we can support.  Thus, we remove it from the list of HTML
block templates until such time as a more robust solution is found.
This recreates the Zooming Image Tool template for the HTML block.  It
does it in such a way that doesn't depend on any external resources:
both the loupe code and sample image are inlined.

Some benefits to this version are:

* We can now maintain the loupe javascript code properly

* Because the javascript is included in the contents of the block
  itself, the course author can customize it as needed

* As opposed to the previous iteration, the magnified image URL is now
  optional: if it's not present, the regular image will be used for
  magnification

* There can now be two or more instances of the tool in the same unit.

This also removes some CSS left over from the previous iteration.
…edx#36031)

Adds the publish status field to the libraries v2 meilisearch index in order to support filtering by component publish status: published, modified, never.
@DanielVZ96 DanielVZ96 requested a review from a team as a code owner February 11, 2025 19:59
@openedx-webhooks
Copy link

Thanks for the pull request, @DanielVZ96!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 11, 2025
@pomegranited
Copy link
Contributor

@DanielVZ96 I think this PR be closed? We don't need to backport new features (and this doesn't target the sumac branch anyway).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: Waiting on Author
Development

Successfully merging this pull request may close these issues.