feat(cdk): deprecate global StrategyCredentials and replace with native (#1389)

hoebbelsB · edbzn · web-flow · commit f46e837137ce · 2022-08-28T10:21:01.000Z
* feat(cdk): deprecate global StrategyCredentials and replace with native

* refactor(cdk): mark global strategy const and name as deprecated

* docs(cdk): mark global strategy as deprecated

Co-authored-by: Edouard Bozon &lt;bozonedouard@gmail.com&gt;
diff --git a/libs/cdk/render-strategies/docs/basic-strategies.md b/libs/cdk/render-strategies/docs/basic-strategies.md
@@ -81,12 +81,12 @@ In combination with Observables, and EmbeddedViews change detection can be speed
 
 ### Strategies
 
-| Name       | Priority | Render Method     | Scheduling              | Render Deadline |
-| ---------- | -------- | ----------------- | ----------------------- | --------------- |
-| `"native"` | ❌       | ⮁ `markForCheck`  | `requestAnimationFrame` | N/A             |
-| `"global"` | ❌       | ⮁ `ɵmarkDirty`    | `requestAnimationFrame` | N/A             |
-| `"local"`  | ❌       | 🠗 `detectChanges` | `requestAnimationFrame` | N/A             |
-| `"noop"`   | ❌       | - `noop`          | `requestAnimationFrame` | N/A             |
+| Name                    | Priority | Render Method     | Scheduling              | Render Deadline |
+|-------------------------| -------- | ----------------- | ----------------------- | --------------- |
+| `"native"`              | ❌       | ⮁ `markForCheck`  | `requestAnimationFrame` | N/A             |
+| `"global"` - _deprecated_ | ❌       | ⮁ `ɵmarkDirty`    | `requestAnimationFrame` | N/A             |
+| `"local"`               | ❌       | 🠗 `detectChanges` | `requestAnimationFrame` | N/A             |
+| `"noop"`                | ❌       | - `noop`          | `requestAnimationFrame` | N/A             |
 
 #### Native
 
@@ -103,6 +103,9 @@ as the internally called function [`markViewDirty`](https://github.com/angular/a
 
 #### Global Strategy
 
+> **deprecated**  
+> angular [drops support](https://github.com/angular/angular/pull/46806) for `ɵmarkDirty`
+
 This strategy leverages Angular's internal [`ɵmarkDirty`](https://github.com/angular/angular/blob/930eeaf177a4c277f437f42314605ff8dc56fc82/packages/core/src/render3/instructions/change_detection.ts#L36) render method.
 It acts identical to [`ChangeDetectorRef#markForCheck`](https://github.com/angular/angular/blob/930eeaf177a4c277f437f42314605ff8dc56fc82/packages/core/src/render3/view_ref.ts#L128) but works also 🚫 zone-less.
 `markDirty` in comparison to `markForCheck` also calls [`scheduleTick`](https://github.com/angular/angular/blob/930eeaf177a4c277f437f42314605ff8dc56fc82/packages/core/src/render3/instructions/shared.ts#L1863) which is the reason why it also works in 🚫 zone-less environments.
diff --git a/libs/cdk/render-strategies/src/lib/model.ts b/libs/cdk/render-strategies/src/lib/model.ts
@@ -30,7 +30,16 @@ export type RxCustomStrategyCredentials<T extends string> = Record<
   T,
   RxStrategyCredentials
 >;
-export type RxNativeStrategyNames = 'native' | 'local' | 'global' | 'noop';
+/**
+ * @deprecated
+ * angular drops the internal markDirty API, will fall back to native if used
+ */
+export type RxGlobalStrategyName = 'global';
+export type RxNativeStrategyNames =
+  | 'native'
+  | 'local'
+  | 'noop'
+  | RxGlobalStrategyName;
 export type RxConcurrentStrategyNames =
   | 'immediate'
   | 'userBlocking'
diff --git a/libs/cdk/render-strategies/src/lib/native-strategies.ts b/libs/cdk/render-strategies/src/lib/native-strategies.ts
@@ -1,4 +1,4 @@
-import { ɵmarkDirty as markDirty } from '@angular/core';
+import { NgZone } from '@angular/core';
 import { Observable } from 'rxjs';
 import { tap } from 'rxjs/operators';
 import { coalesceWith } from '@rx-angular/cdk/coalescing';
@@ -36,15 +36,6 @@ const localCredentials: RxStrategyCredentials = {
       ),
 };
 
-const globalCredentials: RxStrategyCredentials = {
-  name: 'global',
-  work: (_, context) => markDirty(context),
-  behavior:
-    ({ work, ngZone }) =>
-    (o$) =>
-      o$.pipe(tap(() => (ngZone ? ngZone.run(() => work()) : work()))),
-};
-
 const noopCredentials: RxStrategyCredentials = {
   name: 'noop',
   work: () => void 0,
@@ -57,7 +48,22 @@ const nativeCredentials: RxStrategyCredentials = {
   behavior:
     ({ work, ngZone }) =>
     (o$) =>
-      o$.pipe(tap(() => (ngZone ? ngZone.run(() => work()) : work()))),
+      o$.pipe(
+        tap(() =>
+          ngZone && !NgZone.isInAngularZone()
+            ? ngZone.run(() => work())
+            : work()
+        )
+      ),
+};
+
+/**
+ * @deprecated
+ * angular drops the internal markDirty API, will fall back to native if used
+ */
+const globalCredentials: RxStrategyCredentials = {
+  ...nativeCredentials,
+  name: 'global',
 };
 
 export type RxNativeStrategies =
