Add library catalog content filtering (PP-3237) #2933
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add new library configuration options that allow library administrators to specify which audiences and genres should be filtered from their catalog. This is the first step in implementing catalog filtering for K-12 schools that need to hide content matching certain metadata fields. - Add filtered_audiences field with validation against Classifier.AUDIENCES - Add filtered_genres field with validation against available genres - Both fields use FormFieldType.MENU for multi-select UI - Access level set to SYS_ADMIN_OR_MANAGER (library managers can configure) - Add comprehensive tests for both fields
Modify the search Filter class to apply library-configured audience and genre filters when building OpenSearch queries. The Filter now stores filtered_audiences and filtered_genres from LibrarySettings at construction time, and adds must_not clauses to exclude matching works. This enables libraries to hide content by audience (Adult, Young Adult, etc.) and/or genre (Romance, Horror, etc.) from catalog search results. Includes unit tests and an end-to-end test against OpenSearch.
Add filtered_audiences and filtered_genres to expected output.
Add filtering for permalink and URN lookup endpoints based on library's filtered_audiences and filtered_genres settings: - Add Work.is_filtered_for_library() helper method to check if a work should be hidden for a library based on audience or genre filters - Modify load_work() in CirculationManagerController to return 404 for filtered works - Modify URNLookupHandler to accept an optional library parameter and exclude filtered works from lookup results - Add comprehensive tests for the new filtering behavior
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2933 +/- ##
==========================================
+ Coverage 92.78% 92.80% +0.02%
==========================================
Files 454 454
Lines 42838 42892 +54
Branches 5974 5987 +13
==========================================
+ Hits 39746 39805 +59
+ Misses 2021 2017 -4
+ Partials 1071 1070 -1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add library-level content filtering that allows administrators to hide catalog content by audience and/or genre. This enables libraries (particularly K-12 schools) to restrict content such as Adult-only materials or specific genres like Romance or Horror.
Changes include:
filtered_audiencesandfiltered_genressettings to LibrarySettings with validation against controlled vocabulariesWork.is_filtered_for_library()helper method for reusable filtering logicMotivation and Context
Libraries (especially K-12) need the ability to filter catalog content based on audience and genre. This feature allows library administrators to configure content restrictions that are automatically applied to search results and direct work lookups.
Implements PP-3237.
How Has This Been Tested?
Work.is_filtered_for_library()helper methodChecklist