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: disable filter by block on collections tab [FC-0076] #1576

Conversation

rpenido
Copy link
Contributor

@rpenido rpenido commented Dec 19, 2024

Description

This PR adds the disabled prop for FilterByBlockType component and uses it on the Library Collection tab.

More Information

Testing Instruction

  • Open a Library
  • Select some block type on the FilterByBlockType component
  • Navigate to the Collection tab and check if the collections are shown
  • Return to the "All Content" tab and check if the previous filter persists

Private ref: FAL-3981

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Dec 19, 2024
@openedx-webhooks
Copy link

openedx-webhooks commented Dec 19, 2024

Thanks for the pull request, @rpenido!

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 Dec 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.97%. Comparing base (230960b) to head (ca971f5).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1576   +/-   ##
=======================================
  Coverage   92.96%   92.97%           
=======================================
  Files        1075     1075           
  Lines       21197    21205    +8     
  Branches     4560     4576   +16     
=======================================
+ Hits        19706    19715    +9     
+ Misses       1425     1418    -7     
- Partials       66       72    +6     

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

@rpenido rpenido marked this pull request as ready for review December 19, 2024 18:41
@rpenido rpenido requested a review from a team as a code owner December 19, 2024 18:41
@rpenido rpenido changed the title fix: disable filter by block on collections tab fix: disable filter by block on collections tab [FC-0076] Dec 19, 2024
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Dec 19, 2024
Comment on lines 227 to 242
useEffect(() => {
if (disabled) {
// Clear filters when disabled
const selectedBlockTypesFilter = blockTypesFilter;
const selectedProblemTypesFilter = problemTypesFilter;
setBlockTypesFilter([]);
setProblemTypesFilter([]);

return () => {
// Restore filters when re-enabled
setBlockTypesFilter(selectedBlockTypesFilter);
setProblemTypesFilter(selectedProblemTypesFilter);
};
}
return () => {};
}, [disabled]);
Copy link
Contributor

Choose a reason for hiding this comment

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

@rpenido Nice one!

Copy link
Contributor

@navinkarkera navinkarkera left a comment

Choose a reason for hiding this comment

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

@rpenido This works perfectly! I see that patch coverage shows up as 100% but cannot find any tests that actually test this behaviour.

  • I tested this: (Filtered components and verified collections tab behaviour)
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

src/search-manager/FilterByBlockType.tsx Outdated Show resolved Hide resolved
Copy link
Contributor

@ChrisChV ChrisChV left a comment

Choose a reason for hiding this comment

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

@rpenido Looks good. Could you fix the broken validations?

@rpenido
Copy link
Contributor Author

rpenido commented Dec 21, 2024

@rpenido Looks good. Could you fix the broken validations?

Sorry @ChrisChV ! Fixed now.

@ChrisChV ChrisChV merged commit dc0ba6a into openedx:master Dec 21, 2024
7 checks passed
@ChrisChV ChrisChV deleted the rpenido/fal-3981-disable-filter-by-block-on-collections branch December 21, 2024 12:01
pomegranited added a commit to open-craft/frontend-app-authoring that referenced this pull request Jan 1, 2025
Re-implements the functionality added by
openedx#1576 which was
broken when storing types in search params. Had to use a different
approach to avoid "insecure operation" errors from React.

Also adds tests.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project 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