[x-license] Add support for plan version #13459

michelengelen · 2024-06-12T06:54:33Z

Changes to support: https://www.notion.so/mui-org/store-Weekly-meeting-2024-06-03-5a0ca5ee914c406eac43673b89b233a4?pvs=4#be21aefcaef24c7880610b7a7bcf49a8

mui-bot · 2024-06-12T06:59:00Z

Deploy preview: https://deploy-preview-13459--material-ui-x.netlify.app/

Generated by 🚫 dangerJS against a19da9d

packages/x-license/src/generateLicense/generateLicense.ts

This reverts commit 190a18e.

packages/x-license/src/utils/licenseScope.ts

packages/x-license/src/useLicenseVerifier/useLicenseVerifier.ts

packages/x-license/src/verifyLicense/verifyLicense.ts

packages/x-license/src/utils/licenseScope.ts

flaviendelangle

The logic seems good 👌
Thanks for taking care of it

packages/x-license/src/generateLicense/generateLicense.ts

packages/x-license/src/verifyLicense/verifyLicense.ts

packages/x-license/src/utils/licenseScope.ts

packages/x-license/src/verifyLicense/verifyLicense.ts

Co-authored-by: Andrew Cherniavskii <andrew.cherniavskii@gmail.com> Signed-off-by: Michel Engelen <32863416+michelengelen@users.noreply.github.com>

and changed the licenseError for the product scope

…nse/2024-license

michelengelen · 2024-06-20T08:25:29Z

@flaviendelangle

mui-x/packages/x-tree-view-pro/src/RichTreeViewPro/RichTreeViewPro.test.tsx

Line 12 in 0b0f3b4

describeConformance(<RichTreeViewPro items={[]} />, () => ({

seems to be the only commercial component where we do the conformance test. Should we skip that? Or should we adjust it to use the license package?

flaviendelangle · 2024-06-20T08:35:19Z

@michelengelen I think we have also conformance test on range pickers.
We should not drop that

flaviendelangle · 2024-06-20T13:59:02Z

I would have liked to decide clarify the status here before merging: #13459 (comment)

michelengelen · 2024-06-20T14:21:43Z

I would have liked to decide clarify the status here before merging: #13459 (comment)

Oh, I thought with @joserodolfofreitas giving his 👍🏼 it was resolved... sry for that.

I did however open a new PR #13568 where we can adjust this.

flaviendelangle · 2024-06-20T14:39:09Z

I'm talking about the name of the status we use mostly, the error message is nice I think
It's related with #13568 so we can discuss it there 👍

oliviertassinari

These changes make sense to me at a high level, great to have them 👍

oliviertassinari · 2024-06-26T15:06:15Z

packages/x-license/src/Watermark/Watermark.tsx

    case LICENSE_STATUS.OutOfScope:
      return 'MUI X License key plan mismatch';
+    case LICENSE_STATUS.ProductNotCovered:
+      return 'MUI X Product not covered by plan';


It feels like these two errors OutOfScope + ProductNotCovered are the same error. Should we merge them? As for the need to show different error messages, I think this should be done through the meta data.

If we want to keep them distinct, I would make their name match, e.g.

OutOfScope -> PlanScopeNotCovered
ProductNotCovered -> ProductScopeNotCovered

I advocated to change ProductNotCovered into a more specific NotAvailableInInitialProPlan in #13568, so that we can display a more precise error in the doc.
We could indeed rename OutOfScope which is super broad right now.

NotAvailableInInitialProPlan so that we can display a more precise error in the doc.

There will be more cases like this in the future of having a paid for one of the MUI X plans, and trying to use a different plan. I don't see creating a new error type each time scaling.

So It feels like this should be one error type and use the metadata to have a precise error in the console.

For the docs, I agree, I can see why we need to separate the cases: (a.) buying pro and using pro without working is a different confusion source than (b.) buying pro and trying to use premium.

But anyway, no strong push on my end, more of a feeling that in the code, it feels strange.

I don't see creating a new error type each time scaling.

The status is only used to do some sort of switch and display a warning message.
So I don't see how metadata would be more or less scalable than a different status message.
Even if we end up with 20 different statuses, the big part is the switch of conditions.

oliviertassinari · 2024-06-26T15:31:11Z

packages/x-license/src/generateLicense/generateLicense.test.ts

+        orderNumber: 'MUI-123',
+        scope: 'pro',
+        licensingModel: 'subscription',
+        planVersion: 'Q3-2024',


I'm used to:

Suggested change

planVersion: 'Q3-2024',

planVersion: '2024-Q3',

I wonder if we should change this. But I guess it's up to the license key generator logic.

oliviertassinari · 2024-06-26T15:34:08Z

packages/x-license/src/utils/licenseScope.ts

@@ -1,3 +1,20 @@
 export const LICENSE_SCOPES = ['pro', 'premium'] as const;
+export const PRODUCT_SCOPES = ['data-grid', 'date-pickers', 'charts', 'tree-view'] as const;
+export const PLAN_VERSIONS = ['initial', 'Q3-2024'] as const;


I'm not convinced about "initial". To me, what we have today is

Suggested change

export const PLAN_VERSIONS = ['initial', 'Q3-2024'] as const;

export const PLAN_VERSIONS = ['Q3-2022', 'Q3-2024'] as const;

the last time we changed the plan.

oliviertassinari · 2024-06-26T15:42:50Z

packages/x-license/src/useLicenseVerifier/useLicenseVerifier.test.tsx

@@ -14,9 +15,9 @@ const oneDayInMS = 1000 * 60 * 60 * 24;
 const releaseDate = new Date(3000, 0, 0, 0, 0, 0, 0);
 const RELEASE_INFO = generateReleaseInfo(releaseDate);

-function TestComponent() {
-  const licesenStatus = useLicenseVerifier('x-date-pickers-pro', RELEASE_INFO);


Oops, I wrote licesen 🤪

oliviertassinari · 2024-06-26T15:44:16Z

packages/x-license/src/utils/licenseScope.ts

+export type ProductScope = (typeof PRODUCT_SCOPES)[number];
+export type PlanVersion = (typeof PLAN_VERSIONS)[number];
+
+export const extractProductScope = (packageName: string): ProductScope => {


A small detail, default function convention we use is function for top level scope and arrow function for lower scope; applied here would be:

Suggested change

export const extractProductScope = (packageName: string): ProductScope => {

export function extractProductScope(packageName: string): ProductScope {

packages/x-license/src/verifyLicense/verifyLicense.ts

packages/x-license/src/useLicenseVerifier/useLicenseVerifier.ts

Signed-off-by: Michel Engelen <32863416+michelengelen@users.noreply.github.com> Co-authored-by: Andrew Cherniavskii <andrew.cherniavskii@gmail.com> Co-authored-by: Flavien DELANGLE <flaviendelangle@gmail.com>

license update proposal

190a18e

michelengelen requested review from joserodolfofreitas, oliviertassinari and flaviendelangle June 12, 2024 06:54

flaviendelangle reviewed Jun 12, 2024

View reviewed changes

packages/x-license/src/generateLicense/generateLicense.ts Outdated Show resolved Hide resolved

packages/x-license/src/generateLicense/generateLicense.ts Outdated Show resolved Hide resolved

michelengelen added 2 commits June 13, 2024 10:09

Revert "license update proposal"

1706016

This reverts commit 190a18e.

second iteration on license update

93a4e9a

michelengelen requested a review from flaviendelangle June 13, 2024 09:16

flaviendelangle reviewed Jun 13, 2024

View reviewed changes

packages/x-license/src/utils/licenseScope.ts Outdated Show resolved Hide resolved

michelengelen added 4 commits June 13, 2024 15:30

3rd iteration

8b4369e

changed status return on charts/treeview check

f815941

removed tests for now

3ccba21

adjusted things and fixed tests

46cf0d5

michelengelen requested a review from flaviendelangle June 13, 2024 14:00

flaviendelangle reviewed Jun 13, 2024

View reviewed changes

review remarks

da18b3f

flaviendelangle reviewed Jun 14, 2024

View reviewed changes

packages/x-license/src/generateLicense/generateLicense.ts Show resolved Hide resolved

packages/x-license/src/verifyLicense/verifyLicense.ts Outdated Show resolved Hide resolved

removed productScope optional marking

ac5e804

michelengelen commented Jun 14, 2024

View reviewed changes

packages/x-license/src/utils/licenseScope.ts Show resolved Hide resolved

packages/x-license/src/verifyLicense/verifyLicense.ts Show resolved Hide resolved

cherniavskii reviewed Jun 14, 2024

View reviewed changes

packages/x-license/src/verifyLicense/verifyLicense.ts Show resolved Hide resolved

packages/x-license/src/verifyLicense/verifyLicense.ts Outdated Show resolved Hide resolved

michelengelen and others added 6 commits June 14, 2024 17:03

Update verifyLicense.ts

300e0b5

Co-authored-by: Andrew Cherniavskii <andrew.cherniavskii@gmail.com> Signed-off-by: Michel Engelen <32863416+michelengelen@users.noreply.github.com>

added license generation tests

e62b985

fixed typo

f4b0ed5

Added 'Mui X:' prefix on error

b5cec8b

Added Key Version 2.2 tests

88056dd

added product scope tests

508c785

michelengelen requested review from flaviendelangle and cherniavskii June 18, 2024 14:41

added useLicenseVerifier test

c6e7a17

and changed the licenseError for the product scope

Merge remote-tracking branch 'refs/remotes/upstream/master' into lice…

c04fa6b

…nse/2024-license

added text for new license state to watermark

f19b30e

fix tests

a0da60e

michelengelen marked this pull request as ready for review June 20, 2024 12:23

michelengelen enabled auto-merge (squash) June 20, 2024 12:24

fix tests

a19da9d

michelengelen merged commit c84a2ee into mui:master Jun 20, 2024
15 checks passed

michelengelen deleted the license/2024-license branch June 20, 2024 13:16

zannager added the MUI X label Jun 20, 2024

oliviertassinari added the package: x-license Specific to @mui/x-license. label Jun 26, 2024

oliviertassinari changed the title ~~[x-license] license update proposal~~ [x-license] Add support for plan version Jun 26, 2024

oliviertassinari reviewed Jun 26, 2024

View reviewed changes

oliviertassinari mentioned this pull request Jun 26, 2024

[license] Allow usage of charts an tree view pro package for old premium licenses #13619

Merged

This was referenced Jul 13, 2024

[Snyk] Upgrade @mui/x-data-grid from 7.7.0 to 7.7.1 DMPatod/wallet-manager-app#5

Open

[Snyk] Upgrade @mui/x-date-pickers from 7.7.0 to 7.7.1 DMPatod/wallet-manager-app#6

Open

alhabib5565 mentioned this pull request Jul 14, 2024

[Snyk] Upgrade @mui/x-data-grid from 7.3.0 to 7.7.1 alhabib5565/quick-shop-client#5

Open

KotoneZQ mentioned this pull request Jul 18, 2024

[Snyk] Upgrade @mui/x-date-pickers from 7.5.1 to 7.7.1 KotoneZQ/ICT2216-RoomBooker-test#1

Open

This was referenced Jul 20, 2024

[Snyk] Upgrade @mui/x-data-grid from 7.7.0 to 7.8.0 DMPatod/wallet-manager-app#7

Open

[Snyk] Upgrade @mui/x-date-pickers from 7.7.0 to 7.8.0 DMPatod/wallet-manager-app#8

Open

Carment14tham mentioned this pull request Jul 20, 2024

[Snyk] Upgrade @mui/x-date-pickers from 7.5.1 to 7.8.0 Carment14tham/ICT2216-RoomBooker-main#1

Open

oliviertassinari added plan: Pro Impact at least one Pro user plan: Premium Impact at least one Premium user and removed MUI X labels Aug 19, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[x-license] Add support for plan version #13459

[x-license] Add support for plan version #13459

michelengelen commented Jun 12, 2024 •

edited by oliviertassinari

Loading

mui-bot commented Jun 12, 2024 •

edited

Loading

flaviendelangle left a comment

michelengelen commented Jun 20, 2024

flaviendelangle commented Jun 20, 2024

flaviendelangle commented Jun 20, 2024

michelengelen commented Jun 20, 2024

flaviendelangle commented Jun 20, 2024

oliviertassinari left a comment •

edited

Loading

oliviertassinari Jun 26, 2024 •

edited

Loading

flaviendelangle Jun 27, 2024

oliviertassinari Jun 28, 2024 •

edited

Loading

flaviendelangle Jun 30, 2024

oliviertassinari Jun 26, 2024

oliviertassinari Jun 26, 2024

oliviertassinari Jun 26, 2024

oliviertassinari Jun 26, 2024

	export const PLAN_VERSIONS = ['initial', 'Q3-2024'] as const;
	export const PLAN_VERSIONS = ['Q3-2022', 'Q3-2024'] as const;

	export const extractProductScope = (packageName: string): ProductScope => {
	export function extractProductScope(packageName: string): ProductScope {

[x-license] Add support for plan version #13459

[x-license] Add support for plan version #13459

Conversation

michelengelen commented Jun 12, 2024 • edited by oliviertassinari Loading

mui-bot commented Jun 12, 2024 • edited Loading

flaviendelangle left a comment

Choose a reason for hiding this comment

michelengelen commented Jun 20, 2024

flaviendelangle commented Jun 20, 2024

flaviendelangle commented Jun 20, 2024

michelengelen commented Jun 20, 2024

flaviendelangle commented Jun 20, 2024

oliviertassinari left a comment • edited Loading

Choose a reason for hiding this comment

oliviertassinari Jun 26, 2024 • edited Loading

Choose a reason for hiding this comment

flaviendelangle Jun 27, 2024

Choose a reason for hiding this comment

oliviertassinari Jun 28, 2024 • edited Loading

Choose a reason for hiding this comment

flaviendelangle Jun 30, 2024

Choose a reason for hiding this comment

oliviertassinari Jun 26, 2024

Choose a reason for hiding this comment

oliviertassinari Jun 26, 2024

Choose a reason for hiding this comment

oliviertassinari Jun 26, 2024

Choose a reason for hiding this comment

oliviertassinari Jun 26, 2024

Choose a reason for hiding this comment

michelengelen commented Jun 12, 2024 •

edited by oliviertassinari

Loading

mui-bot commented Jun 12, 2024 •

edited

Loading

oliviertassinari left a comment •

edited

Loading

oliviertassinari Jun 26, 2024 •

edited

Loading

oliviertassinari Jun 28, 2024 •

edited

Loading