Compatibility with play-socket.io

mrwillis · 2018-05-20 22:46:08 UTC

Hi,

I am wondering if this library would be compatible with the play-socket.io project. It seems like it would work in theory by injecting the silhouette environment into the engine, but I can’t really tell. Does anyone have any experience with this? Here’s a link to the project:

And the relevant authentication section:

github.com

playframework/play-socket.io/blob/master/docs/ScalaSocketIO.md#using-sessions

# Play socket.io Scala support

This describes the Play socket.io Scala support.

## Installing

You can add Play socket.io to your project by adding the following dependency:

```scala
libraryDependencies += "com.lightbend.play" %% "play-socket-io" % "1.0.0-beta-2"
```

## Understanding socket.io and engine.io

engine.io is a protocol for speaking between a client (typically a browser) and a server. It allows multiple transports, including XHR polling and WebSockets, it sends regular heartbeats using pings to ensure the liveness of the connection and detect failures, and it allows upgrading from one transport to another.

When you connect to a server using engine.io, you create a session, which is uniquely identified by a session id. Generally, any failures that happen result in the session terminating, for example, if the WebSocket becomes disconnected. The JavaScript engine.io client will handle creating a new session in that case, and will inform the client application that a reconnection has occurred, so the application can do any further work.

socket.io is a protocol on top of engine.io that allows multiple namespaces to be multiplexed in one engine.io session. This means if you have multiple concerns, you don't need to create multiple sessions (and consequently multiple WebSockets) to handle them.

This file has been truncated. show original

I guess the question boils down to I have a raw RequestHeader. How can I use that to manually authenticate with my silhouette environment? Happy to submit a PR to the docs if I can get this working.

Thanks!

mrwillis · 2018-05-20 23:59:56 UTC

It was actually quite easy. I simply followed the example in the WebSocket section of the official documentation and injected the silhouette environment into my engine provider. Here is my code for anyone interested:

@Singleton
class SocketIOEngineProvider @Inject()(socketIO: SocketIO,
                                       silhouette: Silhouette[DefaultEnv])(
    implicit mat: Materializer,
    ec: ExecutionContext)
    extends Provider[EngineIOController]
    with Logger {

  override lazy val get: EngineIOController =
    socketIO.builder
      .onConnectAsync { (request, _) =>
        {
          implicit val req: Request[AnyContentAsEmpty.type] =
            Request(request, AnyContentAsEmpty)
          silhouette
            .SecuredRequestHandler { securedRequest =>
              Future.successful(
                HandlerResult(Ok, Some(securedRequest.identity)))
            }
            .map {
              case HandlerResult(_, Some(user)) => Right(user)
              case HandlerResult(r, None) => Left(r)
            }
        }
      }
      .createController()
}

akkie · 2018-05-22 08:13:01 UTC

Would be great to have an example on https://www.silhouette.rocks/docs/endpoints#section-websockets

mrwillis · 2018-05-22 22:01:32 UTC

Hi Akkie,

I just submitting an example to the docs. Please review when you can.

Best,

Julian

akkie · 2018-05-24 09:43:57 UTC

Great, Thanks! I’ve merged it