oncall-engine/engine/apps/schedules/tasks/refresh_ical_files.py
Vadim Stepanov b2f4ffb98a
apps.get_model -> import (#2619)
# 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)
2023-07-25 09:43:23 +00:00

101 lines
3.9 KiB
Python

from celery.utils.log import get_task_logger
from apps.alerts.tasks import notify_ical_schedule_shift
from apps.schedules.ical_utils import is_icals_equal
from apps.schedules.tasks import notify_about_empty_shifts_in_schedule, notify_about_gaps_in_schedule
from apps.slack.tasks import start_update_slack_user_group_for_schedules
from common.custom_celery_tasks import shared_dedicated_queue_retry_task
task_logger = get_task_logger(__name__)
@shared_dedicated_queue_retry_task()
def start_refresh_ical_files():
from apps.schedules.models import OnCallSchedule
task_logger.info("Start refresh ical files")
schedules = OnCallSchedule.objects.filter(organization__deleted_at__isnull=True)
for schedule in schedules:
refresh_ical_file.apply_async((schedule.pk,))
# Update Slack user groups with a delay to make sure all the schedules are refreshed
start_update_slack_user_group_for_schedules.apply_async(countdown=30)
@shared_dedicated_queue_retry_task()
def start_refresh_ical_final_schedules():
from apps.schedules.models import OnCallSchedule
task_logger.info("Start refresh ical final schedules")
schedules = OnCallSchedule.objects.filter(organization__deleted_at__isnull=True)
for schedule in schedules:
refresh_ical_final_schedule.apply_async((schedule.pk,))
@shared_dedicated_queue_retry_task()
def refresh_ical_file(schedule_pk):
from apps.schedules.models import OnCallSchedule
task_logger.info(f"Refresh ical files for schedule {schedule_pk}")
try:
schedule = OnCallSchedule.objects.get(pk=schedule_pk)
except OnCallSchedule.DoesNotExist:
task_logger.info(f"Tried to refresh non-existing schedule {schedule_pk}")
return
schedule.refresh_ical_file()
if schedule.channel is not None:
notify_ical_schedule_shift.apply_async((schedule.pk,))
run_task_primary = False
if schedule.cached_ical_file_primary:
# ie. primary schedule is not empty (None -> no ical, "" -> empty cached value)
if not schedule.prev_ical_file_primary:
# prev value is empty
run_task_primary = True
task_logger.info(f"run_task_primary {schedule_pk} {run_task_primary} prev_ical_file_primary is None")
else:
# prev value is not empty, we need to compare
run_task_primary = not is_icals_equal(
schedule.cached_ical_file_primary,
schedule.prev_ical_file_primary,
)
task_logger.info(f"run_task_primary {schedule_pk} {run_task_primary} icals not equal")
run_task_overrides = False
if schedule.cached_ical_file_overrides:
# ie. overrides schedule is not empty (None -> no ical, "" -> empty cached value)
if not schedule.prev_ical_file_overrides:
# prev value is empty
run_task_overrides = True
task_logger.info(f"run_task_overrides {schedule_pk} {run_task_primary} prev_ical_file_overrides is None")
else:
# prev value is not empty, we need to compare
run_task_overrides = not is_icals_equal(
schedule.cached_ical_file_overrides,
schedule.prev_ical_file_overrides,
)
task_logger.info(f"run_task_overrides {schedule_pk} {run_task_primary} icals not equal")
run_task = run_task_primary or run_task_overrides
if run_task:
notify_about_empty_shifts_in_schedule.apply_async((schedule_pk,))
notify_about_gaps_in_schedule.apply_async((schedule_pk,))
@shared_dedicated_queue_retry_task()
def refresh_ical_final_schedule(schedule_pk):
from apps.schedules.models import OnCallSchedule
task_logger.info(f"Refresh ical final schedule {schedule_pk}")
try:
schedule = OnCallSchedule.objects.get(pk=schedule_pk)
except OnCallSchedule.DoesNotExist:
task_logger.info(f"Tried to refresh final schedule for non-existing schedule {schedule_pk}")
return
schedule.refresh_ical_final_schedule()