feat(editor): Change upgrade CTA on community editions (no-changelog) #6317
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Great PR! Please pay attention to the following items before merging: Files matching
Files matching
Files matching
Files matching
Make sure to check off this list before asking for review. |
RicardoE105
changed the title
n8n-assistant
bot
added
n8n team
RicardoE105
force-pushed
the
ado-669-change-upgrade-cta-on-community-editions
branch
from
2a9da66
to
f08e9e6
Compare
RicardoE105
commented
May 25, 2023
Codecov ReportPatch coverage:
Additional details and impacted files@@ Coverage Diff @@
## master #6317 +/- ##
==========================================
- Coverage 28.32% 28.25% -0.08%
==========================================
Files 2982 2981 -1
Lines 185148 185176 +28
Branches 20298 20300 +2
==========================================
- Hits 52447 52316 -131
- Misses 131916 132073 +157
- Partials 785 787 +2
☔ View full report in Codecov by Sentry. |
OlegIvaniv
previously approved these changes
May 29, 2023
|
|
OlegIvaniv
previously approved these changes
Jun 1, 2023
|
✅ All Cypress E2E specs passed |
OlegIvaniv
approved these changes
Jun 5, 2023
Passing run #1105 ↗︎
Details:
This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. |
|||||||||||||||
|
✅ All Cypress E2E specs passed |
MiloradFilipovic
added a commit
that referenced
this pull request
Jun 13, 2023
* master: test(editor): Unit test Version control frontend components (#6408) fix: Fist name to First Name in certain nodes (no-changelog) (#6404) fix(core): Allow all executions to be stopped (#6386) fix(core): RMC boolean value fix (#6397) fix(editor): Remove root level tag selector from css module to avoid making it a global style (#6392) fix(Ldap Node): Add DN field to update operation (#6371) feat: New trigger PostgreSQL (#5495) build: Update pnpm lock file (no-changelog) (#6395) fix(Date & Time Node): Reset responseData at end of loop (#6385) refactor(core): Google service account remove duplicated functions (no-changelog) (#6368) refactor(LoneScale List Node)!: Rename to LoneScale (#6337) fix(editor): Update version control setup CTA tooltip (#6393) ci: Fix build (no-changelog) (#6391) fix(editor): Add button to refresh branches (#6387) fix(editor): Add Set up version control CTA (#6356) fix(editor): Remove explicit parameter name scanning for code editors (#6390) ci: Fix build (no-changelog) (#6379) fix(editor): Adding branch color (#6380) refactor(editor): Remove user activation modal (no-changelog) (#6361) feat(editor): Change upgrade CTA on community editions (no-changelog) (#6317)
|
Got released with |
csuermann
pushed a commit
that referenced
this pull request
Oct 13, 2023
## Issue In community edition, clicking on "View plans" button on "Settings" -> "Usage and plan" page (e.g. http://127.0.0.1:5678/settings/usage) opens two new tabs with n8n pricing (one of them with UTM tracking, another without). This was introduced in #6317 , when click handler of "View plans" link container [started calling](https://github.com/n8n-io/n8n/pull/6317/files#diff-0bf26afac8a06e03b3d39d0668f22408859355b585a9ab420800c125e33f0691R109) `uiStore.goToUpgrade(...)` which opens n8n pricing in a new tab, while browser opens another tab for the link URL. The simplest fix, implemented in this PR, is to prevent default event handling (so that, after `onViewPlans` is called, browser will not attempt to process the click additionally as clicking on the link), similarly to how it is prevented on some other pages. It only solves the immediate problem of browser opening two new tabs on clicking "View plans". Note that **I didn't implement any tests for the changed behavior**, because it was not covered by tests before, and I couldn't quite figure out how to cover it now within the existing test approach (considering that testing the fact that only one new tab is open will likely require to write entirely new tests relying on puppeteer; as far as I can see, no existing `editor-ui` tests are doing anything like that). I'll gladly implement tests for the new behavior if you tell me how you would like them to look. The existing tests for `editor-ui` still pass; I didn't run tests for other subpackages (see "additional contribution notes" below). ## Additional notes on the issue. I'm not sure that the change in this PR is the correct long-term solution for the issue, because the URLs for these two methods (custom click handler for link container and default link handling) are slightly different: * Custom click handler calls `useTelemetryStore().track('User clicked upgrade CTA', ...)`; then calls `sendUsageTelemetry('view_plans')` (it feels weird that two calls to telemetry are made); then opens new tab for `https://n8n.io/pricing?utm_campaign=open&source=usage_page` (note that prior to #7316 the second call to telemetry was done after the new tab is opened, not before); * Link itself refers to another page, with slightly different tracking parameters: `https://subscription.n8n.io/?instanceid=[REDACTED]&version=1.10.0&callback=http%3A%2F%2F127.0.0.1%3A5678%2Fsettings%2Fusage&source=usage_page`; but this page redirects to `https://n8n.io/pricing/`. It is not clear which one of the two is the right way of doing things. Although `goToUpgrade` is called in 20 places throughout `editor-ui`, while `viewPlansUrl`, as far as I can see, is used for this button only. Additionally, since Settings pages don't work without JS anyway, I can only think of two separate scenarios where any tab would be opened: * Left-clicking the link (or Ctrl-clicking, or pressing Space or Enter when the link is focused, or tapping): previously, both custom click handler was executed and link's `href` was opened; in this PR, only custom click handler is executed (similarly to how it is done in the other places where `goToUpgrade` is called); * Right-clicking (or long tapping, or opening context menu in any other way) and selecting "open link in new tab" (or similar): opens a new tab for URL from the `href` attribute (and does not send any telemetry at all). I'd say that the better permanent solution would probably be to get rid of one of these methods entirely, and only rely on another in all cases (for me, as an outside contributor, the preferred way would be for custom click handler to only send telemetry, while letting my browser handle the actual navigation). However, that would be a large change, much more than one line in this PR. Additionally, other similar places where `goToUpgrade` is currently called (directly or indirectly) would also need to be adapted for this change. ## Additional contribution notes As a first-time contributor, I've encountered several things I didn't expect; I'm not sure if they should be expected or are issues: 1. Tests for the entire monorepo consume a lot of RAM; 20GB free RAM was not enough, so I couldn't run tests for the entire monorepo and had to only run them for `packages/editor-ui`; 2. Linting is very slow; `pnpm lint` in `packages/editor-ui` takes ten minutes to complete; 3. It seems that types are not checked. Code OSS highlights numerous errors in code files: for example, `'debug'` is incompatible with `CloudUpdateLinkSourceType` expected by `goToUpgrade` here: https://github.com/n8n-io/n8n/blob/3e7a4d3b2cc12fcb1b011fccd0773bb807986884/packages/editor-ui/src/composables/useExecutionDebugging.ts#L128 However, I'm not getting any errors during build. There is a `typecheck` script defined in `package.json`, but `pnpm typecheck` fails with: ``` n8n-toy-demo:~/projects/n8n/packages/editor-ui$ pnpm typecheck > n8n-editor-ui@1.10.0 typecheck /home/inga/projects/n8n/packages/editor-ui > vue-tsc --emitDeclarationOnly error TS5069: Option 'emitDeclarationOnly' cannot be specified without specifying option 'declaration' or option 'composite'. Found 1 error. ELIFECYCLE Command failed with exit code 1. n8n-toy-demo:~/projects/n8n/packages/editor-ui$ ``` Replacing `--emitDeclarationsOnly` with `--noEmit` in `package.json` unblocks typechecking and results in seemingly, at first glance, correct "Found 1924 errors in 306 files" (at least several of the reported errors that I've checked seem to be correct). But maybe I'm missing something and there are not in fact two thousands type errors in `editor-ui`?
Merged
elsmr
pushed a commit
that referenced
this pull request
Oct 19, 2023
## Issue In community edition, clicking on "View plans" button on "Settings" -> "Usage and plan" page (e.g. http://127.0.0.1:5678/settings/usage) opens two new tabs with n8n pricing (one of them with UTM tracking, another without). This was introduced in #6317 , when click handler of "View plans" link container [started calling](https://github.com/n8n-io/n8n/pull/6317/files#diff-0bf26afac8a06e03b3d39d0668f22408859355b585a9ab420800c125e33f0691R109) `uiStore.goToUpgrade(...)` which opens n8n pricing in a new tab, while browser opens another tab for the link URL. The simplest fix, implemented in this PR, is to prevent default event handling (so that, after `onViewPlans` is called, browser will not attempt to process the click additionally as clicking on the link), similarly to how it is prevented on some other pages. It only solves the immediate problem of browser opening two new tabs on clicking "View plans". Note that **I didn't implement any tests for the changed behavior**, because it was not covered by tests before, and I couldn't quite figure out how to cover it now within the existing test approach (considering that testing the fact that only one new tab is open will likely require to write entirely new tests relying on puppeteer; as far as I can see, no existing `editor-ui` tests are doing anything like that). I'll gladly implement tests for the new behavior if you tell me how you would like them to look. The existing tests for `editor-ui` still pass; I didn't run tests for other subpackages (see "additional contribution notes" below). ## Additional notes on the issue. I'm not sure that the change in this PR is the correct long-term solution for the issue, because the URLs for these two methods (custom click handler for link container and default link handling) are slightly different: * Custom click handler calls `useTelemetryStore().track('User clicked upgrade CTA', ...)`; then calls `sendUsageTelemetry('view_plans')` (it feels weird that two calls to telemetry are made); then opens new tab for `https://n8n.io/pricing?utm_campaign=open&source=usage_page` (note that prior to #7316 the second call to telemetry was done after the new tab is opened, not before); * Link itself refers to another page, with slightly different tracking parameters: `https://subscription.n8n.io/?instanceid=[REDACTED]&version=1.10.0&callback=http%3A%2F%2F127.0.0.1%3A5678%2Fsettings%2Fusage&source=usage_page`; but this page redirects to `https://n8n.io/pricing/`. It is not clear which one of the two is the right way of doing things. Although `goToUpgrade` is called in 20 places throughout `editor-ui`, while `viewPlansUrl`, as far as I can see, is used for this button only. Additionally, since Settings pages don't work without JS anyway, I can only think of two separate scenarios where any tab would be opened: * Left-clicking the link (or Ctrl-clicking, or pressing Space or Enter when the link is focused, or tapping): previously, both custom click handler was executed and link's `href` was opened; in this PR, only custom click handler is executed (similarly to how it is done in the other places where `goToUpgrade` is called); * Right-clicking (or long tapping, or opening context menu in any other way) and selecting "open link in new tab" (or similar): opens a new tab for URL from the `href` attribute (and does not send any telemetry at all). I'd say that the better permanent solution would probably be to get rid of one of these methods entirely, and only rely on another in all cases (for me, as an outside contributor, the preferred way would be for custom click handler to only send telemetry, while letting my browser handle the actual navigation). However, that would be a large change, much more than one line in this PR. Additionally, other similar places where `goToUpgrade` is currently called (directly or indirectly) would also need to be adapted for this change. ## Additional contribution notes As a first-time contributor, I've encountered several things I didn't expect; I'm not sure if they should be expected or are issues: 1. Tests for the entire monorepo consume a lot of RAM; 20GB free RAM was not enough, so I couldn't run tests for the entire monorepo and had to only run them for `packages/editor-ui`; 2. Linting is very slow; `pnpm lint` in `packages/editor-ui` takes ten minutes to complete; 3. It seems that types are not checked. Code OSS highlights numerous errors in code files: for example, `'debug'` is incompatible with `CloudUpdateLinkSourceType` expected by `goToUpgrade` here: https://github.com/n8n-io/n8n/blob/3e7a4d3b2cc12fcb1b011fccd0773bb807986884/packages/editor-ui/src/composables/useExecutionDebugging.ts#L128 However, I'm not getting any errors during build. There is a `typecheck` script defined in `package.json`, but `pnpm typecheck` fails with: ``` n8n-toy-demo:~/projects/n8n/packages/editor-ui$ pnpm typecheck > n8n-editor-ui@1.10.0 typecheck /home/inga/projects/n8n/packages/editor-ui > vue-tsc --emitDeclarationOnly error TS5069: Option 'emitDeclarationOnly' cannot be specified without specifying option 'declaration' or option 'composite'. Found 1 error. ELIFECYCLE Command failed with exit code 1. n8n-toy-demo:~/projects/n8n/packages/editor-ui$ ``` Replacing `--emitDeclarationsOnly` with `--noEmit` in `package.json` unblocks typechecking and results in seemingly, at first glance, correct "Found 1924 errors in 306 files" (at least several of the reported errors that I've checked seem to be correct). But maybe I'm missing something and there are not in fact two thousands type errors in `editor-ui`?
netroy
pushed a commit
that referenced
this pull request
Oct 23, 2023
## Issue In community edition, clicking on "View plans" button on "Settings" -> "Usage and plan" page (e.g. http://127.0.0.1:5678/settings/usage) opens two new tabs with n8n pricing (one of them with UTM tracking, another without). This was introduced in #6317 , when click handler of "View plans" link container [started calling](https://github.com/n8n-io/n8n/pull/6317/files#diff-0bf26afac8a06e03b3d39d0668f22408859355b585a9ab420800c125e33f0691R109) `uiStore.goToUpgrade(...)` which opens n8n pricing in a new tab, while browser opens another tab for the link URL. The simplest fix, implemented in this PR, is to prevent default event handling (so that, after `onViewPlans` is called, browser will not attempt to process the click additionally as clicking on the link), similarly to how it is prevented on some other pages. It only solves the immediate problem of browser opening two new tabs on clicking "View plans". Note that **I didn't implement any tests for the changed behavior**, because it was not covered by tests before, and I couldn't quite figure out how to cover it now within the existing test approach (considering that testing the fact that only one new tab is open will likely require to write entirely new tests relying on puppeteer; as far as I can see, no existing `editor-ui` tests are doing anything like that). I'll gladly implement tests for the new behavior if you tell me how you would like them to look. The existing tests for `editor-ui` still pass; I didn't run tests for other subpackages (see "additional contribution notes" below). ## Additional notes on the issue. I'm not sure that the change in this PR is the correct long-term solution for the issue, because the URLs for these two methods (custom click handler for link container and default link handling) are slightly different: * Custom click handler calls `useTelemetryStore().track('User clicked upgrade CTA', ...)`; then calls `sendUsageTelemetry('view_plans')` (it feels weird that two calls to telemetry are made); then opens new tab for `https://n8n.io/pricing?utm_campaign=open&source=usage_page` (note that prior to #7316 the second call to telemetry was done after the new tab is opened, not before); * Link itself refers to another page, with slightly different tracking parameters: `https://subscription.n8n.io/?instanceid=[REDACTED]&version=1.10.0&callback=http%3A%2F%2F127.0.0.1%3A5678%2Fsettings%2Fusage&source=usage_page`; but this page redirects to `https://n8n.io/pricing/`. It is not clear which one of the two is the right way of doing things. Although `goToUpgrade` is called in 20 places throughout `editor-ui`, while `viewPlansUrl`, as far as I can see, is used for this button only. Additionally, since Settings pages don't work without JS anyway, I can only think of two separate scenarios where any tab would be opened: * Left-clicking the link (or Ctrl-clicking, or pressing Space or Enter when the link is focused, or tapping): previously, both custom click handler was executed and link's `href` was opened; in this PR, only custom click handler is executed (similarly to how it is done in the other places where `goToUpgrade` is called); * Right-clicking (or long tapping, or opening context menu in any other way) and selecting "open link in new tab" (or similar): opens a new tab for URL from the `href` attribute (and does not send any telemetry at all). I'd say that the better permanent solution would probably be to get rid of one of these methods entirely, and only rely on another in all cases (for me, as an outside contributor, the preferred way would be for custom click handler to only send telemetry, while letting my browser handle the actual navigation). However, that would be a large change, much more than one line in this PR. Additionally, other similar places where `goToUpgrade` is currently called (directly or indirectly) would also need to be adapted for this change. ## Additional contribution notes As a first-time contributor, I've encountered several things I didn't expect; I'm not sure if they should be expected or are issues: 1. Tests for the entire monorepo consume a lot of RAM; 20GB free RAM was not enough, so I couldn't run tests for the entire monorepo and had to only run them for `packages/editor-ui`; 2. Linting is very slow; `pnpm lint` in `packages/editor-ui` takes ten minutes to complete; 3. It seems that types are not checked. Code OSS highlights numerous errors in code files: for example, `'debug'` is incompatible with `CloudUpdateLinkSourceType` expected by `goToUpgrade` here: https://github.com/n8n-io/n8n/blob/3e7a4d3b2cc12fcb1b011fccd0773bb807986884/packages/editor-ui/src/composables/useExecutionDebugging.ts#L128 However, I'm not getting any errors during build. There is a `typecheck` script defined in `package.json`, but `pnpm typecheck` fails with: ``` n8n-toy-demo:~/projects/n8n/packages/editor-ui$ pnpm typecheck > n8n-editor-ui@1.10.0 typecheck /home/inga/projects/n8n/packages/editor-ui > vue-tsc --emitDeclarationOnly error TS5069: Option 'emitDeclarationOnly' cannot be specified without specifying option 'declaration' or option 'composite'. Found 1 error. ELIFECYCLE Command failed with exit code 1. n8n-toy-demo:~/projects/n8n/packages/editor-ui$ ``` Replacing `--emitDeclarationsOnly` with `--noEmit` in `package.json` unblocks typechecking and results in seemingly, at first glance, correct "Found 1924 errors in 306 files" (at least several of the reported errors that I've checked seem to be correct). But maybe I'm missing something and there are not in fact two thousands type errors in `editor-ui`?
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Github issue / Community forum post (link here to close automatically):