Integrate PostHog - Part 1: Groundwork

packages/cli/config/schema.ts

@@ -888,6 +888,20 @@ export const schema = {
 			env: 'N8N_DIAGNOSTICS_ENABLED',
 		},
 		config: {
+			posthog: {
+				apiKey: {
+					doc: 'API key for PostHog',
+					format: String,
+					default: 'phc_QLECpA3yiIJcyafUv0pe6EoxvdfIDZ5A12dGpGXH4jV',
+					env: 'N8N_DIAGNOSTICS_POSTHOG_API_KEY',
+				},
+				apiHost: {
+					doc: 'API host for PostHog',
+					format: String,
+					default: 'https://app.posthog.com',
+					env: 'N8N_DIAGNOSTICS_POSTHOG_API_HOST',
+				},
+			},
 			frontend: {
 				doc: 'Diagnostics config for frontend.',
 				format: String,

packages/cli/package.json

@@ -96,9 +96,9 @@
     "typescript": "~4.6.0"
   },
   "dependencies": {
-    "@oclif/core": "^1.9.3",
     "@apidevtools/swagger-cli": "4.0.0",
     "@oclif/command": "^1.5.18",
+    "@oclif/core": "^1.9.3",
     "@oclif/errors": "^1.2.2",
     "@rudderstack/rudder-sdk-node": "1.0.6",
     "@types/json-diff": "^0.5.1",
@@ -156,6 +156,7 @@
     "passport-cookie": "^1.0.9",
     "passport-jwt": "^4.0.0",
     "pg": "^8.3.0",
+    "posthog-node": "^1.3.0",
     "prom-client": "^13.1.0",
     "psl": "^1.8.0",
     "request-promise-native": "^1.0.7",

packages/cli/src/Interfaces.ts

@@ -515,6 +515,9 @@ export interface IN8nUISettings {
 	missingPackages?: boolean;
 	executionMode: 'regular' | 'queue';
 	communityNodesEnabled: boolean;
+	deployment: {
+		type: string;
+	};
 }
 
 export interface IPersonalizationSurveyAnswers {

packages/cli/src/Server.ts

@@ -172,6 +172,7 @@ import {
 } from './UserManagement/UserManagementHelper';
 import { loadPublicApiVersions } from './PublicApi';
 import { SharedWorkflow } from './databases/entities/SharedWorkflow';
+import * as telemetryScripts from './telemetry/scripts';
 
 require('body-parser-xml')(bodyParser);
 
@@ -337,6 +338,9 @@ class App {
 			},
 			executionMode: config.getEnv('executions.mode'),
 			communityNodesEnabled: config.getEnv('nodes.communityPackages.enabled'),
+			deployment: {
+				type: config.getEnv('deployment.type'),
+			},
 		};
 	}
 
@@ -2604,6 +2608,27 @@ class App {
 			readIndexFile = readIndexFile.replace(/\/%BASE_PATH%\//g, n8nPath);
 			readIndexFile = readIndexFile.replace(/\/favicon.ico/g, `${n8nPath}favicon.ico`);
 
+			if (this.frontendSettings.telemetry.enabled) {
+				// @TODO_PART_3:
+				// Confirm if `autocapture` is needed for session recording, if so enable
+
+				// @TODO_ON_COMPLETION:
+				// Set `disableSessionRecording` to `!['desktop_mac', 'desktop_win', 'cloud'].includes(deploymentType)`
+				// Set `debug` to `config.getEnv('logs.level') === 'debug'`
+
+				const postHogScript = telemetryScripts.postHog({
+					apiKey: config.getEnv('diagnostics.config.posthog.apiKey'),
+					apiHost: config.getEnv('diagnostics.config.posthog.apiHost'),
+					autocapture: false,
+					disableSessionRecording: true,
+					debug: true,
+				});
+
+				const firstLinkedScript = '<link href="/js/';
+
+				readIndexFile = readIndexFile.replace(firstLinkedScript, postHogScript + firstLinkedScript);
+			}
+
 			// Serve the altered index.html file separately
 			this.app.get(`/index.html`, async (req: express.Request, res: express.Response) => {
 				res.send(readIndexFile);

packages/cli/src/telemetry/index.ts

@@ -1,9 +1,10 @@
 /* eslint-disable import/no-cycle */
 /* eslint-disable @typescript-eslint/no-unsafe-call */
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
-import TelemetryClient from '@rudderstack/rudder-sdk-node';
+import RudderStack from '@rudderstack/rudder-sdk-node';
+import PostHog from 'posthog-node';
 import { ITelemetryTrackProperties, LoggerProxy } from 'n8n-workflow';
-import * as config from '../../config';
+import config from '../../config';
 import { IExecutionTrackProperties } from '../Interfaces';
 import { getLogger } from '../Logger';
 
@@ -24,7 +25,9 @@ interface IExecutionsBuffer {
 }
 
 export class Telemetry {
-	private client?: TelemetryClient;
+	private rudderStack?: RudderStack;
+
+	private postHog?: PostHog;
 
 	private instanceId: string;
 
@@ -51,18 +54,14 @@ export class Telemetry {
 				return;
 			}
 
-			this.client = this.createTelemetryClient(key, url, logLevel);
+			this.rudderStack = this.initRudderStack(key, url, logLevel);
 
 			this.startPulse();
 		}
 	}
 
-	private createTelemetryClient(
-		key: string,
-		url: string,
-		logLevel: string,
-	): TelemetryClient | undefined {
-		return new TelemetryClient(key, url, { logLevel });
+	private initRudderStack(key: string, url: string, logLevel: string): RudderStack {
+		return new RudderStack(key, url, { logLevel });
 	}
 
 	private startPulse() {
@@ -72,9 +71,7 @@ export class Telemetry {
 	}
 
 	private async pulse(): Promise<unknown> {
-		if (!this.client) {
-			return Promise.resolve();
-		}
+		if (!this.rudderStack) return Promise.resolve();
 
 		const allPromises = Object.keys(this.executionCountsBuffer).map(async (workflowId) => {
 			const promise = this.track('Workflow execution count', {
@@ -92,7 +89,7 @@ export class Telemetry {
 	}
 
 	async trackWorkflowExecution(properties: IExecutionTrackProperties): Promise<void> {
-		if (this.client) {
+		if (this.rudderStack) {
 			const execTime = new Date();
 			const workflowId = properties.workflow_id;
 
@@ -122,8 +119,10 @@ export class Telemetry {
 		clearInterval(this.pulseIntervalReference);
 		void this.track('User instance stopped');
 		return new Promise<void>((resolve) => {
-			if (this.client) {
-				this.client.flush(resolve);
+			if (this.postHog) this.postHog.shutdown();
+
+			if (this.rudderStack) {
+				this.rudderStack.flush(resolve);
 			} else {
 				resolve();
 			}
@@ -134,8 +133,18 @@ export class Telemetry {
 		[key: string]: string | number | boolean | object | undefined | null;
 	}): Promise<void> {
 		return new Promise<void>((resolve) => {
-			if (this.client) {
-				this.client.identify(
+			if (this.postHog) {
+				this.postHog.identify({
+					distinctId: this.instanceId,
+					properties: {
+						...traits,
+						instanceId: this.instanceId,
+					},
+				});
+			}
+
+			if (this.rudderStack) {
+				this.rudderStack.identify(
 					{
 						userId: this.instanceId,
 						anonymousId: '000000000000',
@@ -154,15 +163,15 @@ export class Telemetry {
 
 	async track(eventName: string, properties: ITelemetryTrackProperties = {}): Promise<void> {
 		return new Promise<void>((resolve) => {
-			if (this.client) {
+			if (this.rudderStack) {
 				const { user_id } = properties;
 				const updatedProperties: ITelemetryTrackProperties = {
 					...properties,
 					instance_id: this.instanceId,
 					version_cli: this.versionCli,
 				};
 
-				this.client.track(
+				this.rudderStack.track(
 					{
 						userId: `${this.instanceId}${user_id ? `#${user_id}` : ''}`,
 						anonymousId: '000000000000',
@@ -177,6 +186,17 @@ export class Telemetry {
 		});
 	}
 
+	async isFeatureFlagEnabled(
+		featureFlagName: string,
+		{ user_id: userId }: ITelemetryTrackProperties = {},
+	): Promise<boolean> {
+		if (!this.postHog) return Promise.resolve(false);
+
+		const fullId = [this.instanceId, userId].join('_'); // PostHog disallows # in ID
+
+		return this.postHog.isFeatureEnabled(featureFlagName, fullId);
+	}
+
 	// test helpers
 
 	getCountsBuffer(): IExecutionsBuffer {