Detect and log when/if Turborepo swallows `SENTRY_AUTH_TOKEN` environment variable

[lforst]

There have been >3 instances of people not realizing that Turborepo swallowed their auth token env var and that turborepo needs to be configured to forward environment variables coming from the outside via passthrough: https://turbo.build/repo/docs/crafting-your-repository/using-environment-variables#passthrough-variables

[lforst]

@a-hariti this could also be one for you to take a look at.

[smeubank]

https://x.com/Pruxis/status/1887825567552049445

[a-hariti]

What variables should we warn about?

should we check for process.env.* references?
@lforst

[lforst]

I think a lot of this task involves investigation. We pretty much only care about the SENTRY_AUTH_TOKEN environment variable. Is turborepo swallowing it completely? Is it renaming it? If the latter, we can detect so and warn.

[a-hariti]

something like console.warn("missing SENTRY_AUTH_TOKEN environment variable, did you set it?") from inside every plugin sounds sensible,

the only question is how to only show it to users who have the env var set up upstream

there's no standard way to find the env vars/files in a monorepo architecture

we can rely on something like TURBO_HASH from Environment variables in tasks as a heuristic to detect if we are running inside a Turborepo task

[lforst]

Using TURBO_HASH sounds reasonable to detect whether we're in a tuborepo context. The hard (potentially even impossible) part is figuring out whether Turborepo swallowed SENTRY_AUTH_TOKEN so we only print this when the user set the auth token but it is swallowed.

[a-hariti]

showing it to all users by default will be annoying as well

maybe the ideal DX would be showing the warning to code paths where the token is necessary, regardless if running inside Turborepo or not

[lforst]

We're already logging if no auth token is set. This task is specifically about instructing Turborepo users to configure the passThroughEnv option if we don't receive an auth token in the plugin.

[a-hariti]

so let's just augment those logs with another line about setting up passThroughEnv?,

it will not be precise as they might have already set it up, but it feels better to err on the side of verbose here

[lforst]

makes sense to me 👍

[lforst]

mayyybe we also should do this for SENTRY_ORG and SENTRY_PROJECT 🤔