-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Migrate to Playframework 3 and Pekko (#435)
* Migrate to Playframework 3 * Minor changes * Fix compile
- Loading branch information
Showing
60 changed files
with
253 additions
and
3,646 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,201 @@ | ||
| /* | ||
| * Copyright (C) from 2022 The Play Framework Contributors <https://github.com/playframework>, 2011-2021 Lightbend Inc. <https://www.lightbend.com> | ||
| */ | ||
|
|
||
| package anorm | ||
|
|
||
| import java.sql.Connection | ||
| import scala.util.control.NonFatal | ||
| import scala.concurrent.{Future, Promise} | ||
| import org.apache.pekko.stream.scaladsl.Source | ||
|
|
||
| import scala.annotation.nowarn | ||
|
|
||
| /** Anorm companion for the Pekko Streams. | ||
| * | ||
| * @define materialization | ||
| * It materializes a [[scala.concurrent.Future]] of [[scala.Int]] containing the number of rows read from the source | ||
| * upon completion, and a possible exception if row parsing failed. | ||
| * @define sqlParam | ||
| * the SQL query | ||
| * @define connectionParam | ||
| * the JDBC connection, which must not be closed until the source is materialized. | ||
| * @define columnAliaserParam | ||
| * the column aliaser | ||
| */ | ||
| // From https://github.com/playframework/anorm/blob/main/pekko/src/main/scala/anorm/PekkoStream.scala | ||
| // We are copying this because the anorm.pekko isn't published yet | ||
| // TODO: remove after anorm.pekko is published | ||
| object PekkoStream { | ||
|
|
||
| /** Returns the rows parsed from the `sql` query as a reactive source. | ||
| * | ||
| * $materialization | ||
| * | ||
| * @tparam T | ||
| * the type of the result elements | ||
| * @param sql | ||
| * $sqlParam | ||
| * @param parser | ||
| * the result (row) parser | ||
| * @param as | ||
| * $columnAliaserParam | ||
| * @param connection | ||
| * $connectionParam | ||
| * | ||
| * {{{ | ||
| * import java.sql.Connection | ||
| * | ||
| * import scala.concurrent.Future | ||
| * | ||
| * import org.apache.pekko.stream.scaladsl.Source | ||
| * | ||
| * import anorm._ | ||
| * | ||
| * def resultSource(implicit con: Connection): Source[String, Future[Int]] = PekkoStream.source(SQL"SELECT * FROM Test", SqlParser.scalar[String], ColumnAliaser.empty) | ||
| * }}} | ||
| */ | ||
| @SuppressWarnings(Array("UnusedMethodParameter")) | ||
| def source[T](sql: => Sql, parser: RowParser[T], as: ColumnAliaser)(implicit | ||
| con: Connection | ||
| ): Source[T, Future[Int]] = Source.fromGraph(new ResultSource[T](con, sql, as, parser)) | ||
|
|
||
| /** Returns the rows parsed from the `sql` query as a reactive source. | ||
| * | ||
| * $materialization | ||
| * | ||
| * @tparam T | ||
| * the type of the result elements | ||
| * @param sql | ||
| * $sqlParam | ||
| * @param parser | ||
| * the result (row) parser | ||
| * @param connection | ||
| * $connectionParam | ||
| */ | ||
| @SuppressWarnings(Array("UnusedMethodParameter")) | ||
| def source[T](sql: => Sql, parser: RowParser[T])(implicit con: Connection): Source[T, Future[Int]] = | ||
| source[T](sql, parser, ColumnAliaser.empty) | ||
|
|
||
| /** Returns the result rows from the `sql` query as an enumerator. This is equivalent to `source[Row](sql, | ||
| * RowParser.successful, as)`. | ||
| * | ||
| * $materialization | ||
| * | ||
| * @param sql | ||
| * $sqlParam | ||
| * @param as | ||
| * $columnAliaserParam | ||
| * @param connection | ||
| * $connectionParam | ||
| */ | ||
| def source(sql: => Sql, as: ColumnAliaser)(implicit connection: Connection): Source[Row, Future[Int]] = | ||
| source(sql, RowParser.successful, as) | ||
|
|
||
| /** Returns the result rows from the `sql` query as an enumerator. This is equivalent to `source[Row](sql, | ||
| * RowParser.successful, ColumnAliaser.empty)`. | ||
| * | ||
| * $materialization | ||
| * | ||
| * @param sql | ||
| * $sqlParam | ||
| * @param connection | ||
| * $connectionParam | ||
| */ | ||
| def source(sql: => Sql)(implicit connnection: Connection): Source[Row, Future[Int]] = | ||
| source(sql, RowParser.successful, ColumnAliaser.empty) | ||
|
|
||
| // Internal stages | ||
|
|
||
| import org.apache.pekko.stream.stage.{GraphStageLogic, GraphStageWithMaterializedValue, OutHandler} | ||
| import org.apache.pekko.stream.{Attributes, Outlet, SourceShape} | ||
|
|
||
| import java.sql.ResultSet | ||
| import scala.util.{Failure, Success} | ||
|
|
||
| private[anorm] class ResultSource[T](connection: Connection, sql: Sql, as: ColumnAliaser, parser: RowParser[T]) | ||
| extends GraphStageWithMaterializedValue[SourceShape[T], Future[Int]] { | ||
|
|
||
| @SuppressWarnings(Array("org.wartremover.warts.Null")) | ||
| private[anorm] var resultSet: ResultSet = _ | ||
|
|
||
| override val toString = "AnormQueryResult" | ||
| val out: Outlet[T] = Outlet(s"${toString}.out") | ||
| val shape: SourceShape[T] = SourceShape(out) | ||
|
|
||
| override def createLogicAndMaterializedValue(inheritedAttributes: Attributes): (GraphStageLogic, Future[Int]) = { | ||
| val result = Promise[Int]() | ||
|
|
||
| val logic = new GraphStageLogic(shape) with OutHandler { | ||
| private var cursor: Option[Cursor] = None | ||
| private var counter: Int = 0 | ||
|
|
||
| private def failWith(cause: Throwable): Unit = { | ||
| result.failure(cause) | ||
| fail(out, cause) | ||
| () | ||
| } | ||
|
|
||
| override def preStart(): Unit = { | ||
| try { | ||
| resultSet = sql.unsafeResultSet(connection) | ||
| nextCursor() | ||
| } catch { | ||
| case NonFatal(cause) => failWith(cause) | ||
| } | ||
| } | ||
|
|
||
| override def postStop() = release() | ||
|
|
||
| private def release(): Unit = { | ||
| val stmt: Option[java.sql.Statement] = { | ||
| if (resultSet != null && !resultSet.isClosed) { | ||
| val s = resultSet.getStatement | ||
| resultSet.close() | ||
| Option(s) | ||
| } else None | ||
| } | ||
|
|
||
| stmt.foreach { s => | ||
| if (!s.isClosed) s.close() | ||
| } | ||
| } | ||
|
|
||
| private def nextCursor(): Unit = { | ||
| cursor = Sql.unsafeCursor(resultSet, sql.resultSetOnFirstRow, as) | ||
| } | ||
|
|
||
| def onPull(): Unit = cursor match { | ||
| case Some(c) => | ||
| c.row.as(parser) match { | ||
| case Success(parsed) => { | ||
| counter += 1 | ||
| push(out, parsed) | ||
| nextCursor() | ||
| } | ||
|
|
||
| case Failure(cause) => | ||
| failWith(cause) | ||
| } | ||
|
|
||
| case _ => { | ||
| result.success(counter) | ||
| complete(out) | ||
| } | ||
| } | ||
|
|
||
| @nowarn | ||
| override def onDownstreamFinish() = { | ||
| result.tryFailure(new InterruptedException("Downstream finished")) | ||
| release() | ||
| super.onDownstreamFinish() | ||
| } | ||
|
|
||
| setHandler(out, this) | ||
| } | ||
|
|
||
| logic -> result.future | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
8f7b8ceThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Preview ready at https://master.sssppa.wiringbits.dev