Skip to content

Commit f310a59

Browse files
alxhubjasonaden
alxhub
authored and
jasonaden
committed
feat(core): deprecate integration with the Web Tracing Framework (WTF) (#30642)
DEPRECATION: Angular previously has supported an integration with the Web Tracing Framework (WTF) for performance testing of Angular applications. This integration has not been maintained and likely does not work for the majority of Angular applications today. As a result, we are deprecating the integration in Angular version 8. This deprecation covers the following public APIs: * `WtfScopeFn` * `wtfCreateScope` * `wtfStartTimeRange` * `wtfEndTimeRange` * `wtfLeave` FW-1338 #resolve PR Close #30642
1 parent b5c8939 commit f310a59

4 files changed

Lines changed: 21 additions & 0 deletions

File tree

‎aio/content/guide/deprecations.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,11 @@ Tip: In the [API reference section](api) of this doc site, deprecated APIs are i
101101
| [`Renderer`](api/core/Renderer) | [`Renderer2`](api/core/Renderer2) | v4 | none |
102102
| [`RootRenderer`](api/core/RootRenderer) | [`RendererFactory2`](api/core/RendererFactory2) | v4 | none |
103103
| [`ViewEncapsulation.Native`](api/core/ViewEncapsulation#Native) | [`ViewEncapsulation.ShadowDom`](api/core/ViewEncapsulation#ShadowDom) | v6 | Use the native encapsulation mechanism of the renderer. See [view.ts](https://github.com/angular/angular/blob/3e992e18ebf51d6036818f26c3d77b52d3ec48eb/packages/core/src/metadata/view.ts#L32).
104+
| [`WtfScopeFn`](api/core/WtfScopeFn) | none | v8 | See [Web Tracing Framework](#wtf) |
105+
| [`wtfCreateScope`](api/core/wtfCreateScope) | none | v8 | See [Web Tracing Framework](#wtf) |
106+
| [`wtfStartTimeRange`](api/core/wtfStartTimeRange) | none | v8 | See [Web Tracing Framework](#wtf) |
107+
| [`wtfEndTimeRange`](api/core/wtfEndTimeRange) | none | v8 | See [Web Tracing Framework](#wtf) |
108+
| [`wtfLeave`](api/core/wtfLeave) | none | v8 | See [Web Tracing Framework](#wtf) |
104109

105110

106111
{@a forms}
@@ -142,6 +147,12 @@ This section lists all of the currently-deprecated features, which includes temp
142147

143148

144149

150+
{@a wtf}
151+
### Web Tracing Framework integration
152+
153+
Angular previously has supported an integration with the Web Tracing Framework (WTF) for performance testing of Angular applications. This integration has not been maintained and likely does not work for the majority of Angular applications today. As a result, we are deprecating the integration in Angular version 8.
154+
155+
145156
{@a deep-component-style-selector}
146157
### `/deep/`, `>>>` and `:ng-deep` component style selectors
147158

‎packages/core/src/profile/profile.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ function noopScope(arg0?: any, arg1?: any): any {
4949
* an exception is expected during normal execution while profiling.
5050
*
5151
* @publicApi
52+
* @deprecated the Web Tracing Framework is no longer supported in Angular
5253
*/
5354
export const wtfCreateScope: (signature: string, flags?: any) => WtfScopeFn =
5455
wtfEnabled ? createScope : (signature: string, flags?: any) => noopScope;
@@ -61,6 +62,7 @@ export const wtfCreateScope: (signature: string, flags?: any) => WtfScopeFn =
6162
*
6263
* Returns the `returnValue for easy chaining.
6364
* @publicApi
65+
* @deprecated the Web Tracing Framework is no longer supported in Angular
6466
*/
6567
export const wtfLeave: <T>(scope: any, returnValue?: T) => T =
6668
wtfEnabled ? leave : (s: any, r?: any) => r;
@@ -77,6 +79,7 @@ export const wtfLeave: <T>(scope: any, returnValue?: T) => T =
7779
* });
7880
* }
7981
* @publicApi
82+
* @deprecated the Web Tracing Framework is no longer supported in Angular
8083
*/
8184
export const wtfStartTimeRange: (rangeType: string, action: string) => any =
8285
wtfEnabled ? startTimeRange : (rangeType: string, action: string) => null;
@@ -86,5 +89,6 @@ export const wtfStartTimeRange: (rangeType: string, action: string) => any =
8689
* [range] is the return value from [wtfStartTimeRange] Async ranges only work if WTF has been
8790
* enabled.
8891
* @publicApi
92+
* @deprecated the Web Tracing Framework is no longer supported in Angular
8993
*/
9094
export const wtfEndTimeRange: (range: any) => void = wtfEnabled ? endTimeRange : (r: any) => null;

‎packages/core/src/profile/wtf_impl.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import {global} from '../util/global';
1212
* A scope function for the Web Tracing Framework (WTF).
1313
*
1414
* @publicApi
15+
* @deprecated the Web Tracing Framework is no longer supported in Angular
1516
*/
1617
export interface WtfScopeFn { (arg0?: any, arg1?: any): any; }
1718

‎tools/public_api_guard/core/core.d.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1440,14 +1440,19 @@ export declare class WrappedValue {
14401440
static wrap(value: any): WrappedValue;
14411441
}
14421442

1443+
/** @deprecated */
14431444
export declare const wtfCreateScope: (signature: string, flags?: any) => WtfScopeFn;
14441445

1446+
/** @deprecated */
14451447
export declare const wtfEndTimeRange: (range: any) => void;
14461448

1449+
/** @deprecated */
14471450
export declare const wtfLeave: <T>(scope: any, returnValue?: T) => T;
14481451

1452+
/** @deprecated */
14491453
export interface WtfScopeFn {
14501454
(arg0?: any, arg1?: any): any;
14511455
}
14521456

1457+
/** @deprecated */
14531458
export declare const wtfStartTimeRange: (rangeType: string, action: string) => any;

0 commit comments

Comments
 (0)