Skip to content

analytics | disable beacon #60

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

Merged
OmerKat merged 1 commit into from
Dec 31, 2025
Merged

analytics | disable beacon #60

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
19 changes: 12 additions & 7 deletions src/modules/analytics.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@ import type { AuthModule } from "./auth.types";
import { generateUuid } from "../utils/common";

export const USER_HEARTBEAT_EVENT_NAME = "__user_heartbeat_event__";
export const ANALYTICS_CONFIG_URL_PARAM_KEY = "analytics-disable";
export const ANALYTICS_CONFIG_ENABLE_URL_PARAM_KEY = "analytics-enable";

export const ANALYTICS_SESSION_ID_LOCAL_STORAGE_KEY =
"base44_analytics_session_id";

const defaultConfiguration: AnalyticsModuleOptions = {
enabled: true,
// default to disabled //
enabled: false,
maxQueueSize: 1000,
throttleTime: 1000,
batchSize: 30,
Expand Down Expand Up @@ -81,6 +83,7 @@ export const createAnalyticsModule = ({
} as AnalyticsApiBatchRequest);
};

// currently disabled, until fully tested //
const beaconRequest = async (events: AnalyticsApiRequestData[]) => {
const beaconPayload = JSON.stringify({ events });
try {
Expand All @@ -100,8 +103,10 @@ export const createAnalyticsModule = ({
const events = eventsData.map(
transformEventDataToApiRequestData(sessionContext_)
);
if (!(await beaconRequest(events))) {
try {
return batchRequestFallback(events);
} catch {
// do nothing
}
};

Expand Down Expand Up @@ -265,21 +270,21 @@ export function getAnalyticsConfigFromUrlParams():
| undefined {
if (typeof window === "undefined") return undefined;
const urlParams = new URLSearchParams(window.location.search);
const analyticsDisable = urlParams.get(ANALYTICS_CONFIG_URL_PARAM_KEY);
const analyticsEnable = urlParams.get(ANALYTICS_CONFIG_ENABLE_URL_PARAM_KEY);

// if the url param is not set, return undefined //
if (analyticsDisable == null || !analyticsDisable.length) return undefined;
if (analyticsEnable == null || !analyticsEnable.length) return undefined;

// remove the url param from the url //
const newUrlParams = new URLSearchParams(window.location.search);
newUrlParams.delete(ANALYTICS_CONFIG_URL_PARAM_KEY);
newUrlParams.delete(ANALYTICS_CONFIG_ENABLE_URL_PARAM_KEY);
const newUrl =
window.location.pathname +
(newUrlParams.toString() ? "?" + newUrlParams.toString() : "");
window.history.replaceState({}, "", newUrl);

// return the config object //
return analyticsDisable === "true" ? { enabled: false } : undefined;
return { enabled: analyticsEnable === "true" };
}

export function getAnalyticsSessionId(): string {
Expand Down