feat(editor): Add cloud ExecutionsUsage and API blocking using licenses #6159

RicardoE105 · 2023-05-03T03:15:01Z

Github issue / Community forum post (link here to close automatically):

github-actions · 2023-05-03T03:15:26Z

Great PR! Please pay attention to the following items before merging:

Files matching packages/**:

If fixing bug, added test to cover scenario.
If addressing forum or Github issue, added link to description.

Files matching packages/**/*.ts:

Added unit tests to cover new or updated functionality.

Files matching **/*.vue:

Used composition API for all new components.
Added component or unit tests to cover functionality.

Files matching packages/editor-ui/**/*.vue:

Added E2E if adding new features.
Used design system tokens (colors, spacings...) where possible.

Files matching packages/design-system/**/*.vue:

Used design system tokens (colors, spacings...) where possible.
Updated Storybook with new component or updated functionality.

Make sure to check off this list before asking for review.

codecov · 2023-05-03T03:34:14Z

Codecov Report

Patch coverage: 70.80% and project coverage change: +0.11 🎉

Comparison is base (51fb913) 27.39% compared to head (9c8f61e) 27.50%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #6159      +/-   ##
==========================================
+ Coverage   27.39%   27.50%   +0.11%     
==========================================
  Files        2937     2940       +3     
  Lines      180177   180626     +449     
  Branches    19557    19563       +6     
==========================================
+ Hits        49362    49685     +323     
- Misses     130082   130206     +124     
- Partials      733      735       +2

Impacted Files	Coverage Δ
packages/cli/src/License.ts	`56.17% <0.00%> (-1.30%)`	⬇️
packages/cli/src/Server.ts	`0.00% <0.00%> (ø)`
...ages/design-system/src/components/N8nMenu/Menu.vue	`0.00% <0.00%> (ø)`
packages/editor-ui/src/App.vue	`0.00% <0.00%> (ø)`
packages/editor-ui/src/stores/cloudPlan.store.ts	`20.48% <20.48%> (ø)`
packages/editor-ui/src/api/cloudPlans.ts	`30.76% <30.76%> (ø)`
packages/cli/src/PublicApi/index.ts	`73.68% <33.33%> (-4.75%)`	⬇️
packages/editor-ui/src/components/MainSidebar.vue	`45.48% <47.82%> (+0.06%)`	⬆️
packages/editor-ui/src/views/SettingsApiView.vue	`61.73% <55.00%> (-1.00%)`	⬇️
packages/editor-ui/src/constants.ts	`97.86% <80.00%> (-0.33%)`	⬇️
... and 9 more

... and 1 file with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

packages/editor-ui/src/n8n-theme-variables.scss

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

packages/editor-ui/src/Interface.ts

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

packages/editor-ui/src/stores/users.ts

mutdmour · 2023-05-04T15:24:41Z

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

+export interface CloudPlanData {
+	planSpec: PlanSpec;
+	instance: Instance;
+	usage: Usage;
+}
+
+export interface PlanSpec {
+	planId: number;
+	monthlyExecutionsLimit: number;
+	activeWorkflowsLimit: number;
+	credentialsLimit: number;
+	isActive: boolean;
+	displayName: string;
+	expirationDate: string;
+	metadata: PlanMetadata;
+}
+export interface PlanMetadata {
+	version: 'v1';
+	group: 'opt-out' | 'opt-in';
+	slug: 'pro-1' | 'pro-2' | 'starter' | 'trial-1';
+	trial?: Trial;
+}
+export interface Trial {
+	length: number;
+	gracePeriod: number;
+}
+export interface Instance {
+	createdAt: string;
+}
+export interface Usage {
+	executions: number;
+	activeWorkflows: number;
+}


why are you duplicating the types here?

It's not possible to use an external type for the defineProps method. See vuejs/core#4294. It can be done with a plugin, but I guess we can do that later on.

damn did not know this.. maybe we can just extend the original types then so we are not duplicating the types completely.. @OlegIvaniv can you take a look here?

interface CloudPlanLocal extends CloudPlan {}

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

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

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

packages/editor-ui/src/App.vue

mutdmour · 2023-05-05T06:32:31Z

packages/editor-ui/src/App.vue

+					// TODO: remove before releasing
+					plan.usage.executions += acc;
+					acc += 20;
+					this.usersStore.setCloudPLan(plan);


this should be done as part of the store action..

packages/editor-ui/src/App.vue

mutdmour · 2023-05-05T06:38:59Z

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

+export interface CloudPlanData {
+	planSpec: PlanSpec;
+	instance: Instance;
+	usage: Usage;
+}
+
+export interface PlanSpec {
+	planId: number;
+	monthlyExecutionsLimit: number;
+	activeWorkflowsLimit: number;
+	credentialsLimit: number;
+	isActive: boolean;
+	displayName: string;
+	expirationDate: string;
+	metadata: PlanMetadata;
+}
+export interface PlanMetadata {
+	version: 'v1';
+	group: 'opt-out' | 'opt-in';
+	slug: 'pro-1' | 'pro-2' | 'starter' | 'trial-1';
+	trial?: Trial;
+}
+export interface Trial {
+	length: number;
+	gracePeriod: number;
+}
+export interface Instance {
+	createdAt: string;
+}
+export interface Usage {
+	executions: number;
+	activeWorkflows: number;
+}


damn did not know this.. maybe we can just extend the original types then so we are not duplicating the types completely.. @OlegIvaniv can you take a look here?

interface CloudPlanLocal extends CloudPlan {}

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

mutdmour · 2023-05-05T06:40:48Z

Looks good overall.. 🙂 just needs tests now

packages/editor-ui/src/stores/users.ts

mutdmour

looks good.. couple of minor questions and nitpicks..

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

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

packages/editor-ui/src/constants.ts

…oud users (#6187) * rename planSpec to plan * Remove instance property as it's not needed anymore * Flatten plan object * remove console.log * feat: disable api using license * feat: add api page * chore: resolve conflicts * chore: resolve conflicts * feat: update and refactor a bit * fix: update endpoints * fix: update endpoints * fix: use host * feat: update copy * fix linting issues --------- Co-authored-by: ricardo <ricardoespinoza105@gmail.com>

mutdmour

LGTM

github-actions · 2023-05-15T12:45:56Z

✅ All Cypress E2E specs passed

github-actions · 2023-05-15T20:37:10Z

✅ All Cypress E2E specs passed

* master: (22 commits) fix: Remove workflow execution credential error message when instance owner (#6116) refactor(editor): Drop vue-typed-mixins (no-changelog) (#6257) feat(core): Return OAuth2 error body if available (#5794) fix: Add itemSize config to workflows view recycle scroller (no-changelog) (#6238) fix(editor): Fix close and cancel operations on useMessage (no-changelog) (#6260) feat(editor): Add cloud ExecutionsUsage and API blocking using licenses (#6159) refactor(editor): Turn showMessage mixin to composable (#6081) (#6244) feat(core): Add experimental proxy support to License-SDK (no-changelog) (#6253) feat(core): Reduce the number of events sent to Sentry (#6235) feat(editor): Drop support for legacy browsers that do not have native ESM support (#6239) refactor(editor): Add missing interface IUserListAction (no-changelog) (#6241) ci: Debug e2e pipeline (no-changelog) (#6240) Revert "refactor(editor): Turn showMessage mixin to composable" (#6243) feat(editor): Updating node reference pattern in expression editor (#6228) refactor(editor): Remove unused dependencies (no-changelog) (#6223) refactor(editor): Turn showMessage mixin to composable (#6081) feat(editor): Version Control settings update (WIP) (#6233) ci: Fix linting issue on master (no-changelog) (#6232) fix: Prevent type error messages for manual executions (no-changelog) (#6229) fix(Code Node): Restore help text (#6231) ...

janober · 2023-05-25T11:40:28Z

Got released with n8n@0.230.1

RicardoE105 changed the title ~~Add ExecutionsUsage component~~ feat(editor): Add ExecutionsUsage component May 3, 2023

RicardoE105 requested a review from mutdmour May 3, 2023 03:17

RicardoE105 force-pushed the ado-638-in-app-build-ui-for-upgrade-path branch from 6647913 to c2c7ed8 Compare May 3, 2023 03:18

n8n-assistant bot added n8n team Authored by the n8n team ui Enhancement in /editor-ui or /design-system labels May 3, 2023

Add ExecutionsUsage component

a87b0b6

RicardoE105 force-pushed the ado-638-in-app-build-ui-for-upgrade-path branch from c2c7ed8 to a87b0b6 Compare May 3, 2023 03:32

mutdmour reviewed May 3, 2023

View reviewed changes

RicardoE105 added 11 commits May 3, 2023 18:37

set $sidebar-expanded-width back to 200px

1d8955c

add days using interpolation

399060c

Rename PlanData type to CloudPlanData

f57d085

Rename Metadata type to PlanMetadata

43209c9

Make prop block in the update button

0ceaf34

Use variable in line-height

a67feae

Remove progressBarSection class

835292a

fix trial expiration calculation

1db1f3f

mock expirationDate and fix issue with days left

0d6729c

Remove unnecesary property from class .container

d834ec3

inject component data via props

0429314

RicardoE105 requested a review from mutdmour May 4, 2023 13:57

mutdmour reviewed May 4, 2023

View reviewed changes

RicardoE105 added 3 commits May 4, 2023 16:12

Check for plan data during app mounting and keep data in the store

bcfd76c

Remove mounted hook

b48adc6

redirect when upgrade plan is clicked

78424c9

RicardoE105 requested a review from mutdmour May 4, 2023 21:30

mutdmour reviewed May 5, 2023

View reviewed changes

packages/editor-ui/src/stores/users.ts Outdated Show resolved Hide resolved

RicardoE105 added 2 commits May 11, 2023 22:33

Improvements

765dd60

small improvements

1f1ff74

mutdmour previously approved these changes May 12, 2023

View reviewed changes

packages/editor-ui/src/utils/apiUtils.ts Show resolved Hide resolved

packages/editor-ui/src/stores/cloudPlan.store.ts Outdated Show resolved Hide resolved

packages/editor-ui/src/stores/cloudPlan.store.ts Outdated Show resolved Hide resolved

mutdmour added 2 commits May 12, 2023 12:37

chore: resolve conflicts

4766591

chore: resolve conflicts

b09bcdc

mutdmour dismissed their stale review via b09bcdc May 12, 2023 10:42

mutdmour requested changes May 12, 2023

View reviewed changes

packages/editor-ui/src/constants.ts Outdated Show resolved Hide resolved

RicardoE105 and others added 8 commits May 13, 2023 16:32

make sure there is data before calculating trial expiration

9b5fbba

Fix issue with component not loading on first page load

454659f

type safety improvements

25b6f91

Sync master

827e1dd

apply component ui feedback

5b9c5e8

fix linting issue

d30632e

chore: clean up unnecessary change from merge conflict

d3a64a1

mutdmour changed the title ~~feat(editor): Add ExecutionsUsage component~~ feat(editor): Add ExecutionsUsage and cloud API component May 15, 2023

mutdmour changed the title ~~feat(editor): Add ExecutionsUsage and cloud API component~~ feat(editor): Add cloud ExecutionsUsage and API blocking using licenses May 15, 2023

mutdmour previously approved these changes May 15, 2023

View reviewed changes

add pluralization to days left text

a745424

RicardoE105 dismissed mutdmour’s stale review via a745424 May 15, 2023 18:13

sync master

9c8f61e

RicardoE105 requested a review from mutdmour May 15, 2023 18:25

mutdmour approved these changes May 15, 2023

View reviewed changes

RicardoE105 merged commit cd7c312 into master May 15, 2023

RicardoE105 deleted the ado-638-in-app-build-ui-for-upgrade-path branch May 15, 2023 21:16

janober added the Released label May 25, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(editor): Add cloud ExecutionsUsage and API blocking using licenses #6159

feat(editor): Add cloud ExecutionsUsage and API blocking using licenses #6159

RicardoE105 commented May 3, 2023

github-actions bot commented May 3, 2023

codecov bot commented May 3, 2023 •

edited

Loading

mutdmour May 4, 2023

RicardoE105 May 4, 2023

mutdmour May 5, 2023

mutdmour May 5, 2023

mutdmour May 5, 2023

mutdmour commented May 5, 2023

mutdmour left a comment

mutdmour left a comment

github-actions bot commented May 15, 2023

github-actions bot commented May 15, 2023

janober commented May 25, 2023

feat(editor): Add cloud ExecutionsUsage and API blocking using licenses #6159

feat(editor): Add cloud ExecutionsUsage and API blocking using licenses #6159

Conversation

RicardoE105 commented May 3, 2023

github-actions bot commented May 3, 2023

codecov bot commented May 3, 2023 • edited Loading

Codecov Report

mutdmour May 4, 2023

Choose a reason for hiding this comment

RicardoE105 May 4, 2023

Choose a reason for hiding this comment

mutdmour May 5, 2023

Choose a reason for hiding this comment

mutdmour May 5, 2023

Choose a reason for hiding this comment

mutdmour May 5, 2023

Choose a reason for hiding this comment

mutdmour commented May 5, 2023

mutdmour left a comment

Choose a reason for hiding this comment

mutdmour left a comment

Choose a reason for hiding this comment

github-actions bot commented May 15, 2023

github-actions bot commented May 15, 2023

janober commented May 25, 2023

codecov bot commented May 3, 2023 •

edited

Loading