Skip to content

Commit ce15faf

Browse files
KristianDDKristianDD
committed
chore: polyfill performance module and track debugging
1 parent 5da5178 commit ce15faf

File tree

7 files changed

+43
-11
lines changed

7 files changed

+43
-11
lines changed

‎lib/common/decorators.ts‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ export function performanceLog(injector?: IInjector): any {
101101
const result = originalMethod.apply(this, args);
102102
const resolvedPromise = Promise.resolve(result);
103103
let end;
104-
104+
105105
if (resolvedPromise !== result) {
106106
end = performanceService.now();
107107
performanceService.processExecutionData(trackName, start, end, args);
@@ -115,13 +115,12 @@ export function performanceLog(injector?: IInjector): any {
115115
end = performanceService.now();
116116
performanceService.processExecutionData(trackName, start, end, args);
117117
});
118-
119118
}
120-
119+
121120
return result;
122121
}
123-
}
124-
descriptor.value = tempObject[originalMethod.name]
122+
};
123+
descriptor.value = tempObject[originalMethod.name];
125124

126125
// used to get parameter names in hooks decorator
127126
descriptor.value.toString = () => {

‎lib/declarations.d.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,10 @@ interface INodePackageManager {
7676
}
7777

7878
interface IPerformanceService {
79+
// Will process the data based on the command opitons (--performance flag and user-reporting setting)
7980
processExecutionData(methodInfo: string, startTime: number, endTime: number, args: any[]): void;
81+
82+
// Will return a reference time in milliseconds
8083
now(): number;
8184
}
8285

‎lib/services/android-device-debug-service.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { sleep } from "../common/helpers";
22
import { DebugServiceBase } from "./debug-service-base";
33
import { LiveSyncPaths } from "../common/constants";
4+
import { performanceLog } from "../common/decorators";
45

56
export class AndroidDeviceDebugService extends DebugServiceBase implements IDeviceDebugService {
67
private _packageName: string;
@@ -24,6 +25,7 @@ export class AndroidDeviceDebugService extends DebugServiceBase implements IDevi
2425
this.deviceIdentifier = device.deviceInfo.identifier;
2526
}
2627

28+
@performanceLog()
2729
public async debug(debugData: IDebugData, debugOptions: IDebugOptions): Promise<IDebugResultInfo> {
2830
this._packageName = debugData.applicationIdentifier;
2931
const result = this.device.isEmulator
@@ -97,6 +99,7 @@ export class AndroidDeviceDebugService extends DebugServiceBase implements IDevi
9799
return this.device.adb.executeCommand(["forward", `tcp:${local}`, `localabstract:${remote}`]);
98100
}
99101

102+
@performanceLog()
100103
private async debugOnDevice(debugData: IDebugData, debugOptions: IDebugOptions): Promise<IDebugResultInfo> {
101104
let packageFile = "";
102105

@@ -119,9 +122,9 @@ export class AndroidDeviceDebugService extends DebugServiceBase implements IDevi
119122
return deviceActionResult[0].result;
120123
}
121124

125+
@performanceLog()
122126
private async debugCore(device: Mobile.IAndroidDevice, packageFile: string, appData: Mobile.IApplicationData, debugOptions: IDebugOptions): Promise<IDebugResultInfo> {
123127
const result: IDebugResultInfo = { hasReconnected: false, debugUrl: null };
124-
125128
if (debugOptions.stop) {
126129
await this.removePortForwarding();
127130
return result;

‎lib/services/debug-service.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import { EventEmitter } from "events";
44
import { CONNECTION_ERROR_EVENT_NAME, DebugCommandErrors } from "../constants";
55
import { CONNECTED_STATUS } from "../common/constants";
66
import { DebugTools, TrackActionNames } from "../constants";
7+
import { performanceLog } from "../common/decorators";
78

89
export class DebugService extends EventEmitter implements IDebugService {
910
private _platformDebugServices: IDictionary<IDeviceDebugService>;
@@ -17,6 +18,7 @@ export class DebugService extends EventEmitter implements IDebugService {
1718
this._platformDebugServices = {};
1819
}
1920

21+
@performanceLog()
2022
public async debug(debugData: IDebugData, options: IDebugOptions): Promise<IDebugInformation> {
2123
const device = this.$devicesService.getDeviceByIdentifier(debugData.deviceIdentifier);
2224

‎lib/services/ios-device-debug-service.ts‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import { getPidFromiOSSimulatorLogs } from "../common/helpers";
88
const inspectorAppName = "NativeScript Inspector.app";
99
const inspectorNpmPackageName = "tns-ios-inspector";
1010
const inspectorUiDir = "WebInspectorUI/";
11+
import { performanceLog } from "../common/decorators";
1112

1213
export class IOSDeviceDebugService extends DebugServiceBase implements IDeviceDebugService {
1314
private _lldbProcess: ChildProcess;
@@ -38,6 +39,7 @@ export class IOSDeviceDebugService extends DebugServiceBase implements IDeviceDe
3839
return "ios";
3940
}
4041

42+
@performanceLog()
4143
public async debug(debugData: IDebugData, debugOptions: IDebugOptions): Promise<IDebugResultInfo> {
4244
const result: IDebugResultInfo = { hasReconnected: false, debugUrl: null };
4345
this.validateOptions(debugOptions);
@@ -79,6 +81,7 @@ export class IOSDeviceDebugService extends DebugServiceBase implements IDeviceDe
7981
}
8082
}
8183

84+
@performanceLog()
8285
private async startDeviceLogProcess(debugData: IDebugData, debugOptions: IDebugOptions): Promise<void> {
8386
if (debugOptions.justlaunch) {
8487
// No logs should be printed on console when `--justlaunch` option is passed.
@@ -99,6 +102,7 @@ export class IOSDeviceDebugService extends DebugServiceBase implements IDeviceDe
99102
await this.device.openDeviceLogStream({ predicate: IOS_LOG_PREDICATE });
100103
}
101104

105+
@performanceLog()
102106
private async startAppOnSimulator(debugData: IDebugData, debugOptions: IDebugOptions): Promise<void> {
103107
const args = debugOptions.debugBrk ? "--nativescript-debug-brk" : "--nativescript-debug-start";
104108
const launchResult = await this.$iOSEmulatorServices.runApplicationOnEmulator(debugData.pathToAppPackage, {
@@ -116,6 +120,7 @@ export class IOSDeviceDebugService extends DebugServiceBase implements IDeviceDe
116120
this.startAppDebuggerOnSimulator(pid);
117121
}
118122

123+
@performanceLog()
119124
private async startAppOnDevice(debugData: IDebugData, debugOptions: IDebugOptions): Promise<void> {
120125
const runOptions: IRunPlatformOptions = {
121126
device: this.deviceIdentifier,
@@ -152,6 +157,7 @@ export class IOSDeviceDebugService extends DebugServiceBase implements IDeviceDe
152157
}
153158
}
154159

160+
@performanceLog()
155161
private async wireDebuggerClient(debugData: IDebugData, debugOptions: IDebugOptions): Promise<string> {
156162
if ((debugOptions.inspector || !debugOptions.client) && this.$hostInfo.isDarwin) {
157163
return await this.setupTcpAppDebugProxy(debugData, debugOptions);
@@ -184,6 +190,7 @@ export class IOSDeviceDebugService extends DebugServiceBase implements IDeviceDe
184190
return null;
185191
}
186192

193+
@performanceLog()
187194
private async openAppInspector(fileDescriptor: string, debugData: IDebugData, debugOptions: IDebugOptions): Promise<ChildProcess> {
188195
if (debugOptions.client) {
189196
const inspectorPath = await this.$packageInstallationManager.getInspectorFromCache(inspectorNpmPackageName, debugData.projectDir);

‎lib/services/livesync/livesync-service.ts‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import { DeviceTypes, DeviceDiscoveryEventNames, HmrConstants } from "../../comm
88
import { cache } from "../../common/decorators";
99
import * as constants from "../../constants";
1010
import { PreviewAppLiveSyncEvents } from "./playground/preview-app-constants";
11+
import { performanceLog } from "../../common/decorators";
1112

1213
const deviceDescriptorPrimaryKey = "identifier";
1314

@@ -158,6 +159,7 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
158159
}
159160
}
160161

162+
@performanceLog()
161163
private async refreshApplication(projectData: IProjectData, liveSyncResultInfo: ILiveSyncResultInfo, debugOpts?: IDebugOptions, outputPath?: string): Promise<IRefreshApplicationInfo | IDebugInformation> {
162164
const deviceDescriptor = this.getDeviceDescriptor(liveSyncResultInfo.deviceAppData.device.deviceInfo.identifier, projectData.projectDir);
163165

@@ -202,6 +204,7 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
202204
return result;
203205
}
204206

207+
@performanceLog()
205208
private async refreshApplicationWithDebug(projectData: IProjectData, liveSyncResultInfo: ILiveSyncResultInfo, debugOptions: IDebugOptions, outputPath?: string): Promise<IDebugInformation> {
206209
let didRestart = false;
207210
const deviceAppData = liveSyncResultInfo.deviceAppData;
@@ -305,6 +308,7 @@ export class LiveSyncService extends EventEmitter implements IDebugLiveSyncServi
305308
return _.find(deviceDescriptors, d => d.identifier === deviceIdentifier);
306309
}
307310

311+
@performanceLog()
308312
private async enableDebuggingCoreWithoutWaitingCurrentAction(deviceOption: IEnableDebuggingDeviceOptions, debuggingAdditionalOptions: IDebuggingAdditionalOptions): Promise<IDebugInformation> {
309313
const currentDeviceDescriptor = this.getDeviceDescriptor(deviceOption.deviceIdentifier, debuggingAdditionalOptions.projectDir);
310314
if (!currentDeviceDescriptor) {

‎lib/services/performance-service.ts‎

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,24 @@
1-
import { TrackActionNames, AnalyticsEventLabelDelimiter } from "../constants";
1+
import { TrackActionNames } from "../constants";
22
const EOL = require("os").EOL;
33
import { getFormattedDate } from "../common/helpers";
4-
const { performance } = require('perf_hooks');
4+
import * as semver from "semver";
55

66
export class PerformanceService implements IPerformanceService {
77
public static LOG_MESSAGE_TEMPLATE = `Execution of method "%s" took %s ms.`;
88
public static FAIL_LOG_MESSAGE_TEMPLATE = `Failed to log pefromance data for method %s.`;
9+
private static MIN_NODE_PERFORMANCE_MODULE_VERSION = "8.5.0";
10+
private performance: {now(): number} = null;
911

1012
constructor(
1113
private $options: IOptions,
1214
private $fs: IFileSystem,
1315
private $logger: ILogger,
1416
private $analyticsService: IAnalyticsService
15-
) { }
17+
) {
18+
if (this.isPerformanceModuleSupported()) {
19+
this.performance = require("perf_hooks").performance;
20+
}
21+
}
1622

1723
public processExecutionData(methodInfo: string, startTime: number, endTime: number, args: any[]): void {
1824
const executionTime = Math.floor(endTime - startTime);
@@ -27,7 +33,15 @@ export class PerformanceService implements IPerformanceService {
2733
}
2834

2935
public now(): number {
30-
return performance.now();
36+
if (this.isPerformanceModuleSupported()) {
37+
return this.performance.now();
38+
} else {
39+
return new Date().getTime();
40+
}
41+
}
42+
43+
private isPerformanceModuleSupported(): boolean {
44+
return semver.gte(process.version, PerformanceService.MIN_NODE_PERFORMANCE_MODULE_VERSION);
3145
}
3246

3347
private trackAnalyticsData(methodInfo: string, executionTime: number): void {
@@ -68,7 +82,7 @@ export class PerformanceService implements IPerformanceService {
6882
executionTime,
6983
timestamp: getFormattedDate(),
7084
methodArgs: JSON.parse(methodArgs)
71-
}
85+
};
7286

7387
try {
7488
this.$fs.appendFile(filePath, `${JSON.stringify(info)}${EOL}`);

0 commit comments

Comments
 (0)