Skip to content

Use native Slack Table Block for test results sample rendering #2227

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
quickcoffee wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Use native Slack Table Block for test results sample rendering #2227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
55d2ac0
Use native Slack Table Block for test results sample rendering
quickcoffee May 7, 2026
2abbdb3
Fix empty raw_text cell when table value is None or empty string
quickcoffee May 7, 2026
18402cf
Apply black formatting to test file
quickcoffee May 7, 2026
2ace13d
Regenerate alert message fixtures for block_kit table format
quickcoffee May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 42 additions & 21 deletions elementary/messages/formats/block_kit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
from typing import Any, Callable, List, Optional, Tuple

from slack_sdk.models import blocks as slack_blocks
from tabulate import tabulate

from elementary.messages.blocks import (
ActionBlock,
Expand Down Expand Up @@ -50,14 +49,16 @@ class FormattedBlockKitMessage(BaseModel):
class BlockKitBuilder:
_SECONDARY_FACT_CHUNK_SIZE = 2
_LONGEST_MARKDOWN_SUFFIX_LEN = 3 # length of markdown's code suffix (```)
_MAX_CELL_LENGTH_BY_COLUMN_COUNT = {4: 11, 3: 14, 2: 22, 1: 40, 0: 40}
_MAX_SLACK_TABLE_COLUMNS = 20
_MAX_SLACK_TABLE_ROWS = 100

def __init__(
self, resolve_mention: Optional[ResolveMentionCallback] = None
) -> None:
self._blocks: List[dict] = []
self._attachment_blocks: List[dict] = []
self._is_divided = False
self._has_table_block = False
self._resolve_mention = resolve_mention or (lambda x: None)

def _format_icon(self, icon: Icon) -> str:
Expand Down Expand Up @@ -98,13 +99,6 @@ def _format_line_block_text(self, block: LineBlock) -> str:
[self._format_inline_block(inline) for inline in block.inlines]
)

def _format_table_cell(self, cell_value: Any, column_count: int) -> str:
value = str(cell_value)
max_cell_length = self._MAX_CELL_LENGTH_BY_COLUMN_COUNT[column_count]
if len(value) > max_cell_length:
return value[: max_cell_length - 2] + ".."
return value

def _format_markdown_section_text(self, text: str) -> dict:
if len(text) > slack_blocks.SectionBlock.text_max_length:
text = (
Expand Down Expand Up @@ -257,24 +251,50 @@ def _add_divider_block(self, block: DividerBlock) -> None:
self._add_block({"type": "divider"})
self._is_divided = True

def _make_header_cell(self, text: str) -> dict:
return {
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{"type": "text", "text": str(text), "style": {"bold": True}}
],
}
],
}

def _make_data_cell(self, value: Any) -> dict:
text = str(value) if value is not None else "NULL"
return {"type": "raw_text", "text": text or " "}

def _add_table_block(self, block: TableBlock) -> None:
column_count = len(block.headers)
if column_count not in self._MAX_CELL_LENGTH_BY_COLUMN_COUNT:

if column_count > self._MAX_SLACK_TABLE_COLUMNS or self._has_table_block:
dicts = [
{header: cell for header, cell in zip(block.headers, row)}
for row in block.rows
]
table_text = json.dumps(dicts, indent=2)
else:
new_rows = [
[self._format_table_cell(cell, column_count) for cell in row]
for row in block.rows
]
new_headers = [
self._format_table_cell(cell, column_count) for cell in block.headers
]
table_text = tabulate(new_rows, headers=new_headers, tablefmt="simple")
self._add_block(self._format_markdown_section(f"```{table_text}```"))
self._add_block(
self._format_markdown_section(f"```{json.dumps(dicts, indent=2)}```")
)
return
Comment thread
ofek1weiss marked this conversation as resolved.

rows: List[List[dict]] = [[self._make_header_cell(h) for h in block.headers]]
for row in block.rows[: self._MAX_SLACK_TABLE_ROWS - 1]:
rows.append([self._make_data_cell(v) for v in row])

self._add_block(
{
"type": "table",
"rows": rows,
"column_settings": [
{"align": "left", "is_wrapped": False} for _ in block.headers
],
}
)
self._has_table_block = True

def _add_actions_block(self, block: ActionsBlock) -> None:
self._add_block(
Expand Down Expand Up @@ -337,6 +357,7 @@ def _get_final_blocks(
def build(self, message: MessageBody) -> FormattedBlockKitMessage:
self._blocks = []
self._attachment_blocks = []
self._has_table_block = False
self._add_message_blocks(message.blocks)
color_code = COLOR_MAP.get(message.color) if message.color else None
blocks, attachment_blocks = self._get_final_blocks(message.color)
Expand Down
64 changes: 59 additions & 5 deletions ...ue_description-True_tags-True_owners-True_table-True_error-True_sample-True_env-True.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,65 @@
}
},
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "```column1 column2\n--------- ---------\nvalue1 value2```"
}
"type": "table",
"rows": [
[
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "text",
"text": "column1",
"style": {
"bold": true
}
}
]
}
]
},
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "text",
"text": "column2",
"style": {
"bold": true
}
}
]
}
]
}
],
[
{
"type": "raw_text",
"text": "value1"
},
{
"type": "raw_text",
"text": "value2"
}
]
],
"column_settings": [
{
"align": "left",
"is_wrapped": false
},
{
"align": "left",
"is_wrapped": false
}
]
}
],
"color": "#ff0000"
Expand Down
64 changes: 59 additions & 5 deletions ...e_description-True_tags-True_owners-True_table-True_error-True_sample-True_env-False.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,65 @@
}
},
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "```column1 column2\n--------- ---------\nvalue1 value2```"
}
"type": "table",
"rows": [
[
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "text",
"text": "column1",
"style": {
"bold": true
}
}
]
}
]
},
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "text",
"text": "column2",
"style": {
"bold": true
}
}
]
}
]
}
],
[
{
"type": "raw_text",
"text": "value1"
},
{
"type": "raw_text",
"text": "value2"
}
]
],
"column_settings": [
{
"align": "left",
"is_wrapped": false
},
{
"align": "left",
"is_wrapped": false
}
]
}
],
"color": "#ff0000"
Expand Down
64 changes: 59 additions & 5 deletions ...escription-False_tags-True_owners-False_table-True_error-False_sample-True_env-False.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,65 @@
}
},
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "```column1 column2\n--------- ---------\nvalue1 value2```"
}
"type": "table",
"rows": [
[
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "text",
"text": "column1",
"style": {
"bold": true
}
}
]
}
]
},
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "text",
"text": "column2",
"style": {
"bold": true
}
}
]
}
]
}
],
[
{
"type": "raw_text",
"text": "value1"
},
{
"type": "raw_text",
"text": "value2"
}
]
],
"column_settings": [
{
"align": "left",
"is_wrapped": false
},
{
"align": "left",
"is_wrapped": false
}
]
}
],
"color": "#ffcc00"
Expand Down
64 changes: 59 additions & 5 deletions ...ue_description-True_tags-True_owners-True_table-True_error-True_sample-True_env-True.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,65 @@
}
},
{
"type": "section",
"text": {
"type": "mrkdwn",
"text": "```column1 column2\n--------- ---------\nvalue1 value2```"
}
"type": "table",
"rows": [
[
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "text",
"text": "column1",
"style": {
"bold": true
}
}
]
}
]
},
{
"type": "rich_text",
"elements": [
{
"type": "rich_text_section",
"elements": [
{
"type": "text",
"text": "column2",
"style": {
"bold": true
}
}
]
}
]
}
],
[
{
"type": "raw_text",
"text": "value1"
},
{
"type": "raw_text",
"text": "value2"
}
]
],
"column_settings": [
{
"align": "left",
"is_wrapped": false
},
{
"align": "left",
"is_wrapped": false
}
]
}
],
"color": "#ffcc00"
Expand Down
Loading
Loading