feat: Update NPS Value Survey

cypress/e2e/12-canvas-actions.cy.ts

@@ -1,4 +1,5 @@
 import { WorkflowPage as WorkflowPageClass } from '../pages/workflow';
+import { successToast } from '../pages/notifications';
 import {
 	MANUAL_TRIGGER_NODE_NAME,
 	MANUAL_TRIGGER_NODE_DISPLAY_NAME,
@@ -8,8 +9,6 @@ import {
 	IF_NODE_NAME,
 	HTTP_REQUEST_NODE_NAME,
 } from './../constants';
-import { WorkflowPage as WorkflowPageClass } from '../pages/workflow';
-import { successToast } from '../pages/notifications';
 
 const WorkflowPage = new WorkflowPageClass();
 describe('Canvas Actions', () => {

cypress/e2e/18-user-management.cy.ts

@@ -1,5 +1,5 @@
 import { INSTANCE_MEMBERS, INSTANCE_OWNER, INSTANCE_ADMIN } from '../constants';
-import { MainSidebar, SettingsSidebar, SettingsUsersPage, WorkflowPage } from '../pages';
+import { MainSidebar, SettingsSidebar, SettingsUsersPage } from '../pages';
 import { PersonalSettingsPage } from '../pages/settings-personal';
 import { getVisibleSelect } from '../utils';
 import { errorToast, successToast } from '../pages/notifications';
@@ -25,7 +25,6 @@ const updatedPersonalData = {
 };
 
 const usersSettingsPage = new SettingsUsersPage();
-const workflowPage = new WorkflowPage();
 const personalSettingsPage = new PersonalSettingsPage();
 const settingsSidebar = new SettingsSidebar();
 const mainSidebar = new MainSidebar();

cypress/e2e/19-execution.cy.ts

@@ -615,6 +615,6 @@ describe('Execution', () => {
 			.within(() => cy.get('.fa-check'))
 			.should('exist');
 
-		errorToast().should('contain', `Problem in node ‘Telegram‘`);
+		errorToast().should('contain', 'Problem in node ‘Telegram‘');
 	});
 });

cypress/e2e/33-settings-personal.cy.ts

@@ -1,8 +1,5 @@
-import { WorkflowPage } from '../pages';
 import { errorToast, successToast } from '../pages/notifications';
 
-const workflowPage = new WorkflowPage();
-
 const INVALID_NAMES = [
 	'https://n8n.io',
 	'http://n8n.io',

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

@@ -29,8 +29,8 @@ describe('NpsSurvey', () => {
 					res.body.data.telemetry = {
 						enabled: true,
 						config: {
-							key: '1zPn9bgWPzlQc0p8Gj1uiK6DOTn',
-							url: 'https://telemetry.n8n.io',
+							key: 'test',
+							url: 'https://telemetry-test.n8n.io',
 						},
 					};
 				}
@@ -75,8 +75,8 @@ describe('NpsSurvey', () => {
 					res.body.data.telemetry = {
 						enabled: true,
 						config: {
-							key: '1zPn9bgWPzlQc0p8Gj1uiK6DOTn',
-							url: 'https://telemetry.n8n.io',
+							key: 'test',
+							url: 'https://telemetry-test.n8n.io',
 						},
 					};
 				}
@@ -118,25 +118,25 @@ describe('NpsSurvey', () => {
 		workflowPage.actions.saveWorkflowOnButtonClick();
 		getNpsSurvey().should('not.be.visible');
 
-		// shows up seven days later to ignore again
-		workflowPage.actions.visit(true, NOW + SEVEN_DAYS * 2 + 10000 * 2);
+		// shows up after at least sever days later to ignore again
+		workflowPage.actions.visit(true, NOW + (SEVEN_DAYS + 10000) * 2 + ONE_DAY);
 		workflowPage.actions.saveWorkflowOnButtonClick();
 		clearNotifications();
 		getNpsSurvey().should('be.visible');
 		getNpsSurveyClose().click();
 		getNpsSurvey().should('not.be.visible');
 
-		workflowPage.actions.visit(true, NOW + SEVEN_DAYS * 2 + 10000 * 2);
+		workflowPage.actions.visit(true, NOW + (SEVEN_DAYS + 10000) * 2 + ONE_DAY * 2);
 		workflowPage.actions.saveWorkflowOnButtonClick();
 		getNpsSurvey().should('not.be.visible');
 
-		// does not show up again 7 days later
-		workflowPage.actions.visit(true, NOW + SEVEN_DAYS * 3 + 10000 * 3);
+		// does not show up again after at least 7 days
+		workflowPage.actions.visit(true, NOW + (SEVEN_DAYS + 10000) * 3 + ONE_DAY * 3);
 		workflowPage.actions.saveWorkflowOnButtonClick();
 		getNpsSurvey().should('not.be.visible');
 
 		// shows up 6 months later
-		workflowPage.actions.visit(true, NOW + SEVEN_DAYS * 3 + 10000 * 3 + ABOUT_SIX_MONTHS);
+		workflowPage.actions.visit(true, NOW + (SEVEN_DAYS + 10000) * 3 + ABOUT_SIX_MONTHS);
 		workflowPage.actions.saveWorkflowOnButtonClick();
 		getNpsSurvey().should('be.visible');
 	});

cypress/e2e/7-workflow-actions.cy.ts

@@ -37,7 +37,7 @@ describe('Workflow Actions', () => {
 		WorkflowPage.getters.isWorkflowSaved();
 	});
 
-	it('should not save already saved workflow', () => {
+	it.skip('should not save already saved workflow', () => {
 		cy.intercept('PATCH', '/rest/workflows/*').as('saveWorkflow');
 		WorkflowPage.actions.saveWorkflowOnButtonClick();
 		WorkflowPage.actions.addNodeToCanvas(MANUAL_TRIGGER_NODE_NAME);

cypress/package.json

@@ -18,6 +18,7 @@
   },
   "dependencies": {
     "@ngneat/falso": "^6.4.0",
+    "@sinonjs/fake-timers": "^11.2.2",
     "cross-env": "^7.0.3",
     "cypress": "^13.6.2",
     "cypress-otp": "^1.0.3",

cypress/pages/workflow.ts

@@ -3,8 +3,6 @@ import { getVisibleSelect } from '../utils';
 import { BasePage } from './base';
 import { NodeCreator } from './features/node-creator';
 
-type CyGetOptions = Parameters<(typeof cy)['get']>[1];
-
 const nodeCreator = new NodeCreator();
 export class WorkflowPage extends BasePage {
 	url = '/workflow/new';

cypress/support/commands.ts

@@ -1,4 +1,5 @@
 import 'cypress-real-events';
+import FakeTimers from '@sinonjs/fake-timers';
 import { WorkflowPage } from '../pages';
 import {
 	BACKEND_BASE_URL,
@@ -7,7 +8,6 @@ import {
 	INSTANCE_OWNER,
 	N8N_AUTH_COOKIE,
 } from '../constants';
-import FakeTimers from '@sinonjs/fake-timers';
 
 Cypress.Commands.add('setAppDate', (targetDate: number | Date) => {
 	cy.window().then((win) => {

package.json

@@ -35,8 +35,6 @@
   },
   "devDependencies": {
     "@n8n_io/eslint-config": "workspace:*",
-    "@ngneat/falso": "^6.4.0",
-    "@sinonjs/fake-timers": "^11.2.2",
     "@types/jest": "^29.5.3",
     "@types/supertest": "^6.0.2",
     "@vitest/coverage-v8": "^1.6.0",

packages/editor-ui/src/Interface.ts

@@ -742,10 +742,9 @@ export interface IUserListAction {
 }
 
 export interface IN8nPrompts {
-	message: string;
-	title: string;
-	showContactPrompt: boolean;
-	showNpsSurvey: boolean;
+	message?: string;
+	title?: string;
+	showContactPrompt?: boolean;
 }
 
 export const enum UserManagementAuthenticationMethod {
@@ -1206,6 +1205,8 @@ export type Modals = {
 	[key: string]: ModalState;
 };
 
+export type ModalKey = keyof Modals;
+
 export type ModalState = {
 	open: boolean;
 	mode?: string | null;
@@ -1921,39 +1922,6 @@ export type EnterpriseEditionFeatureKey =
 	| 'WorkerView'
 	| 'AdvancedPermissions';
 
-export type ModalKey =
-	| 'about'
-	| 'chatEmbed'
-	| 'changePassword'
-	| 'editCredential'
-	| 'selectCredential'
-	| 'deleteUser'
-	| 'inviteUser'
-	| 'duplicate'
-	| 'tagsManager'
-	| 'versions'
-	| 'settings'
-	| 'lmChat'
-	| 'workflowShare'
-	| 'personalization'
-	| 'contactPrompt'
-	| 'npsSurvey'
-	| '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 {

packages/editor-ui/src/__tests__/utils.ts

@@ -39,12 +39,6 @@ export const waitAllPromises = async () => await new Promise((resolve) => setTim
 export const SETTINGS_STORE_DEFAULT_STATE: ISettingsState = {
 	initialized: true,
 	settings: defaultSettings,
-	promptsData: {
-		message: '',
-		title: '',
-		showContactPrompt: false,
-		showNpsSurvey: false,
-	},
 	userManagement: {
 		showSetupOnFirstLoad: false,
 		smtpSetup: false,

packages/editor-ui/src/components/ContactPromptModal.vue

@@ -43,6 +43,7 @@ import { useSettingsStore } from '@/stores/settings.store';
 import { useRootStore } from '@/stores/n8nRoot.store';
 import { createEventBus } from 'n8n-design-system/utils';
 import { useToast } from '@/composables/useToast';
+import { useNpsSurveyStore } from '@/stores/npsSurvey.store';
 
 export default defineComponent({
 	name: 'ContactPromptModal',
@@ -65,17 +66,17 @@ export default defineComponent({
 		};
 	},
 	computed: {
-		...mapStores(useRootStore, useSettingsStore),
+		...mapStores(useRootStore, useSettingsStore, useNpsSurveyStore),
 		title(): string {
-			if (this.settingsStore.promptsData && this.settingsStore.promptsData.title) {
-				return this.settingsStore.promptsData.title;
+			if (this.npsSurveyStore.promptsData?.title) {
+				return this.npsSurveyStore.promptsData.title;
 			}
 
 			return 'You’re a power user 💪';
 		},
 		description(): string {
-			if (this.settingsStore.promptsData && this.settingsStore.promptsData.message) {
-				return this.settingsStore.promptsData.message;
+			if (this.npsSurveyStore.promptsData?.message) {
+				return this.npsSurveyStore.promptsData.message;
 			}
 
 			return 'Your experience with n8n can help us improve — for you and our entire community.';

packages/editor-ui/src/constants.ts

@@ -1,7 +1,6 @@
 import type {
 	EnterpriseEditionFeatureKey,
 	EnterpriseEditionFeatureValue,
-	ModalKey,
 	NodeCreatorOpenSource,
 } from './Interface';
 import { NodeConnectionType } from 'n8n-workflow';
@@ -36,37 +35,37 @@ export const QUICKSTART_NOTE_NAME = '_QUICKSTART_NOTE_';
 export const MAX_TAG_NAME_LENGTH = 24;
 
 // modals
-export const ABOUT_MODAL_KEY: ModalKey = 'about';
-export const CHAT_EMBED_MODAL_KEY: ModalKey = 'chatEmbed';
-export const CHANGE_PASSWORD_MODAL_KEY: ModalKey = 'changePassword';
-export const CREDENTIAL_EDIT_MODAL_KEY: ModalKey = 'editCredential';
-export const CREDENTIAL_SELECT_MODAL_KEY: ModalKey = 'selectCredential';
-export const DELETE_USER_MODAL_KEY: ModalKey = 'deleteUser';
-export const INVITE_USER_MODAL_KEY: ModalKey = 'inviteUser';
-export const DUPLICATE_MODAL_KEY: ModalKey = 'duplicate';
-export const TAGS_MANAGER_MODAL_KEY: ModalKey = 'tagsManager';
-export const VERSIONS_MODAL_KEY: ModalKey = 'versions';
-export const WORKFLOW_SETTINGS_MODAL_KEY: ModalKey = 'settings';
-export const WORKFLOW_LM_CHAT_MODAL_KEY: ModalKey = 'lmChat';
-export const WORKFLOW_SHARE_MODAL_KEY: ModalKey = 'workflowShare';
-export const PERSONALIZATION_MODAL_KEY: ModalKey = 'personalization';
-export const CONTACT_PROMPT_MODAL_KEY: ModalKey = 'contactPrompt';
-export const NPS_SURVEY_MODAL_KEY: ModalKey = 'npsSurvey';
-export const WORKFLOW_ACTIVE_MODAL_KEY: ModalKey = 'activation';
-export const ONBOARDING_CALL_SIGNUP_MODAL_KEY: ModalKey = 'onboardingCallSignup';
-export const COMMUNITY_PACKAGE_INSTALL_MODAL_KEY: ModalKey = 'communityPackageInstall';
-export const COMMUNITY_PACKAGE_CONFIRM_MODAL_KEY: ModalKey = 'communityPackageManageConfirm';
-export const IMPORT_CURL_MODAL_KEY: ModalKey = 'importCurl';
-export const GENERATE_CURL_MODAL_KEY: ModalKey = 'generateCurl';
-export const LOG_STREAM_MODAL_KEY: ModalKey = 'settingsLogStream';
-export const SOURCE_CONTROL_PUSH_MODAL_KEY: ModalKey = 'sourceControlPush';
-export const SOURCE_CONTROL_PULL_MODAL_KEY: ModalKey = 'sourceControlPull';
-export const DEBUG_PAYWALL_MODAL_KEY: ModalKey = 'debugPaywall';
-export const MFA_SETUP_MODAL_KEY: ModalKey = 'mfaSetup';
-export const WORKFLOW_HISTORY_VERSION_RESTORE: ModalKey = 'workflowHistoryVersionRestore';
-export const SETUP_CREDENTIALS_MODAL_KEY: ModalKey = 'setupCredentials';
-
-export const EXTERNAL_SECRETS_PROVIDER_MODAL_KEY: ModalKey = 'externalSecretsProvider';
+export const ABOUT_MODAL_KEY = 'about';
+export const CHAT_EMBED_MODAL_KEY = 'chatEmbed';
+export const CHANGE_PASSWORD_MODAL_KEY = 'changePassword';
+export const CREDENTIAL_EDIT_MODAL_KEY = 'editCredential';
+export const CREDENTIAL_SELECT_MODAL_KEY = 'selectCredential';
+export const DELETE_USER_MODAL_KEY = 'deleteUser';
+export const INVITE_USER_MODAL_KEY = 'inviteUser';
+export const DUPLICATE_MODAL_KEY = 'duplicate';
+export const TAGS_MANAGER_MODAL_KEY = 'tagsManager';
+export const VERSIONS_MODAL_KEY = 'versions';
+export const WORKFLOW_SETTINGS_MODAL_KEY = 'settings';
+export const WORKFLOW_LM_CHAT_MODAL_KEY = 'lmChat';
+export const WORKFLOW_SHARE_MODAL_KEY = 'workflowShare';
+export const PERSONALIZATION_MODAL_KEY = 'personalization';
+export const CONTACT_PROMPT_MODAL_KEY = 'contactPrompt';
+export const NPS_SURVEY_MODAL_KEY = 'npsSurvey';
+export const WORKFLOW_ACTIVE_MODAL_KEY = 'activation';
+export const ONBOARDING_CALL_SIGNUP_MODAL_KEY = 'onboardingCallSignup';
+export const COMMUNITY_PACKAGE_INSTALL_MODAL_KEY = 'communityPackageInstall';
+export const COMMUNITY_PACKAGE_CONFIRM_MODAL_KEY = 'communityPackageManageConfirm';
+export const IMPORT_CURL_MODAL_KEY = 'importCurl';
+export const GENERATE_CURL_MODAL_KEY = 'generateCurl';
+export const LOG_STREAM_MODAL_KEY = 'settingsLogStream';
+export const SOURCE_CONTROL_PUSH_MODAL_KEY = 'sourceControlPush';
+export const SOURCE_CONTROL_PULL_MODAL_KEY = 'sourceControlPull';
+export const DEBUG_PAYWALL_MODAL_KEY = 'debugPaywall';
+export const MFA_SETUP_MODAL_KEY = 'mfaSetup';
+export const WORKFLOW_HISTORY_VERSION_RESTORE = 'workflowHistoryVersionRestore';
+export const SETUP_CREDENTIALS_MODAL_KEY = 'setupCredentials';
+
+export const EXTERNAL_SECRETS_PROVIDER_MODAL_KEY = 'externalSecretsProvider';
 
 export const COMMUNITY_PACKAGE_MANAGE_ACTIONS = {
 	UNINSTALL: 'uninstall',

packages/editor-ui/src/stores/npsSurvey.store.ts

@@ -25,6 +25,7 @@ export const useNpsSurveyStore = defineStore('npsSurvey', () => {
 	const shouldShowNpsSurveyNext = ref<boolean>(false);
 	const currentSurveyState = ref<NpsSurveyState | undefined>();
 	const currentUserId = ref<string | undefined>();
+	const promptsData = ref<IN8nPrompts | undefined>();
 
 	function setupNpsSurveyOnLogin(userId: string, settings?: IUserSettings): void {
 		currentUserId.value = userId;
@@ -89,7 +90,10 @@ export const useNpsSurveyStore = defineStore('npsSurvey', () => {
 		const updatedState: NpsSurveyState = {
 			waitingForResponse: true,
 			lastShownAt: Date.now(),
-			ignoredCount: 0,
+			ignoredCount:
+				currentSurveyState.value && 'ignoredCount' in currentSurveyState.value
+					? currentSurveyState.value.ignoredCount
+					: 0,
 		};
 		await updateNpsSurveyState(rootStore.getRestApiContext, updatedState);
 		currentSurveyState.value = updatedState;
@@ -135,19 +139,24 @@ export const useNpsSurveyStore = defineStore('npsSurvey', () => {
 			return;
 		}
 
-		const promptsData: IN8nPrompts = await getPromptsData(
-			settingsStore.settings.instanceId,
-			currentUserId.value ?? '',
-		);
+		try {
+			promptsData.value = await getPromptsData(
+				settingsStore.settings.instanceId,
+				currentUserId.value ?? '',
+			);
+		} catch (e) {
+			console.error('Failed to fetch prompts data');
+		}
 
-		if (promptsData?.showContactPrompt) {
+		if (promptsData.value?.showContactPrompt) {
 			uiStore.openModal(CONTACT_PROMPT_MODAL_KEY);
 		} else {
 			await useNpsSurveyStore().showNpsSurveyIfPossible();
 		}
 	}
 
 	return {
+		promptsData,
 		resetNpsSurveyOnLogOut,
 		showNpsSurveyIfPossible,
 		ignoreNpsSurvey,