Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions src/client/preview.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,11 @@ describe("Preview environment detection", () => {
delete process.env.GITHUB_REF_NAME;
delete process.env.CI_COMMIT_BRANCH;
delete process.env.CIRCLE_BRANCH;
delete process.env.CIRCLE_PULL_REQUEST;
delete process.env.BUILD_SOURCEBRANCHNAME;
delete process.env.SYSTEM_PULLREQUEST_PULLREQUESTID;
delete process.env.BITBUCKET_BRANCH;
delete process.env.BITBUCKET_PR_ID;
delete process.env.TINYBIRD_BRANCH_NAME;
delete process.env.TINYBIRD_BRANCH_TOKEN;
delete process.env.TINYBIRD_TOKEN;
Expand Down Expand Up @@ -70,6 +73,36 @@ describe("Preview environment detection", () => {
process.env.CI = "true";
expect(isPreviewEnvironment()).toBe(false);
});

it("returns true for CircleCI pull requests", () => {
process.env.CIRCLE_PULL_REQUEST = "https://github.com/org/repo/pull/1";
expect(isPreviewEnvironment()).toBe(true);
});

it("returns false for CircleCI builds without a pull request", () => {
process.env.CIRCLE_BRANCH = "feature-branch";
expect(isPreviewEnvironment()).toBe(false);
});

it("returns true for Azure DevOps pull requests", () => {
process.env.SYSTEM_PULLREQUEST_PULLREQUESTID = "42";
expect(isPreviewEnvironment()).toBe(true);
});

it("returns false for Azure DevOps builds without a pull request", () => {
process.env.BUILD_SOURCEBRANCHNAME = "feature-branch";
expect(isPreviewEnvironment()).toBe(false);
});

it("returns true for Bitbucket Pipelines pull requests", () => {
process.env.BITBUCKET_PR_ID = "7";
expect(isPreviewEnvironment()).toBe(true);
});

it("returns false for Bitbucket Pipelines builds without a pull request", () => {
process.env.BITBUCKET_BRANCH = "feature-branch";
expect(isPreviewEnvironment()).toBe(false);
});
});

describe("getPreviewBranchName", () => {
Expand Down
9 changes: 9 additions & 0 deletions src/client/preview.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ let cachedBranchName: string | null = null;

/**
* Detect if we're running in a preview/CI environment
*
* Recognizes Vercel, GitHub Actions, GitLab, CircleCI, Azure DevOps,
* Bitbucket Pipelines, and generic CI (with an explicit preview flag).
*/
export function isPreviewEnvironment(): boolean {
return !!(
Expand All @@ -34,6 +37,12 @@ export function isPreviewEnvironment(): boolean {
process.env.GITHUB_HEAD_REF ||
// GitLab CI (merge requests)
process.env.CI_MERGE_REQUEST_SOURCE_BRANCH_NAME ||
// CircleCI (PRs)
process.env.CIRCLE_PULL_REQUEST ||
// Azure Pipelines (PRs)
process.env.SYSTEM_PULLREQUEST_PULLREQUESTID ||
// Bitbucket Pipelines (PRs)
process.env.BITBUCKET_PR_ID ||
// Generic CI with preview indicator
(process.env.CI && process.env.TINYBIRD_PREVIEW_MODE === "true")
);
Expand Down
Loading