[CR-204] Have the SendingMessage event include the original exception by mduncan26 · Pull Request #434 · MindscapeHQ/raygun4net

mduncan26 · 2020-07-17T02:11:00Z

Update the SendingMessage event to include the original exception alongside the RaygunMessage object. This allows customers to perform further operations on the exception to extract contextual information only available on the exception.

Ticket: https://raygun.atlassian.net/browse/CR-204

…entArgs. Updated Raygun4Net4 to pass through original exception.

…eption, throughout raygun4net framework.

Ensure API backwards compatibility

Formatting

Ensure API backwards compatibility

Updating WinRT to allow exception obj during SendingMessage event

Must declare properties to build WindowsStore

Fix for Mindscape.Raygun4Net.NetCoreproject failing to load

Bump MVC provider version to 5.11.0

Give Raygun4Net.Core its own AssemblyVersion file.

Bump Raygun4Net.Core package to version 5.11.0

Bump raygun4net.core dependency version to 5.11.0

Bump versions to 5.11.0

Bump raygun4net provider version to 5.11.0

Separating Xamarin iOS from changes.

Separating Xamarin Android from changes.

Separating Xamarin Mac from changes.

samuel-holt

👍 This change seems straightforward, nice work

QuantumNightmare

I have pointed out some methods that now require the new Exception parameter as they don't specify a default value, and I believe this would cause a breaking change.

I'm also going to point out this somewhat related blog post around being careful when using optional parameters. It suggests that adding optional parameters to an existing method can cause runtime exceptions if an application has not been compiled, but has a new version of a client library that has added optional parameters to existing methods. I would expect applications to typically be compiled when upgrading to newer versions of client libraries though, so maybe it's not a concern for us.

QuantumNightmare · 2020-07-21T01:36:33Z

Mindscape.Raygun4Net.WebApi/RaygunWebApiClient.cs

    }
-    
+
    /// <summary>


This comment looks incorrect and could be deleted

QuantumNightmare · 2020-07-21T01:41:05Z

Mindscape.Raygun4Net.WinRT/RaygunClient.cs


    // Returns true if the message can be sent, false if the sending is canceled.
-    protected bool OnSendingMessage(RaygunMessage raygunMessage)
+    protected bool OnSendingMessage(RaygunMessage raygunMessage, Exception exception)


Do we want to give the exception parameter a default value of null here in case someone has an extension to this class and is calling this method?

QuantumNightmare · 2020-07-21T01:41:53Z

Mindscape.Raygun4Net.WindowsStore/RaygunClient.cs


    // Returns true if the message can be sent, false if the sending is canceled.
-    protected bool OnSendingMessage(RaygunMessage raygunMessage)
+    protected bool OnSendingMessage(RaygunMessage raygunMessage, Exception exception)


Do we want to give the exception parameter a default value of null here in case someone has an extension to this class and is calling this method?

QuantumNightmare · 2020-07-21T01:43:09Z

Mindscape.Raygun4Net.WindowsStore/RaygunClient.cs

    /// <param name="raygunMessage">The RaygunMessage to send. This needs its OccurredOn property
    /// set to a valid DateTime and as much of the Details property as is available.</param>
-    public async Task SendAsync(RaygunMessage raygunMessage)
+    public async Task SendAsync(RaygunMessage raygunMessage, Exception exception)


If the new exception parameter doesn't have a default value, couldn't this cause a breaking change?

QuantumNightmare · 2020-07-21T01:43:14Z

Mindscape.Raygun4Net.WindowsStore/RaygunClient.cs

    /// <param name="raygunMessage">The RaygunMessage to send. This needs its OccurredOn property
    /// set to a valid DateTime and as much of the Details property as is available.</param>
-    public void Send(RaygunMessage raygunMessage)
+    public void Send(RaygunMessage raygunMessage, Exception exception)


If the new exception parameter doesn't have a default value, couldn't this cause a breaking change?

QuantumNightmare · 2020-07-21T01:50:38Z

Mindscape.Raygun4Net/RaygunClient.cs

    /// set to a valid DateTime and as much of the Details property as is available.</param>
-    public void SendInBackground(RaygunMessage raygunMessage)
+    /// <param name="exception">The original exception that generated the RaygunMessage</param>
+    public void SendInBackground(RaygunMessage raygunMessage, Exception exception)


If the new exception parameter doesn't have a default value, couldn't this cause a breaking change?

QuantumNightmare · 2020-07-21T01:51:42Z

Mindscape.Raygun4Net/RaygunClientBase.cs


    // Returns true if the message can be sent, false if the sending is canceled.
-    protected bool OnSendingMessage(RaygunMessage raygunMessage)
+    protected bool OnSendingMessage(RaygunMessage raygunMessage, Exception exception)


Do we want to give the exception parameter a default value of null here in case someone has an extension to this class and is calling this method?

QuantumNightmare · 2020-07-21T01:53:09Z

Mindscape.Raygun4Net/RaygunSendingMessageEventArgs.cs

+    private RaygunMessage _raygunMessage;
+    private Exception _exception;
+
+    public RaygunSendingMessageEventArgs(RaygunMessage message, Exception exception)


Unlikely, but do we want to give the new exception parameter a null default, or keep in the old constructor as an overload - just in case someone is using the old constructor in which case this will be a breaking change.

QuantumNightmare · 2020-07-21T01:54:01Z

Mindscape.Raygun4Net4.ClientProfile/RaygunClient.cs

    /// set to a valid DateTime and as much of the Details property as is available.</param>
-    public void SendInBackground(RaygunMessage raygunMessage)
+    /// <param name="exception">The original exception that generated the RaygunMessage</param>
+    public void SendInBackground(RaygunMessage raygunMessage, Exception exception)


If the new exception parameter doesn't have a default value, couldn't this cause a breaking change?

QuantumNightmare · 2020-07-21T01:55:48Z

Mindscape.Raygun4Net.ClientProfile/RaygunClient.cs

    /// set to a valid DateTime and as much of the Details property as is available.</param>
-    public void SendInBackground(RaygunMessage raygunMessage)
+    /// <param name="exception">The original exception that generated the RaygunMessage</param>
+    public void SendInBackground(RaygunMessage raygunMessage, Exception exception)


If the new exception parameter doesn't have a default value, couldn't this cause a breaking change?

Addressing PR comments

MattByers and others added 19 commits July 15, 2020 11:24

Add original exception to SendingMessage handler and SendingMessageEv…

82d6606

…entArgs. Updated Raygun4Net4 to pass through original exception.

Update references to the SendingMessage event to include original exc…

05d5ca4

…eption, throughout raygun4net framework.

Make Send RaygunMessage method take a nullable exception.

22d279b

Ensure API backwards compatibility

266ce2a

Ensure API backwards compatibility

Formatting

554cf29

Formatting

Ensure API backwards compatibility

9bdb9ce

Ensure API backwards compatibility

Ensure API backwards compatibility

55ba5b2

Ensure API backwards compatibility

Updating WinRT to allow exception obj during SendingMessage event

3858cdf

Updating WinRT to allow exception obj during SendingMessage event

Must declare properties to build WindowsStore

b408c91

Must declare properties to build WindowsStore

Fix for Mindscape.Raygun4Net.NetCoreproject failing to load

673114b

Fix for Mindscape.Raygun4Net.NetCoreproject failing to load

Bump MVC provider version to 5.11.0

5f6873f

Bump MVC provider version to 5.11.0

Give Raygun4Net.Core its own AssemblyVersion file.

39154b0

Give Raygun4Net.Core its own AssemblyVersion file.

Bump Raygun4Net.Core package to version 5.11.0

02572e6

Bump Raygun4Net.Core package to version 5.11.0

Bump raygun4net.core dependency version to 5.11.0

5b82b48

Bump raygun4net.core dependency version to 5.11.0

Bump versions to 5.11.0

6f01287

Bump versions to 5.11.0

Bump raygun4net provider version to 5.11.0

62b681a

Bump raygun4net provider version to 5.11.0

Separating Xamarin iOS from changes.

e297897

Separating Xamarin iOS from changes.

Separating Xamarin Android from changes.

5e2596f

Separating Xamarin Android from changes.

Separating Xamarin Mac from changes.

3bb59e2

Separating Xamarin Mac from changes.

mduncan26 requested review from MattByers, QuantumNightmare and samuel-holt July 20, 2020 23:11

samuel-holt previously approved these changes Jul 21, 2020

View reviewed changes

MattByers previously approved these changes Jul 21, 2020

View reviewed changes

QuantumNightmare requested changes Jul 21, 2020

View reviewed changes

Addressing PR comments

1661987

Addressing PR comments

krishnaKapadia dismissed stale reviews from MattByers and samuel-holt via 1661987 August 30, 2021 21:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CR-204] Have the SendingMessage event include the original exception #434

[CR-204] Have the SendingMessage event include the original exception #434
mduncan26 wants to merge 20 commits intomasterfrom
mb/cr-204/sendingmessage-original-exception

mduncan26 commented Jul 17, 2020 •

edited

Loading

Uh oh!

samuel-holt left a comment

Uh oh!

QuantumNightmare left a comment

Uh oh!

QuantumNightmare Jul 21, 2020

Uh oh!

QuantumNightmare Jul 21, 2020

Uh oh!

QuantumNightmare Jul 21, 2020

Uh oh!

QuantumNightmare Jul 21, 2020

Uh oh!

QuantumNightmare Jul 21, 2020

Uh oh!

QuantumNightmare Jul 21, 2020

Uh oh!

QuantumNightmare Jul 21, 2020

Uh oh!

QuantumNightmare Jul 21, 2020

Uh oh!

QuantumNightmare Jul 21, 2020

Uh oh!

QuantumNightmare Jul 21, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

mduncan26 commented Jul 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

samuel-holt left a comment

Choose a reason for hiding this comment

Uh oh!

QuantumNightmare left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mduncan26 commented Jul 17, 2020 •

edited

Loading