Fix Bugsnag call to notify

[rioug]

What? Why?

Looking at some Bugsnag report, I noticed the metadata wasn't showing up. It turned out we are using add_metadata as expected. Doc: https://docs.bugsnag.com/platforms/ruby/rails/reporting-handled-errors/#add_metadata

What should we test?

Green specs 🟢

Release notes

Changelog Category (reviewers may add a label for the release notes):

• User facing changes
• API changes (V0, V1, DFC or Webhook)
• Technical changes only
• Feature toggled

The title of the pull request will be included in the release notes.

[dacook]

Good one!
A couple of thoughts, but not worth changing.

[mkllnk]

Interesting, I would have thought that this worked before. Maybe Bugsnag used to convert objects into hashes automatically before? Maybe it broke in an upgrade?

I'm wondering if we should have our own service object to call Bugsnag. I was against it in the past because I don't want to invest work into replicating something that's already there but interfaces change. And maybe our use case is slightly different. I could imagine a DSL like this:

Alert.raise("This shouldn't happen").add_record(current_order)

def add_record(record)
  payload.add_metadata(record.class.name, record.attributes)
  self
end

Then we can chain method calls to add more data as needed. But mostly it's very simple.

Bugsnag uses a lambda for lazy evaluation but we mostly don't compute anything and have the object on hand. We can wrap that in our service object for an easier API that fits most of our use cases.

Hm, is there a gem for that?

[rioug]

I'm wondering if we should have our own service object to call Bugsnag.

Looks like there was some similar thinking at some point : https://github.com/openfoodfoundation/openfoodnetwork/blob/master/lib/open_food_network/error_logger.rb
It's only used here

openfoodnetwork/app/controllers/user_registrations_controller.rb

Line 40 in db79af4

OpenFoodNetwork::ErrorLogger.notify(e)