akka/akka-http

'relaxed' parsing of URI's with UTF-8 characters

Open

#3,722 opened on Jan 6, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (598 forks)batch import
discusshelp wantednice-to-have (low-prio)

Repository metrics

Stars
 (1,311 stars)
PR merge metrics
 (Avg merge 1d 10h) (2 merged PRs in 30d)

Description

In 'relaxed' mode, the Uri apply method:

/**
   * Parses a valid URI string into a normalized URI reference as defined
   * by http://tools.ietf.org/html/rfc3986#section-4.1.
   * Percent-encoded octets are UTF-8 decoded.
   * Accepts unencoded visible 7-bit ASCII characters in addition to the RFC.
   * If the given string is not a valid URI the method throws an `IllegalUriException`.
   */

As specified, other UTF-8 characters, such as é, will not be accepted. Browsers are more lenient and do convert those to percent-encoding.

The behavior of Uri might be reasonable, but it would be nice to have a utility function that would also accept (invalid) URL's containing UTF-8 characters.

Somewhat related to #86

Contributor guide

Research direction
Inspect the Uri parsing implementation and add a utility function that percent encodes UTF 8 characters in relaxed mode.
Tech stack
scala
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
ScalaURI parsing concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70