Skip to content

remove deprecated parameters directive #764

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 12, 2025
Merged

remove deprecated parameters directive #764

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3b60c96
remove deprecated parameters directive
pjfanning Sep 12, 2025
d642aca
Update remove-deprecated-methods.excludes
pjfanning Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions http/src/main/mima-filters/2.0.x.backwards.excludes/remove-deprecated-methods.excludes
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,19 @@ ProblemFilters.exclude[DirectMissingMethodProblem]("org.apache.pekko.http.scalad
ProblemFilters.exclude[MissingClassProblem]("org.apache.pekko.http.scaladsl.server.LowerPriorityRouteResultImplicits")
ProblemFilters.exclude[DirectMissingMethodProblem]("org.apache.pekko.http.scaladsl.server.RouteResult.routeToFlowViaMaterializer")
ProblemFilters.exclude[MissingTypesProblem]("org.apache.pekko.http.scaladsl.server.RouteResult$")
ProblemFilters.exclude[DirectMissingMethodProblem]("org.apache.pekko.http.scaladsl.server.Directives.parameter")
ProblemFilters.exclude[DirectMissingMethodProblem]("org.apache.pekko.http.scaladsl.server.Directives.parameters")
ProblemFilters.exclude[DirectMissingMethodProblem]("org.apache.pekko.http.scaladsl.server.HttpApp.parameter")
ProblemFilters.exclude[DirectMissingMethodProblem]("org.apache.pekko.http.scaladsl.server.HttpApp.parameters")
ProblemFilters.exclude[DirectMissingMethodProblem]("org.apache.pekko.http.scaladsl.server.directives.ParameterDirectives.parameter")
ProblemFilters.exclude[DirectMissingMethodProblem]("org.apache.pekko.http.scaladsl.server.directives.ParameterDirectives.parameters")
ProblemFilters.exclude[MissingClassProblem]("org.apache.pekko.http.scaladsl.server.directives.ParameterDirectives$ParamDef")
ProblemFilters.exclude[MissingClassProblem]("org.apache.pekko.http.scaladsl.server.directives.ParameterDirectives$ParamDef$")
ProblemFilters.exclude[MissingClassProblem]("org.apache.pekko.http.scaladsl.server.directives.ParameterDirectives$ParamDef$ConvertParamDefAndConcatenate$")
ProblemFilters.exclude[MissingClassProblem]("org.apache.pekko.http.scaladsl.server.directives.ParameterDirectives$ParamMagnet")
ProblemFilters.exclude[MissingClassProblem]("org.apache.pekko.http.scaladsl.server.directives.ParameterDirectives$ParamMagnet$")
ProblemFilters.exclude[MissingFieldProblem]("org.apache.pekko.http.scaladsl.server.directives.ParameterDirectives.ParamMagnet")
ProblemFilters.exclude[MissingFieldProblem]("org.apache.pekko.http.scaladsl.server.directives.ParameterDirectives.ParamDef")
ProblemFilters.exclude[DirectMissingMethodProblem]("org.apache.pekko.http.scaladsl.server.directives.FormFieldDirectives.formField")
ProblemFilters.exclude[DirectMissingMethodProblem]("org.apache.pekko.http.scaladsl.server.directives.FormFieldDirectives.formFields")
ProblemFilters.exclude[MissingClassProblem]("org.apache.pekko.http.scaladsl.server.directives.FormFieldDirectives$FieldMagnet")
Expand Down
110 changes: 0 additions & 110 deletions ...src/main/scala/org/apache/pekko/http/scaladsl/server/directives/ParameterDirectives.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,26 +48,6 @@ trait ParameterDirectives extends ParameterDirectivesInstances with ToNameRecept
* @group param
*/
def parameterSeq: Directive1[immutable.Seq[(String, String)]] = _parameterSeq

/**
* Extracts a query parameter value from the request.
* Rejects the request if the defined query parameter matcher(s) don't match.
*
* @group param
*/
@deprecated("Use new `parameters` overloads with ParamSpec parameters. Kept for binary compatibility",
"Akka HTTP 10.2.0")
private[http] def parameter(pdm: ParamMagnet): pdm.Out = pdm()

/**
* Extracts a number of query parameter values from the request.
* Rejects the request if the defined query parameter matcher(s) don't match.
*
* @group param
*/
@deprecated("Use new `parameters` overloads with ParamSpec parameters. Kept for binary compatibility",
"Akka HTTP 10.2.0")
private[http] def parameters(pdm: ParamMagnet): pdm.Out = pdm()
}

object ParameterDirectives extends ParameterDirectives {
Expand Down Expand Up @@ -130,96 +110,6 @@ object ParameterDirectives extends ParameterDirectives {
ParamSpec(requiredFilter(name, fsu, requiredValue).tmap(_ => Tuple1(())))
}

@deprecated("Use new `parameters` overloads with ParamSpec parameters. Kept for binary compatibility",
"Akka HTTP 10.2.0")
sealed trait ParamMagnet {
type Out
def apply(): Out
}
@deprecated("Use new `parameters` overloads with ParamSpec parameters. Kept for binary compatibility",
"Akka HTTP 10.2.0")
object ParamMagnet {
def apply[T](value: T)(implicit pdef: ParamDef[T]): ParamMagnet { type Out = pdef.Out } =
new ParamMagnet {
type Out = pdef.Out
def apply() = pdef(value)
}
}

@deprecated("Use new `parameters` overloads with ParamSpec parameters. Kept for binary compatibility",
"Akka HTTP 10.2.0")
type ParamDefAux[T, U] = ParamDef[T] { type Out = U }
@deprecated("Use new `parameters` overloads with ParamSpec parameters. Kept for binary compatibility",
"Akka HTTP 10.2.0")
sealed trait ParamDef[T] {
type Out
def apply(value: T): Out
}
@deprecated("Use new `parameters` overloads with ParamSpec parameters. Kept for binary compatibility",
"Akka HTTP 10.2.0")
object ParamDef {
import Impl._
import pekko.http.scaladsl.unmarshalling.{ FromStringUnmarshaller => FSU }

def paramDef[A, B](f: A => B): ParamDefAux[A, B] =
new ParamDef[A] {
type Out = B
def apply(value: A) = f(value)
}
def extractParameter[A, B](f: A => Directive1[B]): ParamDefAux[A, Directive1[B]] = paramDef(f)

def forString(implicit fsu: FSU[String]): ParamDefAux[String, Directive1[String]] =
extractParameter[String, String] { string => filter(string, fsu) }
def forSymbol(implicit fsu: FSU[String]): ParamDefAux[Symbol, Directive1[String]] =
extractParameter[Symbol, String] { symbol => filter(symbol.name, fsu) }
def forNR[T](implicit fsu: FSU[T]): ParamDefAux[NameReceptacle[T], Directive1[T]] =
extractParameter[NameReceptacle[T], T] { nr => filter(nr.name, fsu) }
def forNUR[T]: ParamDefAux[NameUnmarshallerReceptacle[T], Directive1[T]] =
extractParameter[NameUnmarshallerReceptacle[T], T] { nr => filter(nr.name, nr.um) }
def forNOR[T](implicit fsou: FSOU[T]): ParamDefAux[NameOptionReceptacle[T], Directive1[Option[T]]] =
extractParameter[NameOptionReceptacle[T], Option[T]] { nr => filter[Option[T]](nr.name, fsou) }
def forNDR[T](implicit fsou: FSOU[T]): ParamDefAux[NameDefaultReceptacle[T], Directive1[T]] =
extractParameter[NameDefaultReceptacle[T], T] { nr => filter[T](nr.name, fsou.withDefaultValue(nr.default)) }
def forNOUR[T]: ParamDefAux[NameOptionUnmarshallerReceptacle[T], Directive1[Option[T]]] =
extractParameter[NameOptionUnmarshallerReceptacle[T], Option[T]] { nr => filter(nr.name, nr.um: FSOU[T]) }
def forNDUR[T]: ParamDefAux[NameDefaultUnmarshallerReceptacle[T], Directive1[T]] =
extractParameter[NameDefaultUnmarshallerReceptacle[T], T] { nr =>
filter[T](nr.name, (nr.um: FSOU[T]).withDefaultValue(nr.default))
}

//////////////////// required parameter support ////////////////////

def forRVR[T](implicit fsu: FSU[T]): ParamDefAux[RequiredValueReceptacle[T], Directive0] =
paramDef[RequiredValueReceptacle[T], Directive0] { rvr => requiredFilter(rvr.name, fsu, rvr.requiredValue) }
def forRVDR[T]: ParamDefAux[RequiredValueUnmarshallerReceptacle[T], Directive0] =
paramDef[RequiredValueUnmarshallerReceptacle[T], Directive0] { rvr =>
requiredFilter(rvr.name, rvr.um, rvr.requiredValue)
}

//////////////////// repeated parameter support ////////////////////

def forRepVR[T](implicit fsu: FSU[T]): ParamDefAux[RepeatedValueReceptacle[T], Directive1[Iterable[T]]] =
extractParameter[RepeatedValueReceptacle[T], Iterable[T]] { rvr => repeatedFilter(rvr.name, fsu) }
def forRepVDR[T]: ParamDefAux[RepeatedValueUnmarshallerReceptacle[T], Directive1[Iterable[T]]] =
extractParameter[RepeatedValueUnmarshallerReceptacle[T], Iterable[T]] { rvr => repeatedFilter(rvr.name, rvr.um) }

//////////////////// tuple support ////////////////////

import pekko.http.scaladsl.server.util.TupleOps._
import pekko.http.scaladsl.server.util.BinaryPolyFunc

// not implicit any more
private[http] def forTuple[T](
implicit fold: FoldLeft[Directive0, T, ConvertParamDefAndConcatenate.type]): ParamDefAux[T, fold.Out] =
paramDef[T, fold.Out](fold(BasicDirectives.pass, _))

object ConvertParamDefAndConcatenate extends BinaryPolyFunc {
implicit def from[P, TA, TB](implicit pdef: ParamDef[P] { type Out = Directive[TB] }, ev: Join[TA, TB])
: BinaryPolyFunc.Case[Directive[TA], P, ConvertParamDefAndConcatenate.type] { type Out = Directive[ev.Out] } =
at[Directive[TA], P] { (a, t) => a & pdef(t) }
}
}

/** Actual directive implementations shared between old and new API */
private object Impl {
import BasicDirectives._
Expand Down
Loading