refactor: constructor breaking changes for 8.0 (#15647)

Goes through the constructor-related breaking changes for 8.0 in all of the CDK symbols plus `material/form-field` and `material/tabs`.

BREAKING CHANGES:

* `CdkDrag`: `viewportRuler` and `dragDropRegistry` parameters have been removed from the constructor. Furthermore the `dragDrop` and `_changeDetectorRef` parameters in are now required.
* `CdkDropList`:  `dragDropRegistry` and `_documents` parameters have been removed, and `dragDrop` parameter is now required.
* `ConnectedPositionStrategy`: `platform` parameter is now required and a new `overlayContainer` parameter has been added.
* `FlexibleConnectedPositionStrategy`: `_platform` and `_overlayContainer` parameters are now required.
* `OverlayPositionBuilder`: `_platform` and `_overlayContainer` parameters are now required.
* `CdkTable`: `_document` and `_platform` parameters are now required.
* `MatFormField`: `_platform`, `_ngZone` and `_animationMode` parameters are now required.
* `MatTabLink`: `_focusMonitor` parameter is now required.

Author: crisbeto

src/cdk/drag-drop/directives/drag.ts

@@ -7,7 +7,6 @@
  */
 
 import {Directionality} from '@angular/cdk/bidi';
-import {ViewportRuler} from '@angular/cdk/scrolling';
 import {DOCUMENT} from '@angular/common';
 import {
   AfterViewInit,
@@ -33,7 +32,6 @@ import {
 import {coerceBooleanProperty, coerceNumberProperty} from '@angular/cdk/coercion';
 import {Observable, Observer, Subject, merge} from 'rxjs';
 import {startWith, take, map, takeUntil, switchMap, tap} from 'rxjs/operators';
-import {DragDropRegistry} from '../drag-drop-registry';
 import {
   CdkDragDrop,
   CdkDragEnd,
@@ -49,7 +47,6 @@ import {CdkDragPreview} from './drag-preview';
 import {CDK_DROP_LIST} from '../drop-list-container';
 import {CDK_DRAG_PARENT} from '../drag-parent';
 import {DragRef, DragRefConfig, Point} from '../drag-ref';
-import {DropListRef} from '../drop-list-ref';
 import {CdkDropListInternal as CdkDropList} from './drop-list';
 import {DragDrop} from '../drag-drop';
 
@@ -182,36 +179,15 @@ export class CdkDrag<T = any> implements AfterViewInit, OnChanges, OnDestroy {
       });
 
   constructor(
-    /** Element that the draggable is attached to. */
-    public element: ElementRef<HTMLElement>,
-    /** Droppable container that the draggable is a part of. */
-    @Inject(CDK_DROP_LIST) @Optional() @SkipSelf()
-    public dropContainer: CdkDropList,
-    @Inject(DOCUMENT) private _document: any,
-    private _ngZone: NgZone,
-    private _viewContainerRef: ViewContainerRef,
-    viewportRuler: ViewportRuler,
-    dragDropRegistry: DragDropRegistry<DragRef, DropListRef>,
-    @Inject(CDK_DRAG_CONFIG) config: DragRefConfig,
-    @Optional() private _dir: Directionality,
-
-    /**
-     * @deprecated `viewportRuler`, `dragDropRegistry` and `_changeDetectorRef` parameters
-     * to be removed. Also `dragDrop` parameter to be made required.
-     * @breaking-change 8.0.0.
-     */
-    dragDrop?: DragDrop,
-    private _changeDetectorRef?: ChangeDetectorRef) {
-
-
-    // @breaking-change 8.0.0 Remove null check once the paramter is made required.
-    if (dragDrop) {
-      this._dragRef = dragDrop.createDrag(element, config);
-    } else {
-      this._dragRef = new DragRef(element, config, _document, _ngZone, viewportRuler,
-          dragDropRegistry);
-    }
-
+      /** Element that the draggable is attached to. */
+      public element: ElementRef<HTMLElement>,
+      /** Droppable container that the draggable is a part of. */
+      @Inject(CDK_DROP_LIST) @Optional() @SkipSelf() public dropContainer: CdkDropList,
+      @Inject(DOCUMENT) private _document: any, private _ngZone: NgZone,
+      private _viewContainerRef: ViewContainerRef, @Inject(CDK_DRAG_CONFIG) config: DragRefConfig,
+      @Optional() private _dir: Directionality, dragDrop: DragDrop,
+      private _changeDetectorRef: ChangeDetectorRef) {
+    this._dragRef = dragDrop.createDrag(element, config);
     this._dragRef.data = this;
     this._syncInputs(this._dragRef);
     this._handleEvents(this._dragRef);
@@ -361,10 +337,7 @@ export class CdkDrag<T = any> implements AfterViewInit, OnChanges, OnDestroy {
 
       // Since all of these events run outside of change detection,
       // we need to ensure that everything is marked correctly.
-      if (this._changeDetectorRef) {
-        // @breaking-change 8.0.0 Remove null check for _changeDetectorRef
-        this._changeDetectorRef.markForCheck();
-      }
+      this._changeDetectorRef.markForCheck();
     });
 
     ref.released.subscribe(() => {
@@ -376,10 +349,7 @@ export class CdkDrag<T = any> implements AfterViewInit, OnChanges, OnDestroy {
 
       // Since all of these events run outside of change detection,
       // we need to ensure that everything is marked correctly.
-      if (this._changeDetectorRef) {
-        // @breaking-change 8.0.0 Remove null check for _changeDetectorRef
-        this._changeDetectorRef.markForCheck();
-      }
+      this._changeDetectorRef.markForCheck();
     });
 
     ref.entered.subscribe(event => {

src/cdk/drag-drop/directives/drop-list.ts

@@ -20,13 +20,10 @@ import {
   Directive,
   ChangeDetectorRef,
   SkipSelf,
-  Inject,
   AfterContentInit,
 } from '@angular/core';
-import {DOCUMENT} from '@angular/common';
 import {Directionality} from '@angular/cdk/bidi';
 import {CdkDrag} from './drag';
-import {DragDropRegistry} from '../drag-drop-registry';
 import {CdkDragDrop, CdkDragEnter, CdkDragExit, CdkDragSortEvent} from '../drag-events';
 import {CDK_DROP_LIST_CONTAINER, CdkDropListContainer} from '../drop-list-container';
 import {CdkDropListGroup} from './drop-list-group';
@@ -154,28 +151,11 @@ export class CdkDropList<T = any> implements CdkDropListContainer, AfterContentI
   sorted: EventEmitter<CdkDragSortEvent<T>> = new EventEmitter<CdkDragSortEvent<T>>();
 
   constructor(
-    /** Element that the drop list is attached to. */
-    public element: ElementRef<HTMLElement>,
-    dragDropRegistry: DragDropRegistry<DragRef, DropListRef>,
-    private _changeDetectorRef: ChangeDetectorRef,
-    @Optional() private _dir?: Directionality,
-    @Optional() @SkipSelf() private _group?: CdkDropListGroup<CdkDropList>,
-    @Optional() @Inject(DOCUMENT) _document?: any,
-
-    /**
-     * @deprecated `dragDropRegistry` and `_document` parameters to be removed.
-     * Also `dragDrop` parameter to be made required.
-     * @breaking-change 8.0.0.
-     */
-    dragDrop?: DragDrop) {
-
-    // @breaking-change 8.0.0 Remove null check once `dragDrop` parameter is made required.
-    if (dragDrop) {
-      this._dropListRef = dragDrop.createDropList(element);
-    } else {
-      this._dropListRef = new DropListRef(element, dragDropRegistry, _document || document);
-    }
-
+      /** Element that the drop list is attached to. */
+      public element: ElementRef<HTMLElement>, dragDrop: DragDrop,
+      private _changeDetectorRef: ChangeDetectorRef, @Optional() private _dir?: Directionality,
+      @Optional() @SkipSelf() private _group?: CdkDropListGroup<CdkDropList>) {
+    this._dropListRef = dragDrop.createDropList(element);
     this._dropListRef.data = this;
     this._dropListRef.enterPredicate = (drag: DragRef<CdkDrag>, drop: DropListRef<CdkDropList>) => {
       return this.enterPredicate(drag.data, drop.data);

src/cdk/overlay/position/connected-position-strategy.ts

@@ -7,9 +7,14 @@
  */
 
 import {Direction} from '@angular/cdk/bidi';
+import {Platform} from '@angular/cdk/platform';
 import {CdkScrollable, ViewportRuler} from '@angular/cdk/scrolling';
 import {ElementRef} from '@angular/core';
 import {Observable} from 'rxjs';
+
+import {OverlayContainer} from '../overlay-container';
+import {OverlayReference} from '../overlay-reference';
+
 import {
   ConnectedOverlayPositionChange,
   ConnectionPositionPair,
@@ -18,8 +23,6 @@ import {
 } from './connected-position';
 import {FlexibleConnectedPositionStrategy} from './flexible-connected-position-strategy';
 import {PositionStrategy} from './position-strategy';
-import {Platform} from '@angular/cdk/platform';
-import {OverlayReference} from '../overlay-reference';
 
 /**
  * A strategy for positioning overlays. Using this strategy, an overlay is given an
@@ -56,23 +59,18 @@ export class ConnectedPositionStrategy implements PositionStrategy {
   }
 
   constructor(
-      originPos: OriginConnectionPosition,
-      overlayPos: OverlayConnectionPosition,
-      connectedTo: ElementRef<HTMLElement>,
-      viewportRuler: ViewportRuler,
-      document: Document,
-      // @breaking-change 8.0.0 `platform` parameter to be made required.
-      platform?: Platform) {
-
+      originPos: OriginConnectionPosition, overlayPos: OverlayConnectionPosition,
+      connectedTo: ElementRef<HTMLElement>, viewportRuler: ViewportRuler, document: Document,
+      platform: Platform, overlayContainer: OverlayContainer) {
     // Since the `ConnectedPositionStrategy` is deprecated and we don't want to maintain
     // the extra logic, we create an instance of the positioning strategy that has some
     // defaults that make it behave as the old position strategy and to which we'll
     // proxy all of the API calls.
-    this._positionStrategy =
-      new FlexibleConnectedPositionStrategy(connectedTo, viewportRuler, document, platform)
-        .withFlexibleDimensions(false)
-        .withPush(false)
-        .withViewportMargin(0);
+    this._positionStrategy = new FlexibleConnectedPositionStrategy(
+                                 connectedTo, viewportRuler, document, platform, overlayContainer)
+                                 .withFlexibleDimensions(false)
+                                 .withPush(false)
+                                 .withViewportMargin(0);
 
     this.withFallbackPosition(originPos, overlayPos);
   }

src/cdk/overlay/position/flexible-connected-position-strategy.ts

@@ -142,12 +142,9 @@ export class FlexibleConnectedPositionStrategy implements PositionStrategy {
   }
 
   constructor(
-    connectedTo: FlexibleConnectedPositionStrategyOrigin,
-    private _viewportRuler: ViewportRuler,
-    private _document: Document,
-    // @breaking-change 8.0.0 `_platform` and `_overlayContainer` parameters to be made required.
-    private _platform?: Platform,
-    private _overlayContainer?: OverlayContainer) {
+      connectedTo: FlexibleConnectedPositionStrategyOrigin, private _viewportRuler: ViewportRuler,
+      private _document: Document, private _platform: Platform,
+      private _overlayContainer: OverlayContainer) {
     this.setOrigin(connectedTo);
   }
 
@@ -193,8 +190,7 @@ export class FlexibleConnectedPositionStrategy implements PositionStrategy {
    */
   apply(): void {
     // We shouldn't do anything if the strategy was disposed or we're on the server.
-    // @breaking-change 8.0.0 Remove `_platform` null check once it's guaranteed to be defined.
-    if (this._isDisposed || (this._platform && !this._platform.isBrowser)) {
+    if (this._isDisposed || !this._platform.isBrowser) {
       return;
     }
 
@@ -926,11 +922,8 @@ export class FlexibleConnectedPositionStrategy implements PositionStrategy {
       overlayPoint = this._pushOverlayOnScreen(overlayPoint, this._overlayRect, scrollPosition);
     }
 
-    // @breaking-change 8.0.0 Currently the `_overlayContainer` is optional in order to avoid a
-    // breaking change. The null check here can be removed once the `_overlayContainer` becomes
-    // a required parameter.
-    let virtualKeyboardOffset = this._overlayContainer ?
-        this._overlayContainer.getContainerElement().getBoundingClientRect().top : 0;
+    let virtualKeyboardOffset =
+        this._overlayContainer.getContainerElement().getBoundingClientRect().top;
 
     // Normally this would be zero, however when the overlay is attached to an input (e.g. in an
     // autocomplete), mobile browsers will shift everything in order to put the input in the middle

src/cdk/overlay/position/overlay-position-builder.ts

@@ -6,29 +6,28 @@
  * found in the LICENSE file at https://angular.io/license
  */
 
+import {Platform} from '@angular/cdk/platform';
 import {ViewportRuler} from '@angular/cdk/scrolling';
 import {DOCUMENT} from '@angular/common';
-import {ElementRef, Inject, Injectable, Optional} from '@angular/core';
+import {ElementRef, Inject, Injectable} from '@angular/core';
+
+import {OverlayContainer} from '../overlay-container';
+
 import {OriginConnectionPosition, OverlayConnectionPosition} from './connected-position';
 import {ConnectedPositionStrategy} from './connected-position-strategy';
 import {
   FlexibleConnectedPositionStrategy,
   FlexibleConnectedPositionStrategyOrigin,
 } from './flexible-connected-position-strategy';
 import {GlobalPositionStrategy} from './global-position-strategy';
-import {Platform} from '@angular/cdk/platform';
-import {OverlayContainer} from '../overlay-container';
 
 
 /** Builder for overlay position strategy. */
 @Injectable({providedIn: 'root'})
 export class OverlayPositionBuilder {
   constructor(
-    private _viewportRuler: ViewportRuler,
-    @Inject(DOCUMENT) private _document: any,
-    // @breaking-change 8.0.0 `_platform` and `_overlayContainer` parameters to be made required.
-    @Optional() private _platform?: Platform,
-    @Optional() private _overlayContainer?: OverlayContainer) { }
+      private _viewportRuler: ViewportRuler, @Inject(DOCUMENT) private _document: any,
+      private _platform: Platform, private _overlayContainer: OverlayContainer) {}
 
   /**
    * Creates a global position strategy.
@@ -49,9 +48,9 @@ export class OverlayPositionBuilder {
       elementRef: ElementRef,
       originPos: OriginConnectionPosition,
       overlayPos: OverlayConnectionPosition): ConnectedPositionStrategy {
-
-    return new ConnectedPositionStrategy(originPos, overlayPos, elementRef, this._viewportRuler,
-        this._document);
+    return new ConnectedPositionStrategy(
+        originPos, overlayPos, elementRef, this._viewportRuler, this._document, this._platform,
+        this._overlayContainer);
   }
 
   /**

src/cdk/schematics/ng-update/data/constructor-checks.ts

@@ -17,6 +17,15 @@ export type ConstructorChecksUpgradeData = string;
  * automatically through type checking.
  */
 export const constructorChecks: VersionChanges<ConstructorChecksUpgradeData> = {
+  [TargetVersion.V8]: [
+    {
+      pr: 'https://github.com/angular/material2/pull/15647',
+      changes: [
+        'CdkDrag', 'CdkDropList', 'ConnectedPositionStrategy', 'FlexibleConnectedPositionStrategy',
+        'OverlayPositionBuilder', 'CdkTable'
+      ]
+    }
+  ],
   [TargetVersion.V7]: [],
   [TargetVersion.V6]: []
 };

src/cdk/table/table.ts

@@ -387,13 +387,8 @@ export class CdkTable<T> implements AfterContentChecked, CollectionViewer, OnDes
       protected readonly _differs: IterableDiffers,
       protected readonly _changeDetectorRef: ChangeDetectorRef,
       protected readonly _elementRef: ElementRef, @Attribute('role') role: string,
-      @Optional() protected readonly _dir: Directionality,
-      /**
-       * @deprecated
-       * @breaking-change 8.0.0 `_document` and `_platform` to
-       *    be made into a required parameters.
-       */
-      @Inject(DOCUMENT) _document?: any, private _platform?: Platform) {
+      @Optional() protected readonly _dir: Directionality, @Inject(DOCUMENT) _document: any,
+      private _platform: Platform) {
     if (!role) {
       this._elementRef.nativeElement.setAttribute('role', 'grid');
     }
@@ -1002,17 +997,15 @@ export class CdkTable<T> implements AfterContentChecked, CollectionViewer, OnDes
 
   /** Adds native table sections (e.g. tbody) and moves the row outlets into them. */
   private _applyNativeTableSections() {
-    // @breaking-change 8.0.0 remove the `|| document` once the `_document` is a required param.
-    const documentRef = this._document || document;
-    const documentFragment = documentRef.createDocumentFragment();
+    const documentFragment = this._document.createDocumentFragment();
     const sections = [
       {tag: 'thead', outlet: this._headerRowOutlet},
       {tag: 'tbody', outlet: this._rowOutlet},
       {tag: 'tfoot', outlet: this._footerRowOutlet},
     ];
 
     for (const section of sections) {
-      const element = documentRef.createElement(section.tag);
+      const element = this._document.createElement(section.tag);
       element.setAttribute('role', 'rowgroup');
       element.appendChild(section.outlet.elementRef.nativeElement);
       documentFragment.appendChild(element);
@@ -1069,9 +1062,7 @@ export class CdkTable<T> implements AfterContentChecked, CollectionViewer, OnDes
   private _setupStickyStyler() {
     const direction: Direction = this._dir ? this._dir.value : 'ltr';
     this._stickyStyler = new StickyStyler(
-        this._isNativeHtmlTable,
-        // @breaking-change 8.0.0 remove the null check for `this._platform`.
-        this.stickyCssClass, direction, this._platform ? this._platform.isBrowser : true);
+        this._isNativeHtmlTable, this.stickyCssClass, direction, this._platform.isBrowser);
     (this._dir ? this._dir.change : observableOf<Direction>())
         .pipe(takeUntil(this._onDestroy))
         .subscribe(value => {