Files
Evection/apps/rules/test_engine.py
T
ksmithandClaude Sonnet 5 753ae9efc7 Make Starred and Saved-for-later pre-configured system tags
UserArticleState.is_starred/is_saved_for_later/starred_at are gone —
starring and saving now add/remove an ArticleTag against a per-user
"Starred" / "Saved for later" Tag, created lazily on first use and marked
Tag.is_system=True. is_read/is_hidden stay on UserArticleState since
they're genuine reading state, not categorization, which is what made
these two candidates for unifying into the general tag mechanism.

System tags are excluded from the Manage Tags page and from delete_tag
(get_object_or_404 now requires is_system=False, so attempting to delete
one 404s) and from the subscription-tag autocomplete, since they
categorize articles, not feeds. The star/save icons are still exactly
where they were — this only changes what powers them.

apps.rules.engine's star action now does get_system_tag + ArticleTag.
get_or_create instead of setting a boolean field. A data migration
converts every existing is_starred=True/is_saved_for_later=True row into
its ArticleTag equivalent before the fields are dropped — verified by
seeding the pre-removal schema directly (including a row with both flags
set) and confirming the migration produces the right tags.

apps.articles.queries.with_user_state gained one more query (tag lookup
for the current page's articles) to stay in the same "fixed number of
queries regardless of article count" shape it already had.

Verified end to end against a running dev server: toggling star/saved,
the starred/saved filters, the sidebar's Favourites count, and that the
Starred tag doesn't appear on the Manage Tags page.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
2026-10-30 21:36:44 -06:00

180 lines
6.6 KiB
Python

import pytest
from django.contrib.auth import get_user_model
from apps.articles.models import (
STARRED_TAG_NAME,
Article,
ArticleTag,
Tag,
UserArticleState,
)
from apps.feeds.models import Feed
from .engine import evaluate_rules_for_article, rule_matches
from .models import FilterRule
User = get_user_model()
def is_starred(user, article):
return ArticleTag.objects.filter(
user=user, article=article, tag__is_system=True, tag__name=STARRED_TAG_NAME
).exists()
@pytest.fixture
def user(db):
return User.objects.create_user("alice", password="pw-alice-123")
@pytest.fixture
def feed(db):
return Feed.objects.create(feed_url="https://example.com/feed.xml", title="Example Feed")
@pytest.fixture
def article(feed):
return Article.objects.create(
feed=feed,
guid="guid-1",
title="Breaking: Python 4 announced",
author="Jane Doe",
content_html="<p>Lots of details about the release.</p>",
link="https://example.com/python-4",
)
def make_rule(user, **overrides):
defaults = {
"match_field": FilterRule.FIELD_TITLE,
"match_type": FilterRule.MATCH_CONTAINS,
"match_value": "Python",
"action": FilterRule.ACTION_STAR,
}
defaults.update(overrides)
return FilterRule.objects.create(user=user, **defaults)
@pytest.mark.django_db
class TestRuleMatches:
def test_contains_case_insensitive_by_default(self, user, article):
rule = make_rule(user, match_value="python")
assert rule_matches(rule, article) is True
def test_contains_respects_case_sensitivity(self, user, article):
rule = make_rule(user, match_value="python", case_sensitive=True)
assert rule_matches(rule, article) is False
def test_not_contains(self, user, article):
rule = make_rule(user, match_type=FilterRule.MATCH_NOT_CONTAINS, match_value="golang")
assert rule_matches(rule, article) is True
def test_exact_match(self, user, article):
rule = make_rule(
user,
match_type=FilterRule.MATCH_EXACT,
match_value="breaking: python 4 announced",
)
assert rule_matches(rule, article) is True
article.title = "Something else"
assert rule_matches(rule, article) is False
def test_regex_match(self, user, article):
rule = make_rule(user, match_type=FilterRule.MATCH_REGEX, match_value=r"Python \d")
assert rule_matches(rule, article) is True
def test_invalid_regex_does_not_raise(self, user, article):
rule = make_rule(user, match_type=FilterRule.MATCH_REGEX, match_value="(unclosed")
assert rule_matches(rule, article) is False
def test_content_field_strips_html_tags(self, user, article):
rule = make_rule(user, match_field=FilterRule.FIELD_CONTENT, match_value="Lots of details")
assert rule_matches(rule, article) is True
def test_author_field(self, user, article):
rule = make_rule(user, match_field=FilterRule.FIELD_AUTHOR, match_value="Jane")
assert rule_matches(rule, article) is True
def test_feed_title_field(self, user, article):
rule = make_rule(user, match_field=FilterRule.FIELD_FEED_TITLE, match_value="Example")
assert rule_matches(rule, article) is True
def test_url_field(self, user, article):
rule = make_rule(user, match_field=FilterRule.FIELD_URL, match_value="python-4")
assert rule_matches(rule, article) is True
@pytest.mark.django_db
class TestApplyRuleAction:
def test_star_action(self, user, article):
rules = [make_rule(user, action=FilterRule.ACTION_STAR)]
evaluate_rules_for_article(user, article, rules)
assert is_starred(user, article) is True
state = UserArticleState.objects.get(user=user, article=article)
assert state.is_read is False
def test_mark_read_action(self, user, article):
rules = [make_rule(user, action=FilterRule.ACTION_MARK_READ)]
evaluate_rules_for_article(user, article, rules)
state = UserArticleState.objects.get(user=user, article=article)
assert state.is_read is True
assert state.read_at is not None
def test_hide_action_marks_hidden_and_read(self, user, article):
rules = [make_rule(user, action=FilterRule.ACTION_HIDE)]
evaluate_rules_for_article(user, article, rules)
state = UserArticleState.objects.get(user=user, article=article)
assert state.is_hidden is True
assert state.is_read is True
def test_tag_action_creates_and_assigns_tag(self, user, article):
rules = [make_rule(user, action=FilterRule.ACTION_TAG, action_value="python-news")]
evaluate_rules_for_article(user, article, rules)
tag = Tag.objects.get(user=user, name="python-news")
assert ArticleTag.objects.filter(user=user, article=article, tag=tag).exists()
def test_non_matching_rule_creates_no_state(self, user, article):
rules = [make_rule(user, match_value="golang", action=FilterRule.ACTION_STAR)]
evaluate_rules_for_article(user, article, rules)
assert not UserArticleState.objects.filter(user=user, article=article).exists()
@pytest.mark.django_db
class TestRulePriorityAndShortCircuit:
def test_rules_apply_in_priority_order(self, user, article):
tag_rule = make_rule(
user, priority=1, action=FilterRule.ACTION_TAG, action_value="early-tag"
)
star_rule = make_rule(user, priority=2, action=FilterRule.ACTION_STAR)
evaluate_rules_for_article(user, article, [tag_rule, star_rule])
assert is_starred(user, article) is True
assert Tag.objects.filter(user=user, name="early-tag").exists()
def test_hide_short_circuits_later_rules(self, user, article):
hide_rule = make_rule(user, priority=1, action=FilterRule.ACTION_HIDE)
star_rule = make_rule(user, priority=2, action=FilterRule.ACTION_STAR)
evaluate_rules_for_article(user, article, [hide_rule, star_rule])
state = UserArticleState.objects.get(user=user, article=article)
assert state.is_hidden is True
# The star rule never ran because hide short-circuited first.
assert is_starred(user, article) is False
def test_non_hide_actions_stack_across_multiple_rules(self, user, article):
star_rule = make_rule(user, priority=1, action=FilterRule.ACTION_STAR)
read_rule = make_rule(user, priority=2, action=FilterRule.ACTION_MARK_READ)
evaluate_rules_for_article(user, article, [star_rule, read_rule])
assert is_starred(user, article) is True
state = UserArticleState.objects.get(user=user, article=article)
assert state.is_read is True