Optimized Uri.withQuery #637
Merged
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
raboof
approved these changes
Dec 12, 2024
There was a problem hiding this comment.
Logic-wise makes sense to me.
UriSpec.scala already has some tests such as:
uri.withQuery(Query("param1" -> "val\"ue1")) shouldEqual Uri("http://host/path?param1=val%22ue1#fragment")
This is a good start, but perhaps it would be good to add some more test cases with Query instances that are created with the other Query constructors to validate that these also produce the correct results. I'm pretty convinced that this implementation will indeed behave correctly, but good to codify.
YoniKF
reviewed
Dec 12, 2024
| @@ -129,7 +129,8 @@ sealed abstract case class Uri(scheme: String, authority: Authority, path: Path, | |||
| /** | |||
| * Returns a copy of this Uri with the given query. | |||
| */ | |||
| def withQuery(query: Query): Uri = copy(rawQueryString = if (query.isEmpty) None else Some(query.toString)) | |||
| def withQuery(query: Query): Uri = | |||
| createUnsafe(scheme, authority, path, if (query.isEmpty) None else Some(query.toString), fragment) | |||
There was a problem hiding this comment.
Consider adding a copyUnsafe method and calling it here and also in all the other with... methods (this assumes that the query stored inside Uri is also already encoded).
YoniKF
approved these changes
Dec 15, 2024
pjfanning
requested changes
Dec 15, 2024
There was a problem hiding this comment.
fails to compile in scala 2.12 build
[error] /home/runner/work/pekko-http/pekko-http/http-core/src/test/scala/org/apache/pekko/http/scaladsl/model/UriSpec.scala:824:36: value addOne is not a member of scala.collection.mutable.Builder[(String, String),org.apache.pekko.http.scaladsl.model.Uri.Query]
[error] val query = Query.newBuilder.addOne("param1" -> "val\"ue1").result()
[error] ^
Error: value addOne is not a member of scala.collection.mutable.Builder[(String, String),org.apache.pekko.http.scaladsl.model.Uri.Query]
You need to avoid the addOne function.
pjfanning
approved these changes
Dec 15, 2024
raboof
approved these changes
Dec 16, 2024
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.
Uri.withQueryreceives aQueryobject, converts it to a string, and then calls theUri.copymethod which creates a newUriobject with the given query (TheUriclass holds the query as an un-parsed string).The
copymethod ends up inqueryString.map(new UriParser(_).parseRawQueryString())which percent-encodes the query string.As in this flow, the query string is converted from a
Queryobject, it is always percent-encoded, so the additional encoding operation is unnecessary. We can skip it by replacing the call tocopywithcreateUnsafe.