akka/akka-http

Add query parameter name to ParamsSpec

Aperta

#3566 aperta il 23 ott 2020

 (3 commenti) (0 reazioni) (0 assegnatari)Scala (598 fork)batch import
1 - triagedhelp wantednice-to-have (low-prio)t:routing

Metriche repository

Star
 (1311 stelle)
Metriche merge PR
 (Merge medio 1g 10h) (2 PR mergiate in 30 g)

Descrizione

The trait ParamsSpec could also contain the following:

def name: String

being name the requested query parameter field name. This would be very useful for us because we want to override the parameter directive adding some extra action (adding an attribute to the HttpRequest to keep track of consumed query parameters):

  private val atKey: AttributeKey[Set[String]] = AttributeKey("allowed-query-params")

  private def trackQueryParam(name: String): Directive0 =
    optionalAttribute(atKey).flatMap { paramsOpt =>
      mapRequest(addAttribute(atKey, paramsOpt.fold(Set(name))(_ + name)))
    }

def param(pdef1: ParamSpec): Directive[Tuple1[pdef1.Out]] =
    Directives.parameter(pdef1.name) & trackQueryParam(pdef1.name)

Since the field name is not currently accessible from ParamSpec we have to do some ugly work around to make that work currently.

Guida contributor