Add required env variables for e2e telemetry tests to README

[mnholtz]

What does this PR do?

• Follow-up of https://pixiebrix.slack.com/archives/C06RG13FBRS/p1713979660116509
• We had some issues where other devs couldn't get the e2e telemetry tests to pass locally; this adds the required env variables and build information to the README
• Also adds required env variables to env.ts to warn when they're missing

Checklist

• Add jest or playwright tests and/or storybook stories
• Designate a primary reviewer @fungairino

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.50%. Comparing base (44a3b1a) to head (7aeb911).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #8341   +/-   ##
=======================================
  Coverage   73.49%   73.50%           
=======================================
  Files        1330     1330           
  Lines       41142    41142           
  Branches     7657     7657           
=======================================
+ Hits        30239    30242    +3     
+ Misses      10903    10900    -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[fungairino]

Is it worth at all considering just removing the DEBUG check in getDNT? That way we don't have to require the need to define DEV_EVENT_TELEMETRY in the env

pixiebrix-extension/src/telemetry/dnt.ts

Line 34 in eb39806

return boolean((await dntConfig.get()) ?? process.env.DEBUG);

We wouldn't emit metrics anyways if people don't set up their local datadog client token in the env.

[mnholtz]

Is it worth at all considering just removing the DEBUG check in getDNT?

I suppose so? I don't see any reason to keep it, but I'm hesitant because I don't know why it's there.

[fungairino]

Is it worth at all considering just removing the DEBUG check in getDNT?

I suppose so? I don't see any reason to keep it, but I'm hesitant because I don't know why it's there.

Here's the relevant change:
#511

I guess it's to prevent error telemetry in the production pixiebrix app server being polluted by local dev errors, though I'd argue that we should be distinguishing dev errors some other way but still recording them by default.

In the interest of not blowing up the scope of this change, I guess we can leave in this check for now (maybe adding a comment in the relevant line in getDNT on why the check is made.

[mnholtz]

though I'd argue that we should be distinguishing dev errors some other way but still recording them by default.

It already sort of is with the version added to logs (local builds have local in the version name)

[mnholtz]

This file is unchanged except for wrapping this extend in mergeTests and adding the additionalRequiredEnvVariables override below.

[fungairino]

I think you can avoid this by defining the value as void for the fixture

[github-actions]

No loom links were found in the first post. Please add one there if you'd like to it to appear on Slack.

Do not edit this comment manually.