Skip to content

fix(material/core): sanity checks not running #23289

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

Merged
merged 1 commit into from
Aug 6, 2021
Merged

fix(material/core): sanity checks not running #23289

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 15 additions & 15 deletions src/material/core/common-behaviors/common-module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,13 +90,21 @@ export class MatCommonModule {
return typeof win === 'object' && win ? win : null;
}

/** Whether any sanity checks are enabled. */
private _checksAreEnabled(): boolean {
/** Gets whether a specific sanity check is enabled. */
private _checkIsEnabled(name: keyof GranularSanityChecks): boolean {
// TODO(crisbeto): we can't use `ngDevMode` here yet, because ViewEngine apps might not support
// it. Since these checks can have performance implications and they aren't tree shakeable
// in their current form, we can leave the `isDevMode` check in for now.
// tslint:disable-next-line:ban
return isDevMode() && !this._isTestEnv();
if (!isDevMode() || this._isTestEnv()) {
return false;
}

if (typeof this._sanityChecks === 'boolean') {
return this._sanityChecks;
}

return !!this._sanityChecks[name];
}

/** Whether the code is running in tests. */
Expand All @@ -106,10 +114,7 @@ export class MatCommonModule {
}

private _checkDoctypeIsDefined(): void {
const isEnabled = this._checksAreEnabled() &&
(this._sanityChecks === true || (this._sanityChecks as GranularSanityChecks).doctype);

if (isEnabled && !this._document.doctype) {
if (this._checkIsEnabled('doctype') && !this._document.doctype) {
console.warn(
'Current document does not have a doctype. This may cause ' +
'some Angular Material components not to behave as expected.'
Expand All @@ -120,10 +125,8 @@ export class MatCommonModule {
private _checkThemeIsPresent(): void {
// We need to assert that the `body` is defined, because these checks run very early
// and the `body` won't be defined if the consumer put their scripts in the `head`.
const isDisabled = !this._checksAreEnabled() ||
(this._sanityChecks === false || !(this._sanityChecks as GranularSanityChecks).theme);

if (isDisabled || !this._document.body || typeof getComputedStyle !== 'function') {
if (!this._checkIsEnabled('theme') || !this._document.body ||
typeof getComputedStyle !== 'function') {
return;
}

Expand All @@ -150,10 +153,7 @@ export class MatCommonModule {

/** Checks whether the material version matches the cdk version */
private _checkCdkVersionMatch(): void {
const isEnabled = this._checksAreEnabled() &&
(this._sanityChecks === true || (this._sanityChecks as GranularSanityChecks).version);

if (isEnabled && VERSION.full !== CDK_VERSION.full) {
if (this._checkIsEnabled('version') && VERSION.full !== CDK_VERSION.full) {
console.warn(
'The Angular Material version (' + VERSION.full + ') does not match ' +
'the Angular CDK version (' + CDK_VERSION.full + ').\n' +
Expand Down