Error reporting in Cloudflare functions with Sentry

[mlbrgl]

Add Sentry logging for /donation/* Cloudflare Pages functions routes.

At the time of writing, neither bugsnag nor slack have official Cloudflare worker integrations.

Given the criticality of these routes, I favoured reliability and introduced a new logging app which has official Cloudflare support: https://developers.cloudflare.com/pages/functions/plugins/sentry/

We should switch to bugsnag whenever official support is available.

Testing:

• (ENV and SENTRY_DSN secrets are already defined for the preview environment in Cloudflare's "owid" project)
• temporarily disable the Cloudflare Access rule by setting its subdomain to temp
• send an empty JSON to https://donate.owid.pages.dev/donation/donate

-> an error is logged in sentry and an alert email is sent to [TBD]@ourworldindata.org (this will be configured when the use of Sentry is confirmed). Slack integration is only available on paid plans.

[mlbrgl]

Current dependencies on/for this PR:

• master
  • PR 🥅 (donate) notify front-end errors to bugsnag #2956
    • PR Local env for cloudflare functions with makefile #2978
      • PR Migrate donate Netlify function to Cloudflare (#proj-donor-page v2 option 1) #2998
        • PR Migrate thank-you email to Cloudflare Pages functions #3020
          • PR Deploy staging to Cloudflare previews #3055
            • PR Error reporting in Cloudflare functions with Sentry #3068 👈
              • PR 📝(donate) document Stripe CLI login #3085
                • PR 🔊(donate) add Slack error reporting #3086

This stack of pull requests is managed by Graphite.

[danyx23]

Hm. I don't love adding another service to our stack just for this. It's a bit annoying that neither bugsnag nor slack have CF compatible client libraries yet, but I think a bare-bones slack integration really doesn't need the client api as they have a pretty well designed http api. E.g. so send a message to slack channel is as simple as

POST https://slack.com/api/chat.postMessage
Content-type: application/json
Authorization: Bearer xoxb-your-token
{
  "channel": "YOUR_CHANNEL_ID",
  "text": "Hello world :tada:"
}

I'm kind of leaning towards a preference for a barebones slack message - but I'm happy to discuss the pros and cons of it in the site meeting later today if you like!

[mlbrgl]

sure, we can try this too if it is indeed very straightforward.

My only concern would be around reporting unhandled errors, but this is less of a concern here, since most of the functions bodies are wrapped in try {}.

I would be tempted to run them in parallel for a month or so, just to make sure we're not missing anything. If we end up with perfect symmetry, then yes, by all means, let's strip it down.

[mlbrgl]

see follow up in #3086

[danyx23]

[mlbrgl]

Merge activity

• Jan 11, 12:29 PM: @mlbrgl started a stack merge that includes this pull request via Graphite.
• Jan 11, 12:39 PM: Graphite rebased this pull request as part of a merge.
• Jan 11, 12:40 PM: @mlbrgl merged this pull request with Graphite.