Skip to content

Commit 863e1d3

Browse files
RodneyU215RodneyU215
authored
Fixing bugs that were recently introduced in master (slackapi#466)
* Fixing bugs that were recently introduced in master
1 parent 66017f3 commit 863e1d3

File tree

9 files changed

+345
-183
lines changed

9 files changed

+345
-183
lines changed

‎README.md‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ We recommend using [PyPI][pypi] to install the Slack Developer Kit for Python.
5757

5858

5959
```bash
60-
pip3 install slackclient==2.0.0
60+
$ pip3 install slackclient
6161
```
6262

6363
### Getting started tutorial
@@ -204,7 +204,14 @@ async def send_async_message(channel='#random', text='')
204204

205205
### Advanced Options
206206

207-
The Python slackclient v2 now uses [AIOHttp][aiohttp] under the hood so it allows us to use their built-in [SSL](https://docs.aiohttp.org/en/stable/client_advanced.html#ssl-control-for-tcp-sockets) and [Proxy](https://docs.aiohttp.org/en/stable/client_advanced.html#proxy-support) support. You can pass these options directly into both the RTM and the Web client.
207+
The Python slackclient v2 now uses [AIOHttp][aiohttp] under the hood.
208+
209+
Looking for a performance boost? Installing the optional dependencies (aiodns) may help speed up DNS resolving by the client. We've included it as an extra called "optional":
210+
```bash
211+
$ pip3 install slackclient[optional]
212+
```
213+
214+
Interested in SSL or Proxy support? Simply use their built-in [SSL](https://docs.aiohttp.org/en/stable/client_advanced.html#ssl-control-for-tcp-sockets) and [Proxy](https://docs.aiohttp.org/en/stable/client_advanced.html#proxy-support) arguments. You can pass these options directly into both the RTM and the Web client.
208215

209216
```python
210217
import os

‎slack/rtm/client.py‎

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import logging
66
import random
77
import collections
8+
import concurrent
89
import inspect
910
import signal
1011
from typing import Optional, Callable, DefaultDict
@@ -113,6 +114,7 @@ def __init__(
113114
connect_method: Optional[str] = None,
114115
ping_interval: Optional[int] = 30,
115116
loop: Optional[asyncio.AbstractEventLoop] = None,
117+
headers: Optional[dict] = {},
116118
):
117119
self.token = token
118120
self.run_async = run_async
@@ -123,6 +125,7 @@ def __init__(
123125
self.base_url = base_url
124126
self.connect_method = connect_method
125127
self.ping_interval = ping_interval
128+
self.headers = headers
126129
self._event_loop = loop or asyncio.get_event_loop()
127130
self._web_client = None
128131
self._websocket = None
@@ -223,7 +226,7 @@ def send_over_websocket(self, *, payload: dict):
223226
Raises:
224227
SlackClientNotConnectedError: Websocket connection is closed.
225228
"""
226-
return asyncio.ensure_future(self._send_json(payload))
229+
return asyncio.ensure_future(self._send_json(payload), loop=self._event_loop)
227230

228231
async def _send_json(self, payload):
229232
if self._websocket is None or self._event_loop is None:
@@ -434,14 +437,33 @@ async def _dispatch_event(self, event, data=None):
434437
rtm_client=self, web_client=self._web_client, data=data
435438
)
436439
else:
437-
callback(rtm_client=self, web_client=self._web_client, data=data)
440+
self._execute_in_thread(callback, data)
438441
except Exception as err:
439442
name = callback.__name__
440443
module = callback.__module__
441444
msg = f"When calling '#{name}()' in the '{module}' module the following error was raised: {err}"
442445
self._logger.error(msg)
443446
raise
444447

448+
def _execute_in_thread(self, callback, data):
449+
"""Execute the callback in another thread. Wait for and return the results."""
450+
web_client = WebClient(
451+
token=self.token,
452+
base_url=self.base_url,
453+
ssl=self.ssl,
454+
proxy=self.proxy,
455+
headers=self.headers,
456+
)
457+
with concurrent.futures.ThreadPoolExecutor(max_workers=1) as executor:
458+
future = executor.submit(
459+
callback, rtm_client=self, web_client=web_client, data=data
460+
)
461+
462+
while future.running():
463+
pass
464+
465+
future.result()
466+
445467
async def _retreive_websocket_info(self):
446468
"""Retreives the WebSocket info from Slack.
447469
@@ -472,6 +494,7 @@ async def _retreive_websocket_info(self):
472494
run_async=True,
473495
loop=self._event_loop,
474496
session=self._session,
497+
headers=self.headers,
475498
)
476499
self._logger.debug("Retrieving websocket info.")
477500
if self.connect_method in ["rtm.start", "rtm_start"]:

‎slack/web/base_client.py‎

Lines changed: 54 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ def __init__(
3434
proxy=None,
3535
run_async=False,
3636
session=None,
37+
headers: Optional[dict] = None,
3738
):
3839
self.token = token
3940
self.base_url = base_url
@@ -42,17 +43,45 @@ def __init__(
4243
self.proxy = proxy
4344
self.run_async = run_async
4445
self.session = session
46+
self.headers = headers or {}
4547
self._logger = logging.getLogger(__name__)
4648
self._event_loop = loop
4749

48-
def _set_event_loop(self):
49-
if self.run_async:
50+
def _get_event_loop(self):
51+
"""Retrieves the event loop or creates a new one."""
52+
try:
5053
return asyncio.get_event_loop()
51-
else:
54+
except RuntimeError:
5255
loop = asyncio.new_event_loop()
5356
asyncio.set_event_loop(loop)
5457
return loop
5558

59+
def _get_headers(self, has_json, has_files):
60+
"""Contructs the headers need for a request.
61+
Args:
62+
has_json (bool): Whether or not the request has json.
63+
Returns:
64+
The headers dictionary.
65+
e.g. {
66+
'Content-Type': 'application/json;charset=utf-8',
67+
'Authorization': 'Bearer xoxb-1234-1243',
68+
'User-Agent': 'Python/3.6.8 slack/2.1.0 Darwin/17.7.0'
69+
}
70+
"""
71+
headers = {
72+
"User-Agent": self._get_user_agent(),
73+
"Authorization": "Bearer {}".format(self.token),
74+
"Content-Type": "application/x-www-form-urlencoded;charset=utf-8",
75+
}
76+
if has_json:
77+
headers.update({"Content-Type": "application/json;charset=utf-8"})
78+
79+
if has_files:
80+
# These are set automatically by the aiohttp library.
81+
headers.pop("Content-Type", None)
82+
83+
return headers
84+
5685
def api_call(
5786
self,
5887
api_method: str,
@@ -62,7 +91,7 @@ def api_call(
6291
data: Union[dict, FormData] = None,
6392
params: dict = None,
6493
json: dict = None,
65-
):
94+
) -> Union[asyncio.Future, SlackResponse]:
6695
"""Create a request and execute the API call to Slack.
6796
6897
Args:
@@ -93,41 +122,26 @@ def api_call(
93122
SlackRequestError: Json data can only be submitted as
94123
POST requests.
95124
"""
96-
if json is not None and http_verb != "POST":
125+
has_json = json is not None
126+
has_files = files is not None
127+
if has_json and http_verb != "POST":
97128
msg = "Json data can only be submitted as POST requests. GET requests should use the 'params' argument."
98129
raise err.SlackRequestError(msg)
99130

100131
api_url = self._get_url(api_method)
101-
headers = {
102-
"User-Agent": self._get_user_agent(),
103-
"Authorization": "Bearer {}".format(self.token),
104-
}
105-
if files is not None:
106-
form_data = FormData()
107-
for k, v in files.items():
108-
if isinstance(v, str):
109-
with open(v, "rb") as fd:
110-
form_data.add_field(k, fd)
111-
else:
112-
form_data.add_field(k, v)
113-
114-
if isinstance(data, dict):
115-
for k, v in data.items():
116-
form_data.add_field(k, str(v))
117-
118-
data = form_data
119132

120133
req_args = {
121-
"headers": headers,
134+
"headers": self._get_headers(has_json, has_files),
122135
"data": data,
136+
"files": files,
123137
"params": params,
124138
"json": json,
125139
"ssl": self.ssl,
126140
"proxy": self.proxy,
127141
}
128142

129143
if self._event_loop is None:
130-
self._event_loop = self._set_event_loop()
144+
self._event_loop = self._get_event_loop()
131145

132146
future = asyncio.ensure_future(
133147
self._send(http_verb=http_verb, api_url=api_url, req_args=req_args),
@@ -182,9 +196,24 @@ async def _send(self, http_verb, api_url, req_args):
182196
Returns:
183197
The response parsed into a SlackResponse object.
184198
"""
199+
open_files = []
200+
files = req_args.pop("files", None)
201+
if files is not None:
202+
for k, v in files.items():
203+
if isinstance(v, str):
204+
f = open(v.encode("ascii", "ignore"), "rb")
205+
open_files.append(f)
206+
req_args["data"].update({k: f})
207+
else:
208+
req_args["data"].update({k: v})
209+
185210
res = await self._request(
186211
http_verb=http_verb, api_url=api_url, req_args=req_args
187212
)
213+
214+
for f in open_files:
215+
f.close()
216+
188217
data = {
189218
"client": self,
190219
"http_verb": http_verb,

0 commit comments

Comments
 (0)