@dash0/sdk-web 0.21.0 → 0.22.1

package/dist/modules/api/browser-env.js

@@ -0,0 +1,33 @@
+// Shared types and helpers for reading build-environment variables exposed
+// to the browser bundle. Owned by this module because it is used from both
+// init.ts (environment / deployment detection) and vcs.ts (VCS detection).
+//
+// IMPORTANT: each `process.env.NAME` MUST be a LITERAL accessor in the
+// caller's source. Webpack DefinePlugin, Next.js, Gatsby, and equivalents
+// substitute env vars at build time only when they see the literal form.
+// Dynamic lookups (`process.env[name]`, iterating a string array) are NOT
+// substituted — they resolve to `undefined` in the browser bundle.
+//
+// The type unions below are the single source of truth for which env var
+// names the SDK reads. They are composed via template-literal types so
+// every (prefix × suffix) combination is enumerated at the type level.
+// Adding a framework prefix is a one-line edit to `FrameworkPrefix`; adding
+// a suffix is a one-line edit to the appropriate suffix union.
+/**
+ * Return the first truthy value, or undefined. Used to walk the list of
+ * framework-prefixed variants of an env var and pick whichever the user's
+ * bundler substituted at build time.
+ *
+ * The falsy check skips empty strings as well as undefined — bundlers that
+ * do not substitute a literal leave it as `undefined`, not `""`, so empty
+ * is treated as "not set". This is intentional and matches every known
+ * `VERCEL_GIT_*` / `REPOSITORY_URL` / etc. value shape (non-empty strings
+ * or absent; Vercel PR IDs are positive integer strings, never `"0"`).
+ */
+export function pickFirstString(...values) {
+    for (const value of values) {
+        if (value)
+            return value;
+    }
+    return undefined;
+}

package/dist/modules/api/init.js

@@ -1,14 +1,14 @@
 import { vars } from "../vars";
 import { DEPLOYMENT_ENVIRONMENT_NAME, DEPLOYMENT_ID, DEPLOYMENT_NAME, PAGE_LOAD_ID, SERVICE_NAME, SERVICE_NAMESPACE, SERVICE_VERSION, USER_AGENT, } from "../semantic-conventions";
-import { fetch, generateUniqueId, isSafeServiceName, PAGE_LOAD_ID_BYTES, warn, debug, perf, nav, win, NO_VALUE_FALLBACK, pick, loc, } from "../utils";
-import { trackSessions } from "./session";
+import { fetch, generateUniqueId, isSessionSampledIn, isSafeServiceName, PAGE_LOAD_ID_BYTES, warn, debug, perf, nav, win, NO_VALUE_FALLBACK, pick, loc, } from "../utils";
+import { sessionId, trackSessions } from "./session";
 import { startWebVitalsInstrumentation } from "../instrumentations/web-vitals";
 import { startErrorInstrumentation } from "../instrumentations/errors";
 import { addAttribute } from "../utils/otel";
 import { instrumentFetch } from "../instrumentations/http/fetch";
 import { startNavigationInstrumentation } from "../instrumentations/navigation";
-import { merge } from "ts-deepmerge";
 import { initializeTabId } from "../utils/tab-id";
+import { pickFirstString } from "./browser-env";
 import { applyVcsResourceAttributes } from "./vcs";
 let hasBeenInitialised = false;
 export function init(opts) {
@@ -56,6 +56,15 @@ export function init(opts) {
     initializeSignalAttributes(opts);
     initializeTabId();
     trackSessions(opts.sessionInactivityTimeoutMillis, opts.sessionTerminationTimeoutMillis);
+    if (opts.sessionSamplingRate != null) {
+        const rate = Math.max(0, Math.min(100, opts.sessionSamplingRate));
+        vars.isSessionSampled = sessionId != null ? isSessionSampledIn(sessionId, rate) : rate > 0;
+    }
+    if (!vars.isSessionSampled) {
+        debug("Session is not sampled. No telemetry will be transmitted for this session.");
+        hasBeenInitialised = true;
+        return;
+    }
     if (isInstrumentationEnabled("@dash0/navigation", opts)) {
         startNavigationInstrumentation();
     }
@@ -107,17 +116,18 @@ function isSupported() {
 function isClient() {
     return win != null;
 }
+// Vercel auto-prefixes its system env vars under every framework preset
+// (see https://vercel.com/docs/environment-variables/framework-environment-variables).
+// The shared `FrameworkPrefix` union in `./browser-env` is the single source
+// of truth for which prefixes the SDK recognises. To add a new prefix, edit
+// it there; the literal accessors below pick it up automatically via the
+// typed `process.env` declaration.
 function detectEnvironment(opts) {
-    // if there is a manually specified value we use that
     if (opts.environment) {
         return opts.environment;
     }
-    // if process isn't defined access to it causes an exception, but we can't check for its present due to how
-    // plugins like webpack define work.
     try {
-        // vercel
-        // @ts-expect-error -- we need to access like this to allow webpack in the nextjs build to replace this
-        return process?.env?.NEXT_PUBLIC_VERCEL_ENV;
+        return pickFirstString(process?.env?.NEXT_PUBLIC_VERCEL_ENV, process?.env?.NUXT_PUBLIC_VERCEL_ENV, process?.env?.NUXT_ENV_VERCEL_ENV, process?.env?.REACT_APP_VERCEL_ENV, process?.env?.GATSBY_VERCEL_ENV, process?.env?.VITE_VERCEL_ENV, process?.env?.PUBLIC_VERCEL_ENV, process?.env?.VUE_APP_VERCEL_ENV, process?.env?.REDWOOD_ENV_VERCEL_ENV, process?.env?.SANITY_STUDIO_VERCEL_ENV);
     }
     catch (_ignored) {
         return undefined;
@@ -127,12 +137,8 @@ function detectDeploymentName(opts) {
     if (opts.deploymentName) {
         return opts.deploymentName;
     }
-    // if process isn't defined access to it causes an exception, but we can't check for its present due to how
-    // plugins like webpack define work.
     try {
-        // vercel
-        // @ts-expect-error -- we need to access like this to allow webpack in the nextjs build to replace this
-        return process?.env?.NEXT_PUBLIC_VERCEL_TARGET_ENV;
+        return pickFirstString(process?.env?.NEXT_PUBLIC_VERCEL_TARGET_ENV, process?.env?.NUXT_PUBLIC_VERCEL_TARGET_ENV, process?.env?.NUXT_ENV_VERCEL_TARGET_ENV, process?.env?.REACT_APP_VERCEL_TARGET_ENV, process?.env?.GATSBY_VERCEL_TARGET_ENV, process?.env?.VITE_VERCEL_TARGET_ENV, process?.env?.PUBLIC_VERCEL_TARGET_ENV, process?.env?.VUE_APP_VERCEL_TARGET_ENV, process?.env?.REDWOOD_ENV_VERCEL_TARGET_ENV, process?.env?.SANITY_STUDIO_VERCEL_TARGET_ENV);
     }
     catch (_ignored) {
         return undefined;
@@ -142,12 +148,8 @@ function detectDeploymentId(opts) {
     if (opts.deploymentId) {
         return opts.deploymentId;
     }
-    // if process isn't defined access to it causes an exception, but we can't check for its present due to how
-    // plugins like webpack define work.
     try {
-        // vercel
-        // @ts-expect-error -- we need to access like this to allow webpack in the nextjs build to replace this
-        return process?.env?.NEXT_PUBLIC_VERCEL_BRANCH_URL;
+        return pickFirstString(process?.env?.NEXT_PUBLIC_VERCEL_BRANCH_URL, process?.env?.NUXT_PUBLIC_VERCEL_BRANCH_URL, process?.env?.NUXT_ENV_VERCEL_BRANCH_URL, process?.env?.REACT_APP_VERCEL_BRANCH_URL, process?.env?.GATSBY_VERCEL_BRANCH_URL, process?.env?.VITE_VERCEL_BRANCH_URL, process?.env?.PUBLIC_VERCEL_BRANCH_URL, process?.env?.VUE_APP_VERCEL_BRANCH_URL, process?.env?.REDWOOD_ENV_VERCEL_BRANCH_URL, process?.env?.SANITY_STUDIO_VERCEL_BRANCH_URL);
     }
     catch (_ignored) {
         return undefined;
@@ -188,3 +190,24 @@ function isInstrumentationEnabled(name, opts) {
         return true;
     return instrumentations.includes(name);
 }
+function merge(target, source) {
+    const result = { ...target };
+    for (const key of Object.keys(source)) {
+        const srcVal = source[key];
+        const dstVal = target[key];
+        if (srcVal !== undefined) {
+            if (srcVal !== null &&
+                typeof srcVal === "object" &&
+                !Array.isArray(srcVal) &&
+                typeof dstVal === "object" &&
+                dstVal !== null &&
+                !Array.isArray(dstVal)) {
+                result[key] = { ...dstVal, ...srcVal };
+            }
+            else {
+                result[key] = srcVal;
+            }
+        }
+    }
+    return result;
+}

package/dist/modules/api/init_test.js

@@ -1,5 +1,5 @@
 import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import { SERVICE_NAME, SERVICE_NAMESPACE, VCS_CHANGE_ID, VCS_OWNER_NAME, VCS_PROVIDER_NAME, VCS_REF_HEAD_NAME, VCS_REF_HEAD_REVISION, VCS_REPOSITORY_NAME, VCS_REPOSITORY_URL_FULL, } from "../semantic-conventions";
+import { DEPLOYMENT_ENVIRONMENT_NAME, DEPLOYMENT_ID, DEPLOYMENT_NAME, SERVICE_NAME, SERVICE_NAMESPACE, VCS_CHANGE_ID, VCS_OWNER_NAME, VCS_PROVIDER_NAME, VCS_REF_HEAD_NAME, VCS_REF_HEAD_REVISION, VCS_REPOSITORY_NAME, VCS_REPOSITORY_URL_FULL, } from "../semantic-conventions";
 // Mock all the instrumentation modules
 vi.mock("../instrumentations/web-vitals", () => ({
     startWebVitalsInstrumentation: vi.fn(),
@@ -342,7 +342,8 @@ describe("init", () => {
         // detectVcsFromVercel is actually wired up.
         const FRAMEWORK_PREFIX_SAMPLES = [
             ["Next.js", "NEXT_PUBLIC_"],
-            ["Nuxt", "NUXT_ENV_"],
+            ["Nuxt 3", "NUXT_PUBLIC_"],
+            ["Nuxt 2", "NUXT_ENV_"],
             ["Create React App", "REACT_APP_"],
             ["Gatsby", "GATSBY_"],
             ["Vite", "VITE_"],
@@ -534,4 +535,55 @@ describe("init", () => {
             expect(stringAttr(VCS_REPOSITORY_NAME)).toBeUndefined();
         });
     });
+    describe("environment + deployment auto-detection", () => {
+        afterEach(() => {
+            vi.unstubAllEnvs();
+        });
+        const stringAttr = (key) => vars.resource.attributes.find((attr) => attr.key === key)?.value.stringValue;
+        // The 9 framework prefixes Vercel auto-prefixes its `VERCEL_*` system
+        // vars under (per https://vercel.com/docs/environment-variables/framework-environment-variables).
+        // Same matrix the VCS detection uses, sourced from the shared
+        // `FrameworkPrefix` union in `./browser-env`.
+        const FRAMEWORK_PREFIX_SAMPLES = [
+            ["Next.js", "NEXT_PUBLIC_"],
+            ["Nuxt 3", "NUXT_PUBLIC_"],
+            ["Nuxt 2", "NUXT_ENV_"],
+            ["Create React App", "REACT_APP_"],
+            ["Gatsby", "GATSBY_"],
+            ["Vite", "VITE_"],
+            ["Astro / SvelteKit / Hydrogen", "PUBLIC_"],
+            ["Vue CLI", "VUE_APP_"],
+            ["RedwoodJS", "REDWOOD_ENV_"],
+            ["Sanity Studio", "SANITY_STUDIO_"],
+        ];
+        it.each(FRAMEWORK_PREFIX_SAMPLES)("derives environment + deployment resource attributes from %s framework prefix (%s)", (_label, prefix) => {
+            vi.stubEnv(`${prefix}VERCEL_ENV`, "production");
+            vi.stubEnv(`${prefix}VERCEL_TARGET_ENV`, "production");
+            vi.stubEnv(`${prefix}VERCEL_BRANCH_URL`, "my-site-git-main.vercel.app");
+            init(baseOptions);
+            expect(stringAttr(DEPLOYMENT_ENVIRONMENT_NAME)).toBe("production");
+            expect(stringAttr(DEPLOYMENT_NAME)).toBe("production");
+            expect(stringAttr(DEPLOYMENT_ID)).toBe("my-site-git-main.vercel.app");
+        });
+        it("opts.environment / opts.deploymentName / opts.deploymentId override env-var detection", () => {
+            vi.stubEnv("NEXT_PUBLIC_VERCEL_ENV", "from-env");
+            vi.stubEnv("NEXT_PUBLIC_VERCEL_TARGET_ENV", "from-env");
+            vi.stubEnv("NEXT_PUBLIC_VERCEL_BRANCH_URL", "from-env");
+            init({
+                ...baseOptions,
+                environment: "manual-environment",
+                deploymentName: "manual-deployment-name",
+                deploymentId: "manual-deployment-id",
+            });
+            expect(stringAttr(DEPLOYMENT_ENVIRONMENT_NAME)).toBe("manual-environment");
+            expect(stringAttr(DEPLOYMENT_NAME)).toBe("manual-deployment-name");
+            expect(stringAttr(DEPLOYMENT_ID)).toBe("manual-deployment-id");
+        });
+        it("emits no environment/deployment attributes when neither env vars nor opts are set", () => {
+            init(baseOptions);
+            expect(stringAttr(DEPLOYMENT_ENVIRONMENT_NAME)).toBeUndefined();
+            expect(stringAttr(DEPLOYMENT_NAME)).toBeUndefined();
+            expect(stringAttr(DEPLOYMENT_ID)).toBeUndefined();
+        });
+    });
 });

package/dist/modules/api/vcs.js

@@ -1,6 +1,7 @@
 import { vars } from "../vars";
 import { VCS_CHANGE_ID, VCS_OWNER_NAME, VCS_PROVIDER_NAME, VCS_REF_HEAD_NAME, VCS_REF_HEAD_REVISION, VCS_REPOSITORY_NAME, VCS_REPOSITORY_URL_FULL, } from "../semantic-conventions";
 import { addAttribute } from "../utils/otel";
+import { pickFirstString } from "./browser-env";
 // Single source of truth mapping each VcsAttributes field to its OTel
 // resource attribute name. Typed as `Record<keyof VcsAttributes, string>` so
 // adding a field to VcsAttributes without adding an entry here is a compile
@@ -78,12 +79,12 @@ function detectVcsFromVercel() {
     let revision;
     let changeId;
     try {
-        provider = pickFirstString(process?.env?.NEXT_PUBLIC_VERCEL_GIT_PROVIDER, process?.env?.NUXT_ENV_VERCEL_GIT_PROVIDER, process?.env?.REACT_APP_VERCEL_GIT_PROVIDER, process?.env?.GATSBY_VERCEL_GIT_PROVIDER, process?.env?.VITE_VERCEL_GIT_PROVIDER, process?.env?.PUBLIC_VERCEL_GIT_PROVIDER, process?.env?.VUE_APP_VERCEL_GIT_PROVIDER, process?.env?.REDWOOD_ENV_VERCEL_GIT_PROVIDER, process?.env?.SANITY_STUDIO_VERCEL_GIT_PROVIDER);
-        owner = pickFirstString(process?.env?.NEXT_PUBLIC_VERCEL_GIT_REPO_OWNER, process?.env?.NUXT_ENV_VERCEL_GIT_REPO_OWNER, process?.env?.REACT_APP_VERCEL_GIT_REPO_OWNER, process?.env?.GATSBY_VERCEL_GIT_REPO_OWNER, process?.env?.VITE_VERCEL_GIT_REPO_OWNER, process?.env?.PUBLIC_VERCEL_GIT_REPO_OWNER, process?.env?.VUE_APP_VERCEL_GIT_REPO_OWNER, process?.env?.REDWOOD_ENV_VERCEL_GIT_REPO_OWNER, process?.env?.SANITY_STUDIO_VERCEL_GIT_REPO_OWNER);
-        repo = pickFirstString(process?.env?.NEXT_PUBLIC_VERCEL_GIT_REPO_SLUG, process?.env?.NUXT_ENV_VERCEL_GIT_REPO_SLUG, process?.env?.REACT_APP_VERCEL_GIT_REPO_SLUG, process?.env?.GATSBY_VERCEL_GIT_REPO_SLUG, process?.env?.VITE_VERCEL_GIT_REPO_SLUG, process?.env?.PUBLIC_VERCEL_GIT_REPO_SLUG, process?.env?.VUE_APP_VERCEL_GIT_REPO_SLUG, process?.env?.REDWOOD_ENV_VERCEL_GIT_REPO_SLUG, process?.env?.SANITY_STUDIO_VERCEL_GIT_REPO_SLUG);
-        ref = pickFirstString(process?.env?.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF, process?.env?.NUXT_ENV_VERCEL_GIT_COMMIT_REF, process?.env?.REACT_APP_VERCEL_GIT_COMMIT_REF, process?.env?.GATSBY_VERCEL_GIT_COMMIT_REF, process?.env?.VITE_VERCEL_GIT_COMMIT_REF, process?.env?.PUBLIC_VERCEL_GIT_COMMIT_REF, process?.env?.VUE_APP_VERCEL_GIT_COMMIT_REF, process?.env?.REDWOOD_ENV_VERCEL_GIT_COMMIT_REF, process?.env?.SANITY_STUDIO_VERCEL_GIT_COMMIT_REF);
-        revision = pickFirstString(process?.env?.NEXT_PUBLIC_VERCEL_GIT_COMMIT_SHA, process?.env?.NUXT_ENV_VERCEL_GIT_COMMIT_SHA, process?.env?.REACT_APP_VERCEL_GIT_COMMIT_SHA, process?.env?.GATSBY_VERCEL_GIT_COMMIT_SHA, process?.env?.VITE_VERCEL_GIT_COMMIT_SHA, process?.env?.PUBLIC_VERCEL_GIT_COMMIT_SHA, process?.env?.VUE_APP_VERCEL_GIT_COMMIT_SHA, process?.env?.REDWOOD_ENV_VERCEL_GIT_COMMIT_SHA, process?.env?.SANITY_STUDIO_VERCEL_GIT_COMMIT_SHA);
-        changeId = pickFirstString(process?.env?.NEXT_PUBLIC_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.NUXT_ENV_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.REACT_APP_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.GATSBY_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.VITE_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.PUBLIC_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.VUE_APP_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.REDWOOD_ENV_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.SANITY_STUDIO_VERCEL_GIT_PULL_REQUEST_ID);
+        provider = pickFirstString(process?.env?.NEXT_PUBLIC_VERCEL_GIT_PROVIDER, process?.env?.NUXT_PUBLIC_VERCEL_GIT_PROVIDER, process?.env?.NUXT_ENV_VERCEL_GIT_PROVIDER, process?.env?.REACT_APP_VERCEL_GIT_PROVIDER, process?.env?.GATSBY_VERCEL_GIT_PROVIDER, process?.env?.VITE_VERCEL_GIT_PROVIDER, process?.env?.PUBLIC_VERCEL_GIT_PROVIDER, process?.env?.VUE_APP_VERCEL_GIT_PROVIDER, process?.env?.REDWOOD_ENV_VERCEL_GIT_PROVIDER, process?.env?.SANITY_STUDIO_VERCEL_GIT_PROVIDER);
+        owner = pickFirstString(process?.env?.NEXT_PUBLIC_VERCEL_GIT_REPO_OWNER, process?.env?.NUXT_PUBLIC_VERCEL_GIT_REPO_OWNER, process?.env?.NUXT_ENV_VERCEL_GIT_REPO_OWNER, process?.env?.REACT_APP_VERCEL_GIT_REPO_OWNER, process?.env?.GATSBY_VERCEL_GIT_REPO_OWNER, process?.env?.VITE_VERCEL_GIT_REPO_OWNER, process?.env?.PUBLIC_VERCEL_GIT_REPO_OWNER, process?.env?.VUE_APP_VERCEL_GIT_REPO_OWNER, process?.env?.REDWOOD_ENV_VERCEL_GIT_REPO_OWNER, process?.env?.SANITY_STUDIO_VERCEL_GIT_REPO_OWNER);
+        repo = pickFirstString(process?.env?.NEXT_PUBLIC_VERCEL_GIT_REPO_SLUG, process?.env?.NUXT_PUBLIC_VERCEL_GIT_REPO_SLUG, process?.env?.NUXT_ENV_VERCEL_GIT_REPO_SLUG, process?.env?.REACT_APP_VERCEL_GIT_REPO_SLUG, process?.env?.GATSBY_VERCEL_GIT_REPO_SLUG, process?.env?.VITE_VERCEL_GIT_REPO_SLUG, process?.env?.PUBLIC_VERCEL_GIT_REPO_SLUG, process?.env?.VUE_APP_VERCEL_GIT_REPO_SLUG, process?.env?.REDWOOD_ENV_VERCEL_GIT_REPO_SLUG, process?.env?.SANITY_STUDIO_VERCEL_GIT_REPO_SLUG);
+        ref = pickFirstString(process?.env?.NEXT_PUBLIC_VERCEL_GIT_COMMIT_REF, process?.env?.NUXT_PUBLIC_VERCEL_GIT_COMMIT_REF, process?.env?.NUXT_ENV_VERCEL_GIT_COMMIT_REF, process?.env?.REACT_APP_VERCEL_GIT_COMMIT_REF, process?.env?.GATSBY_VERCEL_GIT_COMMIT_REF, process?.env?.VITE_VERCEL_GIT_COMMIT_REF, process?.env?.PUBLIC_VERCEL_GIT_COMMIT_REF, process?.env?.VUE_APP_VERCEL_GIT_COMMIT_REF, process?.env?.REDWOOD_ENV_VERCEL_GIT_COMMIT_REF, process?.env?.SANITY_STUDIO_VERCEL_GIT_COMMIT_REF);
+        revision = pickFirstString(process?.env?.NEXT_PUBLIC_VERCEL_GIT_COMMIT_SHA, process?.env?.NUXT_PUBLIC_VERCEL_GIT_COMMIT_SHA, process?.env?.NUXT_ENV_VERCEL_GIT_COMMIT_SHA, process?.env?.REACT_APP_VERCEL_GIT_COMMIT_SHA, process?.env?.GATSBY_VERCEL_GIT_COMMIT_SHA, process?.env?.VITE_VERCEL_GIT_COMMIT_SHA, process?.env?.PUBLIC_VERCEL_GIT_COMMIT_SHA, process?.env?.VUE_APP_VERCEL_GIT_COMMIT_SHA, process?.env?.REDWOOD_ENV_VERCEL_GIT_COMMIT_SHA, process?.env?.SANITY_STUDIO_VERCEL_GIT_COMMIT_SHA);
+        changeId = pickFirstString(process?.env?.NEXT_PUBLIC_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.NUXT_PUBLIC_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.NUXT_ENV_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.REACT_APP_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.GATSBY_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.VITE_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.PUBLIC_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.VUE_APP_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.REDWOOD_ENV_VERCEL_GIT_PULL_REQUEST_ID, process?.env?.SANITY_STUDIO_VERCEL_GIT_PULL_REQUEST_ID);
     }
     catch (_ignored) {
         // process is not defined (or a bundler shimmed it strangely) — skip.
@@ -110,10 +111,10 @@ function detectVcsFromNetlify() {
     let commit;
     let reviewId;
     try {
-        repositoryUrl = pickFirstString(process?.env?.NEXT_PUBLIC_REPOSITORY_URL, process?.env?.NUXT_ENV_REPOSITORY_URL, process?.env?.REACT_APP_REPOSITORY_URL, process?.env?.GATSBY_REPOSITORY_URL, process?.env?.VITE_REPOSITORY_URL, process?.env?.PUBLIC_REPOSITORY_URL, process?.env?.VUE_APP_REPOSITORY_URL, process?.env?.REDWOOD_ENV_REPOSITORY_URL, process?.env?.SANITY_STUDIO_REPOSITORY_URL);
-        branch = pickFirstString(process?.env?.NEXT_PUBLIC_BRANCH, process?.env?.NUXT_ENV_BRANCH, process?.env?.REACT_APP_BRANCH, process?.env?.GATSBY_BRANCH, process?.env?.VITE_BRANCH, process?.env?.PUBLIC_BRANCH, process?.env?.VUE_APP_BRANCH, process?.env?.REDWOOD_ENV_BRANCH, process?.env?.SANITY_STUDIO_BRANCH);
-        commit = pickFirstString(process?.env?.NEXT_PUBLIC_COMMIT_REF, process?.env?.NUXT_ENV_COMMIT_REF, process?.env?.REACT_APP_COMMIT_REF, process?.env?.GATSBY_COMMIT_REF, process?.env?.VITE_COMMIT_REF, process?.env?.PUBLIC_COMMIT_REF, process?.env?.VUE_APP_COMMIT_REF, process?.env?.REDWOOD_ENV_COMMIT_REF, process?.env?.SANITY_STUDIO_COMMIT_REF);
-        reviewId = pickFirstString(process?.env?.NEXT_PUBLIC_REVIEW_ID, process?.env?.NUXT_ENV_REVIEW_ID, process?.env?.REACT_APP_REVIEW_ID, process?.env?.GATSBY_REVIEW_ID, process?.env?.VITE_REVIEW_ID, process?.env?.PUBLIC_REVIEW_ID, process?.env?.VUE_APP_REVIEW_ID, process?.env?.REDWOOD_ENV_REVIEW_ID, process?.env?.SANITY_STUDIO_REVIEW_ID);
+        repositoryUrl = pickFirstString(process?.env?.NEXT_PUBLIC_REPOSITORY_URL, process?.env?.NUXT_PUBLIC_REPOSITORY_URL, process?.env?.NUXT_ENV_REPOSITORY_URL, process?.env?.REACT_APP_REPOSITORY_URL, process?.env?.GATSBY_REPOSITORY_URL, process?.env?.VITE_REPOSITORY_URL, process?.env?.PUBLIC_REPOSITORY_URL, process?.env?.VUE_APP_REPOSITORY_URL, process?.env?.REDWOOD_ENV_REPOSITORY_URL, process?.env?.SANITY_STUDIO_REPOSITORY_URL);
+        branch = pickFirstString(process?.env?.NEXT_PUBLIC_BRANCH, process?.env?.NUXT_PUBLIC_BRANCH, process?.env?.NUXT_ENV_BRANCH, process?.env?.REACT_APP_BRANCH, process?.env?.GATSBY_BRANCH, process?.env?.VITE_BRANCH, process?.env?.PUBLIC_BRANCH, process?.env?.VUE_APP_BRANCH, process?.env?.REDWOOD_ENV_BRANCH, process?.env?.SANITY_STUDIO_BRANCH);
+        commit = pickFirstString(process?.env?.NEXT_PUBLIC_COMMIT_REF, process?.env?.NUXT_PUBLIC_COMMIT_REF, process?.env?.NUXT_ENV_COMMIT_REF, process?.env?.REACT_APP_COMMIT_REF, process?.env?.GATSBY_COMMIT_REF, process?.env?.VITE_COMMIT_REF, process?.env?.PUBLIC_COMMIT_REF, process?.env?.VUE_APP_COMMIT_REF, process?.env?.REDWOOD_ENV_COMMIT_REF, process?.env?.SANITY_STUDIO_COMMIT_REF);
+        reviewId = pickFirstString(process?.env?.NEXT_PUBLIC_REVIEW_ID, process?.env?.NUXT_PUBLIC_REVIEW_ID, process?.env?.NUXT_ENV_REVIEW_ID, process?.env?.REACT_APP_REVIEW_ID, process?.env?.GATSBY_REVIEW_ID, process?.env?.VITE_REVIEW_ID, process?.env?.PUBLIC_REVIEW_ID, process?.env?.VUE_APP_REVIEW_ID, process?.env?.REDWOOD_ENV_REVIEW_ID, process?.env?.SANITY_STUDIO_REVIEW_ID);
     }
     catch (_ignored) {
         // process is not defined — skip.
@@ -129,13 +130,6 @@ function detectVcsFromNetlify() {
         changeId: reviewId,
     };
 }
-function pickFirstString(...values) {
-    for (const value of values) {
-        if (value)
-            return value;
-    }
-    return undefined;
-}
 function buildRepositoryUrlFromVercel(provider, owner, repo) {
     if (!provider || !owner || !repo)
         return undefined;

package/dist/modules/transport/index.js

@@ -15,6 +15,8 @@ function isRateLimited() {
     return rateLimiter();
 }
 export function sendLog(log) {
+    if (!vars.isSessionSampled)
+        return;
     if (isRateLimited()) {
         debug("Transport rate limit. Will not send item.", log);
         return;
@@ -41,6 +43,8 @@ function sendLogs(logs) {
 export function sendSpan(span) {
     if (!span)
         return;
+    if (!vars.isSessionSampled)
+        return;
     if (isRateLimited()) {
         debug("Transport rate limit. Will not send item.", span);
         return;

package/dist/modules/utils/index.js

@@ -16,3 +16,4 @@ export * from "./url";
 export * from "./pick";
 export * from "./sanitize";
 export * from "./wrap";
+export * from "./session-sampling";

package/dist/modules/utils/session-sampling.js

@@ -0,0 +1,16 @@
+import { crc32 } from "./crc32";
+/**
+ * Determines whether a session should be sampled based on the session ID
+ * and a configured sampling rate.
+ *
+ * @param sessionId The hex session ID string
+ * @param samplingRate A number between 0 and 100 (inclusive)
+ * @returns true if the session should be sampled (data collected), false otherwise
+ */
+export function isSessionSampledIn(sessionId, samplingRate) {
+    if (samplingRate <= 0)
+        return false;
+    if (samplingRate >= 100)
+        return true;
+    return crc32(sessionId) % 100 < samplingRate;
+}

package/dist/modules/utils/session-sampling_test.js

@@ -0,0 +1,72 @@
+import { describe, expect, it } from "vitest";
+import { isSessionSampledIn } from "./session-sampling";
+import { generateSessionId } from "./session-id";
+describe("isSessionSampledIn", () => {
+    it("returns false when sampling rate is 0", () => {
+        expect(isSessionSampledIn("00abcdef01234567", 0)).toBe(false);
+    });
+    it("returns true when sampling rate is 100", () => {
+        expect(isSessionSampledIn("00abcdef01234567", 100)).toBe(true);
+    });
+    it("returns deterministic results for the same session ID and rate", () => {
+        const sessionId = "00abcdef01234567";
+        const rate = 50;
+        const result1 = isSessionSampledIn(sessionId, rate);
+        const result2 = isSessionSampledIn(sessionId, rate);
+        expect(result1).toBe(result2);
+    });
+    it("produces different results for different session IDs", () => {
+        const results = new Set();
+        // Generate enough IDs to get both true and false with high probability
+        for (let i = 0; i < 100; i++) {
+            results.add(isSessionSampledIn(generateSessionId(), 50));
+        }
+        expect(results.size).toBe(2);
+    });
+    it("produces roughly correct distribution over many session IDs", () => {
+        const rate = 30;
+        const total = 10000;
+        let sampledIn = 0;
+        for (let i = 0; i < total; i++) {
+            if (isSessionSampledIn(generateSessionId(), rate)) {
+                sampledIn++;
+            }
+        }
+        const actualRate = sampledIn / total;
+        // Allow 5% tolerance
+        expect(actualRate).toBeGreaterThan(0.25);
+        expect(actualRate).toBeLessThan(0.35);
+    });
+    it("handles edge case: rate just above 0", () => {
+        // With rate=1, about 1% of sessions should be sampled in
+        let sampledIn = 0;
+        const total = 10000;
+        for (let i = 0; i < total; i++) {
+            if (isSessionSampledIn(generateSessionId(), 1)) {
+                sampledIn++;
+            }
+        }
+        const actualRate = sampledIn / total;
+        expect(actualRate).toBeGreaterThan(0.0);
+        expect(actualRate).toBeLessThan(0.05);
+    });
+    it("handles edge case: rate just below 100", () => {
+        // With rate=99, about 99% of sessions should be sampled in
+        let sampledIn = 0;
+        const total = 10000;
+        for (let i = 0; i < total; i++) {
+            if (isSessionSampledIn(generateSessionId(), 99)) {
+                sampledIn++;
+            }
+        }
+        const actualRate = sampledIn / total;
+        expect(actualRate).toBeGreaterThan(0.95);
+        expect(actualRate).toBeLessThan(1.0);
+    });
+    it("returns false for negative sampling rates", () => {
+        expect(isSessionSampledIn("00abcdef01234567", -10)).toBe(false);
+    });
+    it("returns true for sampling rates above 100", () => {
+        expect(isSessionSampledIn("00abcdef01234567", 150)).toBe(true);
+    });
+});

package/dist/modules/vars.js

@@ -24,4 +24,5 @@ export const vars = {
         includeParts: [],
     },
     enableTransportCompression: false,
+    isSessionSampled: true,
 };