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

benbeauchamp7 · 2025-01-25T06:01:05Z

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 · 2025-01-26T21:56:09Z

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 · 2025-01-27T10:03:36Z

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 · 2025-01-27T14:11:32Z

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 · 2025-02-01T01:56:06Z

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

docs/using-jellyseerr/settings/general.md

benbeauchamp7 · 2025-02-03T21:04:56Z

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 · 2025-02-04T21:03:16Z

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

…ion tree too large error

…he main settings

…ther pages

…omatically blacklisted entries

…terfaces There's no reason for it to be there

…acktagsProcessor

…ag and update doc to match

…tings

…een modals

… entry query Doesn't make sense to keep it because tmdbid has a unique constraint on it

benbeauchamp7 · 2025-02-04T23:58:31Z

Rebased on develop, no code was altered in the rebase

server/job/blacklistedTagsProcessor.ts

src/components/BlacklistedTagsBadge/index.tsx

server/job/blacklistedTagsProcessor.ts

gauthier-th · 2025-02-05T23:22:50Z

server/job/blacklistedTagsProcessor.ts

+      });
+
+      if (blacklistEntry != null) {
+        // Don't mark manual blacklists with tags


Because they weren't blacklisted for a tag, they were blacklisted manually. If I added a tag to the db, it would appear in the blacklist as blacklisted by a tag rather than a person. It would also mean it would get dropped at the start of the job, but not re-added if the job didn't find it in one of the tags. It could also get removed if a tag is removed from the setting.

Since it was blacklisted by a human, I felt it should remain as it did before and the job shouldn't touch it.

src/components/BlacklistBlock/index.tsx

gauthier-th · 2025-02-05T23:46:08Z

src/components/BlacklistedTagsSelector/index.tsx

+type BlacklistedTagsCopyButtonProps = {
+  value: string;
+};
+
+const BlacklistedTagsCopyButton = ({
+  value,
+}: BlacklistedTagsCopyButtonProps) => {
+  const intl = useIntl();
+  const [isCopied, setCopied] = useClipboard(value, {
+    successDuration: 1000,
+  });
+  const { addToast } = useToasts();
+
+  useEffect(() => {
+    if (isCopied) {
+      addToast(intl.formatMessage(messages.copyBlacklistedTags), {
+        appearance: 'info',
+        autoDismiss: true,
+      });
+    }
+  }, [isCopied, addToast, intl]);
+
+  return (
+    <Tooltip
+      content={intl.formatMessage(messages.copyBlacklistedTagsTip)}
+      tooltipConfig={{ followCursor: false }}
+    >
+      <button
+        onClick={(e) => {
+          e.preventDefault();
+          setCopied();
+        }}
+        className="input-action"
+        type="button"
+      >
+        <ClipboardDocumentIcon />
+      </button>
+    </Tooltip>
+  );
+};


Why don't you use the already existing CopyButton instead of duplicating it here?

I was messing around with the button initially and forgot to merge my changes back into CopyButton. Fixed!

gauthier-th · 2025-02-05T23:46:42Z

src/components/BlacklistedTagsSelector/index.tsx

+        }}
+      />
+
+      <BlacklistedTagsCopyButton value={value ?? ''} />


You could maybe disable the button if the value is empty?

Good idea, added general CSS support for disabled button.input-actions too

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 · 2025-02-07T00:33:42Z

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

Querying every shown tv show/movie's keywords (feels slow and bad)
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.

…ere's nothing to copy

gauthier-th · 2025-02-07T10:35:25Z

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 changed the title ~~feat(blacktags): Automatically add media with blacklisted tags to the blacklist~~ feat(blacklist): Automatically add media with blacklisted tags to the blacklist Jan 25, 2025

benbeauchamp7 force-pushed the develop branch 2 times, most recently from 6221ba8 to 0d6d2d3 Compare January 26, 2025 21:43

benbeauchamp7 marked this pull request as ready for review January 27, 2025 23:29

benbeauchamp7 requested review from fallenbagel and gauthier-th as code owners January 27, 2025 23:29

fallenbagel requested changes Jan 31, 2025

View reviewed changes

benbeauchamp7 force-pushed the develop branch from 971cadf to bc4e8ba Compare February 1, 2025 01:52

benbeauchamp7 requested a review from fallenbagel February 1, 2025 01:54

gauthier-th reviewed Feb 3, 2025

View reviewed changes

docs/using-jellyseerr/settings/general.md Outdated Show resolved Hide resolved

benbeauchamp7 requested a review from gauthier-th February 4, 2025 01:38

github-actions bot added the merge conflict Cannot merge due to merge conflicts label Feb 4, 2025

benbeauchamp7 added 12 commits February 4, 2025 17:54

feat(blacklist): add blacktag settings to main settings page

7d1c800

feat(blacklist): create blacktag logic and infrastructure

8811921

feat(blacklist): add scheduling for blacktags job

9f8447d

feat(blacklist): create blacktag ui badge for blacklist

c010c27

docs(blacklist): document blacktags in using-jellyseerr

3e20ccb

fix(blacklist): batch blacklist and media db removes to avoid express…

397e4e5

…ion tree too large error

feat(blacklist): allow easy import and export of blacktag configuration

cc7fb16

fix(settings): don't copy the API key every time you press enter on t…

5f127a1

…he main settings

fix(blacklist): move filter inline with page title to match all the o…

2b15a03

…ther pages

feat(blacklist): allow filtering between manually blacklisted and aut…

0393e98

…omatically blacklisted entries

docs(blacklist): reword blacktag documentation a little

53f1c98

refactor(blacklist): remove blacktag settings from public settings in…

ec9ff7f

…terfaces There's no reason for it to be there

benbeauchamp7 added 5 commits February 4, 2025 17:56

refactor(blacklist): remove unused variable from processResults in bl…

8fb895d

…acktagsProcessor

refactor(blacklist): change all instances of blacktag to blacklistedT…

118289d

…ag and update doc to match

docs(blacklist): update general documentation for blacklisted tag set…

1f22a1b

…tings

fix(blacklist): update setting use of "blacklisted tag" to match betw…

c8a9522

…een modals

perf(blacklist): remove media type constraint from existing blacklist…

29508a9

… entry query Doesn't make sense to keep it because tmdbid has a unique constraint on it

benbeauchamp7 force-pushed the develop branch from c790fe2 to 29508a9 Compare February 4, 2025 23:57

github-actions bot removed the merge conflict Cannot merge due to merge conflicts label Feb 4, 2025

fix(blacklist): remove whitespace line causing prettier to fail in CI

a1a5e38

gauthier-th requested changes Feb 5, 2025

View reviewed changes

gauthier-th reviewed Feb 5, 2025

View reviewed changes

benbeauchamp7 added 2 commits February 6, 2025 18:36

refactor(blacklist): swap out some != and == for !s and _s

e97e136

fix(blacklist): merge back CopyButton changes, disable button when th…

edc1802

…ere's nothing to copy

benbeauchamp7 requested a review from gauthier-th February 7, 2025 02:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

benbeauchamp7 commented Jan 25, 2025 •

edited

Loading

benbeauchamp7 commented Jan 26, 2025

gauthier-th commented Jan 27, 2025

benbeauchamp7 commented Jan 27, 2025 via email

fallenbagel left a comment

benbeauchamp7 commented Feb 1, 2025

benbeauchamp7 commented Feb 3, 2025 via email

github-actions bot commented Feb 4, 2025

benbeauchamp7 commented Feb 4, 2025

gauthier-th Feb 5, 2025

benbeauchamp7 Feb 6, 2025

gauthier-th Feb 5, 2025

benbeauchamp7 Feb 7, 2025

gauthier-th Feb 5, 2025

benbeauchamp7 Feb 7, 2025

gauthier-th left a comment

benbeauchamp7 commented Feb 7, 2025 •

edited

Loading

gauthier-th commented Feb 7, 2025

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

Are you sure you want to change the base?

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

Conversation

benbeauchamp7 commented Jan 25, 2025 • edited Loading

Description

Screenshot (if UI-related)

UI

Settings:

Job:

To-Dos

Issues Fixed or Closed

benbeauchamp7 commented Jan 26, 2025

gauthier-th commented Jan 27, 2025

benbeauchamp7 commented Jan 27, 2025 via email

fallenbagel left a comment

Choose a reason for hiding this comment

benbeauchamp7 commented Feb 1, 2025

benbeauchamp7 commented Feb 3, 2025 via email

github-actions bot commented Feb 4, 2025

benbeauchamp7 commented Feb 4, 2025

gauthier-th Feb 5, 2025

Choose a reason for hiding this comment

benbeauchamp7 Feb 6, 2025

Choose a reason for hiding this comment

gauthier-th Feb 5, 2025

Choose a reason for hiding this comment

benbeauchamp7 Feb 7, 2025

Choose a reason for hiding this comment

gauthier-th Feb 5, 2025

Choose a reason for hiding this comment

benbeauchamp7 Feb 7, 2025

Choose a reason for hiding this comment

gauthier-th left a comment

Choose a reason for hiding this comment

benbeauchamp7 commented Feb 7, 2025 • edited Loading

gauthier-th commented Feb 7, 2025

benbeauchamp7 commented Jan 25, 2025 •

edited

Loading

benbeauchamp7 commented Feb 7, 2025 •

edited

Loading