b2f4ffb98a
# What this PR does Remove [`apps.get_model`](https://docs.djangoproject.com/en/3.2/ref/applications/#django.apps.apps.get_model) invocations and use inline `import` statements in places where models are imported within functions/methods to avoid circular imports. I believe `import` statements are more appropriate for most use cases as they allow for better static code analysis & formatting, and solve the issue of circular imports without being unnecessarily dynamic as `apps.get_model`. With `import` statements, it's possible to: - Jump to model definitions in most IDEs - Automatically sort inline imports with `isort` - Find import errors faster/easier (most IDEs highlight broken imports) - Have more consistency across regular & inline imports when importing models This PR also adds a flake8 rule to ban imports of `django.apps.apps`, so it's harder to use `apps.get_model` by mistake (it's possible to ignore this rule by using `# noqa: I251`). The rule is not enforced on directories with migration files, because `apps.get_model` is often used to get a historical state of a model, which is useful when writing migrations ([see this SO answer for more details](https://stackoverflow.com/a/37769213)). So `apps.get_model` is considered OK in migrations (even necessary in some cases). ## Checklist - [x] Unit, integration, and e2e (if applicable) tests updated - [x] Documentation added (or `pr:no public docs` PR label added if not required) - [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not required)
83 lines
3.2 KiB
Python
83 lines
3.2 KiB
Python
import json
|
|
import logging
|
|
|
|
from django.conf import settings
|
|
from django.db import transaction
|
|
from jinja2 import TemplateError
|
|
|
|
from apps.alerts.utils import request_outgoing_webhook
|
|
from common.custom_celery_tasks import shared_dedicated_queue_retry_task
|
|
|
|
from .send_alert_group_signal import send_alert_group_signal
|
|
from .task_logger import task_logger
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
@shared_dedicated_queue_retry_task(
|
|
autoretry_for=(Exception,), retry_backoff=True, max_retries=1 if settings.DEBUG else None
|
|
)
|
|
def custom_button_result(custom_button_pk, alert_group_pk, user_pk=None, escalation_policy_pk=None):
|
|
from apps.alerts.models import AlertGroup, AlertGroupLogRecord, CustomButton, EscalationPolicy
|
|
from apps.user_management.models import User
|
|
|
|
task_logger.debug(
|
|
f"Start custom_button_result for alert_group {alert_group_pk}, " f"custom_button {custom_button_pk}"
|
|
)
|
|
try:
|
|
custom_button = CustomButton.objects.get(pk=custom_button_pk)
|
|
except CustomButton.DoesNotExist:
|
|
task_logger.info(f"Custom_button {custom_button_pk} for alert_group {alert_group_pk} does not exist")
|
|
return
|
|
|
|
alert_group = AlertGroup.objects.filter(pk=alert_group_pk)[0]
|
|
escalation_policy = EscalationPolicy.objects.filter(pk=escalation_policy_pk).first()
|
|
task_logger.debug(
|
|
f"Start getting data for request in custom_button_result task for alert_group {alert_group_pk}, "
|
|
f"custom_button {custom_button_pk}"
|
|
)
|
|
|
|
first_alert = alert_group.alerts.first()
|
|
|
|
try:
|
|
post_kwargs = custom_button.build_post_kwargs(first_alert)
|
|
except TemplateError:
|
|
is_request_successful = False
|
|
result_message = "Template error"
|
|
except json.JSONDecodeError:
|
|
is_request_successful = False
|
|
result_message = "JSON decoding error"
|
|
else:
|
|
is_request_successful, result_message = request_outgoing_webhook(
|
|
custom_button.webhook, "POST", post_kwargs=post_kwargs
|
|
)
|
|
|
|
task_logger.debug(
|
|
f"Send post request in custom_button_result task for alert_group {alert_group_pk}, "
|
|
f"custom_button {custom_button_pk}"
|
|
)
|
|
with transaction.atomic():
|
|
user = None
|
|
if user_pk:
|
|
user = User.objects.get(pk=user_pk)
|
|
|
|
log_record = AlertGroupLogRecord(
|
|
type=AlertGroupLogRecord.TYPE_CUSTOM_BUTTON_TRIGGERED,
|
|
alert_group=alert_group,
|
|
custom_button=custom_button,
|
|
author=user,
|
|
reason=result_message,
|
|
step_specific_info={
|
|
"custom_button_name": custom_button.name,
|
|
"is_request_successful": is_request_successful,
|
|
},
|
|
escalation_policy=escalation_policy,
|
|
escalation_policy_step=EscalationPolicy.STEP_TRIGGER_CUSTOM_BUTTON,
|
|
)
|
|
log_record.save()
|
|
task_logger.debug(
|
|
f"call send_alert_group_signal for alert_group {alert_group_pk}, "
|
|
f"log record {log_record.pk} with type '{log_record.get_type_display()}'"
|
|
)
|
|
transaction.on_commit(lambda: send_alert_group_signal.apply_async((log_record.pk,)))
|
|
task_logger.debug(f"Finish custom_button_result for alert_group {alert_group_pk}, custom_button {custom_button_pk}")
|