Skip to content

Commit dfa55ad

Browse files
rbucktonelibarzilay
rbuckton
authored and
elibarzilay
committed
Write message instead of crashing when native perf API not found.
1 parent a197bee commit dfa55ad

4 files changed

Lines changed: 63 additions & 19 deletions

File tree

‎src/compiler/diagnosticMessages.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4719,6 +4719,10 @@
47194719
"code": 6385,
47204720
"reportsDeprecated": true
47214721
},
4722+
"Performance timings for '--diagnostics' or '--extendedDiagnostics' are not available in this session. A native implementation of the Web Performance API could not be found.": {
4723+
"category": "Message",
4724+
"code": 6386
4725+
},
47224726

47234727
"The expected type comes from property '{0}' which is declared here on type '{1}'": {
47244728
"category": "Message",

‎src/compiler/performance.ts‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,17 @@ namespace ts.performance {
6767
*/
6868
export function measure(measureName: string, startMarkName?: string, endMarkName?: string) {
6969
if (perfHooks && enabled) {
70-
perfHooks.performance.measure(measureName, startMarkName, endMarkName);
70+
// NodeJS perf_hooks depends on call arity, not 'undefined' checks, so we
71+
// need to be sure we call 'measure' with the correct number of arguments.
72+
if (startMarkName === undefined) {
73+
perfHooks.performance.measure(measureName);
74+
}
75+
else if (endMarkName === undefined) {
76+
perfHooks.performance.measure(measureName, startMarkName);
77+
}
78+
else {
79+
perfHooks.performance.measure(measureName, startMarkName, endMarkName);
80+
}
7181
}
7282
}
7383

@@ -100,15 +110,23 @@ namespace ts.performance {
100110
});
101111
}
102112

113+
/**
114+
* Indicates whether the performance API is enabled.
115+
*/
116+
export function isEnabled() {
117+
return enabled;
118+
}
119+
103120
/** Enables (and resets) performance measurements for the compiler. */
104121
export function enable() {
105122
if (!enabled) {
106123
perfHooks ||= tryGetNativePerformanceHooks() || ShimPerformance?.createPerformanceHooksShim(timestamp);
107-
if (!perfHooks) throw new Error("TypeScript requires an environment that provides a compatible native Web Performance API implementation.");
124+
if (!perfHooks) return false;
108125
perfObserver ||= new perfHooks.PerformanceObserver(list => perfEntryList = list);
109126
perfObserver.observe({ entryTypes: ["mark", "measure"] });
110127
enabled = true;
111128
}
129+
return true;
112130
}
113131

114132
/** Disables performance measurements for the compiler. */

‎src/compiler/performanceCore.ts‎

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
/*@internal*/
22
namespace ts {
3+
// The following definitions provide the minimum compatible support for the Web Performance User Timings API
4+
// between browsers and NodeJS:
5+
36
export interface PerformanceHooks {
47
performance: Performance;
58
PerformanceObserver: PerformanceObserverConstructor;
@@ -34,6 +37,7 @@ namespace ts {
3437
export type PerformanceObserverConstructor = new (callback: (list: PerformanceObserverEntryList, observer: PerformanceObserver) => void) => PerformanceObserver;
3538
export type PerformanceEntryList = PerformanceEntry[];
3639

40+
// Browser globals for the Web Performance User Timings API
3741
declare const performance: Performance | undefined;
3842
declare const PerformanceObserver: PerformanceObserverConstructor | undefined;
3943

@@ -55,26 +59,36 @@ namespace ts {
5559
function tryGetNodePerformanceHooks(): PerformanceHooks | undefined {
5660
if (typeof module === "object" && typeof require === "function") {
5761
try {
58-
return require("perf_hooks") as typeof import("perf_hooks");
62+
const perfHooks = require("perf_hooks") as typeof import("perf_hooks");
63+
const { performance, PerformanceObserver } = perfHooks;
64+
if (typeof performance === "object" &&
65+
typeof performance.timeOrigin === "number" &&
66+
typeof performance.clearMarks === "function" &&
67+
typeof performance.mark === "function" &&
68+
typeof performance.measure === "function" &&
69+
typeof performance.now === "function" &&
70+
typeof PerformanceObserver === "function") {
71+
return perfHooks;
72+
}
5973
}
6074
catch {
6175
// ignore errors
6276
}
6377
}
6478
}
6579

80+
// Unlike with the native Map/Set 'tryGet' functions in corePublic.ts, we eagerly evaluate these
81+
// since we will need them for `timestamp`, below.
6682
const nativePerformanceHooks = tryGetWebPerformanceHooks() || tryGetNodePerformanceHooks();
83+
const nativePerformance = nativePerformanceHooks?.performance;
6784

6885
export function tryGetNativePerformanceHooks() {
6986
return nativePerformanceHooks;
7087
}
7188

7289
/** Gets a timestamp with (at least) ms resolution */
73-
export const timestamp = (() => {
74-
if (nativePerformanceHooks) {
75-
const performance = nativePerformanceHooks.performance;
76-
return () => performance.now();
77-
}
78-
return Date.now ? Date.now : () => +(new Date());
79-
})();
90+
export const timestamp =
91+
nativePerformance ? () => nativePerformance.now() :
92+
Date.now ? Date.now :
93+
() => +(new Date());
8094
}

‎src/executeCommandLine/executeCommandLine.ts‎

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -648,19 +648,21 @@ namespace ts {
648648
reportStatisticalValue("Memory used", Math.round(memoryUsed / 1000) + "K");
649649
}
650650

651-
const programTime = performance.getDuration("Program");
652-
const bindTime = performance.getDuration("Bind");
653-
const checkTime = performance.getDuration("Check");
654-
const emitTime = performance.getDuration("Emit");
651+
const programTime = performance.isEnabled() ? performance.getDuration("Program") : 0;
652+
const bindTime = performance.isEnabled() ? performance.getDuration("Bind") : 0;
653+
const checkTime = performance.isEnabled() ? performance.getDuration("Check") : 0;
654+
const emitTime = performance.isEnabled() ? performance.getDuration("Emit") : 0;
655655
if (compilerOptions.extendedDiagnostics) {
656656
const caches = program.getRelationCacheSizes();
657657
reportCountStatistic("Assignability cache size", caches.assignable);
658658
reportCountStatistic("Identity cache size", caches.identity);
659659
reportCountStatistic("Subtype cache size", caches.subtype);
660660
reportCountStatistic("Strict subtype cache size", caches.strictSubtype);
661-
performance.forEachMeasure((name, duration) => reportTimeStatistic(`${name} time`, duration));
661+
if (performance.isEnabled()) {
662+
performance.forEachMeasure((name, duration) => reportTimeStatistic(`${name} time`, duration));
663+
}
662664
}
663-
else {
665+
else if (performance.isEnabled()) {
664666
// Individual component times.
665667
// Note: To match the behavior of previous versions of the compiler, the reported parse time includes
666668
// I/O read time and processing time for triple-slash references and module imports, and the reported
@@ -672,10 +674,16 @@ namespace ts {
672674
reportTimeStatistic("Check time", checkTime);
673675
reportTimeStatistic("Emit time", emitTime);
674676
}
675-
reportTimeStatistic("Total time", programTime + bindTime + checkTime + emitTime);
677+
if (performance.isEnabled()) {
678+
reportTimeStatistic("Total time", programTime + bindTime + checkTime + emitTime);
679+
}
676680
reportStatistics();
677-
678-
performance.disable();
681+
if (!performance.isEnabled()) {
682+
sys.write(Diagnostics.Performance_timings_for_diagnostics_or_extendedDiagnostics_are_not_available_in_this_session_A_native_implementation_of_the_Web_Performance_API_could_not_be_found.message + "\n");
683+
}
684+
else {
685+
performance.disable();
686+
}
679687
}
680688

681689
function reportStatistics() {

0 commit comments

Comments
 (0)