[ServiceBus] Add optional boolean skipParsingBodyAsJson option
#18692
Conversation
to `ReceiveMessagesOptions`, `SubscribeOptions`, and `ServiceBusSessionReceiverOptions`. This allows users to control whether the SDK should skip parsing message body as Json object. By default the SDK will attempt parsing message body as Json object. While updating code, I also fixed sample unit test which is using out-dated paths thus not finding any sample code files, and removed two `await` that are redundant. Resolves Azure#18630
jeremymeng
requested review from
bterlson,
deyaaeldeen,
HarshaNalluru,
ramya-rao-a,
richardpark-msft and
xirzec
as code owners
ghost
added
the
|
I wonder whether we should make this a property of ServiceBusClientOptions instead |
|
API changes have been detected in API changes + skipParsingBodyAsJson?: boolean;
+ skipParsingBodyAsJson?: boolean;
+ skipParsingBodyAsJson?: boolean; |
|
/azp run js - service-bus - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Since it only applies to receiving side, I wouldnt put it in the ServiceBusclientOptions. |
to `ServiceBusReceiverOptions` and remove those on `ReceiveMessagesOptions` and `SubscribeOptions`
yeah that makes more sense! Updated in last commit |
|
API changes have been detected in API changes + skipParsingBodyAsJson?: boolean;
+ skipParsingBodyAsJson?: boolean; |
| // this.body = undefined; | ||
| // } | ||
| // } | ||
| // why above when `fromRheaMessage()` already called `defaultDataTransformer.decodeWithType()` earlier on message body |
There was a problem hiding this comment.
Can you sync with @richardpark-msft about this?
There was a problem hiding this comment.
Discussed with @richardpark-msft and we agreed that this code was doing double-decoding. So deleting.
but the message body is already decoded, and _rawAmqpMessage is assigned in `fromRheaMessage()`
|
/azp run js - service-bus - tests |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
|
||
| message.body = defaultDataTransformer.decode(message.body); | ||
| message.body = defaultDataTransformer.decode( |
There was a problem hiding this comment.
I know this is existing code, but can you check if we even need this step? Shouldnt fromRheaMessage() already call defaultDataTransformer.decode() ?
There was a problem hiding this comment.
On second thought, it feels like we should not have this option for management client, and should always either try or skip?
message.body has been decoded already above by `fromRheaMessage()` call.
…o sb/option-skip-json-parsing
|
API changes have been detected in API changes + skipParsingBodyAsJson?: boolean;
+ skipParsingBodyAsJson?: boolean; |
Co-authored-by: Deyaaeldeen Almahallawi <[email protected]>
Update changes.json (Azure#18692)
Update changes.json (Azure#18692)
Update changes.json (Azure#18692)
Update changes.json (Azure#18692)
Update changes.json (Azure#18692)
Update changes.json (Azure#18692)
Update changes.json (Azure#18692)
Update changes.json (Azure#18692)
to
ServiceBusReceiverOptionsandServiceBusSessionReceiverOptions. This allows users to controlwhether the SDK should skip parsing message body as Json object. By
default, the SDK will attempt parsing message body as Json object.
While updating code, I also fixed sample unit test which is using
out-dated paths thus not finding any sample code files, and removed
two
awaitthat are redundant.Resolves #18630