Do not add default query if it exists in the original URL #733
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
mokagio
approved these changes
Feb 21, 2024
| // Given | ||
| let path = "/path/path" | ||
| let preferredLanguageIdentifier = WordPressComLanguageDatabase().deviceLanguage.slug | ||
| func testThatAppendingLocaleWorks() async throws { |
There was a problem hiding this comment.
What do you think of
Suggested change
| func testThatAppendingLocaleWorks() async throws { | |
| func testAddsLocaleToURLQueryByDefault() async throws { |
| } | ||
|
|
||
| func testThatAppendingLocaleWorksWithExistingParams() { | ||
| // Given | ||
| func testThatAppendingLocaleWorksWithExistingParams() async throws { |
There was a problem hiding this comment.
What do you think of
Suggested change
| func testThatAppendingLocaleWorksWithExistingParams() async throws { | |
| func testAddsLocaleToURLQueryByDefaultAndMaintainsInputParameters() async throws { |
| @@ -205,6 +205,15 @@ class HTTPRequestBuilderTests: XCTestCase { | |||
| try XCTAssertEqual(builder.query(name: "foo", value: "bar").build().url?.query, "locale=zh&foo=bar") | |||
| } | |||
|
|
|||
| func testDefaultQueryExistsInOriginalURL() throws { | |||
There was a problem hiding this comment.
What do you think of
Suggested change
| func testDefaultQueryExistsInOriginalURL() throws { | |
| func testDoesNotOverriedQueryItemInOriginalURL() throws { |
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.
Description
While updating unit tests, I have caught an bug in the exiting implementation of appending default 'locale' query to all WP.com REST API call. The expected behaviour is in
testThatLocaleIsNotAppendedIfAlreadyIncludedInPath.Details
WordPressComRestApiadds alocale=en(or whatever the device locale is) query to all HTTP requests, unless the 'local' is passed as parameter. For example:WordPressComRestApi.get("/post/1")should send an HTTP request with the default 'locale=en' in the URL:https://.../post/1?locale=en.WordPressComRestApi.get("/post/1", parameters: ["locale": "zh"])should send an HTTP request withlocale=zh, instead of the default query "locale=en".However, there is a case missed in the current implementation,
WordPressComRestApi.get("/post/1?locale=zh")should behave like the second example above and send an HTTP request withlocale=zh.Testing Details
The bug fix is covered in the existing
testThatLocaleIsNotAppendedIfAlreadyIncludedInPathand I have added a new dedicate unit test for it.CHANGELOG.mdif necessary.