paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-15 03:11:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

outgoing webhooks: Set a Zulip-specific user-agent.

Browse Source 
This now sets the user-agent to something like:

    ZulipOutgoingWebhook/2.0

(It uses the current ZULIP_VERSION.)

Before this change, the user-agent would be
something like `python-requests/2.18.4`.

Fixes #10741
This commit is contained in:
Steve Howell
2019-01-09 14:29:17 +00:00
committed by Tim Abbott
parent a3ac94fa26
commit 475108b784
2 changed files with 22 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
zerver/lib/outgoing_webhook.py
View File

@@ -21,6 +21,8 @@ from zerver.lib.url_encoding import near_message_url
from zerver.lib.validator import check_dict, check_string from zerver.lib.validator import check_dict, check_string
from zerver.decorator import JsonableError from zerver.decorator import JsonableError
from version import ZULIP_VERSION
class OutgoingWebhookServiceInterface: class OutgoingWebhookServiceInterface:
def __init__(self, token: str, user_profile: UserProfile, service_name: str) -> None: def __init__(self, token: str, user_profile: UserProfile, service_name: str) -> None:
@@ -41,7 +43,11 @@ class GenericOutgoingWebhookService(OutgoingWebhookServiceInterface):
def send_data_to_server(self, def send_data_to_server(self,
base_url: str, base_url: str,
request_data: Any) -> Response: request_data: Any) -> Response:
headers = {'content-type': 'application/json'} user_agent = 'ZulipOutgoingWebhook/' + ZULIP_VERSION
headers = {
'content-type': 'application/json',
'User-Agent': user_agent,
}
response = requests.request('POST', base_url, data=request_data, headers=headers) response = requests.request('POST', base_url, data=request_data, headers=headers)
return response return response

15
zerver/tests/test_outgoing_webhook_system.py
View File

@@ -20,6 +20,8 @@ from zerver.lib.test_classes import ZulipTestCase
from zerver.lib.topic import TOPIC_NAME from zerver.lib.topic import TOPIC_NAME
from zerver.models import get_realm, get_user, UserProfile, get_display_recipient from zerver.models import get_realm, get_user, UserProfile, get_display_recipient
from version import ZULIP_VERSION
class ResponseMock: class ResponseMock:
def __init__(self, status_code: int, content: Optional[Any]=None) -> None: def __init__(self, status_code: int, content: Optional[Any]=None) -> None:
self.status_code = status_code self.status_code = status_code
@@ -96,6 +98,19 @@ The webhook got a response with status code *500*.''')
The webhook got a response with status code *400*.''') The webhook got a response with status code *400*.''')
self.assertEqual(bot_owner_notification.recipient_id, self.bot_user.bot_owner.id) self.assertEqual(bot_owner_notification.recipient_id, self.bot_user.bot_owner.id)
def test_headers(self) -> None:
with mock.patch('requests.request') as mock_request:
do_rest_call('', 'payload-stub', self.mock_event, service_handler)
kwargs = mock_request.call_args[1]
self.assertEqual(kwargs['data'], 'payload-stub')
user_agent = 'ZulipOutgoingWebhook/' + ZULIP_VERSION
headers = {
'content-type': 'application/json',
'User-Agent': user_agent,
}
self.assertEqual(kwargs['headers'], headers)
def test_error_handling(self) -> None: def test_error_handling(self) -> None:
def helper(side_effect: Any, error_text: str) -> None: def helper(side_effect: Any, error_text: str) -> None:
with mock.patch('logging.info'): with mock.patch('logging.info'):