mirror of
https://github.com/Abdulazizzn/n8n-enterprise-unlocked.git
synced 2025-12-18 10:31:15 +00:00
✨ 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>
This commit is contained in:
@@ -4,7 +4,7 @@
|
||||
/* eslint-disable @typescript-eslint/no-unsafe-assignment */
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
import { randomBytes } from 'crypto';
|
||||
import { createHash, randomBytes } from 'crypto';
|
||||
// eslint-disable-next-line import/no-cycle
|
||||
import {
|
||||
ENCRYPTION_KEY_ENV_OVERWRITE,
|
||||
@@ -37,7 +37,12 @@ export async function prepareUserSettings(): Promise<IUserSettings> {
|
||||
if (userSettings !== undefined) {
|
||||
// Settings already exist, check if they contain the encryptionKey
|
||||
if (userSettings.encryptionKey !== undefined) {
|
||||
// Key already exists so return
|
||||
// Key already exists
|
||||
if (userSettings.instanceId === undefined) {
|
||||
userSettings.instanceId = await generateInstanceId(userSettings.encryptionKey);
|
||||
settingsCache = userSettings;
|
||||
}
|
||||
|
||||
return userSettings;
|
||||
}
|
||||
} else {
|
||||
@@ -52,6 +57,8 @@ export async function prepareUserSettings(): Promise<IUserSettings> {
|
||||
userSettings.encryptionKey = randomBytes(24).toString('base64');
|
||||
}
|
||||
|
||||
userSettings.instanceId = await generateInstanceId(userSettings.encryptionKey);
|
||||
|
||||
// eslint-disable-next-line no-console
|
||||
console.log(`UserSettings were generated and saved to: ${settingsPath}`);
|
||||
|
||||
@@ -65,8 +72,8 @@ export async function prepareUserSettings(): Promise<IUserSettings> {
|
||||
* @export
|
||||
* @returns
|
||||
*/
|
||||
// eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
|
||||
export async function getEncryptionKey() {
|
||||
|
||||
export async function getEncryptionKey(): Promise<string | undefined> {
|
||||
if (process.env[ENCRYPTION_KEY_ENV_OVERWRITE] !== undefined) {
|
||||
return process.env[ENCRYPTION_KEY_ENV_OVERWRITE];
|
||||
}
|
||||
@@ -84,6 +91,36 @@ export async function getEncryptionKey() {
|
||||
return userSettings.encryptionKey;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the instance ID
|
||||
*
|
||||
* @export
|
||||
* @returns
|
||||
*/
|
||||
export async function getInstanceId(): Promise<string> {
|
||||
const userSettings = await getUserSettings();
|
||||
|
||||
if (userSettings === undefined) {
|
||||
return '';
|
||||
}
|
||||
|
||||
if (userSettings.instanceId === undefined) {
|
||||
return '';
|
||||
}
|
||||
|
||||
return userSettings.instanceId;
|
||||
}
|
||||
|
||||
async function generateInstanceId(key?: string) {
|
||||
const hash = key
|
||||
? createHash('sha256')
|
||||
.update(key.slice(Math.round(key.length / 2)))
|
||||
.digest('hex')
|
||||
: undefined;
|
||||
|
||||
return hash;
|
||||
}
|
||||
|
||||
/**
|
||||
* Adds/Overwrite the given settings in the currently
|
||||
* saved user settings
|
||||
@@ -141,7 +178,12 @@ export async function writeUserSettings(
|
||||
await fsMkdir(path.dirname(settingsPath));
|
||||
}
|
||||
|
||||
await fsWriteFile(settingsPath, JSON.stringify(userSettings, null, '\t'));
|
||||
const settingsToWrite = { ...userSettings };
|
||||
if (settingsToWrite.instanceId !== undefined) {
|
||||
delete settingsToWrite.instanceId;
|
||||
}
|
||||
|
||||
await fsWriteFile(settingsPath, JSON.stringify(settingsToWrite, null, '\t'));
|
||||
settingsCache = JSON.parse(JSON.stringify(userSettings));
|
||||
|
||||
return userSettings;
|
||||
|
||||
Reference in New Issue
Block a user