oncall-engine/engine/apps/telegram/updates/update_handlers/button_press.py
Yulya Artyukhina 3c93375244
Update alert group state by backsync (#4089)
# What this PR does
Adds method to update alert group state by backsync
Related to https://github.com/grafana/oncall-private/issues/2542
Should be merged with
https://github.com/grafana/oncall-private/pull/2606

## 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] Added the relevant release notes label (see labels prefixed w/
`release:`). These labels dictate how your PR will
    show up in the autogenerated release notes.
2024-03-27 12:37:01 +00:00

130 lines
5.3 KiB
Python

import logging
from dataclasses import dataclass
from typing import Callable, Optional, Tuple
from apps.alerts.constants import ActionSource
from apps.alerts.models import AlertGroup
from apps.api.permissions import RBACPermission, user_is_authorized
from apps.telegram.models import TelegramMessage, TelegramToUserConnector
from apps.telegram.renderers.keyboard import CODE_TO_ACTION_MAP, Action
from apps.telegram.updates.update_handlers import UpdateHandler
from apps.telegram.utils import CallbackQueryFactory
from apps.user_management.models import User
logger = logging.getLogger(__name__)
NOT_FOUND_ERROR = "Alert group not found"
PERMISSION_DENIED = """You don't have a permission to perform this action!
Consider connecting your Telegram account on user settings page ⚙"""
@dataclass
class ActionContext:
alert_group: AlertGroup
action: Action
action_data: str
class ButtonPressHandler(UpdateHandler):
def matches(self) -> bool:
is_callback_query = self.update.callback_query is not None
return is_callback_query
def process_update(self) -> None:
data = self.update.callback_query.data
action_context = self._get_action_context(data)
if action_context is None:
self.update.callback_query.answer(NOT_FOUND_ERROR, show_alert=True)
return
fn, fn_kwargs = self._map_action_context_to_fn(action_context)
user = self._get_user(action_context)
has_permission = self._check_permission(user=user, alert_group=action_context.alert_group)
if has_permission:
fn(user=user, action_source=ActionSource.TELEGRAM, **fn_kwargs)
logger.info(f"User {user} triggered '{fn.__name__}'")
else:
self.update.callback_query.answer(PERMISSION_DENIED, show_alert=True)
logger.info(f"User {user} has no permission to trigger '{fn.__name__}'")
def _get_alert_group_from_message(self) -> Optional[AlertGroup]:
alert_group = None
if self.update.message:
telegram_message = TelegramMessage.objects.get(
message_id=self.update.message.message_id, chat_id=self.update.message.chat.id
)
alert_group = telegram_message.alert_group
return alert_group
def _get_user(self, action_context: ActionContext) -> Optional[User]:
connector = TelegramToUserConnector.objects.filter(
telegram_chat_id=self.update.effective_user.id,
user__organization=action_context.alert_group.channel.organization,
).last()
return connector.user if connector is not None else None
@staticmethod
def _check_permission(user: Optional[User], alert_group: AlertGroup) -> bool:
if not user:
return False
has_permission = user_is_authorized(user, [RBACPermission.Permissions.CHATOPS_WRITE])
return user.organization == alert_group.channel.organization and has_permission
def _get_action_context(self, data: str) -> ActionContext:
args = CallbackQueryFactory.decode_data(data)
# Try to get alert group from telegram message, because encoded data is not valid for migrated organizations
alert_group = self._get_alert_group_from_message()
if alert_group is None:
alert_group_pk = args[0]
try:
alert_group = AlertGroup.objects.get(pk=alert_group_pk)
except AlertGroup.DoesNotExist:
logger.info(f"Alert group {alert_group_pk} does not exist")
return
action_value = args[1]
try:
# if action encoded as action_code - cast it to the action_string
action_value = int(action_value)
action_name = CODE_TO_ACTION_MAP[action_value]
except ValueError:
# support legacy messages with action_name in callback data
action_name = action_value
action = Action(action_name)
action_data = args[2] if len(args) >= 3 and not self._is_oncall_identifier(args[2]) else None
return ActionContext(alert_group=alert_group, action=action, action_data=action_data)
@staticmethod
def _is_oncall_identifier(string: str) -> bool:
# determines if piece of data passed via callback_data is oncall_identifier
# x-oncall-org-id is kept here for backward compatibility.
return string.startswith("x-oncall-org-id") or string.startswith("oncall-uuid")
@staticmethod
def _map_action_context_to_fn(action_context: ActionContext) -> Tuple[Callable, dict]:
action_to_fn = {
Action.RESOLVE: "resolve_by_user_or_backsync",
Action.UNRESOLVE: "un_resolve_by_user_or_backsync",
Action.ACKNOWLEDGE: "acknowledge_by_user_or_backsync",
Action.UNACKNOWLEDGE: "un_acknowledge_by_user_or_backsync",
Action.SILENCE: {
"fn_name": "silence_by_user_or_backsync",
"kwargs": {"silence_delay": int(action_context.action_data) if action_context.action_data else None},
},
Action.UNSILENCE: "un_silence_by_user_or_backsync",
}
fn_info = action_to_fn[action_context.action]
fn_name = fn_info["fn_name"] if isinstance(fn_info, dict) else fn_info
fn_kwargs = fn_info["kwargs"] if isinstance(fn_info, dict) else {}
fn = getattr(action_context.alert_group, fn_name)
return fn, fn_kwargs