Skip to content

Commit

Permalink
Fix: Binary WebSocketFrame (#1005)
Browse files Browse the repository at this point in the history
* fix: change binary websocket frame arg to Chunk[Byte] from ByteBuf
Closes #1004

* test: add unit test for binary websocketframe

* style: fix formatting

(cherry picked from commit 0946576)
  • Loading branch information
girdharshubham committed Feb 16, 2022
1 parent b9527a4 commit 934d3ce
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 10 deletions.
17 changes: 9 additions & 8 deletions zio-http/src/main/scala/zhttp/socket/WebSocketFrame.scala
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
package zhttp.socket

import io.netty.buffer.ByteBuf
import io.netty.buffer.{ByteBuf, ByteBufUtil, Unpooled}
import io.netty.handler.codec.http.websocketx.{WebSocketFrame => JWebSocketFrame, _}
import zio.Chunk

sealed trait WebSocketFrame extends Product with Serializable { self =>
final def toWebSocketFrame: JWebSocketFrame = WebSocketFrame.toJFrame(self)
Expand All @@ -10,13 +11,13 @@ sealed trait WebSocketFrame extends Product with Serializable { self =>

object WebSocketFrame {

case class Binary(buffer: ByteBuf) extends WebSocketFrame { override val isFinal: Boolean = true }
case class Binary(bytes: Chunk[Byte]) extends WebSocketFrame { override val isFinal: Boolean = true }
object Binary {
def apply(buffer: ByteBuf, isFinal: Boolean): Binary = {
def apply(bytes: Chunk[Byte], isFinal: Boolean): Binary = {
val arg = isFinal
new Binary(buffer) { override val isFinal: Boolean = arg }
new Binary(bytes) { override val isFinal: Boolean = arg }
}
def unapply(frame: WebSocketFrame.Binary): Option[ByteBuf] = Some(frame.buffer)
def unapply(frame: WebSocketFrame.Binary): Option[Chunk[Byte]] = Some(frame.bytes)
}

case class Text(text: String) extends WebSocketFrame { override val isFinal: Boolean = true }
Expand Down Expand Up @@ -48,7 +49,7 @@ object WebSocketFrame {
def close(status: Int, reason: Option[String] = None): WebSocketFrame =
WebSocketFrame.Close(status, reason)

def binary(chunks: ByteBuf): WebSocketFrame = WebSocketFrame.Binary(chunks)
def binary(bytes: Chunk[Byte]): WebSocketFrame = WebSocketFrame.Binary(bytes)

def ping: WebSocketFrame = WebSocketFrame.Ping

Expand All @@ -63,7 +64,7 @@ object WebSocketFrame {
case _: PongWebSocketFrame =>
Option(Pong)
case m: BinaryWebSocketFrame =>
Option(Binary((m.content()), m.isFinalFragment))
Option(Binary(Chunk.fromArray(ByteBufUtil.getBytes(m.content())), m.isFinalFragment))
case m: TextWebSocketFrame =>
Option(Text(m.text(), m.isFinalFragment))
case m: CloseWebSocketFrame =>
Expand All @@ -77,7 +78,7 @@ object WebSocketFrame {
def toJFrame(frame: WebSocketFrame): JWebSocketFrame =
frame match {
case b: Binary =>
new BinaryWebSocketFrame(b.isFinal, 0, b.buffer)
new BinaryWebSocketFrame(b.isFinal, 0, Unpooled.wrappedBuffer(b.bytes.toArray))
case t: Text =>
new TextWebSocketFrame(t.isFinal, 0, t.text)
case Close(status, Some(text)) =>
Expand Down
18 changes: 16 additions & 2 deletions zio-http/src/test/scala/zhttp/service/WebSocketServerSpec.scala
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import zhttp.internal.{DynamicServer, HttpRunnableSpec}
import zhttp.service.server._
import zhttp.socket.{Socket, WebSocketFrame}
import zio._
import zio.stream.ZStream
import zio.test.Assertion.equalTo
import zio.test.TestAspect.timeout
import zio.test._
Expand All @@ -16,10 +17,10 @@ object WebSocketServerSpec extends HttpRunnableSpec {
private val app = serve { DynamicServer.app }

override def spec = suite("Server") {
app.as(List(websocketSpec)).useNow
app.as(List(websocketServerSpec, websocketFrameSpec)).useNow
}.provideCustomLayerShared(env) @@ timeout(10 seconds)

def websocketSpec = suite("WebSocket Server") {
def websocketServerSpec = suite("WebSocketServer") {
suite("connections") {
test("Multiple websocket upgrades") {
val app = Socket.succeed(WebSocketFrame.text("BAR")).toHttp.deployWS
Expand All @@ -31,4 +32,17 @@ object WebSocketServerSpec extends HttpRunnableSpec {
}
}
}

def websocketFrameSpec = suite("WebSocketFrameSpec") {
test("binary") {
val socket = Socket.collect[WebSocketFrame] { case WebSocketFrame.Binary(buffer) =>
ZStream.succeed(WebSocketFrame.Binary(buffer))
}

val app = socket.toHttp.deployWS
val open = Socket.succeed(WebSocketFrame.binary(Chunk.fromArray("Hello, World".getBytes)))

assertM(app(socket.toSocketApp.onOpen(open)).map(_.status))(equalTo(Status.SWITCHING_PROTOCOLS))
}
}
}

0 comments on commit 934d3ce

Please sign in to comment.