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

Mark the loadXML call as blocking #28

Merged
merged 2 commits into from
Jun 12, 2022
Merged

Mark the loadXML call as blocking #28

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
f3f933e
Mark the loadXML call as blocking
rossabaker Jun 12, 2022
fa53611
Fix deprecated doc
rossabaker Jun 12, 2022
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
4 changes: 2 additions & 2 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ class JsonXmlHttpEndpoint[F[_]](implicit F: Async[F]) extends Http4sDsl[F] {
}

private def personXmlDecoder: EntityDecoder[F, Person] =
org.http4s.scalaxml.xml[F].map(Person.fromXml)
org.http4s.scalaxml.xmlDecoder[F].map(Person.fromXml)

implicit private def jsonXmlDecoder: EntityDecoder[F, Person] =
jsonOf[F, Person].orElse(personXmlDecoder)
Expand All @@ -55,4 +55,4 @@ class JsonXmlHttpEndpoint[F[_]](implicit F: Async[F]) extends Http4sDsl[F] {
}
}
}
```
```
27 changes: 26 additions & 1 deletion scala-xml/src/main/scala/org/http4s/scalaxml/ElemInstances.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@
package org.http4s
package scalaxml

import cats.data.EitherT
import cats.effect.Async
import cats.effect.Concurrent
import cats.syntax.all._
import org.http4s.Charset.`UTF-8`
import org.http4s.headers.`Content-Type`

Expand Down Expand Up @@ -49,7 +52,8 @@ trait ElemInstances {
*
* @return an XML element
*/
implicit def xml[F[_]](implicit F: Concurrent[F]): EntityDecoder[F, Elem] = {
@deprecated("Blocks. Use xmlDecoder with an Async constraint.", "0.23.12")
def xml[F[_]](implicit F: Concurrent[F]): EntityDecoder[F, Elem] = {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we care enough we can do a runtime check for Async to delegate to the new implementation.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That technique makes me squeamish, but we've adopted it enough other places and I've never seen an accident scene from it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops. I merged before resolving this. If we want, it could still be a separate PR.

import EntityDecoder._
decodeBy(MediaType.text.xml, MediaType.text.html, MediaType.application.xml) { msg =>
val source = new InputSource()
Expand All @@ -67,4 +71,25 @@ trait ElemInstances {
}
}
}

implicit def xmlDecoder[F[_]](implicit F: Async[F]): EntityDecoder[F, Elem] = {
import EntityDecoder._
decodeBy(MediaType.text.xml, MediaType.text.html, MediaType.application.xml) { msg =>
val source = new InputSource()
msg.charset.foreach(cs => source.setEncoding(cs.nioCharset.name))

collectBinary(msg).flatMap[DecodeFailure, Elem] { chunk =>
source.setByteStream(new ByteArrayInputStream(chunk.toArray))
Comment on lines +81 to +82
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could avoid this strictness by converting the fs2 stream to an InputStream. I think we'd spend CPU to save memory with that approach.

val saxParser = saxFactory.newSAXParser()
EitherT(
F.blocking(XML.loadXML(source, saxParser))
.map(Either.right[DecodeFailure, Elem](_))
.recover { case e: SAXParseException =>
Left(MalformedMessageBodyFailure("Invalid XML", Some(e)))
}
)
}
}
}

}