refactor(core): deprecate the NgProbeToken (#51396)

JeanMeche · pkozlowski-opensource · commit a0dc12bfe827 · 2023-10-13T12:19:05.000+02:00
DEPRECATED: NgProbeToken The `NgProbeToken` is not used internally since the transition from View Engine to Ivy. The token has no utility and can be removed from applications and libraries. PR Close #51396
diff --git a/aio/content/guide/deprecations.md b/aio/content/guide/deprecations.md
@@ -129,6 +129,7 @@ v16 - v19
 |:---                                 |:---                                                                                                        |:---           |:---               |
 | `@angular/animations` | `AnimationDriver.NOOP` | v17 | v19 |
 | `@angular/core` | `PACKAGE_ROOT_URL` | v17 | v19 |
+| `@angular/core` | `NgProbeToken` | v17 | v19 |
 
 ### Deprecated features with no planned removal version
 
@@ -193,6 +194,7 @@ In the [API reference section](api) of this site, deprecated APIs are indicated
 | [`providedIn: 'any'`](api/core/Injectable#providedIn) | none | v15 | This option has confusing semantics and nearly zero usage. |
 | [`EnvironmentInjector.runInContext`](api/core/EnvironmentInjector#runInContext) | `runInInjectionContext`  | v16 | `runInInjectionContext` is a more flexible operation which supports element injectors as well |
 | [`@Component.moduleId`](api/core/Component#moduleId) | none | v16 |
+| [`NgProbeToken`](api/core/NgProbeToken) | none | v16 | `ng.prob` was replaced by `ng.getComponent` since Ivy
 
 
 <a id="testing"></a>
diff --git a/goldens/public-api/core/index.md b/goldens/public-api/core/index.md
@@ -1048,7 +1048,7 @@ export abstract class NgModuleRef<T> {
     abstract onDestroy(callback: () => void): void;
 }
 
-// @public
+// @public @deprecated
 export class NgProbeToken {
     constructor(name: string, token: any);
     // (undocumented)
diff --git a/packages/core/src/application_ref.ts b/packages/core/src/application_ref.ts
@@ -152,6 +152,7 @@ export function isBoundToModule<C>(cf: ComponentFactory<C>): boolean {
 /**
  * A token for third-party components that can register themselves with NgProbe.
  *
+ * @deprecated
  * @publicApi
  */
 export class NgProbeToken {
diff --git a/packages/router/src/router_module.ts b/packages/router/src/router_module.ts
@@ -7,7 +7,7 @@
  */
 
 import {HashLocationStrategy, Location, LocationStrategy, PathLocationStrategy, ViewportScroller} from '@angular/common';
-import {APP_BOOTSTRAP_LISTENER, ComponentRef, inject, Inject, InjectionToken, ModuleWithProviders, NgModule, NgProbeToken, NgZone, Optional, Provider, SkipSelf, ɵRuntimeError as RuntimeError} from '@angular/core';
+import {APP_BOOTSTRAP_LISTENER, ComponentRef, inject, Inject, InjectionToken, ModuleWithProviders, NgModule, NgZone, Optional, Provider, SkipSelf, ɵRuntimeError as RuntimeError} from '@angular/core';
 
 import {EmptyOutletComponent} from './components/empty_outlet';
 import {RouterLink} from './directives/router_link';
@@ -55,10 +55,6 @@ export const ROUTER_PROVIDERS: Provider[] = [
                                                     [],
 ];
 
-export function routerNgProbeToken() {
-  return new NgProbeToken('Router', Router);
-}
-
 /**
  * @description
  *
@@ -123,7 +119,6 @@ export class RouterModule {
         config?.useHash ? provideHashLocationStrategy() : providePathLocationStrategy(),
         provideRouterScroller(),
         config?.preloadingStrategy ? withPreloading(config.preloadingStrategy).ɵproviders : [],
-        {provide: NgProbeToken, multi: true, useFactory: routerNgProbeToken},
         config?.initialNavigation ? provideInitialNavigation(config) : [],
         config?.bindToComponentInputs ? withComponentInputBinding().ɵproviders : [],
         config?.enableViewTransitions ? withViewTransitions().ɵproviders : [],

Original file line number	Diff line number	Diff line change
`@@ -1048,7 +1048,7 @@ export abstract class NgModuleRef<T> {`
`1048`	`1048`	`abstract onDestroy(callback: () => void): void;`
`1049`	`1049`	`}`
`1050`	`1050`
`1051`		`-// @public`
	`1051`	`+// @public @deprecated`
`1052`	`1052`	`export class NgProbeToken {`
`1053`	`1053`	`constructor(name: string, token: any);`
`1054`	`1054`	`// (undocumented)`
Original file line number	Diff line number	Diff line change
`@@ -152,6 +152,7 @@ export function isBoundToModule<C>(cf: ComponentFactory<C>): boolean {`
`152`	`152`	`/**`
`153`	`153`	`* A token for third-party components that can register themselves with NgProbe.`
`154`	`154`	`*`
	`155`	`+ * @deprecated`
`155`	`156`	`* @publicApi`
`156`	`157`	`*/`
`157`	`158`	`export class NgProbeToken {`