Skip to content
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

Jump to bottom

Added getAs for QueryParams - errors enhancement #2510

Merged
merged 2 commits into from
Nov 8, 2023
Merged

Added getAs for QueryParams - errors enhancement #2510

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
cd86564
Added getAs for QueryParams - errors enhancement
BanyMaciej Nov 7, 2023
e5544cc
Added getAs for QueryParams - amendments
BanyMaciej Nov 8, 2023
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
23 changes: 10 additions & 13 deletions zio-http/src/main/scala/zio/http/QueryParams.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ package zio.http

import java.nio.charset.Charset

import zio.{Chunk, IO, ZIO}
import zio.{Chunk, IO, NonEmptyChunk, ZIO}

import zio.http.codec.TextCodec
import zio.http.internal.QueryParamEncoding
Expand Down Expand Up @@ -91,17 +91,14 @@ final case class QueryParams(map: Map[String, Chunk[String]]) {
/**
* Retrieves all typed query parameter values having the specified name.
*/
def getAllAs[A](key: String)(implicit codec: TextCodec[A]): Either[QueryParamsError, Chunk[A]] =
map.get(key) match {
case Some(params) =>
params
.map(param => codec.decode(param).toRight(QueryParamsError.Malformed(key, param, codec)))
.partitionMap(identity) match {
case (errors, _) if errors.nonEmpty => Left(QueryParamsError.MultiMalformed(errors))
case (_, typedParams) => Right(typedParams)
}
case None => Left(QueryParamsError.Missing(key))
}
def getAllAs[A](key: String)(implicit codec: TextCodec[A]): Either[QueryParamsError, Chunk[A]] = for {
params <- map.get(key).toRight(QueryParamsError.Missing(key))
(failed, typed) = params.partitionMap(p => codec.decode(p).toRight(p))
result <- NonEmptyChunk
.fromChunk(failed)
.map(fails => QueryParamsError.Malformed(key, codec, fails))
.toLeft(typed)
} yield result

/**
* Retrieves all typed query parameter values having the specified name as
Expand All @@ -120,7 +117,7 @@ final case class QueryParams(map: Map[String, Chunk[String]]) {
*/
def getAs[A](key: String)(implicit codec: TextCodec[A]): Either[QueryParamsError, A] = for {
param <- get(key).toRight(QueryParamsError.Missing(key))
typedParam <- codec.decode(param).toRight(QueryParamsError.Malformed(key, param, codec))
typedParam <- codec.decode(param).toRight(QueryParamsError.Malformed(key, codec, NonEmptyChunk(param)))
} yield typedParam

/**
Expand Down
16 changes: 7 additions & 9 deletions zio-http/src/main/scala/zio/http/QueryParamsError.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import java.nio.charset.Charset

import scala.util.control.NoStackTrace

import zio.Chunk
import zio.{Chunk, NonEmptyChunk}

import zio.http.codec.TextCodec
import zio.http.internal.QueryParamEncoding
Expand All @@ -30,15 +30,13 @@ sealed trait QueryParamsError extends Exception with NoStackTrace {
def message: String
}
object QueryParamsError {
final case class Missing(queryParamName: String) extends QueryParamsError {
def message = s"Missing query parameter with name $queryParamName"
final case class Missing(name: String) extends QueryParamsError {
def message = s"Missing query parameter with name $name"
}

final case class Malformed(name: String, value: String, codec: TextCodec[_]) extends QueryParamsError {
def message = s"Unable to decode query parameter with name $name and value $value using $codec"
}

final case class MultiMalformed(chunk: Chunk[Malformed]) extends QueryParamsError {
def message: String = chunk.map(_.getMessage()).mkString("; ")
final case class Malformed(name: String, codec: TextCodec[_], values: NonEmptyChunk[String])
extends QueryParamsError {
def message: String =
s"Unable to decode query parameter $name with values [ ${values.mkString(", ")} ] using ${codec.describe} codec"
}
}
Loading