Inconsistent structure of error messages in EventBusBridge

[EmadAlblueshi]

IMHO the structure for the type of error messages should be consistent. The following illustrates inconsistency

https://github.com/vert-x3/vertx-web/blob/1cd9a5cd2f98ffc59ea600326b34e8a696ef460d/vertx-web/src/main/java/io/vertx/ext/web/handler/sockjs/impl/EventBusBridgeImpl.java#L339

https://github.com/vert-x3/vertx-web/blob/1cd9a5cd2f98ffc59ea600326b34e8a696ef460d/vertx-web/src/main/java/io/vertx/ext/web/handler/sockjs/impl/EventBusBridgeImpl.java#L494

https://github.com/vert-x3/vertx-web/blob/1cd9a5cd2f98ffc59ea600326b34e8a696ef460d/vertx-web/src/main/java/io/vertx/ext/web/handler/sockjs/impl/EventBusBridgeImpl.java#L594

Currently, sometimes the content of the error message inside "body" and sometimes inside "message" and we should have unified structure for the type of error messages.

[tsegismont]

@EmadAlblueshi any proposal to make in this regard? Always use JSON?

[EmadAlblueshi]

Hi @tsegismont

Any error message should be as follows :

{
  "type" : "err",
  "failureType" : "[the exception name like 'socketexception']",
  "message" : "[the message content as 'String']"
}

The above currently implemented but in the EventBusBridge implementation there are "some" error messages as follows :

{
  "type" : "err",
  "body" : "[the message content as 'String']"
}

My proposal is to unify the first structure in all error messages.

[EmadAlblueshi]

@tsegismont In addition, this should be done to vertx-eventbus.js too.

[tsegismont]

Would you mind contributing this?

[EmadAlblueshi]

Hi @tsegismont

Sure, by next week and this would be planned for Vert.x 5 only as @vietj said because in 4.x it will be a breaking change.

In addition, we should review the existing behavior too probably needs some enhancements if needed.

[tsegismont]

If you can do it early next week it should be fine, we are waiting for a new Netty 4.2 candidate release

[EmadAlblueshi]

@tsegismont I will do my best!