Skip to content

Conversation

@BryanttV
Copy link
Contributor

@BryanttV BryanttV commented Jan 27, 2025

Description

This PR removes the ENABLE_HOME_PAGE_COURSE_API_V2 feature toggle and all its related code. With this change, the API v2 will always be available.

This helps implement:

Other Changes

Since the feature toggle was removed, as well as API v2, API v1 will obtain the courses summary from the CourseOverview.get_all_courses()

Testing instructions

  1. Create a Tutor environment.

  2. Create a mount of edx-platform with the changes in this branch.

  3. Consume the endpoints of HomePageCourseAPI:

    API v2

    http://studio.local.openedx.io:8001/api/contentstore/v2/home/courses
    

    API v1

    http://studio.local.openedx.io:8001/api/contentstore/v1/home/courses
    
  4. You should see the endpoint responses without any problem.

Deadline

None

Other information

None

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

openedx-webhooks commented Jan 27, 2025

Thanks for the pull request, @BryanttV!

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.

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:

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.

@BryanttV BryanttV force-pushed the bav/remove-enable-course-home-page-course-api-v2-feature-toggle branch from d30264b to ea87002 Compare January 27, 2025 23:08
Copy link
Member

@mariajgrimaldi mariajgrimaldi left a comment

Choose a reason for hiding this comment

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

I'm still missing testing this in my local environment, so I'll be doing that next. Also, I wonder if this should be refactor!: instead since we're dropping the path of configuring getting courses from V1 instead of V2, which also includes not getting the courses from mongo but only mysql.

@mariajgrimaldi
Copy link
Member

FYI @feanil: this PR partially addresses a concern you raised a while ago when implementing this API here #34173 (comment) :)

Along with the API V1 deprecation ticket: openedx/public-engineering#287

@BryanttV BryanttV force-pushed the bav/remove-enable-course-home-page-course-api-v2-feature-toggle branch 2 times, most recently from cdcaea7 to 8d79430 Compare February 11, 2025 17:16
@BryanttV BryanttV changed the title refactor: remove ENABLE_HOME_PAGE_COURSE_API_V2 feature toggle refactor!: remove ENABLE_HOME_PAGE_COURSE_API_V2 feature toggle Feb 11, 2025
@BryanttV BryanttV force-pushed the bav/remove-enable-course-home-page-course-api-v2-feature-toggle branch from b8a9241 to c073e3a Compare February 12, 2025 19:24
Copy link
Member

@mariajgrimaldi mariajgrimaldi left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

@hinakhadim: letting you know that I'll be merging this on Monday 8:00 AM Eastern Time. Thank you!

@hinakhadim
Copy link
Contributor

Thanks, Acknowledged.

@mariajgrimaldi mariajgrimaldi merged commit a2bb8c9 into openedx:master Feb 24, 2025
49 checks passed
@edx-pipeline-bot
Copy link
Contributor

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

@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

1 similar comment
@edx-pipeline-bot
Copy link
Contributor

2U Release Notice: This PR has been deployed to the edX production environment.

jciasenza pushed a commit to jciasenza/edx-platform that referenced this pull request Feb 25, 2025
…enedx#36181)

fix: reformulation of the Main component test

fix: reformulation of the Main component test

fix: reformulation of the Main component test

fix: reformulation of the Main component test

fix: reformulation of the Main component test

fix: reformulation of the Main component test

fix: reformulation of the Main component test

fix: enzyme testing replaced by react tester

fix: enzyme testing replaced by react tester

fix: enzyme testing replaced by react tester
tonybusa pushed a commit to tonybusa/edx-platform that referenced this pull request Apr 23, 2025
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

Archived in project

Development

Successfully merging this pull request may close these issues.

5 participants