Fix #1342 files_upload_v2 fails to share files in a channel #1343
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
seratch
added
bug
seratch
commented
Mar 7, 2023
| @@ -3143,9 +3143,10 @@ def files_upload_v2( | |||
| channel_to_share = channels[0] | |||
| completion = self.files_completeUploadExternal( | |||
| files=[{"id": f["file_id"], "title": f["title"]} for f in files], | |||
| channel=channel_to_share, | |||
| channel_id=channel_to_share, | |||
There was a problem hiding this comment.
This is the cause of the issue
| initial_comment=initial_comment, | ||
| thread_ts=thread_ts, | ||
| token=kwargs.get("token"), |
There was a problem hiding this comment.
While fixing the issue, I've noticed that this one is missing here. With this, developers can pass "token" to v2 method to overwrite the token given when initializing WebClient. Current code does not response the parameter for this specific API call. That was a different bug.
Codecov Report
@@ Coverage Diff @@
## main #1343 +/- ##
=======================================
Coverage 85.40% 85.40%
=======================================
Files 111 111
Lines 11406 11406
=======================================
Hits 9741 9741
Misses 1665 1665
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Thanks for your help. You saved my life. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This pull request resolves #1342 . The root cause of the issue is miscoding in this SDK. The current implemenation of the v2 method internally passes "channel" parameter instead of "channel_id" parameter in
files.completeUploadExternalAPI calls. Although "channel_id" is the correct one, the API server-side had been accepting both "channel" and "channel_id" until today. In the initial development of this v2 wrapper method on the SDK side, we overlooked the invalid parameter name due to the server-side behavior.Category (place an
xin each of the[ ])/docs-src(Documents, have you run./scripts/docs.sh?)/docs-src-v2(Documents, have you run./scripts/docs-v2.sh?)/tutorial(PythOnBoardingBot tutorial)tests/integration_tests(Automated tests for this library)Requirements (place an
xin each[ ])python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.shafter making the changes.