Skip to content

ref: attachment manifest #2108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jpnurmi merged 7 commits into from
Sep 22, 2026
Merged

ref: attachment manifest #2108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6b691ac
ref: attachment manifest
jpnurmi Sep 17, 2026
2b570e2
exclude ids
jpnurmi Sep 21, 2026
904ecef
fix absent
jpnurmi Sep 21, 2026
8b4998b
exclude malformed attachment entries
jpnurmi Sep 21, 2026
59d3c72
revise
jpnurmi Sep 21, 2026
82ed4ff
fix msvc
jpnurmi Sep 21, 2026
5f3b00e
bump crashpad
jpnurmi Sep 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion external/crashpad
Open in desktop
Submodule crashpad updated 5 files
+68 −0 client/crash_report_database.cc
+7 −0 client/crash_report_database.h
+4 −2 handler/linux/crash_report_exception_handler.cc
+4 −2 handler/mac/crash_report_exception_handler.cc
+21 −4 handler/win/crash_report_exception_handler.cc
239 changes: 102 additions & 137 deletions src/backends/native/sentry_crash_daemon.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,104 @@ attachment_is_placeholder(const sentry_options_t *options, const char *path)
return is_placeholder;
}

/**
* Reads a legacy JSON attachment manifest (TODO: remove in 1.0)
*/
static sentry_value_t
read_legacy_manifest(const sentry_path_t *manifest_path)
{
size_t buf_len = 0;
char *buf = sentry__path_read_to_buffer(manifest_path, &buf_len);
if (!buf) {
return sentry_value_new_list();
}

const char *start = buf;
const char *end = buf + buf_len;
while (start < end
&& (*start == ' ' || *start == '\t' || *start == '\r'
|| *start == '\n')) {
start++;
}
const char *trimmed_end = end;
while (trimmed_end > start
&& (trimmed_end[-1] == ' ' || trimmed_end[-1] == '\t'
|| trimmed_end[-1] == '\r' || trimmed_end[-1] == '\n')) {
trimmed_end--;
}
sentry_value_t legacy
= start < trimmed_end && *start == '[' && trimmed_end[-1] == ']'
? sentry__value_from_json(start, (size_t)(trimmed_end - start))
: sentry_value_new_null();
sentry_free(buf);
if (sentry_value_get_type(legacy) != SENTRY_VALUE_TYPE_LIST) {
sentry_value_decref(legacy);
return sentry_value_new_null();
}

sentry_value_t attachments = sentry_value_new_list();
size_t len = sentry_value_get_length(legacy);
for (size_t i = 0; i < len; i++) {
sentry_value_t info = sentry_value_get_by_index(legacy, i);
const char *path
= sentry_value_as_string(sentry_value_get_by_key(info, "path"));
const char *filename
= sentry_value_as_string(sentry_value_get_by_key(info, "filename"));
if (sentry__string_empty(path) || sentry__string_empty(filename)) {
continue;
}
sentry_value_t attachment = sentry__attachment_from_file(path);
if (sentry_value_is_null(attachment)) {
continue;
}
sentry_attachment_set_filename(attachment, filename);
sentry_attachment_set_type(attachment,
sentry_value_as_string(
sentry_value_get_by_key(info, "attachment_type")));
sentry_attachment_set_content_type(attachment,
sentry_value_as_string(
sentry_value_get_by_key(info, "content_type")));
sentry_value_append(attachments, attachment);
}
sentry_value_decref(legacy);
return attachments;
}

static sentry_value_t
read_attachment_manifest(const sentry_path_t *run_folder)
{
sentry_path_t *path
= sentry__path_join_str(run_folder, "__sentry-attachments");
if (!path) {
return sentry_value_new_null();
}
sentry_value_t attachments = sentry__read_attachment_manifest(path);
if (sentry_value_is_null(attachments)) {
attachments = read_legacy_manifest(path);
}
sentry__path_free(path);
return attachments;
}

static void
write_attachments_from_manifest(
int fd, const sentry_options_t *options, const sentry_path_t *run_folder)
{
sentry_value_t attachments = read_attachment_manifest(run_folder);
size_t len = sentry_value_get_length(attachments);
for (size_t i = 0; i < len; i++) {
sentry_value_t attachment = sentry_value_get_by_index(attachments, i);
const char *path = sentry__attachment_get_path(attachment);
if (!attachment_is_placeholder(options, path)) {
write_attachment_to_envelope(fd, path,
sentry__attachment_get_filename(attachment),
sentry__attachment_get_type(attachment),
sentry__attachment_get_content_type(attachment));
}
}
sentry_value_decref(attachments);
}

// For each large attachment listed in `<run_folder>/__sentry-attachments`,
// cache it as an attachment-ref item. Small attachments were already inlined
// during envelope writing.
Expand All @@ -375,23 +473,7 @@ add_attachment_refs(sentry_envelope_t *envelope,
|| !options->enable_large_attachments || !run_folder) {
return;
}
sentry_path_t *attach_list_path
= sentry__path_join_str(run_folder, "__sentry-attachments");
if (!attach_list_path) {
SENTRY_WARN("Failed to resolve attachment manifest path");
return;
}
size_t attach_json_len = 0;
char *attach_json
= sentry__path_read_to_buffer(attach_list_path, &attach_json_len);
sentry__path_free(attach_list_path);
if (!attach_json) {
return;
}
sentry_value_t list = attach_json_len > 0
? sentry__value_from_json(attach_json, attach_json_len)
: sentry_value_new_null();
sentry_free(attach_json);
sentry_value_t list = read_attachment_manifest(run_folder);
Comment thread
cursor[bot] marked this conversation as resolved.
if (sentry_value_is_null(list)) {
SENTRY_WARN("Failed to parse attachment manifest");
return;
Expand All @@ -400,42 +482,19 @@ add_attachment_refs(sentry_envelope_t *envelope,
bool materialized = false;
size_t len = sentry_value_get_length(list);
for (size_t i = 0; i < len; i++) {
sentry_value_t info = sentry_value_get_by_index(list, i);
const char *path
= sentry_value_as_string(sentry_value_get_by_key(info, "path"));
const char *filename
= sentry_value_as_string(sentry_value_get_by_key(info, "filename"));
const char *attachment_type = sentry_value_as_string(
sentry_value_get_by_key(info, "attachment_type"));
const char *content_type = sentry_value_as_string(
sentry_value_get_by_key(info, "content_type"));
if (sentry__string_empty(path) || sentry__string_empty(filename)) {
SENTRY_WARN("Skipping malformed attachment manifest entry");
continue;
}
sentry_value_t attachment = sentry__attachment_from_file(path);
if (sentry_value_is_null(attachment)) {
SENTRY_WARNF("Failed to allocate attachment paths for: %s", path);
continue;
}
sentry_attachment_set_filename(attachment, filename);
sentry_attachment_set_type(attachment, attachment_type);
sentry_attachment_set_content_type(attachment, content_type);
sentry_value_t attachment = sentry_value_get_by_index(list, i);
if (!sentry__attachment_is_placeholder(attachment, options)) {
sentry_value_decref(attachment);
continue;
}
if (!materialized && !sentry__envelope_materialize(envelope)) {
SENTRY_WARN("Failed to materialize envelope for attachment-refs");
sentry_value_decref(attachment);
break;
}
materialized = true;
if (!sentry__cache_attachment_ref(
envelope, attachment, options->run->cache_path, NULL)) {
SENTRY_WARN("failed to cache attachment-ref");
}
sentry_value_decref(attachment);
}
sentry_value_decref(list);
}
Expand Down Expand Up @@ -3927,54 +3986,7 @@ write_envelope_with_native_stacktrace(const sentry_options_t *options,

// Add scope attachments using metadata file
if (run_folder) {
sentry_path_t *attach_list_path
= sentry__path_join_str(run_folder, "__sentry-attachments");
if (attach_list_path) {
size_t attach_json_len = 0;
char *attach_json = sentry__path_read_to_buffer(
attach_list_path, &attach_json_len);
sentry__path_free(attach_list_path);

if (attach_json && attach_json_len > 0) {
// Parse attachment list JSON
sentry_value_t attach_list
= sentry__value_from_json(attach_json, attach_json_len);
sentry_free(attach_json);

if (!sentry_value_is_null(attach_list)) {
size_t len = sentry_value_get_length(attach_list);
for (size_t i = 0; i < len; i++) {
sentry_value_t attach_info
= sentry_value_get_by_index(attach_list, i);
sentry_value_t path_val
= sentry_value_get_by_key(attach_info, "path");
sentry_value_t filename_val
= sentry_value_get_by_key(attach_info, "filename");
sentry_value_t attachment_type_val
= sentry_value_get_by_key(
attach_info, "attachment_type");
sentry_value_t content_type_val
= sentry_value_get_by_key(
attach_info, "content_type");

const char *path = sentry_value_as_string(path_val);
const char *filename
= sentry_value_as_string(filename_val);
const char *attachment_type
= sentry_value_as_string(attachment_type_val);
const char *content_type
= sentry_value_as_string(content_type_val);

if (path && filename
&& !attachment_is_placeholder(options, path)) {
write_attachment_to_envelope(fd, path, filename,
attachment_type, content_type);
}
}
sentry_value_decref(attach_list);
}
}
}
write_attachments_from_manifest(fd, options, run_folder);
}

// Add screenshot attachment if captured by the daemon
Expand Down Expand Up @@ -4204,54 +4216,7 @@ write_envelope_with_minidump(const sentry_options_t *options,

// Add scope attachments using metadata file
if (run_folder) {
sentry_path_t *attach_list_path
= sentry__path_join_str(run_folder, "__sentry-attachments");
if (attach_list_path) {
size_t attach_json_len = 0;
char *attach_json = sentry__path_read_to_buffer(
attach_list_path, &attach_json_len);
sentry__path_free(attach_list_path);

if (attach_json && attach_json_len > 0) {
// Parse attachment list JSON
sentry_value_t attach_list
= sentry__value_from_json(attach_json, attach_json_len);
sentry_free(attach_json);

if (!sentry_value_is_null(attach_list)) {
size_t len = sentry_value_get_length(attach_list);
for (size_t i = 0; i < len; i++) {
sentry_value_t attach_info
= sentry_value_get_by_index(attach_list, i);
sentry_value_t path_val
= sentry_value_get_by_key(attach_info, "path");
sentry_value_t filename_val
= sentry_value_get_by_key(attach_info, "filename");
sentry_value_t attachment_type_val
= sentry_value_get_by_key(
attach_info, "attachment_type");
sentry_value_t content_type_val
= sentry_value_get_by_key(
attach_info, "content_type");

const char *path = sentry_value_as_string(path_val);
const char *filename
= sentry_value_as_string(filename_val);
const char *attachment_type
= sentry_value_as_string(attachment_type_val);
const char *content_type
= sentry_value_as_string(content_type_val);

if (path && filename
&& !attachment_is_placeholder(options, path)) {
write_attachment_to_envelope(fd, path, filename,
attachment_type, content_type);
}
}
sentry_value_decref(attach_list);
}
}
}
write_attachments_from_manifest(fd, options, run_folder);
}

// Add screenshot attachment if captured by the daemon
Expand Down
40 changes: 6 additions & 34 deletions src/backends/sentry_backend_crashpad.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,6 @@ typedef struct {

static void crashpad_backend_add_breadcrumb(sentry_backend_t *backend,
sentry_value_t breadcrumb, const sentry_options_t *options);
static sentry_path_t *make_attachment_path(
const sentry_path_t *run_path, sentry_value_t attachment);

/**
* Correctly destruct C++ members of the crashpad state.
Expand Down Expand Up @@ -405,7 +403,8 @@ prepare_initial_attachment(
{
size_t bytes_len = 0;
const char *bytes = sentry__attachment_get_bytes(attachment, &bytes_len);
sentry_path_t *path = make_attachment_path(run_path, attachment);
sentry_path_t *path
= sentry__attachment_make_run_path(run_path, attachment);
if (!path) {
return nullptr;
}
Expand Down Expand Up @@ -883,35 +882,6 @@ process_completed_reports(

#if defined(SENTRY_PLATFORM_WINDOWS) || defined(SENTRY_PLATFORM_LINUX) \
|| defined(SENTRY_PLATFORM_MACOS)
static sentry_path_t *
make_attachment_path(const sentry_path_t *run_path, sentry_value_t attachment)
{
if (!sentry__attachment_get_bytes(attachment, nullptr)) {
return sentry__attachment_make_path(attachment);
}

sentry_uuid_t id = sentry__attachment_get_id(attachment);
const char *filename = sentry__attachment_get_filename(attachment);
if (!run_path || sentry_uuid_is_nil(&id)
|| sentry__string_empty(filename)) {
return nullptr;
}

char uuid[37];
sentry_uuid_as_string(&id, uuid);
sentry_path_t *dir = sentry__path_join_str(run_path, uuid);
sentry_path_t *path = dir ? sentry__path_join_str(dir, filename) : nullptr;
sentry_path_t *parent = path ? sentry__path_dir(path) : nullptr;
bool valid = parent && sentry__path_eq(parent, dir);
sentry__path_free(parent);
sentry__path_free(dir);
if (!valid) {
sentry__path_free(path);
return nullptr;
}
return path;
}

static void
add_attachment(void *state, sentry_value_t attachment)
{
Expand All @@ -922,7 +892,8 @@ add_attachment(void *state, sentry_value_t attachment)

size_t bytes_len = 0;
const char *bytes = sentry__attachment_get_bytes(attachment, &bytes_len);
sentry_path_t *path = make_attachment_path(data->run_path, attachment);
sentry_path_t *path
= sentry__attachment_make_run_path(data->run_path, attachment);
if (!path) {
const char *filename = sentry__attachment_get_filename(attachment);
SENTRY_WARNF("failed to create path for crashpad attachment \"%s\"",
Expand Down Expand Up @@ -953,7 +924,8 @@ remove_attachment(void *state, sentry_value_t attachment)
if (!data || !data->client) {
return;
}
sentry_path_t *path = make_attachment_path(data->run_path, attachment);
sentry_path_t *path
= sentry__attachment_make_run_path(data->run_path, attachment);
if (!path) {
return;
}
Expand Down
Loading
Loading