dd4a41f1-bd6c-471f-a5e2-92a2e0ad5ad0

Committed 27 Jun 2024 04:55PM UTC coverage: 85.353% (+0.05%) from 85.306%

Build # dd4a41f1-bd6c-471f-a5e2-92a2e0ad5ad0

Build Type

Pull #4763

circleci

Committed by

jwhitlock

Commit Message

Optimized bad word checks

Precompute the set of short bad words and list of long bad words, so
that a short optimized check is first.

Use a set for blocklist, so "value in blocklist" can be used.

Pull Request Pull Request #4763: MPP-3827: Move Profile and RegisteredSubdomain models to privaterelay

Run Details

4012 of 5154 branches covered (77.84%)

Branch coverage included in aggregate %.

1107 of 1133 new or added lines in 27 files covered. (97.71%)

22 existing lines in 5 files now uncovered.

15819 of 18080 relevant lines covered (87.49%)

10.31 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.55

/emails/validators.py

"""Field validators for emails models."""

import re

from django.contrib.auth.models import User

from privaterelay.utils import flag_is_active_in_task
from privaterelay.validators import has_bad_words

from .exceptions import (
    AccountIsInactiveException,
    AccountIsPausedException,
    DomainAddrFreeTierException,
    DomainAddrNeedSubdomainException,
    RelayAddrFreeTierLimitException,
)

# A valid local / username part of an email address:
#   can't start or end with a hyphen
#   must be 1-63 lowercase alphanumeric characters and/or hyphens
_re_valid_address = re.compile("^(?![-.])[a-z0-9-.]{1,63}(?<![-.])$")

def check_user_can_make_another_address(user: User) -> None:
    """Raise an exception if the user can not make a RelayAddress."""
    if not user.is_active:
        raise AccountIsInactiveException()

    if user.profile.is_flagged:
        raise AccountIsPausedException()
    # MPP-3021: return early for premium users to avoid at_max_free_aliases DB query
    if user.profile.has_premium:
        return
    if user.profile.at_max_free_aliases:
        raise RelayAddrFreeTierLimitException()


def check_user_can_make_domain_address(user: User) -> None:
    """Raise an exception if the user can not make a DomainAddress."""
    if not user.profile.has_premium:
        raise DomainAddrFreeTierException()

    if not user.profile.subdomain:
        raise DomainAddrNeedSubdomainException()

    if not user.is_active:
        raise AccountIsInactiveException()

    if user.profile.is_flagged:
        raise AccountIsPausedException()


def valid_address(address: str, domain: str, subdomain: str | None = None) -> bool:
    """Return if the given address parts make a valid Relay email."""
    from .models import DeletedAddress, address_hash

    address_pattern_valid = valid_address_pattern(address)
    address_contains_badword = has_bad_words(address)
    address_already_deleted = 0
    if not subdomain or flag_is_active_in_task(
        "custom_domain_management_redesign", None
    ):
        address_already_deleted = DeletedAddress.objects.filter(
            address_hash=address_hash(address, domain=domain, subdomain=subdomain)
        ).count()
    if (
        address_already_deleted > 0
        or address_contains_badword
        or not address_pattern_valid
    ):
        return False
    return True


def valid_address_pattern(address: str) -> bool:
    """Return if the local/user part of an address is valid."""
    return _re_valid_address.match(address) is not None

1	"""Field validators for emails models."""
2
3	import re	1✔
4
5	from django.contrib.auth.models import User	1✔
6
7	from privaterelay.utils import flag_is_active_in_task	1✔
8	from privaterelay.validators import has_bad_words	1✔
9
10	from .exceptions import (	1✔
11	AccountIsInactiveException,
12	AccountIsPausedException,
13	DomainAddrFreeTierException,
14	DomainAddrNeedSubdomainException,
15	RelayAddrFreeTierLimitException,
16	)
17
18	# A valid local / username part of an email address:
19	# can't start or end with a hyphen
20	# must be 1-63 lowercase alphanumeric characters and/or hyphens
21	_re_valid_address = re.compile("^(?![-.])[a-z0-9-.]{1,63}(?<![-.])$")	1✔
22
23	def check_user_can_make_another_address(user: User) -> None:	1✔
24	"""Raise an exception if the user can not make a RelayAddress."""
25	if not user.is_active:	1✔
26	raise AccountIsInactiveException()	1✔
27
28	if user.profile.is_flagged:	1✔
29	raise AccountIsPausedException()	1✔
30	# MPP-3021: return early for premium users to avoid at_max_free_aliases DB query
31	if user.profile.has_premium:	1✔
32	return	1✔
33	if user.profile.at_max_free_aliases:	1✔
34	raise RelayAddrFreeTierLimitException()	1✔
35
36
37	def check_user_can_make_domain_address(user: User) -> None:	1✔
38	"""Raise an exception if the user can not make a DomainAddress."""
39	if not user.profile.has_premium:	1✔
40	raise DomainAddrFreeTierException()	1✔
41
42	if not user.profile.subdomain:	1✔
43	raise DomainAddrNeedSubdomainException()	1✔
44
45	if not user.is_active:	1!
UNCOV 46	raise AccountIsInactiveException()	×
47
48	if user.profile.is_flagged:	1✔
49	raise AccountIsPausedException()	1✔
50
51
52	def valid_address(address: str, domain: str, subdomain: str \| None = None) -> bool:	1✔
53	"""Return if the given address parts make a valid Relay email."""
54	from .models import DeletedAddress, address_hash	1✔
55
56	address_pattern_valid = valid_address_pattern(address)	1✔
57	address_contains_badword = has_bad_words(address)	1✔
58	address_already_deleted = 0	1✔
59	if not subdomain or flag_is_active_in_task(	1✔
60	"custom_domain_management_redesign", None
61	):
62	address_already_deleted = DeletedAddress.objects.filter(	1✔
63	address_hash=address_hash(address, domain=domain, subdomain=subdomain)
64	).count()
65	if (	1✔
66	address_already_deleted > 0
67	or address_contains_badword
68	or not address_pattern_valid
69	):
70	return False	1✔
71	return True	1✔
72
73
74	def valid_address_pattern(address: str) -> bool:	1✔
75	"""Return if the local/user part of an address is valid."""
76	return _re_valid_address.match(address) is not None	1✔

mozilla / fx-private-relay / dd4a41f1-bd6c-471f-a5e2-92a2e0ad5ad0

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous