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

fix: fetch proper courses when keyword searching with applied filters #1497

Merged
merged 1 commit into from
Dec 9, 2024

Conversation

bra-i-am
Copy link
Contributor

@bra-i-am bra-i-am commented Nov 12, 2024

Description

This PR makes the Studio Home search bar work as expected. When active/archived filters were on or there was selected any order filter, the search skipped these values and just returned the courses list without the respective filters. Additionally, when a search keyword was applied and a filter was selected, the keyword stayed stuck and the search list returned was not the appropriate

  • courses-filters/index.jsx: It was added the filter states to the useCallback dependencies so if any of this filters changes, they are applied properly and retrieved the proper data

Supporting information

GitHub Issue: #1477

Testing instructions

Make sure you count on at least one course and do the following:

  1. Mount this branch on the frontend-app-authoring MFE to test it
  2. Go to the Studio Home, you'll watch all your courses
  3. Now apply the filter Archived in the dropdown beside the search bar
  4. Try to look for a course you know is active, but if everything goes well, you shouldn't be able to find it
  5. The same must happen if you have activated the filter Active and try to look for an archived course
  6. Ensure you are shown the message "We could not find any results."

Screenshots

  1. Archive/active filter is taken into account
    image

  2. The sorting filter is applied despite changing the other filters
    image

  3. The search stayed stuck due to a specific keyword was preserved when a filter was applied:

  • Before
    image
  • After
    image

@bra-i-am bra-i-am requested a review from a team as a code owner November 12, 2024 21:15
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 12, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @bra-i-am!

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.

Copy link

codecov bot commented Nov 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.93%. Comparing base (e75ce15) to head (d60f019).
Report is 6 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1497   +/-   ##
=======================================
  Coverage   92.93%   92.93%           
=======================================
  Files        1073     1073           
  Lines       21091    21091           
  Branches     4559     4545   -14     
=======================================
  Hits        19601    19601           
  Misses       1418     1418           
  Partials       72       72           

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

@mariajgrimaldi
Copy link
Member

mariajgrimaldi commented Nov 25, 2024

@arbrandes @bradenmacdonald: could you give us a hand reviewing this PR? It fixes #1477. Thank you!

@@ -95,7 +95,7 @@ const CoursesFilters = ({

const handleSearchCoursesDebounced = useCallback(
debounce((value) => handleSearchCourses(value), 400),
[],
[activeOnly, archivedOnly],
Copy link
Contributor

@bradenmacdonald bradenmacdonald Nov 26, 2024

Choose a reason for hiding this comment

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

Just one question: should order not be included as well ?

Copy link
Member

@mariajgrimaldi mariajgrimaldi Nov 26, 2024

Choose a reason for hiding this comment

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

Also, going back to this fix that addressed this issue in particular about the sorting default, after searching even if sorting is set to "newest" or "oldest" the results are returned sorted only by display name. Could that be fixed by adding order here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@bradenmacdonald @mariajgrimaldi: thanks for your feedback. I already updated the branch

please let me know if anything else

When active/archived filters were on or there was selected any order filter, the search skipped these values and it was just returned the courses list without the respective filters. Additionally, when a search keyword was applied and a filter was selected, the keyword stayed stuck and the search list returned were not the appropriate
@bra-i-am bra-i-am force-pushed the bc/fix-filtered-search branch from d5692e5 to d60f019 Compare December 5, 2024 15:50
@bra-i-am bra-i-am changed the title fix: find proper courses when searching with active/archived filters on fix: fetch proper courses when keyword searching with applied filters Dec 5, 2024
@mariajgrimaldi
Copy link
Member

mariajgrimaldi commented Dec 5, 2024

FYI @farhaanbukhsh

Here's also the backport for you to review: #1496

Copy link
Member

@farhaanbukhsh farhaanbukhsh left a comment

Choose a reason for hiding this comment

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

👍

  • ✅ I tested this on Tutor with Sumac and master
  • ✅ I read through the code
  • ❌ I checked for accessibility issues
  • ❌ Includes documentation
  • ❌ I made sure any change in configuration variables is reflected in the corresponding client's configuration-secure repository.

@mariajgrimaldi
Copy link
Member

@farhaanbukhsh: can you help us merge this PR? Thank you!

@farhaanbukhsh
Copy link
Member

@mariajgrimaldi I can but I don't want to bypass the CC for the repo :) and don't worry we can backport this to sumac.1 as well.

@mariajgrimaldi
Copy link
Member

@farhaanbukhsh: I understand. Thank you!

@bradenmacdonald: Could you give us a hand with a re-review? Thank you!

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. Thanks for fixing this!

bradenmacdonald pushed a commit that referenced this pull request Dec 9, 2024
When active/archived filters were on or there was selected any order filter, the search skipped these values and it was just returned the courses list without the respective filters. Additionally, when a search keyword was applied and a filter was selected, the keyword stayed stuck and the search list returned were not the appropriate
@bradenmacdonald bradenmacdonald merged commit c7e2bf9 into openedx:master Dec 9, 2024
7 checks passed
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: Done
Development

Successfully merging this pull request may close these issues.

5 participants