feat: bulk update legacy library references

[navinkarkera]

Description

Shows an alert in course outline and review tab of course libraries page when the course contains legacy library content blocks that depend on libraries that are already migrated to library v2, i.e. the blocks are ready to be converted into item banks that can make use of these new v2 libraries.
Authors can click on a single button to convert all references in a single go. The button launches a background task which is then polled by the frontend and the status is presented to the Author.

Useful information to include:

• Which user roles will this change impact? "Course Author"

Supporting information

• Bulk migrate LegacyLibraryContent Block references #2758
• Depends on feat: api to bulk update legacy library references openedx-platform#37789
• Private-ref: https://tasks.opencraft.com/browse/FAL-4310

Testing instructions

• Checkout feat: api to bulk update legacy library references openedx-platform#37789 in edx-platform
• If you haven't recently run tutor dev do init --limit=cms, please do so
• Create some legacy libraries and migrate them to new v2 libraries.
• Create some legacy library content blocks in a course and link it to the above legacy libraries.
• The blocks should display an alert inside it asking to update reference. (This is in master as well).
• Now go to course outline or course libraries -> review tab (Refresh page if you can't see the new alert).
• Click on Update library references button and verify that all the legacy content blocks are updated.
• [Optional]: If you have a cms-worker running in dev mode, you can also test toast messages that are displayed when the background process is running. Note that this is not simple, and you need to edit tutor docker templates to make cms-workers run in development mode

Other information

Include anything else that will help reviewers and consumers understand the change.

• Does this change depend on other changes elsewhere?
• Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility.

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

• Any new files are using TypeScript (.ts, .tsx).
• Avoid propTypes and defaultProps in any new or modified code.
• Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
• Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
• Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
• All new i18n messages in messages.ts files have a description for translators to use.
• Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

[openedx-webhooks]

Thanks for the pull request, @navinkarkera!

This repository is currently maintained by @bradenmacdonald.

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.

Details

---

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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]

Codecov Report

❌ Patch coverage is 95.23810% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 94.92%. Comparing base (c2592a7) to head (c1b3c23).
⚠️ Report is 44 commits behind head on master.

Files with missing lines	Patch %	Lines
...rc/course-libraries/LegacyLibContentBlockAlert.tsx	95.00%	2 Missing ⚠️
src/course-outline/data/apiHooks.ts	50.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2764      +/-   ##
==========================================
- Coverage   94.92%   94.92%   -0.01%     
==========================================
  Files        1239     1240       +1     
  Lines       28452    28528      +76     
  Branches     6481     6302     -179     
==========================================
+ Hits        27009    27081      +72     
- Misses       1372     1389      +17     
+ Partials       71       58      -13     

☔ 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.

[rpenido]

LGTM 👍
Thank you for your work, @navinkarkera!

• I tested this using the instructions from the PR
• I read through the code
• I checked for accessibility issues
• Includes documentation

[ChrisChV]

The code looks good!

[ChrisChV]

Note that this is not simple, and you need to edit tutor docker templates to make cms-workers run in development mode

@navinkarkera Were you able to achieve it? A short list of steps to achieve it would be helpful for future assignments :)

[navinkarkera]

Were you able to achieve it? A short list of steps to achieve it would be helpful for future assignments :)

@ChrisChV Yes, but it is not perfect.

• Add below snippet to the dev installation of your tutor repository: tutor/tutor/templates/dev/docker-compose.yml and run tutor config save.

  cms-worker:
    <<: *openedx-service
    environment:
      SERVICE_VARIANT: cms
      DJANGO_SETTINGS_MODULE: cms.envs.tutor.development
    command: celery --app=cms.celery worker --loglevel=info --hostname=edx.cms.core.default.%%h --max-tasks-per-child 100 --exclude-queues=edx.lms.core.default
    volumes:
      - ../apps/openedx/settings/lms:/openedx/edx-platform/lms/envs/tutor:ro
      - ../apps/openedx/settings/cms:/openedx/edx-platform/cms/envs/tutor:ro
      - ../apps/openedx/config:/openedx/config:ro
      - ../../data/cms:/openedx/data
      - ../../data/openedx-media:/openedx/media
      - ../../data/openedx-media-private:/openedx/media-private
      {%- for mount in iter_mounts(MOUNTS, "openedx", "cms-worker") %}
      - {{ mount }}
      {%- endfor %}
    depends_on:
      - cms

• Then restart tutor using tutor dev restart.
• Finally, you need to set CELERY_ALWAYS_EAGER = False in your devtsack settings file or tutor settings file. I set it in cms/envs/devstack.py whenever I want to test in celery. Also you need to restart the cms-worker each time you make changes to your code.

[samuelallan72]

Also for future reference, I converted @navinkarkera's snippets to a single file tutor plugin. This ensures the config is persistent, and makes it easier to disable/enable at will on various devstacks.

from tutor import hooks

# Need to turn eager mode off, otherwise tasks will be run inline without being sent to celery.
hooks.Filters.ENV_PATCHES.add_item(
    (
        "openedx-common-settings",
        "CELERY_ALWAYS_EAGER = False"
    )
)

# The celery worker containers, one each for cms and lms queues.
# NOTE: these will not auto-reload on code changes. You will need to manually run `tutor dev restart`.
hooks.Filters.ENV_PATCHES.add_item(
    (
        "local-docker-compose-dev-services",
        """
cms-worker:
  <<: *openedx-service
  environment:
    SERVICE_VARIANT: cms
    DJANGO_SETTINGS_MODULE: cms.envs.tutor.development
  command: celery --app=cms.celery worker --loglevel=info --hostname=edx.cms.core.default.%%h --max-tasks-per-child 100 --exclude-queues=edx.lms.core.default --exclude-queues=edx.lms.core.high --exclude-queues=edx.lms.core.low
  volumes:
    - ../apps/openedx/settings/lms:/openedx/edx-platform/lms/envs/tutor:ro
    - ../apps/openedx/settings/cms:/openedx/edx-platform/cms/envs/tutor:ro
    - ../apps/openedx/config:/openedx/config:ro
    - ../../data/cms:/openedx/data
    - ../../data/openedx-media:/openedx/media
    - ../../data/openedx-media-private:/openedx/media-private
    {%- for mount in iter_mounts(MOUNTS, "openedx", "cms-worker") %}
    - {{ mount }}
    {%- endfor %}
  depends_on:
    - cms

lms-worker:
  <<: *openedx-service
  environment:
    SERVICE_VARIANT: lms
    DJANGO_SETTINGS_MODULE: lms.envs.tutor.development
  command: celery --app=lms.celery worker --loglevel=info --hostname=edx.lms.core.default.%%h --max-tasks-per-child 100 --exclude-queues=edx.cms.core.default --exclude-queues=edx.cms.core.high --exclude-queues=edx.cms.core.low
  volumes:
    - ../apps/openedx/settings/lms:/openedx/edx-platform/lms/envs/tutor:ro
    - ../apps/openedx/settings/cms:/openedx/edx-platform/cms/envs/tutor:ro
    - ../apps/openedx/config:/openedx/config:ro
    - ../../data/cms:/openedx/data
    - ../../data/openedx-media:/openedx/media
    - ../../data/openedx-media-private:/openedx/media-private
    {%- for mount in iter_mounts(MOUNTS, "openedx", "lms-worker") %}
    - {{ mount }}
    {%- endfor %}
  depends_on:
    - lms
"""
    )
)