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

refactor!: turn on homepage course API V2 consumption by default #1307

Merged

Conversation

mariajgrimaldi
Copy link
Member

@mariajgrimaldi mariajgrimaldi commented Sep 19, 2024

Description

Turn on getting courses from the HomePageCourses API which allows pagination, filtering and ordering. See openedx/edx-platform#34173 for more details on the API implementation.

When we implemented #846, we agreed to turn this feature back on once Redwood was cut, so this change is long overdue.

Supporting information

Please, see https://openedx.atlassian.net/wiki/spaces/OEPM/pages/4032856101/Studio+Home+incremental+upgrades+-+product+approach

Testing instructions

This view should be on by default after this change:
image

Turn on getting courses from the HomePageCourses API
which allows pagination, filtering and ordering. See openedx/edx-platform#34173
for more details on the API implementation.
@openedx-webhooks
Copy link

openedx-webhooks commented Sep 19, 2024

Thanks for the pull request, @mariajgrimaldi!

What's next?

Please work through the following steps to get your changes 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.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/2u-tnl. Tag them in a comment and let them know that your changes are ready for review.

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 Sep 19, 2024
Copy link

codecov bot commented Sep 19, 2024

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 92.49%. Comparing base (8d49f2e) to head (43ba061).
Report is 42 commits behind head on master.

Files with missing lines Patch % Lines
src/studio-home/hooks.jsx 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1307      +/-   ##
==========================================
+ Coverage   92.47%   92.49%   +0.02%     
==========================================
  Files        1025     1031       +6     
  Lines       18979    19112     +133     
  Branches     4036     4055      +19     
==========================================
+ Hits        17551    17678     +127     
- Misses       1360     1369       +9     
+ Partials       68       65       -3     

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

@mariajgrimaldi mariajgrimaldi marked this pull request as ready for review September 19, 2024 20:04
@mariajgrimaldi mariajgrimaldi requested a review from a team as a code owner September 19, 2024 20:04
@mariajgrimaldi
Copy link
Member Author

Hello folks, @jesperhodge @bradenmacdonald @jmakowski1123. I'm tagging you here for visibility to address Braden's comment in the product proposal post. Please let me know if you agree with the changes. Thanks.

Also, Braden, can we get a sandbox to test this change?

@bradenmacdonald bradenmacdonald added the create-sandbox open-craft-grove should create a sandbox environment from this PR label Sep 20, 2024
@bradenmacdonald
Copy link
Contributor

Thanks @mariajgrimaldi. I'm good with this change. I'm also hoping we can follow it up in a few weeks by removing the setting and removing the code for loading it from the old API too, because I don't like having two different code paths if we don't need to.

I've requested a sandbox, but since you're from another org there may be an additional step required to get it to work. I'll follow up if needed.

@bradenmacdonald
Copy link
Contributor

By the way: with or without this change, there is still a bug that the course list on the homepage is not sorted (in any way) by default. It says it's sorted "A-Z" but unless you change the sorting, it is not actually sorted. Notice below that "Alpha" should come before "Beta".

Screenshot

@mariajgrimaldi
Copy link
Member Author

Thanks, @bradenmacdonald. I'll be working on the next steps for the flag removal. As for the bug, I'll ask someone from my team to take a look :)

@dcoa
Copy link
Contributor

dcoa commented Sep 24, 2024

Hi, @bradenmacdonald I made a change to sort the courses initially by A-Z. Could you have a look?

Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

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

LGTM! And the home page sort is now working properly :)

I'll need @KristinAoki or someone from 2U to approve this before we merge it though. I'm not sure of the context on why this API hasn't been switched on already.

@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@bradenmacdonald
Copy link
Contributor

bradenmacdonald commented Sep 25, 2024

@mariajgrimaldi Here is a sandbox for you ^

Edit: spoke too soon; there is some issue with the sandbox
Edit 2: now it's working :)

@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@open-craft-grove
Copy link

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@open-craft-grove
Copy link

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@open-craft-grove
Copy link

Sandbox deployment failed 💥
Please check the settings and requirements.
Retry deployment by pushing a new commit or updating the requirements/settings in the pull request's description.
📜 Failure Logs
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@mariajgrimaldi
Copy link
Member Author

@bradenmacdonald, thank you! I've tested it, and it's working fine :)

@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@open-craft-grove
Copy link

Sandbox deployment successful 🚀
🎓 LMS
📝 Studio
ℹ️ Grove Config, Tutor Config, Tutor Requirements

@KristinAoki KristinAoki merged commit 8a4d1f4 into openedx:master Oct 16, 2024
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
create-sandbox open-craft-grove should create a sandbox environment from this PR 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.

6 participants