feat: Update NPS Value Survey #9638

mutdmour · 2024-06-05T17:12:25Z

Summary

Fix and refactor value (NPS) survey to show periodically for users

Value (NPS) survey asks user to rate n8n as below, then asks if they want to share their email. It depends on calling an external service that decides whether to show survey or not. That has been broken for a long time.

(current version)

Now we are rebuilding it without depending on an external service. It simply periodically (every 6 months) asks user to rate n8n again (if user ignores survey, it crops up a week later at most 3 times). The response is sent through telemetry.

(updated version)

Related tickets and issues

Include links to Linear ticket or Github issue or Community forum post. Important in order to close automatically and provide context to reviewers.

Review / Merge checklist

PR title and summary are descriptive. Remember, the title automatically goes into the changelog. Use (no-changelog) otherwise. (conventions)
Docs updated or follow-up ticket created.
Tests included.

A bug is not considered fixed, unless a test is added to prevent it from happening again.
A feature is not complete without tests.

github-actions · 2024-06-10T13:03:56Z

✅ All Cypress E2E specs passed

mutdmour · 2024-06-11T07:21:09Z

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

@@ -36,7 +37,7 @@ describe('Workflow Actions', () => {
 		WorkflowPage.getters.isWorkflowSaved();
 	});

-	it('should not save already saved workflow', () => {
+	it.skip('should not save already saved workflow', () => {


test failing on master. @MiloradFilipovic is looking into this. https://github.com/n8n-io/n8n/actions/runs/9453100846/job/26037911945

Please ensure that this doesn't get left in the end

tomi

Couple questions still but otherwise LGTM

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

tomi · 2024-06-11T07:25:02Z

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

@@ -36,7 +37,7 @@ describe('Workflow Actions', () => {
 		WorkflowPage.getters.isWorkflowSaved();
 	});

-	it('should not save already saved workflow', () => {
+	it.skip('should not save already saved workflow', () => {


Please ensure that this doesn't get left in the end

tomi · 2024-06-11T07:26:38Z

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

+		try {
+			promptsData.value = await getPromptsData(
+				settingsStore.settings.instanceId,
+				currentUserId.value ?? '',
+			);
+		} catch (e) {
+			console.error('Failed to fetch prompts data');
+		}


What happens if this fails?

nothing, but maybe the nps survey will show. n8n api might be down, but it should not affect UX and no need to show notification (we make this call too often and user does not know about it).

tomi · 2024-06-11T07:28:44Z

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

+		try {
+			promptsData.value = await getPromptsData(
+				settingsStore.settings.instanceId,
+				currentUserId.value ?? '',


Do we even want to fetch the prompts data if currentUserId is not set? Why not skip the whole requests then? In what case might this happen? Is there a possible race condition that this is called before currentUserId has value?

Sure, I can add this. Technically no, since specific user actions are needed to trigger this, for example save a workflow.
I think this logic predates user management so maybe that's why. We did not have user id, just instance id.

for a long time in n8n until v1, setting up an owner user was optional, even after we added user management. so userId could be undefined but a user is logged in.

If it should always be defined, it would be nicer to have an assert to satisfy TS compiler and to communicate that this should always be defined when this gets called. Otherwise it can cause nasty bugs that are hard to debug (e.g. if there's a bug that this function gets always called before the currentUserId is defined the nps survey will never get initialized properly).

Yes that makes sense. Thanks for the suggestion

Co-authored-by: Tomi Turtiainen <10324676+tomi@users.noreply.github.com>

* master: ci: Fix custom docker builds (no-changelog) (#9702) test: Fix e2e for projects missing instance owner (no-changelog) (#9703) ci: Refactor e2e tests to be less flaky (no-changelog) (#9695) feat(editor): Add move resources option to workflows and credentials on (#9654) fix: Introduce `HooksService` (#8962) fix(editor): Improve large data warning in input/output panel (#9671) ci(editor): Enforce type-safety in @n8n/chat builds as well (no-changelog) (#9685) fix(editor): Un-skip workflow save test (no-changelog) (#9698) refactor(core): Remove more dead code from event bus (no-changelog) (#9697) ci: Remove unused WaitTracker mocking (no-changelog) (#9694) feat: Update NPS Value Survey (#9638) refactor(core): Remove event bus channel (no-changelog) (#9663) refactor(core): Remove event bus helpers (no-changelog) (#9690) refactor(core): Merge event bus controllers and remove dead code (no-changelog) (#9688) ci: Fix e2e tests (no-changelog) (#9689) refactor(core): Use `@Licensed()` in event bus controller (no-changelog) (#9687) fix(editor): Node background for executing nodes in dark mode (#9682) fix(editor): Prevent saving already saved workflows (#9670) fix(editor): Fix node connection showing incorrect item count during … (#9684) refactor: Set up Cypress as pnpm workspace (no-changelog) (#6049)

* master: fix(editor): Add back credential type icon (no-changelog) (#9704) feat(editor): Add canvas edge toolbar hover show/hide support (no-changelog) (#9699) ci: Fix custom docker builds (no-changelog) (#9702) test: Fix e2e for projects missing instance owner (no-changelog) (#9703) ci: Refactor e2e tests to be less flaky (no-changelog) (#9695) feat(editor): Add move resources option to workflows and credentials on (#9654) fix: Introduce `HooksService` (#8962) fix(editor): Improve large data warning in input/output panel (#9671) ci(editor): Enforce type-safety in @n8n/chat builds as well (no-changelog) (#9685) fix(editor): Un-skip workflow save test (no-changelog) (#9698) refactor(core): Remove more dead code from event bus (no-changelog) (#9697) ci: Remove unused WaitTracker mocking (no-changelog) (#9694) feat: Update NPS Value Survey (#9638) refactor(core): Remove event bus channel (no-changelog) (#9663) refactor(core): Remove event bus helpers (no-changelog) (#9690)

janober · 2024-06-12T14:06:41Z

Got released with n8n@1.46.0

mutdmour added 21 commits May 23, 2024 16:38

fix: refactor value component

c5923c3

feat: add nps score to value survey

931ab36

feat: add value survey endpoints

6295b8d

Merge branch 'master' of github.com:n8n-io/n8n into ado-768

a6fdb1e

fix: add logic to decide to show value survey

213fb7a

feat: add logic to update survey

c6e195c

feat: update logic to show

0c4a75e

merge master

1858e28

reduce changes

08acc4e

handle edge case for ignoring users

e55a241

add migration to set for existing users

4a4b9fa

prevent if telemetry disabled

2a8ce40

Merge branch 'master' of github.com:n8n-io/n8n into ado-768

b7acea8

refactor: add clear state to api, add store

7c0c2ff

refactor to seperate store

33f5c46

clean up

9b31e25

Merge branch 'master' of github.com:n8n-io/n8n into ado-768

995946e

add tests

7ef0d9d

refactor, add tests

e07e054

add tests for controller

a560053

fix up package

29b19f3

mutdmour requested a review from a team as a code owner June 5, 2024 17:12

n8n-assistant bot added core Enhancement outside /nodes-base and /editor-ui n8n team Authored by the n8n team ui Enhancement in /editor-ui or /design-system labels Jun 5, 2024

mutdmour added 5 commits June 5, 2024 19:47

remove import

cc6b2fc

add initial e2e tests

007cee7

Add test for email part

0436667

lint fix

e67caad

rename var

0aec1b4

netroy changed the title ~~feature: Update NPS Value Survey~~ feat: Update NPS Value Survey Jun 10, 2024

mutdmour added 3 commits June 10, 2024 15:40

Merge branch 'master' of github.com:n8n-io/n8n into ado-768

c50b9ba

fix types

ebc1e86

fix last type issues

9ec6414

mutdmour dismissed tomi’s stale review via 9ec6414 June 10, 2024 16:25

mutdmour and others added 9 commits June 10, 2024 19:12

fix: bug with retry logic

0be328e

merge in masteR

b60e4cd

update to test domains

683848a

clean up unused import

962a3e8

make tests less flaky

e84151d

remove only

04db697

lintfix

51f58b4

Merge branch 'master' of github.com:n8n-io/n8n into ado-768

aa72281

skip failing test

d4d6829

mutdmour commented Jun 11, 2024

View reviewed changes

fix lint

dd03c94

tomi reviewed Jun 11, 2024

View reviewed changes

mutdmour and others added 2 commits June 11, 2024 09:32

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

f517535

Co-authored-by: Tomi Turtiainen <10324676+tomi@users.noreply.github.com>

address feedback

d8a9b47

mutdmour requested a review from tomi June 11, 2024 07:41

user assert instead of type check

9fb993d

tomi approved these changes Jun 11, 2024

View reviewed changes

mutdmour merged commit 50bd5b9 into master Jun 11, 2024
14 of 18 checks passed

mutdmour deleted the ado-768 branch June 11, 2024 08:23

github-actions bot mentioned this pull request Jun 12, 2024

🚀 Release 1.46.0 #9716

Merged

janober added the Released label Jun 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Update NPS Value Survey #9638

feat: Update NPS Value Survey #9638

mutdmour commented Jun 5, 2024 •

edited

Loading

github-actions bot commented Jun 10, 2024

mutdmour Jun 11, 2024

tomi Jun 11, 2024

tomi left a comment

tomi Jun 11, 2024

tomi Jun 11, 2024

mutdmour Jun 11, 2024

tomi Jun 11, 2024

mutdmour Jun 11, 2024

mutdmour Jun 11, 2024

tomi Jun 11, 2024

mutdmour Jun 11, 2024

janober commented Jun 12, 2024

feat: Update NPS Value Survey #9638

feat: Update NPS Value Survey #9638

Conversation

mutdmour commented Jun 5, 2024 • edited Loading

Summary

Related tickets and issues

Review / Merge checklist

github-actions bot commented Jun 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tomi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

janober commented Jun 12, 2024

mutdmour commented Jun 5, 2024 •

edited

Loading