26946f0d43
# What this PR does https://www.loom.com/share/1ac33822301444748133ffe72638ddc4 The two asks in the [original GH issue](https://github.com/grafana/oncall-private/issues/2947) were: > 1. Make the error message clearer. We can identify if it's delivering or updating and being rate-limited. This is possible because Slack sets limits per API method. Also, this limit is a per-slack channel while we are posting messages & applying ratelimit per on-call integration, which confuses customers. > 2. Debounce update alert group message in Slack Both of these have been addressed in this PR ## Which issue(s) this PR closes Closes https://github.com/grafana/oncall-private/issues/2947 ## 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.
465 lines
17 KiB
Python
465 lines
17 KiB
Python
import json
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
from apps.slack.chatops_proxy_routing import make_value
|
|
from apps.slack.client import SlackClient
|
|
from apps.slack.constants import BLOCK_SECTION_TEXT_MAX_SIZE
|
|
from apps.slack.errors import SlackAPIViewNotFoundError
|
|
from apps.slack.scenarios.scenario_step import ScenarioStep
|
|
from apps.slack.tests.conftest import build_slack_response
|
|
from common.api_helpers.utils import create_engine_url
|
|
|
|
|
|
@pytest.mark.django_db
|
|
def test_get_resolution_notes_blocks_default_if_empty(
|
|
make_organization_and_user_with_slack_identities,
|
|
make_alert_receive_channel,
|
|
make_alert_group,
|
|
):
|
|
SlackResolutionNoteModalStep = ScenarioStep.get_step("resolution_note", "ResolutionNoteModalStep")
|
|
organization, _, slack_team_identity, _ = make_organization_and_user_with_slack_identities()
|
|
step = SlackResolutionNoteModalStep(slack_team_identity)
|
|
|
|
alert_receive_channel = make_alert_receive_channel(organization)
|
|
alert_group = make_alert_group(alert_receive_channel)
|
|
|
|
blocks = step.get_resolution_notes_blocks(alert_group, "", False)
|
|
|
|
expected_blocks = [
|
|
{
|
|
"type": "image",
|
|
"title": {
|
|
"type": "plain_text",
|
|
"text": SlackResolutionNoteModalStep.MESSAGE_SHORTCUT_INSTRUCTION,
|
|
},
|
|
"image_url": create_engine_url("static/images/resolution_note.gif"),
|
|
"alt_text": SlackResolutionNoteModalStep.MESSAGE_SHORTCUT_INSTRUCTION,
|
|
},
|
|
]
|
|
assert blocks == expected_blocks
|
|
|
|
|
|
@pytest.mark.django_db
|
|
def test_get_resolution_notes_blocks_non_empty(
|
|
make_organization_and_user_with_slack_identities,
|
|
make_alert_receive_channel,
|
|
make_alert_group,
|
|
make_resolution_note_slack_message,
|
|
):
|
|
SlackResolutionNoteModalStep = ScenarioStep.get_step("resolution_note", "ResolutionNoteModalStep")
|
|
organization, user, slack_team_identity, _ = make_organization_and_user_with_slack_identities()
|
|
step = SlackResolutionNoteModalStep(slack_team_identity)
|
|
|
|
alert_receive_channel = make_alert_receive_channel(organization)
|
|
alert_group = make_alert_group(alert_receive_channel)
|
|
resolution_note = make_resolution_note_slack_message(alert_group=alert_group, user=user, added_by_user=user, ts=1)
|
|
|
|
blocks = step.get_resolution_notes_blocks(alert_group, "", False)
|
|
|
|
expected_blocks = [
|
|
{
|
|
"type": "divider",
|
|
},
|
|
{
|
|
"type": "section",
|
|
"text": {
|
|
"type": "mrkdwn",
|
|
"text": "{} <!date^{:.0f}^{{date_num}} {{time_secs}}|message_created_at>\n{}".format(
|
|
resolution_note.user.get_username_with_slack_verbal(mention=True),
|
|
float(resolution_note.ts),
|
|
resolution_note.text,
|
|
),
|
|
},
|
|
"accessory": {
|
|
"type": "button",
|
|
"style": "primary",
|
|
"text": {
|
|
"type": "plain_text",
|
|
"text": "Add",
|
|
"emoji": True,
|
|
},
|
|
"action_id": "AddRemoveThreadMessageStep",
|
|
"value": make_value(
|
|
{
|
|
"resolution_note_window_action": "edit",
|
|
"msg_value": "add",
|
|
"message_pk": resolution_note.pk,
|
|
"resolution_note_pk": None,
|
|
"alert_group_pk": alert_group.pk,
|
|
},
|
|
organization,
|
|
),
|
|
},
|
|
},
|
|
]
|
|
|
|
assert blocks == expected_blocks
|
|
|
|
|
|
@pytest.mark.django_db
|
|
def test_get_resolution_note_blocks_truncate_text(
|
|
make_organization_and_user_with_slack_identities,
|
|
make_alert_receive_channel,
|
|
make_alert_group,
|
|
make_resolution_note,
|
|
):
|
|
UpdateResolutionNoteStep = ScenarioStep.get_step("resolution_note", "UpdateResolutionNoteStep")
|
|
organization, user, slack_team_identity, _ = make_organization_and_user_with_slack_identities()
|
|
step = UpdateResolutionNoteStep(slack_team_identity)
|
|
|
|
alert_receive_channel = make_alert_receive_channel(organization)
|
|
alert_group = make_alert_group(alert_receive_channel)
|
|
resolution_note = make_resolution_note(alert_group=alert_group, author=user, message_text="a" * 3000)
|
|
author_verbal = resolution_note.author_verbal(mention=False)
|
|
|
|
blocks = step.get_resolution_note_blocks(resolution_note)
|
|
|
|
expected_blocks = [
|
|
{
|
|
"type": "section",
|
|
"text": {
|
|
"type": "mrkdwn",
|
|
# text is truncated, ellipsis added
|
|
"text": resolution_note.text[: BLOCK_SECTION_TEXT_MAX_SIZE - 1] + "…",
|
|
},
|
|
},
|
|
{
|
|
"type": "context",
|
|
"elements": [
|
|
{
|
|
"type": "mrkdwn",
|
|
"text": f"{author_verbal} resolution note from {resolution_note.get_source_display()}.",
|
|
}
|
|
],
|
|
},
|
|
]
|
|
|
|
assert blocks == expected_blocks
|
|
|
|
|
|
@pytest.mark.django_db
|
|
def test_post_or_update_resolution_note_in_thread_truncate_message_text(
|
|
make_organization_and_user_with_slack_identities,
|
|
make_alert_receive_channel,
|
|
make_alert_group,
|
|
make_slack_message,
|
|
make_slack_channel,
|
|
make_resolution_note,
|
|
):
|
|
organization, user, slack_team_identity, _ = make_organization_and_user_with_slack_identities()
|
|
alert_receive_channel = make_alert_receive_channel(organization)
|
|
alert_group = make_alert_group(alert_receive_channel)
|
|
|
|
slack_channel = make_slack_channel(slack_team_identity)
|
|
make_slack_message(alert_group=alert_group, channel=slack_channel)
|
|
|
|
resolution_note = make_resolution_note(alert_group=alert_group, author=user, message_text="a" * 3000)
|
|
|
|
UpdateResolutionNoteStep = ScenarioStep.get_step("resolution_note", "UpdateResolutionNoteStep")
|
|
step = UpdateResolutionNoteStep(slack_team_identity)
|
|
|
|
with patch("apps.slack.client.SlackClient.api_call") as mock_slack_api_call:
|
|
mock_slack_api_call.return_value = {
|
|
"ts": "timestamp",
|
|
"message": {"ts": "timestamp"},
|
|
"permalink": "https://link.to.message",
|
|
}
|
|
step.post_or_update_resolution_note_in_thread(resolution_note)
|
|
|
|
assert mock_slack_api_call.called
|
|
post_message_call = mock_slack_api_call.mock_calls[0]
|
|
assert post_message_call.args[0] == "chat.postMessage"
|
|
assert post_message_call.kwargs["json"]["text"] == resolution_note.text[: BLOCK_SECTION_TEXT_MAX_SIZE - 1] + "…"
|
|
|
|
|
|
@pytest.mark.django_db
|
|
def test_post_or_update_resolution_note_in_thread_update_truncate_message_text(
|
|
make_organization_and_user_with_slack_identities,
|
|
make_alert_receive_channel,
|
|
make_alert_group,
|
|
make_slack_message,
|
|
make_slack_channel,
|
|
make_resolution_note,
|
|
make_resolution_note_slack_message,
|
|
):
|
|
organization, user, slack_team_identity, _ = make_organization_and_user_with_slack_identities()
|
|
alert_receive_channel = make_alert_receive_channel(organization)
|
|
alert_group = make_alert_group(alert_receive_channel)
|
|
|
|
slack_channel = make_slack_channel(slack_team_identity)
|
|
make_slack_message(alert_group=alert_group, channel=slack_channel)
|
|
|
|
resolution_note = make_resolution_note(alert_group=alert_group, author=user, message_text="a" * 3000)
|
|
make_resolution_note_slack_message(
|
|
alert_group=alert_group,
|
|
resolution_note=resolution_note,
|
|
user=user,
|
|
posted_by_bot=True,
|
|
added_by_user=user,
|
|
ts=1,
|
|
text=resolution_note.text,
|
|
)
|
|
|
|
UpdateResolutionNoteStep = ScenarioStep.get_step("resolution_note", "UpdateResolutionNoteStep")
|
|
step = UpdateResolutionNoteStep(slack_team_identity)
|
|
|
|
with patch("apps.slack.client.SlackClient.api_call") as mock_slack_api_call:
|
|
mock_slack_api_call.return_value = {
|
|
"ts": "timestamp",
|
|
"message": {"ts": "timestamp"},
|
|
"permalink": "https://link.to.message",
|
|
}
|
|
step.post_or_update_resolution_note_in_thread(resolution_note)
|
|
|
|
assert mock_slack_api_call.called
|
|
post_message_call = mock_slack_api_call.mock_calls[0]
|
|
assert post_message_call.args[0] == "chat.update"
|
|
assert post_message_call.kwargs["json"]["text"] == resolution_note.text[: BLOCK_SECTION_TEXT_MAX_SIZE - 1] + "…"
|
|
|
|
|
|
@pytest.mark.django_db
|
|
def test_get_resolution_notes_blocks_latest_limit(
|
|
make_organization_and_user_with_slack_identities,
|
|
make_alert_receive_channel,
|
|
make_alert_group,
|
|
make_resolution_note_slack_message,
|
|
):
|
|
SlackResolutionNoteModalStep = ScenarioStep.get_step("resolution_note", "ResolutionNoteModalStep")
|
|
organization, user, slack_team_identity, _ = make_organization_and_user_with_slack_identities()
|
|
step = SlackResolutionNoteModalStep(slack_team_identity)
|
|
|
|
alert_receive_channel = make_alert_receive_channel(organization)
|
|
alert_group = make_alert_group(alert_receive_channel)
|
|
|
|
max_count = SlackResolutionNoteModalStep.RESOLUTION_NOTE_MESSAGES_MAX_COUNT
|
|
messages = [
|
|
make_resolution_note_slack_message(alert_group=alert_group, user=user, added_by_user=user, ts=i, text=i)
|
|
for i in range(max_count * 2)
|
|
]
|
|
|
|
blocks = step.get_resolution_notes_blocks(alert_group, "", False)
|
|
|
|
expected_blocks = [
|
|
{
|
|
"type": "divider",
|
|
},
|
|
{
|
|
"type": "section",
|
|
"text": {
|
|
"type": "mrkdwn",
|
|
"text": (
|
|
":warning: Listing up to last {} thread messages, "
|
|
"you can still add any other message using contextual menu actions."
|
|
).format(max_count),
|
|
},
|
|
},
|
|
]
|
|
for m in list(reversed(messages))[:max_count]:
|
|
expected_blocks += [
|
|
{
|
|
"type": "divider",
|
|
},
|
|
{
|
|
"type": "section",
|
|
"text": {
|
|
"type": "mrkdwn",
|
|
"text": "{} <!date^{:.0f}^{{date_num}} {{time_secs}}|message_created_at>\n{}".format(
|
|
m.user.get_username_with_slack_verbal(mention=True),
|
|
float(m.ts),
|
|
m.text,
|
|
),
|
|
},
|
|
"accessory": {
|
|
"type": "button",
|
|
"style": "primary",
|
|
"text": {
|
|
"type": "plain_text",
|
|
"text": "Add",
|
|
"emoji": True,
|
|
},
|
|
"action_id": "AddRemoveThreadMessageStep",
|
|
"value": make_value(
|
|
{
|
|
"resolution_note_window_action": "edit",
|
|
"msg_value": "add",
|
|
"message_pk": m.pk,
|
|
"resolution_note_pk": None,
|
|
"alert_group_pk": alert_group.pk,
|
|
},
|
|
organization,
|
|
),
|
|
},
|
|
},
|
|
]
|
|
|
|
assert blocks == expected_blocks
|
|
|
|
|
|
@pytest.mark.django_db
|
|
@patch.object(
|
|
SlackClient,
|
|
"api_call",
|
|
side_effect=SlackAPIViewNotFoundError(response=build_slack_response({"ok": False, "error": "not_found"})),
|
|
)
|
|
def test_resolution_notes_modal_closed_before_update(
|
|
mock_slack_api_call,
|
|
make_organization_and_user_with_slack_identities,
|
|
make_alert_receive_channel,
|
|
make_alert_group,
|
|
make_slack_channel,
|
|
make_slack_message,
|
|
):
|
|
ResolutionNoteModalStep = ScenarioStep.get_step("resolution_note", "ResolutionNoteModalStep")
|
|
|
|
organization, user, slack_team_identity, slack_user_identity = make_organization_and_user_with_slack_identities()
|
|
|
|
alert_receive_channel = make_alert_receive_channel(organization)
|
|
alert_group = make_alert_group(alert_receive_channel)
|
|
|
|
slack_channel = make_slack_channel(slack_team_identity)
|
|
make_slack_message(alert_group=alert_group, channel=slack_channel, slack_id="RANDOM_MESSAGE_ID")
|
|
|
|
payload = {
|
|
"trigger_id": "TEST",
|
|
"view": {"id": "TEST"},
|
|
"actions": [
|
|
{
|
|
"type": "button",
|
|
"value": json.dumps(
|
|
{
|
|
"organization_id": organization.pk,
|
|
"alert_group_pk": alert_group.pk,
|
|
"resolution_note_window_action": "update",
|
|
}
|
|
),
|
|
}
|
|
],
|
|
}
|
|
|
|
# Check that no error is raised even if the Slack API call fails
|
|
step = ResolutionNoteModalStep(organization=organization, user=user, slack_team_identity=slack_team_identity)
|
|
step.process_scenario(slack_user_identity, slack_team_identity, payload)
|
|
|
|
# Check that "views.update" API call was made
|
|
call_args, _ = mock_slack_api_call.call_args
|
|
assert call_args[0] == "views.update"
|
|
|
|
|
|
@patch("apps.slack.models.SlackMessage.update_alert_groups_message")
|
|
@patch.object(SlackClient, "reactions_add")
|
|
@patch.object(SlackClient, "chat_getPermalink", return_value={"permalink": "https://example.com"})
|
|
@pytest.mark.django_db
|
|
def test_add_to_resolution_note(
|
|
_mock_chat_getPermalink,
|
|
mock_reactions_add,
|
|
mock_update_alert_groups_message,
|
|
make_organization_and_user_with_slack_identities,
|
|
make_alert_receive_channel,
|
|
make_alert_group,
|
|
make_alert,
|
|
make_slack_message,
|
|
make_slack_channel,
|
|
):
|
|
organization, user, slack_team_identity, slack_user_identity = make_organization_and_user_with_slack_identities()
|
|
alert_receive_channel = make_alert_receive_channel(organization)
|
|
alert_group = make_alert_group(alert_receive_channel)
|
|
make_alert(alert_group=alert_group, raw_request_data={})
|
|
|
|
slack_channel = make_slack_channel(slack_team_identity)
|
|
slack_message = make_slack_message(alert_group=alert_group, channel=slack_channel)
|
|
|
|
payload = {
|
|
"channel": {"id": slack_channel.slack_id},
|
|
"message_ts": "random_ts",
|
|
"message": {
|
|
"type": "message",
|
|
"text": "Test resolution note",
|
|
"ts": "random_ts",
|
|
"thread_ts": slack_message.slack_id,
|
|
"user": slack_user_identity.slack_id,
|
|
},
|
|
"trigger_id": "random_trigger_id",
|
|
}
|
|
|
|
AddToResolutionNoteStep = ScenarioStep.get_step("resolution_note", "AddToResolutionNoteStep")
|
|
step = AddToResolutionNoteStep(organization=organization, user=user, slack_team_identity=slack_team_identity)
|
|
step.process_scenario(slack_user_identity, slack_team_identity, payload)
|
|
|
|
mock_reactions_add.assert_called_once()
|
|
mock_update_alert_groups_message.assert_called_once_with(debounce=False)
|
|
|
|
assert alert_group.resolution_notes.get().text == "Test resolution note"
|
|
|
|
|
|
@pytest.mark.django_db
|
|
def test_add_to_resolution_note_broadcast(make_organization_and_user_with_slack_identities, settings):
|
|
settings.UNIFIED_SLACK_APP_ENABLED = True
|
|
|
|
organization, user, slack_team_identity, slack_user_identity = make_organization_and_user_with_slack_identities()
|
|
|
|
payload = {
|
|
"channel": {"id": "TEST"},
|
|
"message_ts": "TEST",
|
|
"message": {"thread_ts": "TEST"},
|
|
"trigger_id": "TEST",
|
|
}
|
|
|
|
AddToResolutionNoteStep = ScenarioStep.get_step("resolution_note", "AddToResolutionNoteStep")
|
|
step = AddToResolutionNoteStep(organization=organization, user=user, slack_team_identity=slack_team_identity)
|
|
with patch.object(SlackClient, "api_call") as mock_api_call:
|
|
step.process_scenario(slack_user_identity, slack_team_identity, payload)
|
|
|
|
mock_api_call.assert_not_called() # no Slack API calls should be made
|
|
|
|
|
|
@patch.object(SlackClient, "chat_getPermalink", return_value={"permalink": "https://example.com"})
|
|
@pytest.mark.django_db
|
|
def test_add_to_resolution_note_deleted_org(
|
|
_,
|
|
make_organization_and_user_with_slack_identities,
|
|
make_alert_receive_channel,
|
|
make_alert_group,
|
|
make_alert,
|
|
make_slack_channel,
|
|
make_slack_message,
|
|
make_organization,
|
|
make_user_for_organization,
|
|
settings,
|
|
):
|
|
settings.UNIFIED_SLACK_APP_ENABLED = True
|
|
|
|
organization, _, slack_team_identity, slack_user_identity = make_organization_and_user_with_slack_identities()
|
|
alert_receive_channel = make_alert_receive_channel(organization)
|
|
alert_group = make_alert_group(alert_receive_channel)
|
|
make_alert(alert_group=alert_group, raw_request_data={})
|
|
|
|
slack_channel = make_slack_channel(slack_team_identity)
|
|
slack_message = make_slack_message(alert_group=alert_group, channel=slack_channel)
|
|
organization.delete()
|
|
|
|
other_organization = make_organization(slack_team_identity=slack_team_identity)
|
|
other_user = make_user_for_organization(organization=other_organization, slack_user_identity=slack_user_identity)
|
|
|
|
payload = {
|
|
"channel": {"id": slack_message.channel.slack_id},
|
|
"message_ts": "random_ts",
|
|
"message": {
|
|
"type": "message",
|
|
"text": "Test resolution note",
|
|
"ts": "random_ts",
|
|
"thread_ts": slack_message.slack_id,
|
|
"user": slack_user_identity.slack_id,
|
|
},
|
|
"trigger_id": "random_trigger_id",
|
|
}
|
|
|
|
AddToResolutionNoteStep = ScenarioStep.get_step("resolution_note", "AddToResolutionNoteStep")
|
|
step = AddToResolutionNoteStep(
|
|
organization=other_organization, user=other_user, slack_team_identity=slack_team_identity
|
|
)
|
|
with patch.object(SlackClient, "api_call") as mock_api_call:
|
|
step.process_scenario(slack_user_identity, slack_team_identity, payload)
|
|
|
|
mock_api_call.assert_not_called() # no Slack API calls should be made
|