rsocket / rsocket-kotlin

RSocket Kotlin multi-platform implementation
http://rsocket.io
Apache License 2.0
552 stars 37 forks source link

metadata not properly encoded when sending requestStream with BearerAuthMetadata(jwt) #234

Open kumaraish opened 1 year ago

kumaraish commented 1 year ago

metadata in REQUEST_STREAM is not properly encoded when compositeMetadata is used and it includes both RoutingMetadata and BearerAuthMetadata

Expected Behavior

The following requestStream should be accepted by the Spring Boot Rsocket Server

scope.launch {
  rsocket
  .requestStream(
    buildPayload {
      data(ByteReadPacket(clientId.toByteArray())) // clientid is 1523ad4b-5035-4791-a788-3268a98e296a
      compositeMetadata {
        add(RoutingMetadata("api.v1.authenticate"))
        add(BearerAuthMetadata(jwt))  // jwt is a 1192 characters long token
      }
    }
  )
  .catch { console.log("Exception ${it.message}") }   // 'metadata is malformed'
  .onEach { handler(it) }
  .launchIn(this)
}

The exact same code works when sending a requestResponse() frame

In the Setup Frame, payload MimeType is MessageRSocketCompositeMetadata. Setup frame doesn't sends any metadata

PayloadMimeType(
    data = WellKnownMimeType.ApplicationJson,
    metadata = WellKnownMimeType.MessageRSocketCompositeMetadata
  )

Actual Behavior

The Server returns ERROR frame with 'metadata is malformed'

Steps to Reproduce

Possible Solution

Your Environment

whyoleg commented 1 year ago

Hey!

Thx for the report, though it's hard to understand what is the issue on current moment. Can you please add frame logging on client or server side (via rsocket-java/rsocket-kotlin functionality) and post frame logs here (or via link to gist)? As for rsocket-kotlin (on client side) you will need to add loggerFactory = PrintLogger.withLevel(LoggingLevel.DEBUG) to connector configuration. f.e. if you are using ktor-client integration:

install(RSocketSupport) {
  connector {
    loggerFactory = PrintLogger.withLevel(LoggingLevel.DEBUG)
  }
}

Also, do you have some custom client / server configuration regarding fragmentation, like maxFragmentSize in rsocket-kotlin?

kumaraish commented 1 year ago

You are so correct !! I had maxFragmentSize = 1024 set in rsocket-kotlin If I remove that, that error is gone...

I had copied it right from the //create ktor client example on https://github.com/rsocket/rsocket-kotlin

Is using maxFragmentSize = 1024 an issue?

whyoleg commented 1 year ago

Good to hear that it solves issue on your side! Overall using maxFragmentSize should not cause any issues, but overall - stick with defaults unless needed :) Example in README just shows what is possible to configure, may be we need to cleanup it a bit to make it more robust.

Though, you report confirms that there is a bug somewhere in fragmentation logic inside rsocket-kotlin regarding handling of request stream/channel frames (likely because of additional initialRequest field, that could be handled differently). I believe rsocket-java implementation is correct, so I think that I will setup some cross-implementation testing in future (at least for fragmentation use case).