feat: #146 async send support #181
Conversation
| customData?: CustomData, | ||
| callback?: (err: Error | null) => void, | ||
| request?: RequestParams, | ||
| tags?: Tag[], | ||
| ): void { | ||
| const result = this.buildSendOptions( | ||
| exception, | ||
| customData, | ||
| callback, | ||
| request, | ||
| tags, |
There was a problem hiding this comment.
Removed all the unused parameters, although this would be out of scope for this PR
| this.send(err, customData || {}, requestParams, [ | ||
| "UnhandledException", | ||
| ]); | ||
| ]).catch((err) => { | ||
| console.log(`[Raygun] Failed to send Express error: ${err}`); | ||
| }); |
There was a problem hiding this comment.
This is internal to the express error handler.
| const send = (e) => | ||
| new Promise((resolve, reject) => { | ||
| raygunClient.send(e, null, (err, data) => { | ||
| if (err) { | ||
| reject(err); | ||
| } else { | ||
| resolve(data); | ||
| } | ||
| }); | ||
| }); | ||
|
|
||
| await send(new Error("offline error")); |
There was a problem hiding this comment.
this is no longer necessary, because now the raygunClient.send method is asynchronous
| @@ -27,7 +27,7 @@ test("send basic", {}, function (t) { | |||
| var client = new Raygun.Client().init({ | |||
| apiKey: API_KEY, | |||
| }); | |||
| client.send(new Error(), {}, function (response) { | |||
| client.sendWithCallback(new Error(), {}, function (response) { | |||
There was a problem hiding this comment.
The old raygun_send_test still uses the legacy sendWithCallback method, this test fine can be removed when the sendWithCallback method is finally removed.
miquelbeltran
changed the title
miquelbeltran
requested review from
a team,
TheRealAgentK and
PanosNB
and removed request for
a team
Co-authored-by: Sumitra Manga <[email protected]>
|
I need a new review... 🙃 The tickets have been created, I'll edit them with some extra info. |
|
What's the ETA on getting this merged and released? I'm super keen to try it out and get it hooked into Winston as a custom transport. |
|
Hi @paul-uz we are talking internally that we want to do a pre-release with these changes once they are merged in. I'll try to remember to ping you when we have it ready, and be looking forward to your feedback! |
|
Please do what you can to extradite this ✌️ |
|
Just double checking - Did you turn all to do's into an Issue? |
yes, I did! |
|
@miquelbeltran how long until a new release version is out? |
feat: #146 async send support
Description 📝
sendAPI methodsendassendWithCallbackand create a newsendasync method..send()does not with without async/await. #141Note: the client requires a major clean-up to fully remove all callbacks from the internal implementation. This will be done in separated PRs after this one.
Type of change
Updates
sendwith a callback was renamed tosendWithCallback, it is still being used internally, so it was hard to fully remove the existing callback parameter without doing a major package rewrite.sendmethod that supports awaited calls.Promisethat can be anIncomingMessage. Users can ignore this response if they want, or used to verify that the error was sent correctly to Raygun.Promisewill be "rejected", users can catch this error. The error payload can be eitherError & IncomingMessageor justError.Promiseconstructor, wrapping the legacysendWithCallbackmethod.Other changes:
sendimplementations, they still use callbacks internally, and will require a lot of work to clean up. This work should be done in small batches split in several PRs.README.mdwith usage examples.examples/using-domains.send()method directly.Test plan 🧪
raygun_send_testbut for asyncsendcalls.examples/using-domains, which now uses the asyncsendmethod.Author to check 👓
Reviewer to check ✔️