fix: Force posthog recording to be disabled outside cloud

The recordings are not enabled by default, but env variable enabled opt-in. This changes the logic that opt-in requires specific domain.
n8n-io · Jan 18, 2024 · 5bb0acd · 5bb0acd
1 parent 9945701
commit 5bb0acd
Show file tree

Hide file tree

Showing 8 changed files with 13 additions and 14 deletions.
diff --git a/packages/cli/src/config/schema.ts b/packages/cli/src/config/schema.ts
@@ -1143,12 +1143,6 @@ export const schema = {
 					default: 'https://ph.n8n.io',
 					env: 'N8N_DIAGNOSTICS_POSTHOG_API_HOST',
 				},
-				disableSessionRecording: {
-					doc: 'Disable posthog session recording',
-					format: Boolean,
-					default: true,
-					env: 'N8N_DIAGNOSTICS_POSTHOG_DISABLE_RECORDING',
-				},
 			},
 			sentry: {
 				dsn: {

diff --git a/packages/cli/src/services/frontend.service.ts b/packages/cli/src/services/frontend.service.ts
@@ -115,9 +115,6 @@ export class FrontendService {
 				apiHost: config.getEnv('diagnostics.config.posthog.apiHost'),
 				apiKey: config.getEnv('diagnostics.config.posthog.apiKey'),
 				autocapture: false,
-				disableSessionRecording: config.getEnv(
-					'diagnostics.config.posthog.disableSessionRecording',
-				),
 				debug: config.getEnv('logs.level') === 'debug',
 			},
 			personalizationSurveyEnabled:

diff --git a/packages/editor-ui/src/__tests__/server/endpoints/settings.ts b/packages/editor-ui/src/__tests__/server/endpoints/settings.ts
@@ -50,7 +50,6 @@ const defaultSettings: IN8nUISettings = {
 		apiKey: '',
 		autocapture: false,
 		debug: false,
-		disableSessionRecording: false,
 		enabled: false,
 	},
 	publicApi: { enabled: false, latestVersion: 0, path: '', swaggerUi: { enabled: false } },

diff --git a/packages/editor-ui/src/__tests__/utils.ts b/packages/editor-ui/src/__tests__/utils.ts
@@ -61,7 +61,6 @@ export const SETTINGS_STORE_DEFAULT_STATE: ISettingsState = {
 			apiKey: '',
 			autocapture: false,
 			debug: false,
-			disableSessionRecording: false,
 			enabled: false,
 		},
 		publicApi: { enabled: false, latestVersion: 0, path: '', swaggerUi: { enabled: false } },

diff --git a/packages/editor-ui/src/stores/__tests__/posthog.test.ts b/packages/editor-ui/src/stores/__tests__/posthog.test.ts
@@ -13,7 +13,6 @@ const DEFAULT_POSTHOG_SETTINGS: IN8nUISettings['posthog'] = {
 	apiHost: 'host',
 	apiKey: 'key',
 	autocapture: false,
-	disableSessionRecording: true,
 	debug: false,
 };
 const CURRENT_USER_ID = '1';

diff --git a/packages/editor-ui/src/stores/posthog.store.ts b/packages/editor-ui/src/stores/posthog.store.ts
@@ -118,7 +118,7 @@ export const usePostHog = defineStore('posthog', () => {
 			return;
 		}
 
-		const config = settingsStore.settings.posthog;
+		const config = settingsStore.posthogSettings;
 		if (!config.enabled) {
 			return;
 		}

diff --git a/packages/editor-ui/src/stores/settings.store.ts b/packages/editor-ui/src/stores/settings.store.ts
@@ -36,6 +36,10 @@ import { useTitleChange } from '@/composables/useTitleChange';
 import { useToast } from '@/composables/useToast';
 import { i18n } from '@/plugins/i18n';
 
+export type PosthogSettings = IN8nUISettings['posthog'] & {
+	disableSessionRecording: boolean;
+};
+
 export const useSettingsStore = defineStore(STORES.SETTINGS, {
 	state: (): ISettingsState => ({
 		initialized: false,
@@ -193,6 +197,14 @@ export const useSettingsStore = defineStore(STORES.SETTINGS, {
 		isDevRelease(): boolean {
 			return this.settings.releaseChannel === 'dev';
 		},
+		posthogSettings(): PosthogSettings {
+			const disableSessionRecording = !window.location.hostname.endsWith('n8n.cloud');
+
+			return {
+				...this.settings.posthog,
+				disableSessionRecording,
+			};
+		},
 	},
 	actions: {
 		async initialize() {

diff --git a/packages/workflow/src/Interfaces.ts b/packages/workflow/src/Interfaces.ts
@@ -2340,7 +2340,6 @@ export interface IN8nUISettings {
 		apiHost: string;
 		apiKey: string;
 		autocapture: boolean;
-		disableSessionRecording: boolean;
 		debug: boolean;
 	};
 	personalizationSurveyEnabled: boolean;