Skip to content

[license] Updated the LicenseInfo class with 2 additional checks #16404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

[license] Updated the LicenseInfo class with 2 additional checks #16404

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fab9d2e
updated the LicenseInfo class and added 2 new errors for setLicenseKe…
michelengelen Jan 30, 2025
4395a7f
Merge branch 'master' into license/update-licensInfo-class
michelengelen Jan 30, 2025
28644f4
Apply suggestions from code review
michelengelen Jan 31, 2025
2c09097
Update packages/x-license/src/utils/licenseErrorMessageUtils.ts
michelengelen Feb 1, 2025
18eb656
Update packages/x-license/src/utils/licenseErrorMessageUtils.ts
michelengelen Feb 1, 2025
f23eba0
Merge branch 'master' into license/update-licensInfo-class
michelengelen Feb 10, 2025
49d1048
removed the license key is not set error in favor of license status
michelengelen Feb 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions packages/x-license/src/useLicenseVerifier/useLicenseVerifier.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ import {
showLicenseKeyPlanMismatchError,
showExpiredPackageVersionError,
showNotAvailableInInitialProPlanError,
showLicenseKeyNotSetError,
showSetLicenseKeyNotCalledError,
} from '../utils/licenseErrorMessageUtils';
import { LICENSE_STATUS, LicenseStatus } from '../utils/licenseStatus';
import MuiLicenseInfoContext from '../Unstable_LicenseInfoProvider/MuiLicenseInfoContext';
Expand All @@ -31,6 +33,12 @@ export function useLicenseVerifier(
} {
const { key: contextKey } = React.useContext(MuiLicenseInfoContext);
return React.useMemo(() => {
if (!LicenseInfo.getHasSetLicenseKeyRun()) {
showSetLicenseKeyNotCalledError();
}
if (!LicenseInfo.getIsLicenseKeySet()) {
showLicenseKeyNotSetError();
}
const licenseKey = contextKey ?? LicenseInfo.getLicenseKey();

// Cache the response to not trigger the error twice.
Expand Down
22 changes: 22 additions & 0 deletions packages/x-license/src/utils/licenseErrorMessageUtils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,28 @@ function showError(message: string[]) {
);
}

export function showSetLicenseKeyNotCalledError() {
showError([
'MUI X: `setLicenseKey` was never called.',
'',
'The `setLicenseKey()` function was never called. This might be because you did not call `setLicenseKey()` during runtime.',
'',
'To resolve this issue, ensure that `setLicenseKey()` is called with the right argument during runtime.',
'Please check the license key installation instructions: https://mui.com/r/x-license-key-installation.',
]);
}

export function showLicenseKeyNotSetError() {
showError([
'MUI X: License key not set.',
'',
'The license key is not set. This might be because you did not call `setLicenseKey()` or called it without an argument.',
'',
'To resolve this issue, ensure that `setLicenseKey()` is called with the right argument.',
'Please check the license key installation instructions: https://mui.com/r/x-license-key-installation',
]);
}

export function showInvalidLicenseKeyError() {
showError([
'MUI X: Invalid license key.',
Expand Down
14 changes: 14 additions & 0 deletions packages/x-license/src/utils/licenseInfo.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ ponyfillGlobal.__MUI_LICENSE_INFO__ = ponyfillGlobal.__MUI_LICENSE_INFO__ || {
};

export class LicenseInfo {
private static hasSetLicenseKeyRun: boolean = false;

private static isLicenseKeySet: boolean = false;

private static getLicenseInfo() {
// eslint-disable-next-line no-underscore-dangle
return ponyfillGlobal.__MUI_LICENSE_INFO__;
Expand All @@ -29,5 +33,15 @@ export class LicenseInfo {
public static setLicenseKey(key: string) {
const licenseInfo = LicenseInfo.getLicenseInfo();
licenseInfo.key = key;
LicenseInfo.isLicenseKeySet = !!key;
LicenseInfo.hasSetLicenseKeyRun = true;
}

public static getIsLicenseKeySet(): boolean {
return LicenseInfo.isLicenseKeySet;
}

public static getHasSetLicenseKeyRun(): boolean {
return LicenseInfo.hasSetLicenseKeyRun;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could do this with less code, no?

Suggested change
LicenseInfo.isLicenseKeySet = !!key;
LicenseInfo.hasSetLicenseKeyRun = true;
}
public static getIsLicenseKeySet(): boolean {
return LicenseInfo.isLicenseKeySet;
}
public static getHasSetLicenseKeyRun(): boolean {
return LicenseInfo.hasSetLicenseKeyRun;
}

and then

 ponyfillGlobal.__MUI_LICENSE_INFO__ = ponyfillGlobal.__MUI_LICENSE_INFO__ || {
-  key: undefined,
+  key: 'default',
 };

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one very specific edge-case where this would not be enough:
setLicenseKey was called, but with undefined as parameter.
Not sure if we want to cover that case though ... WDYT?

}
}