feat(web-api): add recipient_team_id and recipient_user_id to chat_startStream method
#1751
Conversation
mwbrooks
added
enhancement
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## ai-apps #1751 +/- ##
==========================================
Coverage ? 85.01%
==========================================
Files ? 113
Lines ? 12955
Branches ? 0
==========================================
Hits ? 11014
Misses ? 1941
Partials ? 0 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
@mwbrooks LGTM! And thanks for the super fast follow here.
I like that you included generated reference to keep commits contained, but I did leave one comment on perhaps an prior oversight? I forget what was here before 📠
When you're feeling like the time is right we should merge this for another prerelease 🌚 ✨
| <dt id="slack_sdk.oauth.installation_store.file.FileInstallationStore"><code class="flex name class"> | ||
| <span>class <span class="ident">FileInstallationStore</span></span> | ||
| <span>(</span><span>*,<br>base_dir: str = '/Users/eden.zimbelman/.bolt-app-installation',<br>historical_data_enabled: bool = True,<br>client_id: str | None = None,<br>logger: logging.Logger = <Logger slack_sdk.oauth.installation_store.file (WARNING)>)</span> | ||
| <span>(</span><span>*,<br>base_dir: str = '/Users/michael.brooks/.bolt-app-installation',<br>historical_data_enabled: bool = True,<br>client_id: str | None = None,<br>logger: logging.Logger = <Logger slack_sdk.oauth.installation_store.file (WARNING)>)</span> |
There was a problem hiding this comment.
🤖 suggestion(non-blocking): Hmm I didn't notice this in a past change, but I am wondering if we can use a $HOME placeholder here instead?
There was a problem hiding this comment.
Good catch!
Digging into it, it's been around a year ago during Aug 2024 and it dates back to 3 year ago when v3.16.2 introduced the user paths..
I like your suggestion of replacing it with a placeholder. Let's create an issue to handle it in another PR.
| await async_method() | ||
| elif method_name == "chat_startStream": | ||
| self.api_methods_to_call.remove(method(channel="C123")["method"]) | ||
| method(channel="C123", recipient_team_id="T123", recipient_user_id="U123") |
There was a problem hiding this comment.
⭐ praise: Thank you for enhancing tests with this change!
|
Thanks for the quick review @zimeg! We can tackle the docs fix after this work, but it's a very good find! |
Summary
This pull request add 2 optional types to the
chat_startStreammethod:recipient_team_idis an optional Team ID that is required whenrecipient_user_idexistsrecipient_user_idis an optional User ID that is required whenrecipient_team_idexistsThe developer must provide these optional params when starting a conversation stream outside of a DM.
Testing
Category
/docs(Documents)/tutorial(PythOnBoardingBot tutorial)tests/integration_tests(Automated tests for this library)Requirements
python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.shafter making the changes.