feat: Add user attachments support

[limbonaut]

Add user attachments support

• Attachments: Users can now add attachments with path or bytes on the global scope
• Two creation methods:
  • SentryAttachment.create_with_path() - attach files from disk
  • SentryAttachment.create_with_bytes() - attach in-memory data
• Works on desktop and Android
• Resolves Support arbitrary attachments #120
• Wishlist: Feature request: allow clearing attachments in the global scope sentry-native#1289
• Documentation PR: Godot: Add attachment handling documentation sentry-docs#14210

[github-actions]

	Messages
📖	Do not forget to update Sentry-docs with your feature once the pull request gets approved.

Generated by 🚫 dangerJS against 1bc3ed1

[limbonaut]

@sentry review

[seer-by-sentry]

On it! We are reviewing the PR and will provide feedback shortly.

[seer-by-sentry]

PR Description

This pull request introduces user-defined attachment support to the Sentry Godot SDK. The goal is to allow developers to attach arbitrary files or byte data to Sentry events, providing more context for debugging and issue resolution.

Click to see more

Key Technical Changes

The key technical changes include: 1) Creation of a SentryAttachment class in the Godot layer, which can represent either a file path or raw byte data. 2) Implementation of add_attachment and remove_attachment methods in the SentrySDK class to manage attachments. 3) Modifications to the Android and Native SDKs to handle the new attachment types, including methods for adding and removing attachments using the underlying Sentry native libraries or Android plugin. 4) Addition of tests to verify the functionality of the SentryAttachment class.

Architecture Decisions

The architectural decisions involve creating an abstraction (SentryAttachment) to represent attachments in a platform-agnostic way. The InternalSDK interface is extended to include add_attachment and remove_attachment methods, which are then implemented by the Android and Native SDKs. This allows the core Sentry SDK to manage attachments without being tied to platform-specific details. The Native SDK directly uses the Sentry native library for attachment handling, while the Android SDK uses the Android plugin.

Dependencies and Interactions

This change depends on the Godot Engine's file system and data structures (e.g., String, PackedByteArray). It interacts with the Android plugin and the Sentry native library, delegating the actual attachment handling to these components. It also interacts with the ProjectSettings class to resolve Godot virtual paths to absolute file paths.

Risk Considerations

Potential risks include: 1) File access issues if the Godot application does not have the necessary permissions to read the attached files. 2) Performance overhead if large files are attached, especially on mobile platforms. 3) Compatibility issues with older versions of the Sentry native library or Android plugin. 4) Increased event size, potentially leading to higher data usage and Sentry costs. 5) Incorrect content type leading to issues with Sentry displaying the attachment correctly.

Notable Implementation Details

Notable implementation details include: 1) The use of ProjectSettings::get_singleton()->globalize_path to ensure that file paths are correctly resolved, including Godot virtual paths. 2) The lazy reading of file attachments in the Native SDK, where the file is only read when the event is sent to Sentry. 3) The handling of byte-based attachments in both the Android and Native SDKs. 4) The addition of remove_attachment methods to allow developers to remove attachments that are no longer needed.

[jpnurmi]

One open question about sentry-cocoa remains for the future (maybe something we could contribute if necessary?), but everything included in the PR looks good to me. 👍

Special thanks to the bot for helping ironing out the details. 😁