slack: fixed celery serialization breaking slack_data dataclass

rhodecode/integrations/types/slack.py

@@ -1,185 +1,189 b''
 # Copyright (C) 2012-2023 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 
 
 import time
 import logging
 
 import deform # noqa
 import deform.widget
 import colander
 
 from rhodecode import events
 from rhodecode.model.validation_schema.widgets import CheckboxChoiceWidgetDesc
 from rhodecode.translation import _
 from rhodecode.lib import helpers as h
 from rhodecode.lib.celerylib import run_task, async_task, RequestContextTask
 from rhodecode.lib.colander_utils import strip_whitespace
 from rhodecode.integrations.types.base import (
     IntegrationTypeBase,
     requests_retry_call,
 )
 
 from rhodecode.integrations.types.handlers.slack import SlackDataHandler, SlackData
 
 
 log = logging.getLogger(__name__)
 
 
 class SlackSettingsSchema(colander.Schema):
     service = colander.SchemaNode(
         colander.String(),
         title=_('Slack service URL'),
         description=h.literal(_(
             'This can be setup at the '
             '<a href="https://my.slack.com/services/new/incoming-webhook/">'
             'slack app manager</a>')),
         default='',
         preparer=strip_whitespace,
         validator=colander.url,
         widget=deform.widget.TextInputWidget(
             placeholder='https://hooks.slack.com/services/...',
         ),
     )
     username = colander.SchemaNode(
         colander.String(),
         title=_('Username'),
         description=_('Username to show notifications coming from.'),
         missing='Rhodecode',
         preparer=strip_whitespace,
         widget=deform.widget.TextInputWidget(
             placeholder='Rhodecode'
         ),
     )
     channel = colander.SchemaNode(
         colander.String(),
         title=_('Channel'),
         description=_('Channel to send notifications to.'),
         missing='',
         preparer=strip_whitespace,
         widget=deform.widget.TextInputWidget(
             placeholder='#general'
         ),
     )
     icon_emoji = colander.SchemaNode(
         colander.String(),
         title=_('Emoji'),
         description=_('Emoji to use eg. :studio_microphone:'),
         missing='',
         preparer=strip_whitespace,
         widget=deform.widget.TextInputWidget(
             placeholder=':studio_microphone:'
         ),
     )
 
 
 class SlackIntegrationType(IntegrationTypeBase):
     key = 'slack'
     display_name = _('Slack')
     description = _('Send events such as repo pushes and pull requests to '
                     'your slack channel.')
 
     @classmethod
     def icon(cls):
         return '''<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg viewBox="0 0 256 256" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" preserveAspectRatio="xMidYMid"><g><path d="M165.963541,15.8384262 C162.07318,3.86308197 149.212328,-2.69009836 137.239082,1.20236066 C125.263738,5.09272131 118.710557,17.9535738 122.603016,29.9268197 L181.550164,211.292328 C185.597902,222.478689 197.682361,228.765377 209.282098,225.426885 C221.381246,221.943607 228.756984,209.093246 224.896,197.21023 C224.749115,196.756984 165.963541,15.8384262 165.963541,15.8384262" fill="#DFA22F"></path><path d="M74.6260984,45.515541 C70.7336393,33.5422951 57.8727869,26.9891148 45.899541,30.8794754 C33.9241967,34.7698361 27.3710164,47.6306885 31.2634754,59.6060328 L90.210623,240.971541 C94.2583607,252.157902 106.34282,258.44459 117.942557,255.104 C130.041705,251.62282 137.417443,238.772459 133.556459,226.887344 C133.409574,226.436197 74.6260984,45.515541 74.6260984,45.515541" fill="#3CB187"></path><path d="M240.161574,166.045377 C252.136918,162.155016 258.688,149.294164 254.797639,137.31882 C250.907279,125.345574 238.046426,118.792393 226.07318,122.682754 L44.7076721,181.632 C33.5213115,185.677639 27.234623,197.762098 30.5731148,209.361836 C34.0563934,221.460984 46.9067541,228.836721 58.7897705,224.975738 C59.2430164,224.828852 240.161574,166.045377 240.161574,166.045377" fill="#CE1E5B"></path><path d="M82.507541,217.270557 C94.312918,213.434754 109.528131,208.491016 125.855475,203.186361 C122.019672,191.380984 117.075934,176.163672 111.76918,159.83423 L68.4191475,173.924721 L82.507541,217.270557" fill="#392538"></path><path d="M173.847082,187.591344 C190.235279,182.267803 205.467279,177.31777 217.195016,173.507148 C213.359213,161.70177 208.413377,146.480262 203.106623,130.146623 L159.75659,144.237115 L173.847082,187.591344" fill="#BB242A"></path><path d="M210.484459,74.7058361 C222.457705,70.8154754 229.010885,57.954623 225.120525,45.9792787 C221.230164,34.0060328 208.369311,27.4528525 196.393967,31.3432131 L15.028459,90.292459 C3.84209836,94.3380984 -2.44459016,106.422557 0.896,118.022295 C4.37718033,130.121443 17.227541,137.49718 29.1126557,133.636197 C29.5638033,133.489311 210.484459,74.7058361 210.484459,74.7058361" fill="#72C5CD"></path><path d="M52.8220328,125.933115 C64.6274098,122.097311 79.8468197,117.151475 96.1762623,111.84682 C90.8527213,95.4565246 85.9026885,80.2245246 82.0920656,68.4946885 L38.731541,82.5872787 L52.8220328,125.933115" fill="#248C73"></path><path d="M144.159475,96.256 C160.551869,90.9303607 175.785967,85.9803279 187.515803,82.1676066 C182.190164,65.7752131 177.240131,50.5390164 173.42741,38.807082 L130.068984,52.8996721 L144.159475,96.256" fill="#62803A"></path></g></svg>'''
 
     valid_events = [
         events.PullRequestCloseEvent,
         events.PullRequestMergeEvent,
         events.PullRequestUpdateEvent,
         events.PullRequestCommentEvent,
         events.PullRequestReviewEvent,
         events.PullRequestCreateEvent,
         events.RepoPushEvent,
         events.RepoCreateEvent,
     ]
 
     def settings_schema(self):
         schema = SlackSettingsSchema()
         schema.add(colander.SchemaNode(
             colander.Set(),
             widget=CheckboxChoiceWidgetDesc(
                 values=sorted(
                     [(e.name, e.display_name, e.description) for e in self.valid_events]
                 ),
             ),
             description="List of events activated for this integration",
             name='events'
         ))
 
         return schema
 
     def send_event(self, event):
         log.debug('handling event %s with integration %s', event.name, self)
 
         if event.__class__ not in self.valid_events:
             log.debug('event %r not present in valid event list (%s)', event, self.valid_events)
             return
 
         if not self.event_enabled(event):
             return
 
         data = event.as_dict()
 
         handler = SlackDataHandler()
         slack_data = handler(event, data)
         # title, text, fields, overrides
         run_task(post_text_to_slack, self.settings, slack_data)
 
 
 @async_task(ignore_result=True, base=RequestContextTask)
 def post_text_to_slack(settings, slack_data: SlackData):
+    # because JSON serialization, if we run async with celery, deserialize to SlackData
+    if isinstance(slack_data, dict):
+        slack_data = SlackData(**slack_data)
+
     title = slack_data.title
     text = slack_data.text
     fields = slack_data.fields
     overrides = slack_data.overrides
 
     log.debug('sending %s (%s) to slack %s', title, text, settings['service'])
 
     fields = fields or []
     overrides = overrides or {}
 
     message_data = {
                 "fallback": text,
                 "color": "#427cc9",
                 "pretext": title,
                 #"author_name": "Bobby Tables",
                 #"author_link": "http://flickr.com/bobby/",
                 #"author_icon": "http://flickr.com/icons/bobby.jpg",
                 #"title": "Slack API Documentation",
                 #"title_link": "https://api.slack.com/",
                 "text": text,
                 "fields": fields,
                 #"image_url": "http://my-website.com/path/to/image.jpg",
                 #"thumb_url": "http://example.com/path/to/thumb.png",
                 "footer": "RhodeCode",
                 #"footer_icon": "",
                 "ts": time.time(),
                 "mrkdwn_in": ["pretext", "text"]
     }
     message_data.update(overrides)
     json_message = {
         "icon_emoji": settings.get('icon_emoji', ':studio_microphone:'),
         "channel": settings.get('channel', ''),
         "username": settings.get('username', 'Rhodecode'),
         "attachments": [message_data]
     }
     req_session = requests_retry_call()
     resp = req_session.post(settings['service'], json=json_message, timeout=60)
     resp.raise_for_status()  # raise exception on a failed request

rhodecode/tests/lib/test_ext_json.py

@@ -1,166 +1,178 b''
-
+import dataclasses
 # Copyright (C) 2010-2023 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 import io
 import datetime
 import decimal
 import textwrap
 
 import pytest
 
 from rhodecode.lib import ext_json
 from rhodecode.translation import _, _pluralize
 
 
 class Timezone(datetime.tzinfo):
     def __init__(self, hours):
         self.hours = hours
 
     def utcoffset(self, unused_dt):
         return datetime.timedelta(hours=self.hours)
 
 
 class SerializableObject(object):
     def __json__(self):
         return 'foo'
 
 
 def test_dumps_set():
     result = ext_json.json.dumps(set((1, 2, 3)))
     # We cannot infer what the order of result is going to be
     result = ext_json.json.loads(result)
     assert isinstance(result, list)
     assert [1, 2, 3] == sorted(result)
 
 
 def test_dumps_decimal():
     assert b'"1.5"' == ext_json.json.dumps(decimal.Decimal('1.5'))
 
 
 def test_dumps_complex():
     assert b"[0.0,1.0]" == ext_json.json.dumps(1j)
     assert b"[1.0,0.0]" == ext_json.json.dumps(1 + 0j)
     assert b"[1.1,1.2]" == ext_json.json.dumps(1.1 + 1.2j)
 
 
 def test_dumps_object_with_json_method():
     assert '"foo"' == ext_json.str_json(SerializableObject())
 
 
 def test_dumps_object_with_json_attribute():
 
     assert '"foo"' == ext_json.str_json(SerializableObject())
 
 
 def test_dumps_time():
     assert '"03:14:15.926535"' == ext_json.str_json(datetime.time(3, 14, 15, 926535))
 
 
 def test_dumps_time_no_microseconds():
     assert '"03:14:15"' == ext_json.str_json(datetime.time(3, 14, 15))
 
 
 def test_dumps_time_with_timezone():
     with pytest.raises(TypeError) as excinfo:
         ext_json.json.dumps(datetime.time(3, 14, 15, 926535, Timezone(0)))
 
     error_msg = str(excinfo.value)
 
     assert 'timezone library is not supported' in error_msg
     # only for simplejson
     #assert 'Time-zone aware times are not JSON serializable' in error_msg
 
 
 def test_dumps_date():
     assert b'"1969-07-20"' == ext_json.json.dumps(datetime.date(1969, 7, 20))
 
 
 def test_dumps_datetime():
     json_data = ext_json.json.dumps(datetime.datetime(1969, 7, 20, 3, 14, 15, 926535))
     assert b'"1969-07-20T03:14:15.926535"' == json_data
 
 
 def test_dumps_datetime_no_microseconds():
     json_data = ext_json.json.dumps(datetime.datetime(1969, 7, 20, 3, 14, 15))
     assert b'"1969-07-20T03:14:15"' == json_data
 
 
 def test_dumps_datetime_with_utc_timezone():
     json_data = ext_json.json.dumps(
         datetime.datetime(1969, 7, 20, 3, 14, 15, 926535, Timezone(0)))
     assert b'"1969-07-20T03:14:15.926535+00:00"' == json_data
 
 
 def test_dumps_datetime_with_plus1_timezone():
     json_data = ext_json.json.dumps(
         datetime.datetime(1969, 7, 20, 3, 14, 15, 926535, Timezone(1)))
     assert b'"1969-07-20T03:14:15.926535+01:00"' == json_data
 
 
 def test_dumps_unserializable_class():
     unserializable_obj = object()
     with pytest.raises(TypeError) as excinfo:
         ext_json.json.dumps(unserializable_obj)
 
     assert 'object' in str(excinfo.value)
     assert 'is not JSON serializable' in str(excinfo.value)
 
 
 def test_dump_is_like_dumps():
     data = {
         'decimal': decimal.Decimal('1.5'),
         'set': set([1]),  # Just one element to guarantee the order
         'complex': 1 - 1j,
         'datetime': datetime.datetime(1969, 7, 20, 3, 14, 15, 926535),
         'time': datetime.time(3, 14, 15, 926535),
         'date': datetime.date(1969, 7, 20),
     }
     json_buffer = io.StringIO()  # StringIO because dump uses simplejson not orjson
     ext_json.json.dump(data, json_buffer)
 
     assert ext_json.sjson.dumps(data) == json_buffer.getvalue()
 
 
 def test_formatted_json():
     data = {
         'b': {'2': 2, '1': 1},
         'a': {'3': 3, '4': 4},
     }
 
     expected_data = textwrap.dedent('''
     {
       "a": {
         "3": 3,
         "4": 4
       },
       "b": {
         "1": 1,
         "2": 2
       }
     }''').strip()
 
     assert expected_data == ext_json.formatted_str_json(data)
 
 
 def test_lazy_translation_string(baseapp):
     data = {'label': _('hello')}
     data2 = {'label2': _pluralize('singular', 'plural', 1)}
 
     assert b'{"label":"hello"}' == ext_json.json.dumps(data)
     assert b'{"label2":"singular"}' == ext_json.json.dumps(data2)
+
+
+def test_serialize_dataclass():
+
+    @dataclasses.dataclass
+    class ExampleStruct:
+        field_str: str
+        field_int: int
+    struct = ExampleStruct(field_int=1, field_str='hello')
+    raw_struct = b'{"field_str":"hello","field_int":1}'
+    assert raw_struct == ext_json.json.dumps(struct)
+    assert struct == ExampleStruct(**ext_json.json.loads(raw_struct))