bugsplat-git/bugsplat-dotnet-standard

🌋📋🕵️ BugSplat error reporting for .NET Standard applications

bugsplat-dotnet-standard's Issues

Provide an interface for FormDataParam

This is feedback from our bugsplat-unity PR BugSplat-Git/bugsplat-unity#31

Support Symbol Signature Information

Let's add an issue for getting the GUID from the PDB! Let's turn https://github.com/BugSplat-Git/src-backend/blob/799208e53c3d8a13bf35c3ba1c405ecdc81a4c6a/BugSplat/PdbLibrary/PdbLibrary/PdbLibrary.cs#L295 into a common package and consume it here!

Originally posted by @bobbyg603 in #52 (comment)

Support overriding crashTypeId

So we can leverage this on Unity, Unity Windows Native, UWP, Xbox, Unreal Xbox etc

Override ExceptionType and MinidumpType when Unknown

ExceptionPostOptions and MinidumpPostOptions were implemented without defaults for ExceptionType and MinidumpType respectively. The thought was that they would get initialized to null, but it turns out they get initialized to 0 and thus checking if they are equal to null will never work. We need to update them to override if the value is 0 (Unknown) instead and set the default value to Unknown.

https://github.com/BugSplat-Git/bugsplat-net-standard/blob/185b1297e5620d9e611e316ad70c4eb76d92fd3b/BugSplatDotNetStandard/BugSplat.cs#L93

https://github.com/BugSplat-Git/bugsplat-net-standard/blob/185b1297e5620d9e611e316ad70c4eb76d92fd3b/BugSplatDotNetStandard/BugSplat.cs#L111

https://github.com/BugSplat-Git/bugsplat-net-standard/blob/185b1297e5620d9e611e316ad70c4eb76d92fd3b/BugSplatDotNetStandard/BugSplatPostOptions.cs#L14

https://github.com/BugSplat-Git/bugsplat-net-standard/blob/185b1297e5620d9e611e316ad70c4eb76d92fd3b/BugSplatDotNetStandard/BugSplatPostOptions.cs#L22

Add support for Description, Email, Key, User and overrides at post time

Add Updated Header Info to ReadMe

Update the readme to match the styles in the BugSplat Website ReadMe

![bugsplat-github-banner-basic-outline](https://user-images.githubusercontent.com/20464226/149019306-3186103c-5315-4dad-a499-4fd1df408475.png)
<br/><br/> 
# <div align="center">BugSplat</div> 
### **<div align="center">Crash and error reporting built for busy developers.</div>**
<div align="center"> <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/bugsplatco?label=Follow%20BugSplat&style=social">  <img alt="Discord" src="https://img.shields.io/discord/664965194799251487?label=Join%20Discord&logo=Discord&style=social"> </div>

There's a whole world of shields (badges) we can add next to the Twitter and Discord ones. Maybe add a last commit or project size shield from - https://shields.io/category/rating.

Symbol files should be uploaded with name of zip instead of name of symbol

Fix missing CrashTypeId in minidump post

When we moved to a zipped upload via pre-signed url we broke the ability to specify which crashTypeId is associated with the minidump.

Add Support for the Notes Field

Mainly for Unity

Add Symbol Uploads

Remove dependency on Newtonsoft

This package is used to provide support for exception and minidump posts in Unity. Unity's dependency management for packages appears to be non-existent and they already load a version of Newtonsoft into a shared AppDomain. This means that shipping a version of the Newtonsoft dll is not an option. Relying on the version of Newtonsoft loaded by Unity without defining the dependency anywhere feels pretty terrible too.

Instead of wading into this swamp let's tear out Newtonsoft. We can write our own Json parser and replace it when Unity supports .NET 5 or greater by using System.Text.Json.

Unity exception type id should be 24

We added a new crash type id to the backend for Unity crashes captured by bugsplat-net-standard.

see https://github.com/BugSplat-Git/webroot/pull/465
and https://github.com/BugSplat-Git/src-backend/pull/137

Add README to nupkg

Add ability to attach logs for BugSplatDotNetStandard.dll

Upload README.md images to GitHub directly

They won't be displayed by NuGet otherwise (for security reasons)

Throw better exceptions if arguments are null or empty

In bugsplat-unity we are getting null reference exceptions. We should really be throwing an ArgumentNullException at the entry point of the method with a better exception message so it's easier to debug.

Add XML documentations comments

Support Aggregate Exceptions

The user shouldn't have to unwind aggregate Exceptions themselves, we should just support this.

https://docs.microsoft.com/en-us/dotnet/standard/parallel-programming/how-to-handle-exceptions-in-parallel-loops

TaskScheduler.UnobservedTaskException += async (sender, e) =>
{
    foreach(var ex in e.Exception.Flatten().InnerExceptions)
    {
        await CrashReporter.Post(ex);
    }
};

Add Emoji's to the chapter headers

To make our repo's stand out a bit more, let's give them a spice of life with some emoji's in the chapter text.

Here's an example from our production website ReadMe

### :blue_book: Documentation
Our private repository and documentation is available at GitHub. Visit https://docs.bugsplat.com/ for further info.

You can find all of the emoji's github allows here - https://gist.github.com/rxaviers/7360908

Post Minidumps via Presigned URL

We took a shortcut when implementing this package and are currently posting directly to our web servers. To better support production volume we should acquire a presigned URL and post directly to S3. An example of how to do this can be seen here.

Fix minidump attachment support

When we switched to uploading minidumps via presigned-url we didn't implement uploading attachments.

Add README to nupkg

Update Social Sharing Image for Repo

Follow these instructions for this repo to add social sharing image - https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview

Social image for github.

Add tests for AdditionalFormDataParams

It looks like we can create an internal constructor that accepts an IHttpClient and add the following attribute to make it available to the tests assembly:

[assembly: InternalsVisibleTo("BugSplatDotNetStandard.Test")]

Remove AttachFile

Replace with default Attachments on the class and AdditionalAttachments option

Add a try/catch to make attachments safer

add try catch around this

https://github.com/BugSplat-Git/BugSplatDotNetStandard/blob/c21fa158128f575bc91a5a18f82a4b683c22b26c/BugSplatDotNetStandard/BugSplat.cs#L130

Originally posted by @bobbyg603 in #7 (comment)

Add README to nupkg

Update documentation

We added support for posting minidumps, overriding params etc

Add Build Check

We should run the unit tests before merging. This is something we've agreed to do as part of SOC2 compliance.

Rename repo to bugsplat-dotnet

Null reference exception from .NET Core app when options is not provided.

The following line was crashing

var task = bugsplat.Post(new FileInfo(dumpFile));

when testing locally, adding options = options ?? new MinidumpPostOptions(); at the top of Post fixed the problem

Change Package Author to BugSplat

Fix Sharing Violation Exception reading attachment contents when file is being written by another program

Same as the issue outlined here https://stackoverflow.com/questions/64365963/unity-ioexception-sharing-violation-on-path-for-output-log-txt-how-to-read-a-f

Add Support for Uploading Minidumps

Support environment info when posting Exception

We should display something in the environment field when an exception is posted

Add support for posting .NET minidump

On our backend this is crashTypeId 2

Crash posts should always post directly to S3

Minidumps currently post this way. We need to do this for stringified stacks too.

Add Publish Script

I don't want to have to do this manually again.

Upload attachments using $_FILES compatible body instead of indexed form data params

In Unity we need the ability to attach a file that's kept in memory (using AdditionalFormDataParams instead of AdditionaAttachments). If we attach files via indexed params we run the risk of overwriting things. Let's just attach the files by name instead.

https://github.com/BugSplat-Git/BugSplatDotNetStandard/blob/c21fa158128f575bc91a5a18f82a4b683c22b26c/BugSplatDotNetStandard/BugSplat.cs#L143

Add support for string representations of a StackTrace

This is needed to post the Unity LogMessageReceived stack trace to BugSplat and might come in handy elsewhere.