fix(material/core): avoid running sanity checks on some test environments

Fixes that the sanity checks were running on some testing environments like Jest.

These changes also move the test environment check into a centralized place so that it's easier to keep up to date.

Fixes #23365.

Author: crisbeto

src/cdk/overlay/overlay-container.ts

@@ -10,30 +10,6 @@ import {DOCUMENT} from '@angular/common';
 import {Inject, Injectable, OnDestroy} from '@angular/core';
 import {Platform} from '@angular/cdk/platform';
 
-// Avoid using `declare const` because it caused conflicts inside Google
-// with the real typings for these symbols. We use `declare interface` instead
-// of just `interface` for interop with Closure Compiler (prevents property renaming):
-// https://github.com/angular/tsickle/blob/master/README.md#differences-from-typescript
-declare interface TestGlobals {
-  jasmine: unknown;
-  __karma__: unknown;
-  jest: unknown;
-  Mocha: unknown;
-}
-
-const globalsForTest = (typeof window !== 'undefined' ? window : {}) as {} as TestGlobals;
-
-/**
- * Whether we're in a testing environment.
- * TODO(crisbeto): remove this once we have an overlay testing module or Angular starts tearing
- * down the testing `NgModule` (see https://github.com/angular/angular/issues/18831).
- */
-const isTestEnvironment =
-    (typeof globalsForTest.__karma__ !== 'undefined' && !!globalsForTest.__karma__) ||
-    (typeof globalsForTest.jasmine !== 'undefined' && !!globalsForTest.jasmine) ||
-    (typeof globalsForTest.jest !== 'undefined' && !!globalsForTest.jest) ||
-    (typeof globalsForTest.Mocha !== 'undefined' && !!globalsForTest.Mocha);
-
 /** Container inside which all overlays will render. */
 @Injectable({providedIn: 'root'})
 export class OverlayContainer implements OnDestroy {
@@ -54,7 +30,7 @@ export class OverlayContainer implements OnDestroy {
 
   /**
    * This method returns the overlay container element. It will lazily
-   * create the element the first time  it is called to facilitate using
+   * create the element the first time it is called to facilitate using
    * the container in non-browser environments.
    * @returns the container element
    */
@@ -73,7 +49,10 @@ export class OverlayContainer implements OnDestroy {
   protected _createContainer(): void {
     const containerClass = 'cdk-overlay-container';
 
-    if (this._platform.isBrowser || isTestEnvironment) {
+    // TODO(crisbeto): remove the testing check once we have an overlay testing
+    // module or Angular starts tearing down the testing `NgModule`. See:
+    // https://github.com/angular/angular/issues/18831
+    if (this._platform.isBrowser || this._platform.isTest) {
       const oppositePlatformContainers =
           this._document.querySelectorAll(`.${containerClass}[platform="server"], ` +
                                           `.${containerClass}[platform="test"]`);
@@ -97,7 +76,7 @@ export class OverlayContainer implements OnDestroy {
     // module which does the cleanup, we try to detect that we're in a test environment and we
     // always clear the container. See #17006.
     // TODO(crisbeto): remove the test environment check once we have an overlay testing module.
-    if (isTestEnvironment) {
+    if (this._platform.isTest) {
       container.setAttribute('platform', 'test');
     } else if (!this._platform.isBrowser) {
       container.setAttribute('platform', 'server');

src/cdk/platform/platform.ts

@@ -24,6 +24,19 @@ try {
   hasV8BreakIterator = false;
 }
 
+// Avoid using `declare const` because it caused conflicts inside Google
+// with the real typings for these symbols. We use `declare interface` instead
+// of just `interface` for interop with Closure Compiler (prevents property renaming):
+// https://github.com/angular/tsickle/blob/master/README.md#differences-from-typescript
+declare interface TestGlobals {
+  jasmine: unknown;
+  __karma__: unknown;
+  jest: unknown;
+  Mocha: unknown;
+}
+
+const testGlobals = (typeof window !== 'undefined' ? window : {}) as {} as TestGlobals;
+
 /**
  * Service to detect the current platform by comparing the userAgent strings and
  * checking browser-specific global properties.
@@ -37,6 +50,13 @@ export class Platform {
   isBrowser: boolean = this._platformId ?
       isPlatformBrowser(this._platformId) : typeof document === 'object' && !!document;
 
+  /** Whether the application is running inside a testing environment. */
+  isTest: boolean =
+    (typeof testGlobals.__karma__ !== 'undefined' && !!testGlobals.__karma__) ||
+    (typeof testGlobals.jasmine !== 'undefined' && !!testGlobals.jasmine) ||
+    (typeof testGlobals.jest !== 'undefined' && !!testGlobals.jest) ||
+    (typeof testGlobals.Mocha !== 'undefined' && !!testGlobals.Mocha);
+
   /** Whether the current browser is Microsoft Edge. */
   EDGE: boolean = this.isBrowser && /(edge)/i.test(navigator.userAgent);
 

src/material/core/common-behaviors/common-module.ts

@@ -11,6 +11,7 @@ import {BidiModule} from '@angular/cdk/bidi';
 import {Inject, InjectionToken, isDevMode, NgModule, Optional, Version} from '@angular/core';
 import {VERSION as CDK_VERSION} from '@angular/cdk';
 import {DOCUMENT} from '@angular/common';
+import {Platform} from '@angular/cdk/platform';
 
 // Private version constant to circumvent test/build issues,
 // i.e. avoid core to depend on the @angular/material primary entry-point
@@ -65,7 +66,8 @@ export class MatCommonModule {
   constructor(
       highContrastModeDetector: HighContrastModeDetector,
       @Optional() @Inject(MATERIAL_SANITY_CHECKS) sanityChecks: any,
-      @Inject(DOCUMENT) document: any) {
+      @Inject(DOCUMENT) document: any,
+      @Optional() private _platform?: Platform) {
     this._document = document;
 
     // While A11yModule also does this, we repeat it here to avoid importing A11yModule
@@ -84,19 +86,13 @@ export class MatCommonModule {
     }
   }
 
-  /** Use defaultView of injected document if available or fallback to global window reference */
-  private _getWindow(): Window | null {
-    const win = this._document.defaultView || window;
-    return typeof win === 'object' && win ? win : null;
-  }
-
   /** 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
-    if (!isDevMode() || this._isTestEnv()) {
+    if (!isDevMode() || this._platform?.isTest) {
       return false;
     }
 
@@ -107,12 +103,6 @@ export class MatCommonModule {
     return !!this._sanityChecks[name];
   }
 
-  /** Whether the code is running in tests. */
-  private _isTestEnv() {
-    const window = this._getWindow() as any;
-    return window && (window.__karma__ || window.jasmine);
-  }
-
   private _checkDoctypeIsDefined(): void {
     if (this._checkIsEnabled('doctype') && !this._document.doctype) {
       console.warn(

tools/public_api_guard/cdk/platform.md

@@ -33,6 +33,7 @@ export class Platform {
     FIREFOX: boolean;
     IOS: boolean;
     isBrowser: boolean;
+    isTest: boolean;
     SAFARI: boolean;
     TRIDENT: boolean;
     WEBKIT: boolean;

tools/public_api_guard/material/core.md

@@ -200,10 +200,10 @@ export const MAT_RIPPLE_GLOBAL_OPTIONS: InjectionToken<RippleGlobalOptions>;
 
 // @public
 export class MatCommonModule {
-    constructor(highContrastModeDetector: HighContrastModeDetector, sanityChecks: any, document: any);
+    constructor(highContrastModeDetector: HighContrastModeDetector, sanityChecks: any, document: any, _platform?: Platform | undefined);
     protected _document: Document;
     // (undocumented)
-    static ɵfac: i0.ɵɵFactoryDeclaration<MatCommonModule, [null, { optional: true; }, null]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<MatCommonModule, [null, { optional: true; }, null, { optional: true; }]>;
     // (undocumented)
     static ɵinj: i0.ɵɵInjectorDeclaration<MatCommonModule>;
     // (undocumented)