rn-perf-kit 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +33 -4
- package/src/PerfProvider.tsx +57 -0
- package/src/adapters.ts +3 -0
- package/src/index.ts +8 -0
- package/src/install.ts +8 -0
- package/src/navigation.ts +1 -0
- package/src/perf.ts +27 -0
- package/tsconfig.json +5 -0
- package/README.md +0 -3
package/package.json
CHANGED
|
@@ -1,6 +1,35 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rn-perf-kit",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Deep performance profiling toolkit for React Native apps",
|
|
5
|
+
"main": "./src/index.ts",
|
|
6
|
+
"types": "./src/index.ts",
|
|
7
|
+
"exports": {
|
|
8
|
+
".": "./src/index.ts",
|
|
9
|
+
"./install": "./src/install.ts",
|
|
10
|
+
"./navigation": "./src/navigation.ts",
|
|
11
|
+
"./adapters": "./src/adapters.ts"
|
|
12
|
+
},
|
|
13
|
+
"scripts": {
|
|
14
|
+
"typecheck": "tsc --noEmit",
|
|
15
|
+
"lint": "eslint src/"
|
|
16
|
+
},
|
|
17
|
+
"peerDependencies": {
|
|
18
|
+
"react": ">=18.0.0",
|
|
19
|
+
"react-native": ">=0.73.0"
|
|
20
|
+
},
|
|
21
|
+
"devDependencies": {
|
|
22
|
+
"typescript": "^5.3.0",
|
|
23
|
+
"@types/react": "^18.0.0"
|
|
24
|
+
},
|
|
25
|
+
"dependencies": {
|
|
26
|
+
"@rn-perf-kit/core": "^0.1.0",
|
|
27
|
+
"@rn-perf-kit/native": "^0.1.0",
|
|
28
|
+
"@rn-perf-kit/react": "^0.1.0",
|
|
29
|
+
"@rn-perf-kit/navigation": "^0.1.0",
|
|
30
|
+
"@rn-perf-kit/adapters": "^0.1.0",
|
|
31
|
+
"@rn-perf-kit/analyzers": "^0.1.0",
|
|
32
|
+
"@rn-perf-kit/overlay": "^0.1.0",
|
|
33
|
+
"@rn-perf-kit/reporters": "^0.1.0"
|
|
34
|
+
}
|
|
35
|
+
}
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* PerfProvider — top-level context provider.
|
|
3
|
+
* Initializes all collectors and provides configuration to child components.
|
|
4
|
+
*/
|
|
5
|
+
import React, { createContext, useContext, useEffect, type ReactNode } from 'react';
|
|
6
|
+
import { timeline, BudgetEngine, type BudgetConfig, type DeviceTier } from '@rn-perf-kit/core';
|
|
7
|
+
import type { BudgetViolation } from '@rn-perf-kit/core';
|
|
8
|
+
import { setFiberHookEnabled } from '@rn-perf-kit/react';
|
|
9
|
+
import { startStallDetector, stopStallDetector } from '@rn-perf-kit/native';
|
|
10
|
+
import { installFetchInterceptor, uninstallFetchInterceptor } from '@rn-perf-kit/adapters';
|
|
11
|
+
|
|
12
|
+
export type PerfMode = 'light' | 'deep';
|
|
13
|
+
|
|
14
|
+
export interface PerfProviderConfig {
|
|
15
|
+
enabled?: boolean;
|
|
16
|
+
mode?: PerfMode;
|
|
17
|
+
budgets?: BudgetConfig;
|
|
18
|
+
onViolation?: (violation: BudgetViolation) => void;
|
|
19
|
+
deviceTier?: DeviceTier;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
interface PerfContextValue { enabled: boolean; mode: PerfMode; tier: DeviceTier }
|
|
23
|
+
|
|
24
|
+
const PerfContext = createContext<PerfContextValue>({ enabled: false, mode: 'light', tier: 'MID' });
|
|
25
|
+
|
|
26
|
+
export function PerfProvider({
|
|
27
|
+
children,
|
|
28
|
+
enabled = false,
|
|
29
|
+
mode = 'light',
|
|
30
|
+
budgets,
|
|
31
|
+
onViolation,
|
|
32
|
+
deviceTier = 'MID',
|
|
33
|
+
}: PerfProviderConfig & { children: ReactNode }): React.JSX.Element {
|
|
34
|
+
useEffect(() => {
|
|
35
|
+
if (!enabled) return;
|
|
36
|
+
timeline.enabled = true;
|
|
37
|
+
startStallDetector();
|
|
38
|
+
installFetchInterceptor();
|
|
39
|
+
setFiberHookEnabled(true, mode === 'deep');
|
|
40
|
+
return () => {
|
|
41
|
+
stopStallDetector();
|
|
42
|
+
uninstallFetchInterceptor();
|
|
43
|
+
setFiberHookEnabled(false);
|
|
44
|
+
timeline.enabled = false;
|
|
45
|
+
};
|
|
46
|
+
}, [enabled, mode]);
|
|
47
|
+
|
|
48
|
+
return (
|
|
49
|
+
<PerfContext.Provider value={{ enabled, mode, tier: deviceTier }}>
|
|
50
|
+
{children}
|
|
51
|
+
</PerfContext.Provider>
|
|
52
|
+
);
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
export function usePerfContext(): PerfContextValue {
|
|
56
|
+
return useContext(PerfContext);
|
|
57
|
+
}
|
package/src/adapters.ts
ADDED
package/src/index.ts
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export { PerfProvider, usePerfContext } from './PerfProvider';
|
|
2
|
+
export type { PerfProviderConfig, PerfMode } from './PerfProvider';
|
|
3
|
+
export { perf } from './perf';
|
|
4
|
+
export { PerfOverlay } from '@rn-perf-kit/overlay';
|
|
5
|
+
export { PerfTrace, usePerfScreen, useDiscardedRenderTracker } from '@rn-perf-kit/react';
|
|
6
|
+
export { timeline, perfClock } from '@rn-perf-kit/core';
|
|
7
|
+
export type { PerfEvent, DeviceTier, BudgetConfig, BudgetViolation } from '@rn-perf-kit/core';
|
|
8
|
+
export { generateJsonReport, generatePerfettoTrace, serializeReport } from '@rn-perf-kit/reporters';
|
package/src/install.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { withNavigationPerf, installNavigationListeners, useNavigationPerf, recordNavPhase } from '@rn-perf-kit/navigation';
|
package/src/perf.ts
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Manual tracing API.
|
|
3
|
+
*
|
|
4
|
+
* Usage:
|
|
5
|
+
* import { perf } from 'rn-perf-kit';
|
|
6
|
+
* const t = perf.start('parse-catalog');
|
|
7
|
+
* parseCatalog(json);
|
|
8
|
+
* t.end();
|
|
9
|
+
*/
|
|
10
|
+
import { timeline } from '@rn-perf-kit/core';
|
|
11
|
+
|
|
12
|
+
interface TraceHandle { end: (data?: unknown) => void }
|
|
13
|
+
|
|
14
|
+
export const perf = {
|
|
15
|
+
start(name: string, data?: unknown): TraceHandle {
|
|
16
|
+
const startT = timeline.now();
|
|
17
|
+
timeline.mark(`${name}:start`, data);
|
|
18
|
+
return {
|
|
19
|
+
end(endData?: unknown) {
|
|
20
|
+
timeline.mark(`${name}:end`, { ...((endData as object) ?? {}), dur: timeline.now() - startT });
|
|
21
|
+
},
|
|
22
|
+
};
|
|
23
|
+
},
|
|
24
|
+
mark(name: string, data?: unknown): void {
|
|
25
|
+
timeline.mark(name, data);
|
|
26
|
+
},
|
|
27
|
+
};
|
package/tsconfig.json
ADDED
package/README.md
DELETED