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)
104 lines
3.4 KiB
Python
104 lines
3.4 KiB
Python
from dataclasses import asdict
|
|
|
|
from rest_framework import serializers
|
|
|
|
from apps.base.models import LiveSetting
|
|
from apps.phone_notifications.phone_provider import get_phone_provider
|
|
from apps.slack.models import SlackTeamIdentity
|
|
from apps.user_management.models import Organization
|
|
from common.api_helpers.mixins import EagerLoadingMixin
|
|
|
|
|
|
class FastSlackTeamIdentitySerializer(serializers.ModelSerializer):
|
|
class Meta:
|
|
model = SlackTeamIdentity
|
|
fields = ["cached_name"]
|
|
|
|
|
|
class OrganizationSerializer(EagerLoadingMixin, serializers.ModelSerializer):
|
|
pk = serializers.CharField(read_only=True, source="public_primary_key")
|
|
slack_team_identity = FastSlackTeamIdentitySerializer(read_only=True)
|
|
|
|
name = serializers.CharField(required=False, allow_null=True, allow_blank=True, source="org_title")
|
|
slack_channel = serializers.SerializerMethodField()
|
|
|
|
rbac_enabled = serializers.BooleanField(source="is_rbac_permissions_enabled")
|
|
|
|
SELECT_RELATED = ["slack_team_identity"]
|
|
|
|
class Meta:
|
|
model = Organization
|
|
fields = [
|
|
"pk",
|
|
"name",
|
|
"slack_team_identity",
|
|
"slack_channel",
|
|
"rbac_enabled",
|
|
]
|
|
read_only_fields = [
|
|
"slack_team_identity",
|
|
"rbac_enabled",
|
|
]
|
|
|
|
def get_slack_channel(self, obj):
|
|
from apps.slack.models import SlackChannel
|
|
|
|
if obj.general_log_channel_id is None or obj.slack_team_identity is None:
|
|
return None
|
|
try:
|
|
channel = obj.slack_team_identity.get_cached_channels().get(slack_id=obj.general_log_channel_id)
|
|
except SlackChannel.DoesNotExist:
|
|
return {"display_name": None, "slack_id": obj.general_log_channel_id, "id": None}
|
|
|
|
return {
|
|
"display_name": channel.name,
|
|
"slack_id": channel.slack_id,
|
|
"id": channel.public_primary_key,
|
|
}
|
|
|
|
|
|
class CurrentOrganizationSerializer(OrganizationSerializer):
|
|
env_status = serializers.SerializerMethodField()
|
|
banner = serializers.SerializerMethodField()
|
|
|
|
class Meta(OrganizationSerializer.Meta):
|
|
fields = [
|
|
*OrganizationSerializer.Meta.fields,
|
|
"is_resolution_note_required",
|
|
"env_status",
|
|
"banner",
|
|
]
|
|
read_only_fields = [
|
|
*OrganizationSerializer.Meta.read_only_fields,
|
|
"banner",
|
|
]
|
|
|
|
def get_banner(self, obj):
|
|
from apps.base.models import DynamicSetting
|
|
|
|
banner = DynamicSetting.objects.get_or_create(
|
|
name="banner",
|
|
defaults={"json_value": {"title": None, "body": None}},
|
|
)[0]
|
|
return banner.json_value
|
|
|
|
def get_env_status(self, obj):
|
|
# deprecated in favour of ConfigAPIView.
|
|
# All new env statuses should be added there
|
|
LiveSetting.populate_settings_if_needed()
|
|
|
|
telegram_configured = not LiveSetting.objects.filter(name__startswith="TELEGRAM", error__isnull=False).exists()
|
|
phone_provider_config = get_phone_provider().flags
|
|
return {
|
|
"telegram_configured": telegram_configured,
|
|
"phone_provider": asdict(phone_provider_config),
|
|
}
|
|
|
|
|
|
class FastOrganizationSerializer(serializers.ModelSerializer):
|
|
pk = serializers.CharField(read_only=True, source="public_primary_key")
|
|
name = serializers.CharField(read_only=True, source="org_title")
|
|
|
|
class Meta:
|
|
model = Organization
|
|
fields = ["pk", "name"]
|