Refactor: move DebugImage and DebugMeta to Sentry.Protocol

[vaind]

Reasoning: some of the protocol classes (those sent to Sentry, mostly POCO) are residing directly in the Sentry namespace. Maybe we should move them to Protocol, although, it's a case-by-case decision because some may be used too frequently by SDK users so the migration wouldn't be worth any small benefit from the cleanup done here.

Let me know if you think any of these should move, or if I should abandon this completely. The list is a simple search of : IJsonSerializable

C:\dev\dotnet\src\Sentry\Breadcrumb.cs
  11,32: public sealed class Breadcrumb : IJsonSerializable

C:\dev\dotnet\src\Sentry\Package.cs
  9,29: public sealed class Package : IJsonSerializable

C:\dev\dotnet\src\Sentry\PersistedSessionUpdate.cs
  6,39: internal class PersistedSessionUpdate : IJsonSerializable

C:\dev\dotnet\src\Sentry\Request.cs
  28,29: public sealed class Request : IJsonSerializable

C:\dev\dotnet\src\Sentry\SdkVersion.cs
  11,32: public sealed class SdkVersion : IJsonSerializable

C:\dev\dotnet\src\Sentry\SentryMessage.cs
  19,35: public sealed class SentryMessage : IJsonSerializable

C:\dev\dotnet\src\Sentry\SentryStackFrame.cs
  10,38: public sealed class SentryStackFrame : IJsonSerializable

C:\dev\dotnet\src\Sentry\SentryStackTrace.cs
  43,31: public class SentryStackTrace : IJsonSerializable

C:\dev\dotnet\src\Sentry\SentryThread.cs
  10,34: public sealed class SentryThread : IJsonSerializable

C:\dev\dotnet\src\Sentry\SentryValues.cs
  9,39: internal sealed class SentryValues<T> : IJsonSerializable

C:\dev\dotnet\src\Sentry\User.cs
  10,26: public sealed class User : IJsonSerializable

C:\dev\dotnet\src\Sentry\UserFeedback.cs
  9,34: public sealed class UserFeedback : IJsonSerializable

C:\dev\dotnet\src\Sentry\ViewHierarchy.cs
  9,39:     public sealed class ViewHierarchy : IJsonSerializable

C:\dev\dotnet\src\Sentry\ViewHierarchyNode.cs
  8,41: public abstract class ViewHierarchyNode : IJsonSerializable

Note

There are also these types that implement IJsonSerializable in addition to other interfaces:

public sealed class Contexts : IDictionary<string, object>, IJsonSerializable
public sealed class SentryEvent : IEventLike, IJsonSerializable
public readonly struct SentryId : IEquatable<SentryId>, IJsonSerializable
public sealed class SentryStackFrame : IJsonSerializable
public class SessionUpdate : ISession, IJsonSerializable
public class Span : ISpanData, IJsonSerializable
public readonly struct SpanId : IEquatable<SpanId>, IJsonSerializable
public class Transaction : ITransactionData, IJsonSerializable

[jamescrosswell]

Maybe a naive question, but what's the purpose/benefit of the Protocol namespace? Is it just to help organise/identify the all the classes that get sent across the wire to Sentry? If so then yeah, makes sense to move all of the above... hopefully it's just global usings changes for SDK users, the most part.

[bruno-garcia]

I'd prefer we optmize for the end user DX. Having to import another namespace just to send an event for example is not ideal, what's why some stuff was put in the root namespace, so import Sentry by itself is all you need.

[bruno-garcia]

That said DebugMeta and stuff isn't really used a lot so it's fine to move, but we need to document a "before/after" so folks know what to when it breaks after bumping the SDK

[github-actions]

• 🚫 The changelog entry seems to be part of an already released section ## 4.0.0.
  Consider moving the entry to the ## Unreleased section, please.