Trimmed trailing slash in URL provided to create Client API #15513
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
…ates a double-slash unwanted side effects.
lieut-data
added
2: Dev Review
lieut-data
requested changes
Sep 16, 2020
lieut-data
reviewed
Sep 16, 2020
…eck api endpoint. Test case includes checks for expected (0), probable (1), and arbitrary (5) number of slashes to stress the implementation to ensure it wasnt built for a specific numbre of slashes
shieldsjared
force-pushed
the
MM_ClientApi_TrimTrailingSlash
branch
from
46d517a
to
2cab4ee
Compare
|
Changes implemented and ready for review again @lieut-data - Thanks! |
amyblais
added
the
CherryPick/Approved
|
@prapti Kind reminder to review for v5.28. |
|
Thanks @amyblais! |
|
/update-branch |
prapti
approved these changes
Sep 23, 2020
There was a problem hiding this comment.
Looks good to me! Thank you @shieldsjared for this fix and thank you for noting that "this fix does not correct if a user attempts to use a URL with multiple trailing-slashes", that was helpful :)
prapti
added
4: Reviews Complete
|
Cherry pick is scheduled. |
mattermost-build
pushed a commit
to mattermost-build/mattermost
that referenced
this pull request
Sep 24, 2020
mattermod
added
CherryPick/Done
amyblais
added
Changelog/Not Needed
mattermod
added a commit
to mattermost-build/mattermost
that referenced
this pull request
Sep 25, 2020
…server-mattermost#15513-upstream-release-5.28
hanzei
pushed a commit
that referenced
this pull request
Sep 25, 2020
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
As described in this issue while attempting to utilize the MM Plugin Started Template, it was determined that including a trailing slash when calling
model.NewAPIv4Clientwith a URL that includes a trailing slash, the resulting URL's become malformed (double-slash) and MM is unable to route the requests appropriately. Trimming a trailing slash prevents users from having to be too particular when specifying the URL of their target server.Note that this fix does not correct if a user attempts to use a URL with multiple trailing-slashes (however, this should be a bit more obvious of an issue to the end-user if they incorrectly set the MM url with multiple trailing-slashes).
Ticket Link
Fixes: mattermost/mattermost-plugin-starter-template#115
Also, please see PR on that repository for discussion and agreed-upon path forward for resolution (included in this PR)