Skip to content

fix(node,vercel-edge,bundler-plugins): Ignore commit env vars set to their own name #25244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
mwarkentin wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

fix(node,vercel-edge,bundler-plugins): Ignore commit env vars set to their own name #25244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 57 additions & 40 deletions packages/bundler-plugins/src/core/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,81 +224,81 @@ export function determineReleaseName(): string | undefined {

const possibleReleaseNameOfGitProvider =
// GitHub Actions - https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
process.env['GITHUB_SHA'] ||
readCommitEnvVar('GITHUB_SHA') ||
// GitLab CI - https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
process.env['CI_MERGE_REQUEST_SOURCE_BRANCH_SHA'] ||
process.env['CI_BUILD_REF'] ||
process.env['CI_COMMIT_SHA'] ||
readCommitEnvVar('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA') ||
readCommitEnvVar('CI_BUILD_REF') ||
readCommitEnvVar('CI_COMMIT_SHA') ||
// Bitbucket - https://support.atlassian.com/bitbucket-cloud/docs/variables-and-secrets/
process.env['BITBUCKET_COMMIT'];
readCommitEnvVar('BITBUCKET_COMMIT');

const possibleReleaseNameOfCiProvidersWithSpecificEnvVar =
// AppVeyor - https://www.appveyor.com/docs/environment-variables/
process.env['APPVEYOR_PULL_REQUEST_HEAD_COMMIT'] ||
process.env['APPVEYOR_REPO_COMMIT'] ||
readCommitEnvVar('APPVEYOR_PULL_REQUEST_HEAD_COMMIT') ||
readCommitEnvVar('APPVEYOR_REPO_COMMIT') ||
// AWS CodeBuild - https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html
process.env['CODEBUILD_RESOLVED_SOURCE_VERSION'] ||
readCommitEnvVar('CODEBUILD_RESOLVED_SOURCE_VERSION') ||
// AWS Amplify - https://docs.aws.amazon.com/amplify/latest/userguide/environment-variables.html
process.env['AWS_COMMIT_ID'] ||
readCommitEnvVar('AWS_COMMIT_ID') ||
// Azure Pipelines - https://docs.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml
process.env['BUILD_SOURCEVERSION'] ||
readCommitEnvVar('BUILD_SOURCEVERSION') ||
// Bitrise - https://devcenter.bitrise.io/builds/available-environment-variables/
process.env['GIT_CLONE_COMMIT_HASH'] ||
readCommitEnvVar('GIT_CLONE_COMMIT_HASH') ||
// Buddy CI - https://buddy.works/docs/pipelines/environment-variables#default-environment-variables
process.env['BUDDY_EXECUTION_REVISION'] ||
readCommitEnvVar('BUDDY_EXECUTION_REVISION') ||
// Builtkite - https://buildkite.com/docs/pipelines/environment-variables
process.env['BUILDKITE_COMMIT'] ||
readCommitEnvVar('BUILDKITE_COMMIT') ||
// CircleCI - https://circleci.com/docs/variables/
process.env['CIRCLE_SHA1'] ||
readCommitEnvVar('CIRCLE_SHA1') ||
// Cirrus CI - https://cirrus-ci.org/guide/writing-tasks/#environment-variables
process.env['CIRRUS_CHANGE_IN_REPO'] ||
readCommitEnvVar('CIRRUS_CHANGE_IN_REPO') ||
// Codefresh - https://codefresh.io/docs/docs/codefresh-yaml/variables/
process.env['CF_REVISION'] ||
readCommitEnvVar('CF_REVISION') ||
// Codemagic - https://docs.codemagic.io/yaml-basic-configuration/environment-variables/
process.env['CM_COMMIT'] ||
readCommitEnvVar('CM_COMMIT') ||
// Cloudflare Pages - https://developers.cloudflare.com/pages/platform/build-configuration/#environment-variables
process.env['CF_PAGES_COMMIT_SHA'] ||
readCommitEnvVar('CF_PAGES_COMMIT_SHA') ||
// Drone - https://docs.drone.io/pipeline/environment/reference/
process.env['DRONE_COMMIT_SHA'] ||
readCommitEnvVar('DRONE_COMMIT_SHA') ||
// Flightcontrol - https://www.flightcontrol.dev/docs/guides/flightcontrol/environment-variables#built-in-environment-variables
process.env['FC_GIT_COMMIT_SHA'] ||
readCommitEnvVar('FC_GIT_COMMIT_SHA') ||
// Heroku #1 https://devcenter.heroku.com/articles/heroku-ci
process.env['HEROKU_TEST_RUN_COMMIT_VERSION'] ||
readCommitEnvVar('HEROKU_TEST_RUN_COMMIT_VERSION') ||
// Heroku #2 https://docs.sentry.io/product/integrations/deployment/heroku/#configure-releases
process.env['HEROKU_SLUG_COMMIT'] ||
readCommitEnvVar('HEROKU_SLUG_COMMIT') ||
// Railway - https://docs.railway.app/reference/variables#git-variables
process.env['RAILWAY_GIT_COMMIT_SHA'] ||
readCommitEnvVar('RAILWAY_GIT_COMMIT_SHA') ||
// Render - https://render.com/docs/environment-variables
process.env['RENDER_GIT_COMMIT'] ||
readCommitEnvVar('RENDER_GIT_COMMIT') ||
// Semaphore CI - https://docs.semaphoreci.com/ci-cd-environment/environment-variables
process.env['SEMAPHORE_GIT_SHA'] ||
readCommitEnvVar('SEMAPHORE_GIT_SHA') ||
// TravisCI - https://docs.travis-ci.com/user/environment-variables/#default-environment-variables
process.env['TRAVIS_PULL_REQUEST_SHA'] ||
readCommitEnvVar('TRAVIS_PULL_REQUEST_SHA') ||
// Vercel - https://vercel.com/docs/v2/build-step#system-environment-variables
process.env['VERCEL_GIT_COMMIT_SHA'] ||
process.env['VERCEL_GITHUB_COMMIT_SHA'] ||
process.env['VERCEL_GITLAB_COMMIT_SHA'] ||
process.env['VERCEL_BITBUCKET_COMMIT_SHA'] ||
readCommitEnvVar('VERCEL_GIT_COMMIT_SHA') ||
readCommitEnvVar('VERCEL_GITHUB_COMMIT_SHA') ||
readCommitEnvVar('VERCEL_GITLAB_COMMIT_SHA') ||
readCommitEnvVar('VERCEL_BITBUCKET_COMMIT_SHA') ||
// Zeit (now known as Vercel)
process.env['ZEIT_GITHUB_COMMIT_SHA'] ||
process.env['ZEIT_GITLAB_COMMIT_SHA'] ||
process.env['ZEIT_BITBUCKET_COMMIT_SHA'];
readCommitEnvVar('ZEIT_GITHUB_COMMIT_SHA') ||
readCommitEnvVar('ZEIT_GITLAB_COMMIT_SHA') ||
readCommitEnvVar('ZEIT_BITBUCKET_COMMIT_SHA');

const possibleReleaseNameOfCiProvidersWithGenericEnvVar =
// CloudBees CodeShip - https://docs.cloudbees.com/docs/cloudbees-codeship/latest/pro-builds-and-configuration/environment-variables
process.env['CI_COMMIT_ID'] ||
readCommitEnvVar('CI_COMMIT_ID') ||
// Coolify - https://coolify.io/docs/knowledge-base/environment-variables
process.env['SOURCE_COMMIT'] ||
readCommitEnvVar('SOURCE_COMMIT') ||
// Heroku #3 https://devcenter.heroku.com/changelog-items/630
process.env['SOURCE_VERSION'] ||
readCommitEnvVar('SOURCE_VERSION') ||
// Jenkins - https://plugins.jenkins.io/git/#environment-variables
process.env['GIT_COMMIT'] ||
readCommitEnvVar('GIT_COMMIT') ||
// Netlify - https://docs.netlify.com/configure-builds/environment-variables/#build-metadata
process.env['COMMIT_REF'] ||
readCommitEnvVar('COMMIT_REF') ||
// TeamCity - https://www.jetbrains.com/help/teamcity/predefined-build-parameters.html
process.env['BUILD_VCS_NUMBER'] ||
readCommitEnvVar('BUILD_VCS_NUMBER') ||
// Woodpecker CI - https://woodpecker-ci.org/docs/usage/environment
process.env['CI_COMMIT_SHA'];
readCommitEnvVar('CI_COMMIT_SHA');

return (
possibleReleaseNameOfGitProvider ||
Expand All @@ -308,6 +308,23 @@ export function determineReleaseName(): string | undefined {
);
}

/**
* Reads an environment variable that should hold a commit SHA. A value that is the variable's own
* name, such as `VERCEL_GIT_COMMIT_SHA=VERCEL_GIT_COMMIT_SHA`, is ignored: it never changes, so as
* a release name it would put every build into one release.
*/
function readCommitEnvVar(name: string): string | undefined {
const value = process.env[name];
if (value?.trim() === name) {
// eslint-disable-next-line no-console
console.warn(
`[@sentry/bundler-plugins] Ignoring the ${name} environment variable as a release name, because its value is its own name. Set the release explicitly, or fix the variable in your build environment.`,
);
return undefined;
}
return value;
}

/**
* Generates code for the global injector which is responsible for setting the global
* `SENTRY_RELEASE` & `SENTRY_BUILD_INFO` variables.
Expand Down
13 changes: 13 additions & 0 deletions packages/bundler-plugins/test/core/utils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,4 +300,17 @@ describe('determineReleaseName', () => {
execSyncSpy.mockRestore();
}
});
it('ignores a commit env var whose value is its own name', () => {
const originalEnv = process.env;
process.env = { VERCEL_GIT_COMMIT_SHA: 'VERCEL_GIT_COMMIT_SHA', COMMIT_REF: 'abc123' };
const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => undefined);

try {
expect(determineReleaseName()).toBe('abc123');
expect(warnSpy).toHaveBeenCalledWith(expect.stringContaining('VERCEL_GIT_COMMIT_SHA'));
} finally {
process.env = originalEnv;
warnSpy.mockRestore();
}
});
});
103 changes: 61 additions & 42 deletions packages/node/src/sdk/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// PUBLIC APIS

import type { StackParser } from '@sentry/core';
import { createStackParser, GLOBAL_OBJ } from '@sentry/core';
import { consoleSandbox, createStackParser, GLOBAL_OBJ } from '@sentry/core';
import { nodeStackLineParser } from '@sentry/core/server';
import { createGetModuleFromFilename } from '../utils/module';

Expand All @@ -27,83 +27,83 @@ export function getSentryRelease(fallback?: string): string | undefined {

const possibleReleaseNameOfGitProvider =
// GitHub Actions - https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
process.env['GITHUB_SHA'] ||
readCommitEnvVar('GITHUB_SHA') ||
// GitLab CI - https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
process.env['CI_MERGE_REQUEST_SOURCE_BRANCH_SHA'] ||
process.env['CI_BUILD_REF'] ||
process.env['CI_COMMIT_SHA'] ||
readCommitEnvVar('CI_MERGE_REQUEST_SOURCE_BRANCH_SHA') ||
readCommitEnvVar('CI_BUILD_REF') ||
readCommitEnvVar('CI_COMMIT_SHA') ||
// Bitbucket - https://support.atlassian.com/bitbucket-cloud/docs/variables-and-secrets/
process.env['BITBUCKET_COMMIT'];
readCommitEnvVar('BITBUCKET_COMMIT');

const possibleReleaseNameOfCiProvidersWithSpecificEnvVar =
// AppVeyor - https://www.appveyor.com/docs/environment-variables/
process.env['APPVEYOR_PULL_REQUEST_HEAD_COMMIT'] ||
process.env['APPVEYOR_REPO_COMMIT'] ||
readCommitEnvVar('APPVEYOR_PULL_REQUEST_HEAD_COMMIT') ||
readCommitEnvVar('APPVEYOR_REPO_COMMIT') ||
// AWS CodeBuild - https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html
process.env['CODEBUILD_RESOLVED_SOURCE_VERSION'] ||
readCommitEnvVar('CODEBUILD_RESOLVED_SOURCE_VERSION') ||
// AWS Amplify - https://docs.aws.amazon.com/amplify/latest/userguide/environment-variables.html
process.env['AWS_COMMIT_ID'] ||
readCommitEnvVar('AWS_COMMIT_ID') ||
// Azure Pipelines - https://docs.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml
process.env['BUILD_SOURCEVERSION'] ||
readCommitEnvVar('BUILD_SOURCEVERSION') ||
// Bitrise - https://devcenter.bitrise.io/builds/available-environment-variables/
process.env['GIT_CLONE_COMMIT_HASH'] ||
readCommitEnvVar('GIT_CLONE_COMMIT_HASH') ||
// Buddy CI - https://buddy.works/docs/pipelines/environment-variables#default-environment-variables
process.env['BUDDY_EXECUTION_REVISION'] ||
readCommitEnvVar('BUDDY_EXECUTION_REVISION') ||
// Builtkite - https://buildkite.com/docs/pipelines/environment-variables
process.env['BUILDKITE_COMMIT'] ||
readCommitEnvVar('BUILDKITE_COMMIT') ||
// CircleCI - https://circleci.com/docs/variables/
process.env['CIRCLE_SHA1'] ||
readCommitEnvVar('CIRCLE_SHA1') ||
// Cirrus CI - https://cirrus-ci.org/guide/writing-tasks/#environment-variables
process.env['CIRRUS_CHANGE_IN_REPO'] ||
readCommitEnvVar('CIRRUS_CHANGE_IN_REPO') ||
// Codefresh - https://codefresh.io/docs/docs/codefresh-yaml/variables/
process.env['CF_REVISION'] ||
readCommitEnvVar('CF_REVISION') ||
// Codemagic - https://docs.codemagic.io/yaml-basic-configuration/environment-variables/
process.env['CM_COMMIT'] ||
readCommitEnvVar('CM_COMMIT') ||
// Cloudflare Pages - https://developers.cloudflare.com/pages/platform/build-configuration/#environment-variables
process.env['CF_PAGES_COMMIT_SHA'] ||
readCommitEnvVar('CF_PAGES_COMMIT_SHA') ||
// Drone - https://docs.drone.io/pipeline/environment/reference/
process.env['DRONE_COMMIT_SHA'] ||
readCommitEnvVar('DRONE_COMMIT_SHA') ||
// Flightcontrol - https://www.flightcontrol.dev/docs/guides/flightcontrol/environment-variables#built-in-environment-variables
process.env['FC_GIT_COMMIT_SHA'] ||
readCommitEnvVar('FC_GIT_COMMIT_SHA') ||
// Heroku #1 https://devcenter.heroku.com/articles/heroku-ci
process.env['HEROKU_TEST_RUN_COMMIT_VERSION'] ||
readCommitEnvVar('HEROKU_TEST_RUN_COMMIT_VERSION') ||
// Heroku #2 https://devcenter.heroku.com/articles/dyno-metadata#dyno-metadata
process.env['HEROKU_BUILD_COMMIT'] ||
readCommitEnvVar('HEROKU_BUILD_COMMIT') ||
// Heroku #3 (deprecated by Heroku, kept for backward compatibility)
process.env['HEROKU_SLUG_COMMIT'] ||
readCommitEnvVar('HEROKU_SLUG_COMMIT') ||
// Railway - https://docs.railway.app/reference/variables#git-variables
process.env['RAILWAY_GIT_COMMIT_SHA'] ||
readCommitEnvVar('RAILWAY_GIT_COMMIT_SHA') ||
// Render - https://render.com/docs/environment-variables
process.env['RENDER_GIT_COMMIT'] ||
readCommitEnvVar('RENDER_GIT_COMMIT') ||
// Semaphore CI - https://docs.semaphoreci.com/ci-cd-environment/environment-variables
process.env['SEMAPHORE_GIT_SHA'] ||
readCommitEnvVar('SEMAPHORE_GIT_SHA') ||
// TravisCI - https://docs.travis-ci.com/user/environment-variables/#default-environment-variables
process.env['TRAVIS_PULL_REQUEST_SHA'] ||
readCommitEnvVar('TRAVIS_PULL_REQUEST_SHA') ||
// Vercel - https://vercel.com/docs/v2/build-step#system-environment-variables
process.env['VERCEL_GIT_COMMIT_SHA'] ||
process.env['VERCEL_GITHUB_COMMIT_SHA'] ||
process.env['VERCEL_GITLAB_COMMIT_SHA'] ||
process.env['VERCEL_BITBUCKET_COMMIT_SHA'] ||
readCommitEnvVar('VERCEL_GIT_COMMIT_SHA') ||
readCommitEnvVar('VERCEL_GITHUB_COMMIT_SHA') ||
readCommitEnvVar('VERCEL_GITLAB_COMMIT_SHA') ||
readCommitEnvVar('VERCEL_BITBUCKET_COMMIT_SHA') ||
// Zeit (now known as Vercel)
process.env['ZEIT_GITHUB_COMMIT_SHA'] ||
process.env['ZEIT_GITLAB_COMMIT_SHA'] ||
process.env['ZEIT_BITBUCKET_COMMIT_SHA'];
readCommitEnvVar('ZEIT_GITHUB_COMMIT_SHA') ||
readCommitEnvVar('ZEIT_GITLAB_COMMIT_SHA') ||
readCommitEnvVar('ZEIT_BITBUCKET_COMMIT_SHA');

const possibleReleaseNameOfCiProvidersWithGenericEnvVar =
// CloudBees CodeShip - https://docs.cloudbees.com/docs/cloudbees-codeship/latest/pro-builds-and-configuration/environment-variables
process.env['CI_COMMIT_ID'] ||
readCommitEnvVar('CI_COMMIT_ID') ||
// Coolify - https://coolify.io/docs/knowledge-base/environment-variables
process.env['SOURCE_COMMIT'] ||
readCommitEnvVar('SOURCE_COMMIT') ||
// Heroku #3 https://devcenter.heroku.com/changelog-items/630
process.env['SOURCE_VERSION'] ||
readCommitEnvVar('SOURCE_VERSION') ||
// Jenkins - https://plugins.jenkins.io/git/#environment-variables
process.env['GIT_COMMIT'] ||
readCommitEnvVar('GIT_COMMIT') ||
// Netlify - https://docs.netlify.com/configure-builds/environment-variables/#build-metadata
process.env['COMMIT_REF'] ||
readCommitEnvVar('COMMIT_REF') ||
// TeamCity - https://www.jetbrains.com/help/teamcity/predefined-build-parameters.html
process.env['BUILD_VCS_NUMBER'] ||
readCommitEnvVar('BUILD_VCS_NUMBER') ||
// Woodpecker CI - https://woodpecker-ci.org/docs/usage/environment
process.env['CI_COMMIT_SHA'];
readCommitEnvVar('CI_COMMIT_SHA');

return (
possibleReleaseNameOfGitProvider ||
Expand All @@ -113,5 +113,24 @@ export function getSentryRelease(fallback?: string): string | undefined {
);
}

/**
* Reads an environment variable that should hold a commit SHA. A value that is the variable's own
* name, such as `VERCEL_GIT_COMMIT_SHA=VERCEL_GIT_COMMIT_SHA`, is ignored: it never changes, so as
* a release name it would put every build into one release.
*/
function readCommitEnvVar(name: string): string | undefined {
const value = process.env[name];
if (value?.trim() === name) {
consoleSandbox(() => {
// eslint-disable-next-line no-console
console.warn(
`[Sentry] Ignoring the ${name} environment variable as a release name, because its value is its own name. Set the release explicitly, or fix the variable in your build environment.`,
);
});
return undefined;
}
return value;
}

/** Node.js stack parser */
export const defaultStackParser: StackParser = createStackParser(nodeStackLineParser(createGetModuleFromFilename()));
17 changes: 17 additions & 0 deletions packages/node/test/sdk/getSentryRelease.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,21 @@ describe('getSentryRelease', () => {

expect(getSentryRelease()).toBe('heroku-build-commit-sha');
});

it('ignores a commit env var whose value is its own name', () => {
const warnSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
vi.stubEnv('VERCEL_GIT_COMMIT_SHA', 'VERCEL_GIT_COMMIT_SHA');
vi.stubEnv('COMMIT_REF', 'netlify-commit-ref');

expect(getSentryRelease()).toBe('netlify-commit-ref');
expect(warnSpy).toHaveBeenCalledWith(expect.stringContaining('VERCEL_GIT_COMMIT_SHA'));
warnSpy.mockRestore();
});

it('falls back when the only commit env var is its own name', () => {
vi.spyOn(console, 'warn').mockImplementation(() => {});
vi.stubEnv('VERCEL_GIT_COMMIT_SHA', 'VERCEL_GIT_COMMIT_SHA');

expect(getSentryRelease('fallback')).toBe('fallback');
});
});
Loading
Loading