✨ Introduce telemetry (#2099)

* introduce analytics * add user survey backend * add user survey backend * set answers on survey submit Co-authored-by: Mutasem Aldmour <4711238+mutdmour@users.noreply.github.com> * change name to personalization * lint Co-authored-by: Mutasem Aldmour <4711238+mutdmour@users.noreply.github.com> * N8n 2495 add personalization modal (#2280) * update modals * add onboarding modal * implement questions * introduce analytics * simplify impl * implement survey handling * add personalized cateogry * update modal behavior * add thank you view * handle empty cases * rename modal * standarize modal names * update image, add tags to headings * remove unused file * remove unused interfaces * clean up footer spacing * introduce analytics * refactor to fix bug * update endpoint * set min height * update stories * update naming from questions to survey * remove spacing after core categories * fix bug in logic * sort nodes * rename types * merge with be * rename userSurvey * clean up rest api * use constants for keys * use survey keys * clean up types * move personalization to its own file Co-authored-by: ahsan-virani <ahsan.virani@gmail.com> * Survey new options (#2300) * split up options * fix quotes * remove unused import * add user created workflow event (#2301) * simplify env vars * fix versionCli on FE * update personalization env * fix event User opened Credentials panel * fix select modal spacing * fix nodes panel event * fix workflow id in workflow execute event * improve telemetry error logging * fix config and stop process events * add flush call on n8n stop * ready for release * improve telemetry process exit * fix merge * improve n8n stop events Co-authored-by: Mutasem Aldmour <4711238+mutdmour@users.noreply.github.com> Co-authored-by: Mutasem <mutdmour@gmail.com> Co-authored-by: Jan Oberhauser <jan.oberhauser@gmail.com>
2025-12-17 18:12:04 +00:00 · 2021-10-19 05:57:49 +02:00
parent 4b857b19ac
commit 421dd72224
100 changed files with 2223 additions and 550 deletions
--- a/packages/workflow/src/Interfaces.ts
+++ b/packages/workflow/src/Interfaces.ts
@@ -1064,3 +1064,41 @@ export type PropertiesOf<M extends { resource: string; operation: string }> = Ar
 		};
 	}
 >;
+
+// Telemetry
+
+export interface INodesGraph {
+	node_types: string[];
+	node_connections: IDataObject[];
+	nodes: INodesGraphNode;
+}
+
+export interface INodesGraphNode {
+	[key: string]: INodeGraphItem;
+}
+
+export interface INodeGraphItem {
+	type: string;
+	resource?: string;
+	operation?: string;
+	domain?: string;
+}
+
+export interface INodeNameIndex {
+	[name: string]: string;
+}
+
+export interface INodesGraphResult {
+	nodeGraph: INodesGraph;
+	nameIndices: INodeNameIndex;
+}
+
+export interface ITelemetryClientConfig {
+	url: string;
+	key: string;
+}
+
+export interface ITelemetrySettings {
+	enabled: boolean;
+	config?: ITelemetryClientConfig;
+}
--- a/packages/workflow/src/TelemetryHelpers.ts
+++ b/packages/workflow/src/TelemetryHelpers.ts
@@ -0,0 +1,61 @@
+/* eslint-disable import/no-cycle */
+import {
+	IConnection,
+	INode,
+	INodeNameIndex,
+	INodesGraph,
+	INodeGraphItem,
+	INodesGraphResult,
+	IWorkflowBase,
+} from '.';
+
+export function getNodeTypeForName(workflow: IWorkflowBase, nodeName: string): INode | undefined {
+	return workflow.nodes.find((node) => node.name === nodeName);
+}
+
+export function generateNodesGraph(workflow: IWorkflowBase): INodesGraphResult {
+	const nodesGraph: INodesGraph = {
+		node_types: [],
+		node_connections: [],
+		nodes: {},
+	};
+	const nodeNameAndIndex: INodeNameIndex = {};
+
+	workflow.nodes.forEach((node: INode, index: number) => {
+		nodesGraph.node_types.push(node.type);
+		const nodeItem: INodeGraphItem = {
+			type: node.type,
+		};
+
+		if (node.type === 'n8n-nodes-base.httpRequest') {
+			try {
+				nodeItem.domain = new URL(node.parameters.url as string).hostname;
+			} catch (e) {
+				nodeItem.domain = node.parameters.url as string;
+			}
+		} else {
+			Object.keys(node.parameters).forEach((parameterName) => {
+				if (parameterName === 'operation' || parameterName === 'resource') {
+					nodeItem[parameterName] = node.parameters[parameterName] as string;
+				}
+			});
+		}
+		nodesGraph.nodes[`${index}`] = nodeItem;
+		nodeNameAndIndex[node.name] = index.toString();
+	});
+
+	const getGraphConnectionItem = (startNode: string, connectionItem: IConnection) => {
+		return { start: nodeNameAndIndex[startNode], end: nodeNameAndIndex[connectionItem.node] };
+	};
+
+	Object.keys(workflow.connections).forEach((nodeName) => {
+		const connections = workflow.connections[nodeName];
+		connections.main.forEach((element) => {
+			element.forEach((element2) => {
+				nodesGraph.node_connections.push(getGraphConnectionItem(nodeName, element2));
+			});
+		});
+	});
+
+	return { nodeGraph: nodesGraph, nameIndices: nodeNameAndIndex };
+}
--- a/packages/workflow/src/index.ts
+++ b/packages/workflow/src/index.ts
@@ -6,6 +6,7 @@ import * as ObservableObject from './ObservableObject';
 export * from './Interfaces';
 export * from './Expression';
 export * from './NodeErrors';
+export * as TelemetryHelpers from './TelemetryHelpers';
 export * from './Workflow';
 export * from './WorkflowDataProxy';
 export * from './WorkflowErrors';