slackapi / slackapi/python-slack-sdk

files_upload_v2 should respect the retry handlers

オープン
#1,853 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

auto-triage-skip bug python web-client
主要言語
Python
スター
4k
フォーク
857
平均マージ
22時間 21分
マージ済み PR(30日)
16

説明

The WebClient (and async version of the same) have the convenience method files_upload_v2 that does the three step process for uploading a file using the "new" style: call getUploadURLExternal, POST the file to that URL, then call completeUploadExternal. For steps (1) and (3), the call goes through api_call so will respect the retry handlers that are available on the client itself. However, step (2) is not covered by the retry handlers, so transient HTTP errors can escape up to the caller, who could only retry the entire operation (and would need to implement retry support from scratch, not using the retry system available in the SDK).

This started coming up for us recently. We are seeing 2-6 HTTP 504 errors per day in the _upload_file internal call. Here's an example from our logs, showing the timing (all times EDT). It looks like about 30 seconds from the upload starting to the exception being raised from the SDK:

20260406 16:34:46.349 INFO     txn 85 </rpc.slackmessenger.SlackMessenger/SendSlackThread: 75978> processing request from ('<ip>', <port>)
20260406 16:34:46.350 INFO     pylib3.slackmessenger.basic 466 </rpc.slackmessenger.SlackMessenger/SendSlackThread: 75978> SendSlackThread()
20260406 16:34:46.350 INFO     root 281 </rpc.slackmessenger.SlackMessenger/SendSlackThread: 75978> Channel '@<user> resolved to User IDs ['U<uid>'].
20260406 16:34:46.351 INFO     pylib3.slackmessenger.basic 112 </rpc.slackmessenger.SlackMessenger/SendSlackThread: 75978> Uploading a file with title=Test result summary, filetype=text, filename=Test_result_summary.txt, type=text
20260406 16:35:17.740 ERROR    pylib3.rpc.servers.exceptions_and_metadata 274 </rpc.slackmessenger.SlackMessenger/SendSlackThread: 75978> The following exception was propagated to the client:
Traceback (most recent call last):
  File "/mnt/macaroon_binaries/obin/obin-bamboo/20260405233709/pylib3/rpc/servers/exceptions_and_metadata.py", line 248, in handle_exceptions_and_metadata_asyncio
    yield
  File "/mnt/macaroon_binaries/obin/obin-bamboo/20260405233709/pylib3/rpc/servers/service_base.py", line 347, in method_wrapper_asyncio
    yield
  File "/mnt/macaroon_binaries/obin/obin-bamboo/20260405233709/pylib3/rpc/servers/service_base.py", line 355, in wrapper
    await method(stream)
  File "/mnt/macaroon_binaries/obin/obin-bamboo/20260405233709/pylib3/rpc/servers/trio_decorators.py", line 122, in aio_rpc_handler
    stream, await trio_as_aio(rpc_func)(self, request, metadata)
            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/venvs/opsvenv2/lib/python3.11/site-packages/trio_asyncio/_handles.py", line 148, in _run
    res = await self._callback(*self._args)
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/mnt/macaroon_binaries/obin/obin-bamboo/20260405233709/pylib3/slackmessenger/basic.py", line 472, in SendSlackThread
    return await self._send_slack_thread(message_state, request.messages)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/mnt/macaroon_binaries/obin/obin-bamboo/20260405233709/pylib3/slackmessenger/basic.py", line 452, in _send_slack_thread
    await message_state.direct_send(first_message, self.slack_client)
  File "/mnt/macaroon_binaries/obin/obin-bamboo/20260405233709/pylib3/slackmessenger/basic.py", line 138, in direct_send
    permalink = await self._upload_file(slack_client, message.new_file)
                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/venvs/opsvenv2/lib/python3.11/site-packages/trio_asyncio/_adapter.py", line 54, in __call__
    return await self.loop.run_aio_coroutine(f)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/venvs/opsvenv2/lib/python3.11/site-packages/trio_asyncio/_base.py", line 225, in run_aio_coroutine
    return await run_aio_future(fut)
           ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/venvs/opsvenv2/lib/python3.11/site-packages/trio_asyncio/_util.py", line 43, in run_aio_future
    res = await trio.lowlevel.wait_task_rescheduled(abort_cb)
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/venvs/opsvenv2/lib/python3.11/site-packages/trio/_core/_traps.py", line 178, in wait_task_rescheduled
    return (await _async_yield(WaitTaskRescheduled(abort_func))).unwrap()
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/venvs/opsvenv2/lib/python3.11/site-packages/outcome/_impl.py", line 213, in unwrap
    raise captured_error
  File "/usr/local/venvs/opsvenv2/lib/python3.11/site-packages/trio_asyncio/_adapter.py", line 17, in _call_defer
    return await proc(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/mnt/macaroon_binaries/obin/obin-bamboo/20260405233709/pylib3/slackmessenger/basic.py", line 119, in _upload_file
    uploaded = await slack_client.files_upload_v2(
               ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/venvs/opsvenv2/lib/python3.11/site-packages/slack_sdk/web/async_client.py", line 3844, in files_upload_v2
    raise e.SlackRequestError(message)
slack_sdk.errors.SlackRequestError: Failed to upload a file (status: 504, body: None, filename: Test_result_summary.txt, title: Test result summary)

Can you consider an enhancement to _upload_file to have it use the same retry system? Do you have other advice for handling or avoiding this situation? I will also open a support request to understand why this has started happening more often.

Category
  • slack_sdk.web.WebClient (sync/async) (Web API client)

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

slack_sdk/web/async_client.py の files_upload_v2 と、その _upload_file ステップから始め、続いてステップ (1) と (3) で api_call が使用している retry 処理を比較します。同期版の WebClient 実装も追跡します。ファイルの POST 中に発生する一時的な HTTP エラーが、呼び出し元へ直接伝播するのではなく、クライアント既存の retry ハンドラーを使用すれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
python
領域
api
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
静か
明瞭さ
おおむね明確
初心者へのやさしさ
52/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。