Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[service-bus] Updating receiveMessagesStreaming sample to showcase proper error handling #12111

Merged
merged 18 commits into from
Oct 29, 2020
Merged

[service-bus] Updating receiveMessagesStreaming sample to showcase proper error handling #12111

merged 18 commits into from
Oct 29, 2020

Conversation

richardpark-msft
Copy link
Member

@richardpark-msft richardpark-msft commented Oct 28, 2020 •
edited
Loading

As part of our changes to make the subscribe() internals more robust (and more forgiving of errors) we need to update our sample.

The sample should now show how to handle errors, since we've now returned control to the user as to what is considered fatal.

Some other changes:

  • I've also updated the isMessagingError and MessagingError definitions to make it simpler to get good type checking on the constants while still being backwards compatible for users that were already referencing MessagingError (isMessagingError, being new, does not have this constraint)
  • Quite a few of our samples were actually broken so those have also been updated.

Fixes #12051, #8653, #7905

@richardpark-msft
- Fixing the samples so they're correct with the current preview API
6351a1d 
- Syncing the javascript and typescript samples so they have 99% of the same formatting to make the next sync easier.
@richardpark-msft
Some quality of life changes for those using MessagingError.
e43c60a 
1. Make it so you can narrow the type ofr 'code' so you can get useful autocomplete information.

By default `isMessagingError` (which is new to this release) returns MessagingError's that are strictly typed (with an option to get the more loosely typed version that takes a 'string' for the .code field).

MessagingError itself (when no type parameter is specified) defaults to what it was previously - just a string.

So this change should be backwards compatible.

2. I've added in proper doc comments for the various error codes and alphabetized them. There's a _lot_ but at least this makes it easier to scan and find the one you want. Our samples in ServiceBus will clarify which of these codes are likely to be relevant for most users.
@richardpark-msft
Reformatting the codes so they're alphabetical in the jsdoc comment a…
f3eeb4f 
…nd the underlying defined string union as well.
@richardpark-msft
- Updating sample to show how to handle errors.
334d4c7 
- api file needed updating since I rearranged the members of the string union.
@richardpark-msft
Copy link
Member Author

@HarshaNalluru , @ramya-rao-a - JavaScript receiveStreamingMessages sample to come after we finish reviewing the typescript version. (also, still testing but wanted to see if the structure of the sample made sense).

@richardpark-msft
Increasing the wait time a bit to make it more interesting.
337bf69 
Adding in some more comment text to illustrate where you can turn off autocomplete.
@richardpark-msft
Updating from typescript
4b9a30d
@HarshaNalluru HarshaNalluru mentioned this pull request Oct 29, 2020
Closed
@ramya-rao-a
Copy link
Contributor

/azp run js - core - ci

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@richardpark-msft richardpark-msft merged commit 88ae7db into Azure:master Oct 29, 2020
@richardpark-msft richardpark-msft deleted the richardpark-sb-foreverloop branch October 29, 2020 20:56
@ramya-rao-a ramya-rao-a mentioned this pull request Oct 29, 2020
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@HarshaNalluru HarshaNalluru HarshaNalluru approved these changes

@ramya-rao-a ramya-rao-a ramya-rao-a approved these changes

@bterlson bterlson Awaiting requested review from bterlson

@chradek chradek Awaiting requested review from chradek

@xirzec xirzec Awaiting requested review from xirzec

Assignees
No one assigned
Labels
Azure.Core Service Bus
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Azure Service Bus Samples Issues
4 participants
@richardpark-msft @ramya-rao-a @bterlson @HarshaNalluru