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)
53 lines
2 KiB
Python
53 lines
2 KiB
Python
from rest_framework import mixins, status, viewsets
|
|
from rest_framework.decorators import action
|
|
from rest_framework.permissions import IsAuthenticated
|
|
from rest_framework.response import Response
|
|
|
|
from apps.api.permissions import RBACPermission
|
|
from apps.api.serializers.telegram import TelegramToOrganizationConnectorSerializer
|
|
from apps.auth_token.auth import PluginAuthentication
|
|
from common.api_helpers.mixins import PublicPrimaryKeyMixin
|
|
from common.insight_log.chatops_insight_logs import ChatOpsEvent, ChatOpsTypePlug, write_chatops_insight_log
|
|
|
|
|
|
class TelegramChannelViewSet(
|
|
PublicPrimaryKeyMixin,
|
|
mixins.RetrieveModelMixin,
|
|
mixins.DestroyModelMixin,
|
|
mixins.ListModelMixin,
|
|
viewsets.GenericViewSet,
|
|
):
|
|
authentication_classes = (PluginAuthentication,)
|
|
permission_classes = (IsAuthenticated, RBACPermission)
|
|
|
|
rbac_permissions = {
|
|
"metadata": [RBACPermission.Permissions.CHATOPS_READ],
|
|
"list": [RBACPermission.Permissions.CHATOPS_READ],
|
|
"retrieve": [RBACPermission.Permissions.CHATOPS_READ],
|
|
"destroy": [RBACPermission.Permissions.CHATOPS_UPDATE_SETTINGS],
|
|
"set_default": [RBACPermission.Permissions.CHATOPS_UPDATE_SETTINGS],
|
|
}
|
|
|
|
serializer_class = TelegramToOrganizationConnectorSerializer
|
|
|
|
def get_queryset(self):
|
|
from apps.telegram.models import TelegramToOrganizationConnector
|
|
|
|
return TelegramToOrganizationConnector.objects.filter(organization=self.request.user.organization)
|
|
|
|
@action(detail=True, methods=["post"])
|
|
def set_default(self, request, pk):
|
|
telegram_channel = self.get_object()
|
|
telegram_channel.make_channel_default(request.user)
|
|
|
|
return Response(status=status.HTTP_200_OK)
|
|
|
|
def perform_destroy(self, instance):
|
|
user = self.request.user
|
|
write_chatops_insight_log(
|
|
author=user,
|
|
event_name=ChatOpsEvent.CHANNEL_DISCONNECTED,
|
|
chatops_type=ChatOpsTypePlug.TELEGRAM.value,
|
|
channel_name=instance.channel_name,
|
|
)
|
|
instance.delete()
|