Unable to modify breadcrumbs from registerCallback

[MakerTim]

Unable to modify breadcrumbs from registerCallback

[luke-belton]

Hi @MakerTim - you should be able to use the redactedKeys config option to filter out breadcrumb metadata that contains sensitive data. Do you think this will work for your use case?

[natepage]

@MakerTim Hi! We've faced a similar situation in different projects and agree that sanitizing data within breadcrumbs is a bit tricky with the current implementation. It would be nice to see an easier way to do it in this package directly, in the meantime here is the code we are using to do so.

It's a little "magic" as we are using a closure that we bind to the report instance to modify the value of its $breadcrumbs property but it works 😄

// Our own sanitizer service
$sanitizer = $this->sensitiveDataSanitizer;

// Call registerCallback on Client
$bugsnag->registerCallback(static function (Report $report) use ($sanitizer): void {
    // First we sanitise the metadata of the report itself
    $report->setMetaData($sanitizer->sanitize($report->getMetaData()), false);

    // Fetch breadcrumbs from report array representation
    $breadcrumbs = $report->toArray()['breadcrumbs'] ?? [];
    $redactedBreadcrumbs = [];

    // Build our own breadcrumbs array with sanitized data
    foreach ($breadcrumbs as $breadcrumb) {
        if (isset($breadcrumb['metaData'])) {
            $breadcrumb['metaData'] = $sanitizer->sanitize($breadcrumb['metaData']);
        }

        $redactedBreadcrumbs[] = $breadcrumb;
    }

    // Override the value of $breadcrumbs property on report using bound closure
    (function ($property, $value): void {
        $this->{$property} = $value;
    })->call($report, 'breadcrumbs', $redactedBreadcrumbs);
});

[johnkiely1]

Going to close this out as there are a couple of workaround options suggested above.