feat: Update NPS Value Survey

cypress/e2e/42-value-survey.cy.ts

@@ -0,0 +1,50 @@
+import { getValueSurvey, getValueSurveyEmail, getValueSurveyRatings } from '../pages/valueSurvey';
+import { WorkflowPage } from '../pages/workflow';
+
+const workflowPage = new WorkflowPage();
+
+const NOW = Date.now();
+const ONE_DAY = 24 * 60 * 60 * 1000;
+const THREE_DAYS = ONE_DAY * 3;
+
+describe('ValueSurvey', () => {
+	it('shows value survey to recently activated user and can submit email ', () => {
+		cy.intercept('/rest/settings', { middleware: true }, (req) => {
+			req.on('response', (res) => {
+				if (res.body.data) {
+					res.body.data.telemetry = { enabled: true };
+				}
+			});
+		});
+
+		cy.intercept('/rest/login', { middleware: true }, (req) => {
+			req.on('response', (res) => {
+				if (res.body.data) {
+					res.body.data.settings = res.body.data.settings || {};
+					res.body.data.settings.userActivated = true;
+					res.body.data.settings.userActivatedAt = NOW - THREE_DAYS - 1000;
+				}
+			});
+		});
+
+		workflowPage.actions.visit();
+
+		workflowPage.actions.saveWorkflowOnButtonClick();
+
+		getValueSurvey().should('be.visible');
+		getValueSurveyRatings().find('button').should('have.length', 11);
+
+		getValueSurveyRatings().find('button').first().click();
+
+		getValueSurveyEmail().find('input').type('[email protected]');
+		getValueSurveyEmail().find('button').click();
+
+		// test that modal does not show up again
+		cy.reload();
+
+		workflowPage.actions.visit();
+		workflowPage.actions.saveWorkflowOnButtonClick();
+
+		getValueSurvey().should('not.be.visible');
+	});
+});

cypress/pages/valueSurvey.ts

@@ -0,0 +1,13 @@
+/**
+ * Getters
+ */
+
+export const getValueSurvey = () => cy.getByTestId('value-survey-modal');
+
+export const getValueSurveyRatings = () => cy.getByTestId('value-survey-ratings');
+
+export const getValueSurveyEmail = () => cy.getByTestId('value-survey-email');
+
+/**
+ * Actions
+ */

packages/cli/src/Server.ts

@@ -72,6 +72,7 @@ import { InvitationController } from './controllers/invitation.controller';
 import { OrchestrationService } from '@/services/orchestration.service';
 import { ProjectController } from './controllers/project.controller';
 import { RoleController } from './controllers/role.controller';
+import { ValueSurveyController } from './controllers/valueSurvey.controller';
 
 const exec = promisify(callbackExec);
 
@@ -150,6 +151,7 @@ export class Server extends AbstractServer {
 			ProjectController,
 			RoleController,
 			CurlController,
+			ValueSurveyController,
 		];
 
 		if (

packages/cli/src/controllers/valueSurvey.controller.ts

@@ -0,0 +1,33 @@
+import { Post, RestController } from '@/decorators';
+import { ValueSurveyRequest } from '@/requests';
+import { UserService } from '@/services/user.service';
+
+@RestController('/value-survey')
+export class ValueSurveyController {
+	constructor(private readonly userService: UserService) {}
+
+	@Post('/show')
+	async valueSurveyShown(req: ValueSurveyRequest.ValueSurveyShown): Promise<void> {
+		await this.userService.updateSettings(req.user.id, {
+			valueSurveyLastShownAt: Date.now(),
+			valueSurveyLastResponseState: 'waiting',
+			valueSurveyIgnoredLastCount: 0,
+		});
+	}
+
+	@Post('/respond')
+	async valueSurveyResponded(req: ValueSurveyRequest.ValueSurveyResponded): Promise<void> {
+		await this.userService.updateSettings(req.user.id, {
+			valueSurveyLastResponseState: 'done',
+			valueSurveyIgnoredLastCount: 0,
+		});
+	}
+
+	@Post('/ignore')
+	async valueSurveyIgnored(req: ValueSurveyRequest.ValueSurveyIgnored): Promise<void> {
+		const lastCount = req.user.settings?.valueSurveyIgnoredLastCount ?? 0;
+		await this.userService.updateSettings(req.user.id, {
+			valueSurveyIgnoredLastCount: lastCount + 1,
+		});
+	}
+}

packages/cli/src/databases/migrations/common/1717498465931-AddActivatedAtUserSetting.ts

@@ -0,0 +1,18 @@
+import type { MigrationContext, ReversibleMigration } from '@db/types';
+
+export class AddActivatedAtUserSetting1717498465931 implements ReversibleMigration {
+	async up({ queryRunner, tablePrefix }: MigrationContext) {
+		const now = Date.now();
+		await queryRunner.query(
+			`UPDATE ${tablePrefix}user
+			SET settings = JSON_SET(settings, '$.userActivatedAt', ${now})
+			WHERE JSON_EXTRACT(settings, '$.userActivated') = true;`,
+		);
+	}
+
+	async down({ queryRunner, tablePrefix }: MigrationContext) {
+		await queryRunner.query(
+			`UPDATE ${tablePrefix}user SET settings = JSON_REMOVE(settings, '$.userActivatedAt')`,
+		);
+	}
+}

packages/cli/src/databases/migrations/mysqldb/index.ts

@@ -57,6 +57,7 @@ import { RemoveFailedExecutionStatus1711018413374 } from '../common/171101841337
 import { MoveSshKeysToDatabase1711390882123 } from '../common/1711390882123-MoveSshKeysToDatabase';
 import { RemoveNodesAccess1712044305787 } from '../common/1712044305787-RemoveNodesAccess';
 import { MakeExecutionStatusNonNullable1714133768521 } from '../common/1714133768521-MakeExecutionStatusNonNullable';
+import { AddActivatedAtUserSetting1717498465931 } from '../common/1717498465931-AddActivatedAtUserSetting';
 
 export const mysqlMigrations: Migration[] = [
 	InitialMigration1588157391238,
@@ -117,4 +118,5 @@ export const mysqlMigrations: Migration[] = [
 	RemoveNodesAccess1712044305787,
 	CreateProject1714133768519,
 	MakeExecutionStatusNonNullable1714133768521,
+	AddActivatedAtUserSetting1717498465931,
 ];

packages/cli/src/databases/migrations/postgresdb/index.ts

@@ -56,6 +56,7 @@ import { RemoveFailedExecutionStatus1711018413374 } from '../common/171101841337
 import { MoveSshKeysToDatabase1711390882123 } from '../common/1711390882123-MoveSshKeysToDatabase';
 import { RemoveNodesAccess1712044305787 } from '../common/1712044305787-RemoveNodesAccess';
 import { MakeExecutionStatusNonNullable1714133768521 } from '../common/1714133768521-MakeExecutionStatusNonNullable';
+import { AddActivatedAtUserSetting1717498465931 } from '../common/1717498465931-AddActivatedAtUserSetting';
 
 export const postgresMigrations: Migration[] = [
 	InitialMigration1587669153312,
@@ -115,4 +116,5 @@ export const postgresMigrations: Migration[] = [
 	RemoveNodesAccess1712044305787,
 	CreateProject1714133768519,
 	MakeExecutionStatusNonNullable1714133768521,
+	AddActivatedAtUserSetting1717498465931,
 ];

packages/cli/src/databases/migrations/sqlite/1717498465931-AddActivatedAtUserSetting.ts

@@ -0,0 +1,5 @@
+import { AddActivatedAtUserSetting1717498465931 as BaseMigration } from '../common/1717498465931-AddActivatedAtUserSetting';
+
+export class AddActivatedAtUserSetting1717498465931 extends BaseMigration {
+	transaction = false as const;
+}

packages/cli/src/databases/migrations/sqlite/index.ts

@@ -54,6 +54,7 @@ import { RemoveFailedExecutionStatus1711018413374 } from '../common/171101841337
 import { MoveSshKeysToDatabase1711390882123 } from '../common/1711390882123-MoveSshKeysToDatabase';
 import { RemoveNodesAccess1712044305787 } from '../common/1712044305787-RemoveNodesAccess';
 import { MakeExecutionStatusNonNullable1714133768521 } from '../common/1714133768521-MakeExecutionStatusNonNullable';
+import { AddActivatedAtUserSetting1717498465931 } from './1717498465931-AddActivatedAtUserSetting';
 
 const sqliteMigrations: Migration[] = [
 	InitialMigration1588102412422,
@@ -111,6 +112,7 @@ const sqliteMigrations: Migration[] = [
 	RemoveNodesAccess1712044305787,
 	CreateProject1714133768519,
 	MakeExecutionStatusNonNullable1714133768521,
+	AddActivatedAtUserSetting1717498465931,
 ];
 
 export { sqliteMigrations };

packages/cli/src/requests.ts

@@ -601,3 +601,12 @@ export declare namespace ProjectRequest {
 	>;
 	type Delete = AuthenticatedRequest<{ projectId: string }, {}, {}, { transferId?: string }>;
 }
+
+// ----------------------------------
+//           /value-survey
+// ----------------------------------
+export declare namespace ValueSurveyRequest {
+	type ValueSurveyShown = AuthenticatedRequest;
+	type ValueSurveyResponded = AuthenticatedRequest;
+	type ValueSurveyIgnored = AuthenticatedRequest;
+}

packages/cli/src/services/events.service.ts

@@ -63,6 +63,7 @@ export class EventsService extends EventEmitter {
 						await Container.get(UserService).updateSettings(owner.id, {
 							firstSuccessfulWorkflowId: workflowId,
 							userActivated: true,
+							userActivatedAt: runData.startedAt.getTime(),
 						});
 					}
 

packages/cli/test/unit/controllers/valueSurvey.controller.test.ts

@@ -0,0 +1,71 @@
+import { ValueSurveyController } from '@/controllers/valueSurvey.controller';
+import type { ValueSurveyRequest } from '@/requests';
+import type { UserService } from '@/services/user.service';
+import { mock } from 'jest-mock-extended';
+
+const NOW = 1717607016208;
+jest.useFakeTimers({
+	now: NOW,
+});
+
+describe('ValueSurveyController', () => {
+	const userService = mock<UserService>();
+	const controller = new ValueSurveyController(userService);
+
+	describe('valueSurveyShown', () => {
+		it('updates user settings, reseting to waiting state', async () => {
+			const req = mock<ValueSurveyRequest.ValueSurveyShown>();
+			req.user.id = '1';
+
+			await controller.valueSurveyShown(req);
+
+			expect(userService.updateSettings).toHaveBeenCalledWith('1', {
+				valueSurveyIgnoredLastCount: 0,
+				valueSurveyLastResponseState: 'waiting',
+				valueSurveyLastShownAt: 1717607016208,
+			});
+		});
+	});
+
+	describe('valueSurveyResponded', () => {
+		it('updates user settings, setting response state to done', async () => {
+			const req = mock<ValueSurveyRequest.ValueSurveyResponded>();
+			req.user.id = '1';
+
+			await controller.valueSurveyResponded(req);
+
+			expect(userService.updateSettings).toHaveBeenCalledWith('1', {
+				valueSurveyIgnoredLastCount: 0,
+				valueSurveyLastResponseState: 'done',
+			});
+		});
+	});
+
+	describe('valueSurveyIgnored', () => {
+		it('updates user settings, incrementing ignore count', async () => {
+			const req = mock<ValueSurveyRequest.ValueSurveyIgnored>();
+			req.user.id = '1';
+			req.user.settings = {
+				valueSurveyIgnoredLastCount: 1,
+			};
+
+			await controller.valueSurveyIgnored(req);
+
+			expect(userService.updateSettings).toHaveBeenCalledWith('1', {
+				valueSurveyIgnoredLastCount: 2,
+			});
+		});
+
+		it('updates user settings, incrementing ignore count from 0, if not set', async () => {
+			const req = mock<ValueSurveyRequest.ValueSurveyIgnored>();
+			req.user.id = '1';
+			req.user.settings = {};
+
+			await controller.valueSurveyIgnored(req);
+
+			expect(userService.updateSettings).toHaveBeenCalledWith('1', {
+				valueSurveyIgnoredLastCount: 2,
+			});
+		});
+	});
+});

packages/editor-ui/src/Interface.ts

@@ -770,14 +770,6 @@ export interface IN8nPrompts {
 	showValueSurvey: boolean;
 }
 
-export interface IN8nValueSurveyData {
-	[key: string]: string;
-}
-
-export interface IN8nPromptResponse {
-	updated: boolean;
-}
-
 export const enum UserManagementAuthenticationMethod {
 	Email = 'email',
 	Ldap = 'ldap',
@@ -1951,4 +1943,41 @@ export type EnterpriseEditionFeatureKey =
 	| 'WorkerView'
 	| 'AdvancedPermissions';
 
+export type ModalKey =
+	| 'about'
+	| 'chatEmbed'
+	| 'changePassword'
+	| 'editCredential'
+	| 'selectCredential'
+	| 'deleteUser'
+	| 'inviteUser'
+	| 'duplicate'
+	| 'tagsManager'
+	| 'versions'
+	| 'settings'
+	| 'lmChat'
+	| 'workflowShare'
+	| 'personalization'
+	| 'contactPrompt'
+	| 'valueSurvey'
+	| 'activation'
+	| 'onboardingCallSignup'
+	| 'communityPackageInstall'
+	| 'communityPackageManageConfirm'
+	| 'importCurl'
+	| 'generateCurl'
+	| 'settingsLogStream'
+	| 'sourceControlPush'
+	| 'sourceControlPull'
+	| 'debugPaywall'
+	| 'mfaSetup'
+	| 'workflowHistoryVersionRestore'
+	| 'suggestedTemplatePreview'
+	| 'setupCredentials'
+	| 'externalSecretsProvider';
+
 export type EnterpriseEditionFeatureValue = keyof Omit<IN8nUISettings['enterprise'], 'projects'>;
+
+export interface IN8nPromptResponse {
+	updated: boolean;
+}

packages/editor-ui/src/api/settings.ts

@@ -1,9 +1,4 @@
-import type {
-	IRestApiContext,
-	IN8nPrompts,
-	IN8nValueSurveyData,
-	IN8nPromptResponse,
-} from '../Interface';
+import type { IRestApiContext, IN8nPrompts, IN8nPromptResponse } from '../Interface';
 import { makeRestApiRequest, get, post } from '@/utils/apiUtils';
 import { N8N_IO_BASE_URL, NPM_COMMUNITY_NODE_SEARCH_API_URL } from '@/constants';
 import type { IN8nUISettings } from 'n8n-workflow';
@@ -34,17 +29,6 @@ export async function submitContactInfo(
 	);
 }
 
-export async function submitValueSurvey(
-	instanceId: string,
-	userId: string,
-	params: IN8nValueSurveyData,
-): Promise<IN8nPromptResponse> {
-	return await post(N8N_IO_BASE_URL, '/value-survey', params, {
-		'n8n-instance-id': instanceId,
-		'n8n-user-id': userId,
-	});
-}
-
 export async function getAvailableCommunityPackageCount(): Promise<number> {
 	const response = await get(
 		NPM_COMMUNITY_NODE_SEARCH_API_URL,

packages/editor-ui/src/api/valueSurvey.ts

@@ -0,0 +1,14 @@
+import type { IRestApiContext } from '@/Interface';
+import { makeRestApiRequest } from '@/utils/apiUtils';
+
+export async function valueSurveyShown(context: IRestApiContext): Promise<void> {
+	await makeRestApiRequest(context, 'POST', '/value-survey/show');
+}
+
+export async function valueSurveyResponded(context: IRestApiContext): Promise<void> {
+	await makeRestApiRequest(context, 'POST', '/value-survey/respond');
+}
+
+export async function valueSurveyIgnored(context: IRestApiContext): Promise<void> {
+	await makeRestApiRequest(context, 'POST', '/value-survey/ignore');
+}