feat(blacklist): Automatically add media with blacklisted tags to the blacklist

[benbeauchamp7]

Description

This pull request introduces blacktags, which automatically blacklist media based on their tags (keywords). Blacktags are configured on the settings page and processed with the Process Blacktags job, which is configured to run weekly by default.

The job queries discover with each sort option round-robin style, with each sort being queries up to "Limit" times, where limit is configured in the settings just under where tags are entered. This is done so that media is blacklisted as much as possible no matter the sort used on the discover page (I don't want media with blacktags to appear when I sort popularity ascending for example). The default limit is 50 pages, resulting in a maximum of 32,000 blacklist entries per tag (2 media types * 50 pages * 20 entries per page * 16 sort options). The maximum limit is 250, which would cap out at 160,000 entries per tag.

Screenshot (if UI-related)

UI

Settings:

Job:

To-Dos

• Add copy and paste functionality to keyword setting to allow sharing of blacktag configurations
• Add blacklist filter to hide media added by blacktag
• Successful build pnpm build
• Translation keys pnpm i18n:extract
• Database migration (if required)
• More bugtesting before ready for review

Issues Fixed or Closed

• Fixes Add Tag-Based Content Filtering System in Blacklist Settings #1076

[benbeauchamp7]

That covers the functionality I was planning to implement. The only request I didn't cover from the original issue is an easy way to enable or disable the feature from the settings with a checkbox. I kind-of implemented a way to easily mass-unblock media by running the job without any blacktags configured, which will drop the blacktagged media.

Hoping to open everything up for review tomorrow night, want to do one last pass for bugs and code review

[gauthier-th]

Genuine question, I didn't look at the code yet: why do you have to implement it using a job? Why can't this be done the same way as the standard blacklist is done, i.e. dismissing the item when it is displayed if the condition matches?

[benbeauchamp7]

TMDB doesn't return keywords on their endpoints, it actually looks like keywords are one of the only things they *don't* return. In order to not stuff the blacklist, I would have needed to hit the API again *for each movie* to get their keywords before actually showing the media. That felt slow and bad, so I went with the job.

…

On Mon, Jan 27, 2025 at 4:03 AM Gauthier ***@***.***> wrote: Genuine question, I didn't look at the code yet: why do you have to implement it using a job? Why can't this be done the same way as the standard blacklist is done, i.e. dismissing the item when it is displayed if the condition matches? — Reply to this email directly, view it on GitHub <#1306 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AKKZSHDCWCCYIW3D4LOE5IT2MYAA5AVCNFSM6AAAAABV3ARAB2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMJVGMYTMNBXHE> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[fallenbagel]

@benbeauchamp7 please rename it to blacklistTags

[benbeauchamp7]

Changed all instances to some form of blacklistedTag. Rebased on top of develop (force push did not alter any previous commits)

[benbeauchamp7]

The blacklisted tags are processed only when the job runs, so any updates you make to the list will only go into effect the next time the job runs. Entries for that tag aren’t removed immediately. Will update/rephrase doc when I get home from work

…

On Mon, Feb 3, 2025 at 2:50 PM Gauthier ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In docs/using-jellyseerr/settings/general.md <#1306 (comment)> : > @@ -62,6 +62,12 @@ Set the default display language for Jellyseerr. Users can override this setting These settings filter content shown on the "Discover" home page based on regional availability and original language, respectively. The Streaming Region filters the available streaming providers on the media page. Users can override these global settings by configuring these same options in their user settings. +## Blacklist Content with Tags and Limit Content Blacklisted per Tag + +These settings blacklist any TV shows or movies that have one of the entered tags. Entries are added to the blacklist using the "Process Blacklisted Tags" job. Removing blacklisted tags will remove media from the blacklist if it was blacklisted for that tag. To clear all blacklist entries created with tag, remove all tags in the setting and run the "Process Blacklisted Tags" job. You say that "Removing blacktags will remove media from the blacklist if it was blacklisted for that blacktag". But after you say that you need to run the "Process Blacktags" job to remove all entries. Does the Process Blacktags job also have to run to remove a single entry? It's not really clear. — Reply to this email directly, view it on GitHub <#1306 (review)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AKKZSHAW7N7272CN7BISMBT2N7JAXAVCNFSM6AAAAABV3ARAB2VHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDKOJQHE3TGMJVHA> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[github-actions]

This pull request has merge conflicts. Please resolve the conflicts so the PR can be successfully reviewed and merged.

[benbeauchamp7]

Rebased on develop, no code was altered in the rebase

[gauthier-th]

Currently, this will not work when a user search a media that have not been added with the job, i.e. for older movies not present in the discovery sections.
I didn't check if it's possible, but can you think of a convenient way of blacklisting it / hiding it in the search page too?

[benbeauchamp7]

Thank you for your review!

It looks like Jellyseerr's search uses the /search/multi endpoint here, which unfortunately doesn't have any keyword filtering capabilities. The only way I can think to resolve this is by

1. Querying every shown tv show/movie's keywords (feels slow and bad)
2. Increasing the limit setting to hopefully catch those shows

Since the original issue was "my feed's full of the kinda shows I don't want on my TV" I think this sufficiently solves that issue. Is probably worth writing up another issue for the search problem.

[gauthier-th]

It looks like Jellyseerr's search uses the /search/multi endpoint here, which unfortunately doesn't have any keyword filtering capabilities.

Yep, that's what I was afraid of. I'll look at TMDB forums to see if there is any open issue to add tags in the search response (or create one if there isn't), it would solve our issue.

[gauthier-th]

Just created a ticket on TMDB forum to ask for the without_keyword filter in the /search endpoint and in the /trending endpoint: https://www.themoviedb.org/talk/67abc9c85bd9fe5057b0a872
The without_keyword filter already exists in the /discover endpoint.

[gauthier-th]

Tested and worked well for what I tried. A few more tests are welcome though.

[github-actions]

This pull request has merge conflicts. Please resolve the conflicts so the PR can be successfully reviewed and merged.