WebSocketClient channels do not expose full error payload

[prodderman]

Hi,

It appears that when a channel receives an error, the error object passed to listeners does not include the full payload returned by the server.

Setup:

const client = new DXLinkWebSocketClient({})
client.setAuthToken('token')
client.connect('url')
const channel = client.openChannel('SERVICE', {})
channel.addErrorListener((error) => console.log(error))

// send invalid message
channel.addStateChangeListener((state) => {
      if (state === DXLinkChannelState.OPENED) {
        channel.send({
          type: 'MESSAGE_TYPE',
          channel: channel.id,
          invalidField: 'invalid'
     })
  }
})

Observed behavior:

The error received in the listener is:

{ "type": "INVALID_MESSAGE", "message": "Some text" }

Expected behavior:

The full error payload returned by the server should be exposed to the listener, for example:

{
  "type": "ERROR",
  "channel": 1,
  "error": "INVALID_MESSAGE",
  "message": "Some text",
  "correlationId": "228"
}

The additional fields are important for proper error handling.
Thanks!

[antonio-pedro99]

Hi @prodderman, that's not part of the dxlink protocol. The full payload returned by the server on any error looks something like this

[prodderman]

I understand but I cannot get this full payload because of client

[antonio-pedro99]

I understand but I cannot get this full payload because of client

I do not think there's a way to get the "correlationId": "228"field. Isn't?

[prodderman]

@antonio-pedro99 It does not matter what the shape of the message. The problem is that the error handler doesn't provide whole message, just two fields "type" and "message" and omits any other fields.

It happens here

dxLink/dxlink-javascript/dxlink-websocket-client/src/client.ts

Lines 336 to 340 in f030277

	case 'ERROR':
	return this.publishError({
	type: message.error,
	message: message.message,
	})

[antonio-pedro99]

I know where it happens. I thought you wanted the correlationId field too. That's why I had to point that out.