4acae603-8a34-4769-8d68-bc616957bdd3

Committed 28 Jun 2024 02:05PM UTC coverage: 85.441% (+0.02%) from 85.42%

Build # 4acae603-8a34-4769-8d68-bc616957bdd3

Build Type

Pull #4763

circleci

Committed by

jwhitlock

Commit Message

Update imports of Profile

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

Run Details

4075 of 5220 branches covered (78.07%)

Branch coverage included in aggregate %.

1001 of 1026 new or added lines in 26 files covered. (97.56%)

16 existing lines in 3 files now uncovered.

15931 of 18195 relevant lines covered (87.56%)

10.9 hits per line

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

77.97

/emails/apps.py

import logging
import os

from django.apps import AppConfig, apps
from django.conf import settings
from django.utils.functional import cached_property

import boto3
from botocore.config import Config
from mypy_boto3_ses.client import SESClient

logger = logging.getLogger("events")


class EmailsConfig(AppConfig):
    name = "emails"

    @cached_property
    def ses_client(self) -> SESClient | None:
        try:
            return boto3.client("ses", region_name=settings.AWS_REGION)
        except Exception:
            logger.exception("exception during SES connect")
            return None

    @cached_property
    def s3_client(self):
        try:
            s3_config = Config(
                region_name=settings.AWS_REGION,
                retries={
                    # max_attempts includes the initial attempt to get the email
                    # so this does not retry with backoff, to avoid timeouts
                    "max_attempts": 1,
                    "mode": "standard",
                },
            )
            return boto3.client("s3", config=s3_config)
        except Exception:
            logger.exception("exception during S3 connect")

    def __init__(self, app_name, app_module):
        super().__init__(app_name, app_module)

        # badwords file from:
        # https://www.cs.cmu.edu/~biglou/resources/bad-words.txt
        # Using `.text` extension because of
        # https://github.com/dependabot/dependabot-core/issues/1657
        self.badwords = self._load_terms("badwords.text")
        self.blocklist = self._load_terms("blocklist.text")

    def _load_terms(self, filename: str) -> list[str]:
        """Load a list of terms from a file."""
        terms = []
        terms_file_path = os.path.join(settings.BASE_DIR, "emails", filename)
        with open(terms_file_path) as terms_file:
            for word in terms_file:
                if len(word.strip()) > 0 and word.strip()[0] == "#":
                    continue
                terms.append(word.strip())
        return terms


def emails_config() -> EmailsConfig:
    emails_config = apps.get_app_config("emails")
    if not isinstance(emails_config, EmailsConfig):
        raise TypeError("emails_config must be type EmailsConfig")
    return emails_config


def ses_client() -> SESClient | None:
    return emails_config().ses_client


def s3_client():
    return emails_config().s3_client

1	import logging	1✔
2	import os	1✔
3
4	from django.apps import AppConfig, apps	1✔
5	from django.conf import settings	1✔
6	from django.utils.functional import cached_property	1✔
7
8	import boto3	1✔
9	from botocore.config import Config	1✔
10	from mypy_boto3_ses.client import SESClient	1✔
11
12	logger = logging.getLogger("events")	1✔
13
14
15	class EmailsConfig(AppConfig):	1✔
16	name = "emails"	1✔
17
18	@cached_property	1✔
19	def ses_client(self) -> SESClient \| None:	1✔
UNCOV 20	try:	×
UNCOV 21	return boto3.client("ses", region_name=settings.AWS_REGION)	×
UNCOV 22	except Exception:	×
UNCOV 23	logger.exception("exception during SES connect")	×
UNCOV 24	return None	×
25
26	@cached_property	1✔
27	def s3_client(self):	1✔
UNCOV 28	try:	×
29	s3_config = Config(	×
30	region_name=settings.AWS_REGION,
31	retries={
32	# max_attempts includes the initial attempt to get the email
33	# so this does not retry with backoff, to avoid timeouts
34	"max_attempts": 1,
35	"mode": "standard",
36	},
37	)
38	return boto3.client("s3", config=s3_config)	×
UNCOV 39	except Exception:	×
UNCOV 40	logger.exception("exception during S3 connect")	×
41
42	def __init__(self, app_name, app_module):	1✔
43	super().__init__(app_name, app_module)	1✔
44
45	# badwords file from:
46	# https://www.cs.cmu.edu/~biglou/resources/bad-words.txt
47	# Using `.text` extension because of
48	# https://github.com/dependabot/dependabot-core/issues/1657
49	self.badwords = self._load_terms("badwords.text")	1✔
50	self.blocklist = self._load_terms("blocklist.text")	1✔
51
52	def _load_terms(self, filename: str) -> list[str]:	1✔
53	"""Load a list of terms from a file."""
54	terms = []	1✔
55	terms_file_path = os.path.join(settings.BASE_DIR, "emails", filename)	1✔
56	with open(terms_file_path) as terms_file:	1✔
57	for word in terms_file:	1✔
58	if len(word.strip()) > 0 and word.strip()[0] == "#":	1✔
59	continue	1✔
60	terms.append(word.strip())	1✔
61	return terms	1✔
62
63
64	def emails_config() -> EmailsConfig:	1✔
65	emails_config = apps.get_app_config("emails")	1✔
66	if not isinstance(emails_config, EmailsConfig):	1!
UNCOV 67	raise TypeError("emails_config must be type EmailsConfig")	×
68	return emails_config	1✔
69
70
71	def ses_client() -> SESClient \| None:	1✔
72	return emails_config().ses_client	1✔
73
74
75	def s3_client():	1✔
UNCOV 76	return emails_config().s3_client	×

mozilla / fx-private-relay / 4acae603-8a34-4769-8d68-bc616957bdd3

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