feat: disable tracking by default in non-production environments

Author: JeanMeijer

packages/analytics/src/client/utils.ts

@@ -1,11 +1,41 @@
 import type { SimpleAnalyticsProps } from "./simple-analytics";
+import { PHASE_PRODUCTION_BUILD } from "next/constants";
+
+export function isProduction() {
+  if (process.env.NEXT_PUBLIC_ENABLE_ANALYTICS_IN_DEV === "1") {
+    return true;
+  }
+
+  if (process.env.NODE_ENV !== "production") {
+    return false;
+  }
+
+  if (!process.env.NEXT_PUBLIC_VERCEL_ENV) {
+    return true;
+  }
+
+  return process.env.NEXT_PUBLIC_VERCEL_ENV !== "production";
+}
+
+function isBuildTime() {
+  return process.env.NEXT_PHASE === PHASE_PRODUCTION_BUILD;
+}
 
 export function parseDataProps(settings?: SimpleAnalyticsProps) {
   if (!process.env.NEXT_PUBLIC_SIMPLE_ANALYTICS_HOSTNAME) {
     console.error("No hostname provided for Simple Analytics");
     return {};
   }
 
+  if (isBuildTime()) {
+    return {};
+  }
+
+  if (!isProduction()) {
+    console.log("Simple Analytics is disabled by default in development and preview environments, enable it by setting NEXT_PUBLIC_ENABLE_ANALYTICS_IN_DEV=1 in your environment");
+    return {};
+  }
+
   if (!settings) {
     return {
       "data-hostname": process.env.NEXT_PUBLIC_SIMPLE_ANALYTICS_HOSTNAME,

packages/analytics/src/server/simple-analytics.ts

@@ -7,7 +7,7 @@ import type {
   HeaderOnlyContext,
   ServerContext,
 } from "./interfaces";
-import { isDoNotTrackEnabled, parseRequest } from "./utils";
+import { isBuildTime, isProduction, isDoNotTrackEnabled, parseRequest } from "./utils";
 import { parseHeaders } from "./headers";
 import { parseUtmParameters } from "./utm";
 
@@ -40,6 +40,15 @@ export async function trackEvent(
     ...parseHeaders(headers, options.ignoreMetrics),
   };
 
+  if (isBuildTime()) {
+    return;
+  }
+
+  if (!isProduction()) {
+    console.log("Simple Analytics is disabled by default in development and preview environments, enable it by setting ENABLE_ANALYTICS_IN_DEV=1 in your environment");
+    return;
+  }
+
   const response = await fetch("https://queue.simpleanalyticscdn.com/events", {
     method: "POST",
     headers: {
@@ -110,6 +119,15 @@ export async function trackPageview(options: TrackPageviewOptions) {
       : {}),
   };
 
+  if (isBuildTime()) {
+    return;
+  }
+
+  if (!isProduction()) {
+    console.log("Simple Analytics is disabled by default in development and preview environments, enable it by setting ENABLE_ANALYTICS_IN_DEV=1 in your environment");
+    return;
+  }
+
   const response = await fetch("https://queue.simpleanalyticscdn.com/events", {
     method: "POST",
     headers: {

packages/analytics/src/server/utils.ts

@@ -1,3 +1,5 @@
+import { PHASE_PRODUCTION_BUILD } from "next/constants";
+
 export function isDoNotTrackEnabled(headers: Headers) {
   return headers.has("DNT") && headers.get("DNT") === "1";
 }
@@ -10,3 +12,27 @@ export function parseRequest(request: Request) {
     searchParams: url.searchParams,
   };
 }
+
+export function isProduction() {
+  if (process.env.ENABLE_ANALYTICS_IN_DEV === "1") {
+    return true;
+  }
+
+  if (process.env.NODE_ENV !== "production") {
+    return false;
+  }
+
+  if (!process.env.VERCEL_ENV) {
+    return true;
+  }
+
+  return process.env.VERCEL_ENV !== "production";
+}
+
+export function isRunningOnVercel() {
+  return process.env.VERCEL === "1";
+}
+
+export function isBuildTime() {
+  return process.env.NEXT_PHASE === PHASE_PRODUCTION_BUILD;
+}