mirror of
https://github.com/NativeScript/NativeScript.git
synced 2025-08-16 03:31:45 +08:00
feat: Scoped Packages (#7911)
* chore: move tns-core-modules to nativescript-core * chore: preparing compat generate script * chore: add missing definitions * chore: no need for http-request to be private * chore: packages chore * test: generate tests for tns-core-modules * chore: add anroid module for consistency * chore: add .npmignore * chore: added privateModulesWhitelist * chore(webpack): added bundle-entry-points * chore: scripts * chore: tests changed to use @ns/core * test: add scoped-packages test project * test: fix types * test: update test project * chore: build scripts * chore: update build script * chore: npm scripts cleanup * chore: make the compat pgk work with old wp config * test: generate diff friendly tests * chore: create barrel exports * chore: move files after rebase * chore: typedoc config * chore: compat mode * chore: review of barrels * chore: remove tns-core-modules import after rebase * chore: dev workflow setup * chore: update developer-workflow * docs: experiment with API extractor * chore: api-extractor and barrel exports * chore: api-extractor configs * chore: generate d.ts rollup with api-extractor * refactor: move methods inside Frame * chore: fic tests to use Frame static methods * refactor: create Builder class * refactor: use Builder class in tests * refactor: include Style in ui barrel * chore: separate compat build script * chore: fix tslint errors * chore: update NATIVESCRIPT_CORE_ARGS * chore: fix compat pack * chore: fix ui-test-app build with linked modules * chore: Application, ApplicationSettings, Connectivity and Http * chore: export Trace, Profiling and Utils * refactor: Static create methods for ImageSource * chore: fix deprecated usages of ImageSource * chore: move Span and FormattedString to ui * chore: add events-args and ImageSource to index files * chore: check for CLI >= 6.2 when building for IOS * chore: update travis build * chore: copy Pod file to compat package * chore: update error msg ui-tests-app * refactor: Apply suggestions from code review Co-Authored-By: Martin Yankov <m.i.yankov@gmail.com> * chore: typings and refs * chore: add missing d.ts files for public API * chore: adress code review FB * chore: update api-report * chore: dev-workflow for other apps * chore: api update * chore: update api-report
This commit is contained in:

committed by
GitHub

parent
6c7139477e
commit
cc97a16800
6
nativescript-core/profiling/package.json
Normal file
6
nativescript-core/profiling/package.json
Normal file
@ -0,0 +1,6 @@
|
||||
{
|
||||
"name": "profiling",
|
||||
"main": "profiling",
|
||||
"types": "profiling.d.ts",
|
||||
"nativescript": {}
|
||||
}
|
161
nativescript-core/profiling/profiling.d.ts
vendored
Normal file
161
nativescript-core/profiling/profiling.d.ts
vendored
Normal file
@ -0,0 +1,161 @@
|
||||
/**
|
||||
* Contains contains utility methods for profiling.
|
||||
* All methods in this module are experimental and may be changed in a non-major version.
|
||||
* @module "profiling"
|
||||
*/ /** */
|
||||
|
||||
interface TimerInfo {
|
||||
totalTime: number;
|
||||
count: number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Profiling mode to use.
|
||||
* - `counters` Accumulates method call counts and times until dumpProfiles is called and then prints aggregated statistic in the console. This is the default.
|
||||
* - `timeline` Outputs method names along start/end timestamps in the console on the go.
|
||||
* - `lifecycle` Outputs basic non-verbose times for startup, navigation, etc.
|
||||
*/
|
||||
type InstrumentationMode = "counters" | "timeline" | "lifecycle";
|
||||
|
||||
/**
|
||||
* Logging levels in order of verbosity.
|
||||
*/
|
||||
export enum Level {
|
||||
none,
|
||||
lifecycle,
|
||||
timeline,
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the current logging level.
|
||||
*/
|
||||
export function level(): Level;
|
||||
|
||||
/**
|
||||
* Enables profiling.
|
||||
*
|
||||
* Upon loading of the module it will cache the package.json of the app and check if there is a "profiling" key set,
|
||||
* its value can be one of the options available for InstrumentationMode, and if set,
|
||||
* enable() will be called in pre app start with the value in the package.json.
|
||||
*
|
||||
* An example for an `app/package.json` enabling the manual instrumentation profiling is:
|
||||
* ```
|
||||
* {
|
||||
* "main": "main.js",
|
||||
* "profiling": "timeline"
|
||||
* }
|
||||
* ```
|
||||
*
|
||||
* @param type Profiling mode to use.
|
||||
* - "counters" - Accumulates method call counts and times until dumpProfiles is called and then prints aggregated statistic in the console. This is the default.
|
||||
* - "timeline" - Outputs method names along start/end timestamps in the console on the go.
|
||||
* - "lifecycle" - Outputs basic non-verbose times for startup, navigation, etc.
|
||||
*/
|
||||
export declare function enable(type?: InstrumentationMode): void;
|
||||
|
||||
/**
|
||||
* Disables profiling.
|
||||
*/
|
||||
export declare function disable(): void;
|
||||
|
||||
/**
|
||||
* Gets accurate system timestamp in ms.
|
||||
*/
|
||||
export declare function time(): number;
|
||||
|
||||
/**
|
||||
* Starts a timer with a specific name.
|
||||
* Works only if profiling is enabled.
|
||||
* @param name Name of the timer.
|
||||
*/
|
||||
export declare function start(name: string): void;
|
||||
|
||||
/**
|
||||
* Pauses a timer with a specific name. This will increase call count and accumulate time.
|
||||
* Works only if profiling is enabled.
|
||||
* @param name Name of the timer.
|
||||
* @returns TimerInfo for the paused timer.
|
||||
*/
|
||||
export declare function stop(name: string): TimerInfo;
|
||||
|
||||
/**
|
||||
* Read a timer info.
|
||||
* @param name The name of the timer to obtain information about.
|
||||
*/
|
||||
export function timer(name: string): TimerInfo;
|
||||
|
||||
/**
|
||||
* Returns true if a timer is currently running.
|
||||
* @param name Name of the timer.
|
||||
* @returns true is the timer is currently running.
|
||||
*/
|
||||
export declare function isRunning(name: string): boolean;
|
||||
|
||||
/**
|
||||
* Method decorator factory. It will intercept the method call and start and pause a timer before and after the method call.
|
||||
* Works only if profiling is enabled.
|
||||
* @param name Name of the timer which will be used for method calls. If not provided - the name of the method will be used.
|
||||
*/
|
||||
export declare function profile(name?: string): MethodDecorator;
|
||||
|
||||
/**
|
||||
* Function factory. It will intercept the function call and start and pause a timer before and after the function call. Works only if profiling is enabled.
|
||||
* Works only if profiling is enabled.
|
||||
* @param fn The function to wrap. Uses the function name to track the times.
|
||||
*/
|
||||
export declare function profile<F extends Function>(fn: F): F;
|
||||
|
||||
/**
|
||||
* Function factory. It will intercept the function call and start and pause a timer before and after the function call. Works only if profiling is enabled.
|
||||
* @param name The name used to track calls and times.
|
||||
* @param fn The function to wrap.
|
||||
*/
|
||||
export declare function profile<F extends Function>(name: string, fn: F): F;
|
||||
|
||||
/**
|
||||
* Method decorator. It will intercept the method calls and start and pause a timer before and after the method call. Works only if profiling is enabled.
|
||||
*/
|
||||
export declare function profile<T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T> | void;
|
||||
export function profile(): any;
|
||||
|
||||
/**
|
||||
* Prints the timer for all methods instrumented with profile decorator.
|
||||
*/
|
||||
export declare function dumpProfiles(): void;
|
||||
|
||||
/**
|
||||
* Resets the timers for all methods instrumented with profile decorator.
|
||||
*/
|
||||
export function resetProfiles(): void;
|
||||
|
||||
/**
|
||||
* Starts android cpu profiling.
|
||||
* @param name Name of the cpu profiling session.
|
||||
*/
|
||||
export declare function startCPUProfile(name: string): void;
|
||||
|
||||
/**
|
||||
* Stops android cpu profiling.
|
||||
* @param name Name of the cpu profiling session.
|
||||
*/
|
||||
export declare function stopCPUProfile(name: string): void;
|
||||
|
||||
/**
|
||||
* Gets the uptime of the current process in milliseconds.
|
||||
*/
|
||||
export function uptime(): number;
|
||||
|
||||
/**
|
||||
* Logs important messages. Contrary to console.log's behavior, the profiling log should output even for release builds.
|
||||
*/
|
||||
export function log(message: string): void;
|
||||
|
||||
/**
|
||||
* Manually output profiling messages. The `@profile` decorator is useful when measuring times that function calls take on the stack
|
||||
* but when measuring times between longer periods (startup times, times between the navigatingTo - navigatedTo events etc.)
|
||||
* you can call this method and provide manually the times to be logged.
|
||||
* @param message A string message
|
||||
* @param start The start time (see `time()`)
|
||||
* @param end The end time (see `time()`)
|
||||
*/
|
||||
export function trace(message: string, start: number, end: number): void;
|
325
nativescript-core/profiling/profiling.ts
Normal file
325
nativescript-core/profiling/profiling.ts
Normal file
@ -0,0 +1,325 @@
|
||||
declare var __startCPUProfiler: any;
|
||||
declare var __stopCPUProfiler: any;
|
||||
|
||||
import { TimerInfo as TimerInfoDefinition, InstrumentationMode } from ".";
|
||||
|
||||
export function uptime() {
|
||||
return global.android ? (<any>org).nativescript.Process.getUpTime() : (<any>global).__tns_uptime();
|
||||
}
|
||||
|
||||
export function log(message: string): void {
|
||||
if ((<any>global).__nslog) {
|
||||
(<any>global).__nslog("CONSOLE LOG: " + message);
|
||||
}
|
||||
console.log(message);
|
||||
}
|
||||
|
||||
interface TimerInfo extends TimerInfoDefinition {
|
||||
totalTime: number;
|
||||
lastTime?: number;
|
||||
count: number;
|
||||
currentStart: number;
|
||||
/**
|
||||
* Counts the number of entry and exits a function had.
|
||||
*/
|
||||
runCount: number;
|
||||
}
|
||||
|
||||
// Use object instead of map as it is a bit faster
|
||||
const timers: { [index: string]: TimerInfo } = {};
|
||||
const anyGlobal = <any>global;
|
||||
const profileNames: string[] = [];
|
||||
|
||||
export const time = (<any>global).__time || Date.now;
|
||||
|
||||
export function start(name: string): void {
|
||||
let info = timers[name];
|
||||
|
||||
if (info) {
|
||||
info.currentStart = time();
|
||||
info.runCount++;
|
||||
} else {
|
||||
info = {
|
||||
totalTime: 0,
|
||||
count: 0,
|
||||
currentStart: time(),
|
||||
runCount: 1
|
||||
};
|
||||
timers[name] = info;
|
||||
profileNames.push(name);
|
||||
}
|
||||
}
|
||||
|
||||
export function stop(name: string): TimerInfo {
|
||||
const info = timers[name];
|
||||
|
||||
if (!info) {
|
||||
throw new Error(`No timer started: ${name}`);
|
||||
}
|
||||
|
||||
if (info.runCount) {
|
||||
info.runCount--;
|
||||
if (info.runCount) {
|
||||
info.count++;
|
||||
} else {
|
||||
info.lastTime = time() - info.currentStart;
|
||||
info.totalTime += info.lastTime;
|
||||
info.count++;
|
||||
info.currentStart = 0;
|
||||
}
|
||||
} else {
|
||||
throw new Error(`Timer ${name} paused more times than started.`);
|
||||
}
|
||||
|
||||
return info;
|
||||
}
|
||||
|
||||
export function timer(name: string): TimerInfo {
|
||||
return timers[name];
|
||||
}
|
||||
|
||||
export function print(name: string): TimerInfo {
|
||||
const info = timers[name];
|
||||
if (!info) {
|
||||
throw new Error(`No timer started: ${name}`);
|
||||
}
|
||||
|
||||
console.log(`---- [${name}] STOP total: ${info.totalTime} count:${info.count}`);
|
||||
|
||||
return info;
|
||||
}
|
||||
|
||||
export function isRunning(name: string): boolean {
|
||||
const info = timers[name];
|
||||
|
||||
return !!(info && info.runCount);
|
||||
}
|
||||
|
||||
function countersProfileFunctionFactory<F extends Function>(fn: F, name: string, type: MemberType = MemberType.Instance): F {
|
||||
profileNames.push(name);
|
||||
|
||||
return <any>function () {
|
||||
start(name);
|
||||
try {
|
||||
return fn.apply(this, arguments);
|
||||
} finally {
|
||||
stop(name);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
function timelineProfileFunctionFactory<F extends Function>(fn: F, name: string, type: MemberType = MemberType.Instance): F {
|
||||
return type === MemberType.Instance ? <any>function () {
|
||||
const start = time();
|
||||
try {
|
||||
return fn.apply(this, arguments);
|
||||
} finally {
|
||||
const end = time();
|
||||
console.log(`Timeline: Modules: ${name} ${this} (${start}ms. - ${end}ms.)`);
|
||||
}
|
||||
} : function () {
|
||||
const start = time();
|
||||
try {
|
||||
return fn.apply(this, arguments);
|
||||
} finally {
|
||||
const end = time();
|
||||
console.log(`Timeline: Modules: ${name} (${start}ms. - ${end}ms.)`);
|
||||
}
|
||||
};
|
||||
}
|
||||
|
||||
const enum MemberType {
|
||||
Static,
|
||||
Instance
|
||||
}
|
||||
|
||||
export enum Level {
|
||||
none,
|
||||
lifecycle,
|
||||
timeline,
|
||||
}
|
||||
let tracingLevel: Level = Level.none;
|
||||
|
||||
let profileFunctionFactory: <F extends Function>(fn: F, name: string, type?: MemberType) => F;
|
||||
export function enable(mode: InstrumentationMode = "counters") {
|
||||
profileFunctionFactory = mode && {
|
||||
counters: countersProfileFunctionFactory,
|
||||
timeline: timelineProfileFunctionFactory
|
||||
}[mode];
|
||||
|
||||
tracingLevel = {
|
||||
lifecycle: Level.lifecycle,
|
||||
timeline: Level.timeline,
|
||||
}[mode] || Level.none;
|
||||
}
|
||||
|
||||
try {
|
||||
const appConfig = require("~/package.json");
|
||||
if (appConfig && appConfig.profiling) {
|
||||
enable(appConfig.profiling);
|
||||
}
|
||||
} catch (e1) {
|
||||
try {
|
||||
console.log("Profiling startup failed to figure out defaults from package.json, error: " + e1);
|
||||
} catch (e2) {
|
||||
// We can get here if an exception is thrown in the mksnapshot as there is no console there.
|
||||
}
|
||||
}
|
||||
|
||||
export function disable() {
|
||||
profileFunctionFactory = undefined;
|
||||
}
|
||||
|
||||
function profileFunction<F extends Function>(fn: F, customName?: string): F {
|
||||
return profileFunctionFactory(fn, customName || fn.name);
|
||||
}
|
||||
|
||||
const profileMethodUnnamed = (target, key, descriptor) => {
|
||||
// save a reference to the original method this way we keep the values currently in the
|
||||
// descriptor and don't overwrite what another decorator might have done to the descriptor.
|
||||
if (descriptor === undefined) {
|
||||
descriptor = Object.getOwnPropertyDescriptor(target, key);
|
||||
}
|
||||
const originalMethod = descriptor.value;
|
||||
|
||||
let className = "";
|
||||
if (target && target.constructor && target.constructor.name) {
|
||||
className = target.constructor.name + ".";
|
||||
}
|
||||
|
||||
let name = className + key;
|
||||
|
||||
//editing the descriptor/value parameter
|
||||
descriptor.value = profileFunctionFactory(originalMethod, name, MemberType.Instance);
|
||||
|
||||
// return edited descriptor as opposed to overwriting the descriptor
|
||||
return descriptor;
|
||||
};
|
||||
|
||||
const profileStaticMethodUnnamed = (ctor, key, descriptor) => {
|
||||
// save a reference to the original method this way we keep the values currently in the
|
||||
// descriptor and don't overwrite what another decorator might have done to the descriptor.
|
||||
if (descriptor === undefined) {
|
||||
descriptor = Object.getOwnPropertyDescriptor(ctor, key);
|
||||
}
|
||||
const originalMethod = descriptor.value;
|
||||
|
||||
let className = "";
|
||||
if (ctor && ctor.name) {
|
||||
className = ctor.name + ".";
|
||||
}
|
||||
let name = className + key;
|
||||
|
||||
//editing the descriptor/value parameter
|
||||
descriptor.value = profileFunctionFactory(originalMethod, name, MemberType.Static);
|
||||
|
||||
// return edited descriptor as opposed to overwriting the descriptor
|
||||
return descriptor;
|
||||
};
|
||||
|
||||
function profileMethodNamed(name: string): MethodDecorator {
|
||||
return (target, key, descriptor: PropertyDescriptor) => {
|
||||
|
||||
// save a reference to the original method this way we keep the values currently in the
|
||||
// descriptor and don't overwrite what another decorator might have done to the descriptor.
|
||||
if (descriptor === undefined) {
|
||||
descriptor = Object.getOwnPropertyDescriptor(target, key);
|
||||
}
|
||||
const originalMethod = descriptor.value;
|
||||
|
||||
//editing the descriptor/value parameter
|
||||
descriptor.value = profileFunctionFactory(originalMethod, name);
|
||||
|
||||
// return edited descriptor as opposed to overwriting the descriptor
|
||||
return descriptor;
|
||||
};
|
||||
}
|
||||
|
||||
const voidMethodDecorator = () => {
|
||||
// no op
|
||||
};
|
||||
|
||||
export function profile(nameFnOrTarget?: string | Function | Object, fnOrKey?: Function | string | symbol, descriptor?: PropertyDescriptor): Function | MethodDecorator {
|
||||
if (typeof nameFnOrTarget === "object" && (typeof fnOrKey === "string" || typeof fnOrKey === "symbol")) {
|
||||
if (!profileFunctionFactory) {
|
||||
return;
|
||||
}
|
||||
|
||||
return profileMethodUnnamed(nameFnOrTarget, fnOrKey, descriptor);
|
||||
} else if (typeof nameFnOrTarget === "function" && (typeof fnOrKey === "string" || typeof fnOrKey === "symbol")) {
|
||||
if (!profileFunctionFactory) {
|
||||
return;
|
||||
}
|
||||
|
||||
return profileStaticMethodUnnamed(nameFnOrTarget, fnOrKey, descriptor);
|
||||
} else if (typeof nameFnOrTarget === "string" && typeof fnOrKey === "function") {
|
||||
if (!profileFunctionFactory) {
|
||||
return fnOrKey;
|
||||
}
|
||||
|
||||
return profileFunction(fnOrKey, nameFnOrTarget);
|
||||
} else if (typeof nameFnOrTarget === "function") {
|
||||
if (!profileFunctionFactory) {
|
||||
return nameFnOrTarget;
|
||||
}
|
||||
|
||||
return profileFunction(nameFnOrTarget);
|
||||
} else if (typeof nameFnOrTarget === "string") {
|
||||
if (!profileFunctionFactory) {
|
||||
return voidMethodDecorator;
|
||||
}
|
||||
|
||||
return profileMethodNamed(nameFnOrTarget);
|
||||
} else {
|
||||
if (!profileFunctionFactory) {
|
||||
return voidMethodDecorator;
|
||||
}
|
||||
|
||||
return profileMethodUnnamed;
|
||||
}
|
||||
}
|
||||
|
||||
export function dumpProfiles(): void {
|
||||
profileNames.forEach(function (name) {
|
||||
const info = timers[name];
|
||||
if (info) {
|
||||
console.log("---- [" + name + "] STOP total: " + info.totalTime + " count:" + info.count);
|
||||
}
|
||||
else {
|
||||
console.log("---- [" + name + "] Never called");
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
export function resetProfiles(): void {
|
||||
profileNames.forEach(function (name) {
|
||||
const info = timers[name];
|
||||
if (info) {
|
||||
if (info.runCount) {
|
||||
console.log("---- timer with name [" + name + "] is currently running and won't be reset");
|
||||
} else {
|
||||
timers[name] = undefined;
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
export function startCPUProfile(name: string) {
|
||||
if (anyGlobal.android) {
|
||||
__startCPUProfiler(name);
|
||||
}
|
||||
}
|
||||
|
||||
export function stopCPUProfile(name: string) {
|
||||
if (anyGlobal.android) {
|
||||
__stopCPUProfiler(name);
|
||||
}
|
||||
}
|
||||
|
||||
export function level(): Level {
|
||||
return tracingLevel;
|
||||
}
|
||||
|
||||
export function trace(message: string, start: number, end: number): void {
|
||||
log(`Timeline: Modules: ${message} (${start}ms. - ${end}ms.)`);
|
||||
}
|
Reference in New Issue
Block a user